# coding=utf-8
from __future__ import absolute_import

__author__ = "Gina Häußge <osd@foosel.net>"
__license__ = 'GNU Affero General Public License http://www.gnu.org/licenses/agpl.html'
__copyright__ = "Copyright (C) 2014 The OctoPrint Project - Released under terms of the AGPLv3 License"


import unittest
import mock
import warnings

from ddt import ddt, unpack, data

import octoprint.plugin
import octoprint.settings

@ddt
class SettingsTestCase(unittest.TestCase):

	def setUp(self):
		warnings.simplefilter("always")

		self.plugin_key = "test_plugin"

		self.settings = mock.create_autospec(octoprint.settings.Settings)

		self.defaults = dict(
			some_raw_key="some_raw_value",
			some_int_key=1,
			some_float_key=2.5,
			some_boolean_key=True,
		)

		self.plugin_settings = octoprint.plugin.PluginSettings(self.settings, self.plugin_key, defaults=self.defaults)

	@data(
		("get", (["some_raw_key",],), dict(), "get"),
		("get", (["some_raw_key",],), dict(merged=True), "get"),
		("get", (["some_raw_key",],), dict(asdict=True), "get"),
		("get", (["some_raw_key",],), dict(merged=True, asdict=True), "get"),
		("get_int", (["some_int_key,"],), dict(), "getInt"),
		("get_float", (["some_float_key"],), dict(), "getFloat"),
		("get_boolean", (["some_boolean_key",],), dict(), "getBoolean"),
	)
	@unpack
	def test_forwarded_getter(self, getter, getter_args, getter_kwargs, forwarded):
		method_under_test = getattr(self.plugin_settings, getter)
		self.assertTrue(callable(method_under_test))

		method_under_test(*getter_args, **getter_kwargs)

		forwarded_method = getattr(self.settings, forwarded)
		forwarded_args = (["plugins", self.plugin_key] + getter_args[0],)
		forwarded_kwargs = getter_kwargs
		forwarded_kwargs.update(dict(defaults=dict(plugins=dict(test_plugin=self.defaults))))
		forwarded_method.assert_called_once_with(*forwarded_args, **forwarded_kwargs)

	@data(
		("global_get", (["some_raw_key"],), dict(), "get"),
		("global_get", (["some_raw_key"],), dict(merged=True), "get"),
		("global_get", (["some_raw_key"],), dict(asdict=True), "get"),
		("global_get", (["some_raw_key"],), dict(merged=True, asdict=True), "get"),
		("global_get_int", (["some_int_key"],), dict(), "getInt"),
		("global_get_float", (["some_float_key"],), dict(), "getFloat"),
		("global_get_boolean", (["some_boolean_key"],), dict(), "getBoolean")
	)
	@unpack
	def test_global_getter(self, getter, getter_args, getter_kwargs, forwarded):
		method_under_test = getattr(self.plugin_settings, getter)
		self.assertTrue(callable(method_under_test))

		method_under_test(*getter_args, **getter_kwargs)

		forwarded_method = getattr(self.settings, forwarded)
		forwarded_method.assert_called_once_with(*getter_args, **getter_kwargs)

	@data(
		("getInt", "get_int", "getInt"),
		("getFloat", "get_float", "getFloat"),
		("getBoolean", "get_boolean", "getBoolean"),
	)
	@unpack
	def test_deprecated_forwarded_getter(self, deprecated, current, forwarded):
		with warnings.catch_warnings(record=True) as w:
			called_method = getattr(self.settings, forwarded)
			called_method.__name__ = forwarded

			method = getattr(self.plugin_settings, deprecated)
			self.assertTrue(callable(method))
			method(["some_raw_key"])

			called_method.assert_called_once_with(["plugins", self.plugin_key, "some_raw_key"], defaults=dict(plugins=dict(test_plugin=self.defaults)))

			self.assertEquals(1, len(w))
			self.assertTrue(issubclass(w[-1].category, DeprecationWarning))
			self.assertTrue("{old} has been renamed to {new}".format(old=deprecated, new=current) in (w[-1].message))

	@data(
		("globalGet", "global_get", "get"),
		("globalGetInt", "global_get_int", "getInt"),
		("globalGetFloat", "global_get_float", "getFloat"),
		("globalGetBoolean", "global_get_boolean", "getBoolean")
	)
	@unpack
	def test_deprecated_global_getter(self, deprecated, current, forwarded):
		with warnings.catch_warnings(record=True) as w:
			called_method = getattr(self.settings, forwarded)
			called_method.__name__ = forwarded

			method = getattr(self.plugin_settings, deprecated)
			self.assertTrue(callable(method))
			method(["some_raw_key"])

			called_method.assert_called_once_with(["some_raw_key",])

			self.assertEquals(1, len(w))
			self.assertTrue(issubclass(w[-1].category, DeprecationWarning))
			self.assertTrue("{old} has been renamed to {new}".format(old=deprecated, new=current) in (w[-1].message))

	@data(
		("set", (["some_raw_key",], "some_value"), dict(), "set"),
		("set", (["some_raw_key",], "some_value"), dict(force=True), "set"),
		("set_int", (["some_int_key",], 23), dict(), "setInt"),
		("set_int", (["some_int_key",], 23), dict(force=True), "setInt"),
		("set_float", (["some_float_key",], 2.3), dict(), "setFloat"),
		("set_float", (["some_float_key",], 2.3), dict(force=True), "setFloat"),
		("set_boolean", (["some_boolean_key",], True), dict(), "setBoolean"),
		("set_boolean", (["some_boolean_key",], True), dict(force=True), "setBoolean"),
	)
	@unpack
	def test_forwarded_setter(self, setter, setter_args, setter_kwargs, forwarded):
		method_under_test = getattr(self.plugin_settings, setter)
		self.assertTrue(callable(method_under_test))

		method_under_test(*setter_args, **setter_kwargs)

		forwarded_method = getattr(self.settings, forwarded)
		forwarded_args = (["plugins", self.plugin_key] + setter_args[0], setter_args[1])
		forwarded_kwargs = setter_kwargs
		forwarded_kwargs.update(dict(defaults=dict(plugins=dict(test_plugin=self.defaults))))
		forwarded_method.assert_called_once_with(*forwarded_args, **forwarded_kwargs)

	@data(
		("global_set", (["some_raw_key",], "some_value"), dict(), "set"),
		("global_set", (["some_raw_key",], "some_value"), dict(force=True), "set"),
		("global_set_int", (["some_int_key",], 23), dict(), "setInt"),
		("global_set_int", (["some_int_key",], 23), dict(force=True), "setInt"),
		("global_set_float", (["some_float_key",], 2.3), dict(), "setFloat"),
		("global_set_float", (["some_float_key",], 2.3), dict(force=True), "setFloat"),
		("global_set_boolean", (["some_boolean_key",], True), dict(), "setBoolean"),
		("global_set_boolean", (["some_boolean_key",], True), dict(force=True), "setBoolean"),
	)
	@unpack
	def test_global_setter(self, setter, setter_args, setter_kwargs, forwarded):
		method_under_test = getattr(self.plugin_settings, setter)
		self.assertTrue(callable(method_under_test))

		method_under_test(*setter_args, **setter_kwargs)

		forwarded_method = getattr(self.settings, forwarded)
		forwarded_method.assert_called_once_with(*setter_args, **setter_kwargs)

	@data(
		("setInt", "set_int", "setInt", 1),
		("setFloat", "set_float", "setFloat", 2.5),
		("setBoolean", "set_boolean", "setBoolean", True)
	)
	@unpack
	def test_deprecated_forwarded_setter(self, deprecated, current, forwarded, value):
		with warnings.catch_warnings(record=True) as w:
			called_method = getattr(self.settings, forwarded)
			called_method.__name__ = forwarded

			method = getattr(self.plugin_settings, deprecated)
			self.assertTrue(callable(method))
			method(["some_raw_key"], value)

			called_method.assert_called_once_with(["plugins", self.plugin_key, "some_raw_key"], value, defaults=dict(plugins=dict(test_plugin=self.defaults)))

			self.assertEquals(1, len(w))
			self.assertTrue(issubclass(w[-1].category, DeprecationWarning))
			self.assertTrue("{old} has been renamed to {new}".format(old=deprecated, new=current) in (w[-1].message))

	@data(
		("globalSet", "global_set", "set", "some_value"),
		("globalSetInt", "global_set_int", "setInt", 1),
		("globalSetFloat", "global_set_float", "setFloat", 2.5),
		("globalSetBoolean", "global_set_boolean", "setBoolean", True)
	)
	@unpack
	def test_deprecated_global_setter(self, deprecated, current, forwarded, value):
		with warnings.catch_warnings(record=True) as w:
			called_method = getattr(self.settings, forwarded)
			called_method.__name__ = forwarded

			method = getattr(self.plugin_settings, deprecated)
			self.assertTrue(callable(method))
			method(["some_raw_key"], value)

			called_method.assert_called_once_with(["some_raw_key"], value)

			self.assertEquals(1, len(w))
			self.assertTrue(issubclass(w[-1].category, DeprecationWarning))
			self.assertTrue("{old} has been renamed to {new}".format(old=deprecated, new=current) in (w[-1].message))

	def test_global_get_basefolder(self):
		self.plugin_settings.global_get_basefolder("some_folder")
		self.settings.getBaseFolder.assert_called_once_with("some_folder")

	def test_deprecated_global_get_basefolder(self):
		with warnings.catch_warnings(record=True) as w:
			self.plugin_settings.globalGetBaseFolder("some_folder")
			self.settings.getBaseFolder.assert_called_once_with("some_folder")

			self.assertEquals(1, len(w))
			self.assertTrue(issubclass(w[-1].category, DeprecationWarning))
			self.assertTrue("globalGetBaseFolder has been renamed to global_get_basefolder" in (w[-1].message))

	def test_logfile_path(self):
		import os

		self.settings.getBaseFolder.return_value = "/some/folder"

		path = self.plugin_settings.get_plugin_logfile_path()

		self.settings.getBaseFolder.assert_called_once_with("logs")
		self.assertEquals("/some/folder/plugin_{key}.log".format(key=self.plugin_key), path.replace(os.sep, "/"))

	def test_logfile_path_with_postfix(self):
		import os

		self.settings.getBaseFolder.return_value = "/some/folder"

		path = self.plugin_settings.get_plugin_logfile_path(postfix="mypostfix")

		self.settings.getBaseFolder.assert_called_once_with("logs")
		self.assertEquals("/some/folder/plugin_{key}_mypostfix.log".format(key=self.plugin_key), path.replace(os.sep, "/"))

	def test_deprecated_logfile_path(self):
		import os

		with warnings.catch_warnings(record=True) as w:
			self.settings.getBaseFolder.return_value = "/some/folder"
			path = self.plugin_settings.getPluginLogfilePath()

			self.settings.getBaseFolder.assert_called_once_with("logs")
			self.assertEquals("/some/folder/plugin_{key}.log".format(key=self.plugin_key), path.replace(os.sep, "/"))

			self.assertEquals(1, len(w))
			self.assertTrue(issubclass(w[-1].category, DeprecationWarning))
			self.assertTrue("getPluginLogfilePath has been renamed to get_plugin_logfile_path" in (w[-1].message))

	def test_unhandled_method(self):
		try:
			self.plugin_settings.some_method("some_parameter")
		except AttributeError as e:
			self.assertTrue("Mock object has no attribute 'some_method'" in str(e))