# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from http import client as http_client
import json
from unittest import mock

from sushy.resources import constants as res_cons
from sushy.resources.taskservice import constants as ts_cons
from sushy.resources.taskservice import task
from sushy.tests.unit import base


class TaskTestCase(base.TestCase):

    def setUp(self):
        super().setUp()
        self.conn = mock.Mock()
        with open('sushy/tests/unit/json_samples/task.json') as f:
            self.json_doc = json.load(f)

        self.conn.get.return_value.json.return_value = self.json_doc

        message_registry = mock.Mock()
        message = mock.Mock()
        message.message = "Property %1 is read only."
        message.number_of_args = 1
        message_registry.messages = {"PropertyNotWriteable": message}

        self.task = task.Task(
            self.conn, '/redfish/v1/TaskService/Tasks/545',
            redfish_version='1.4.3',
            registries={'Base.1.0': message_registry})

    def test__parse_attributes(self):
        self.task._parse_attributes(self.json_doc)
        self.assertEqual('545', self.task.identity)
        self.assertEqual('Task 545', self.task.name)
        self.assertEqual('Task description', self.task.description)
        self.assertEqual('/taskmon/545', self.task.task_monitor)
        self.assertEqual('2012-03-07T14:44+06:00', self.task.start_time)
        self.assertEqual('2012-03-07T14:45+06:00', self.task.end_time)
        self.assertEqual(100, self.task.percent_complete)
        self.assertEqual(ts_cons.TaskState.COMPLETED, self.task.task_state)
        self.assertEqual(res_cons.Health.OK, self.task.task_status)
        self.assertEqual(1, len(self.task.messages))
        self.assertEqual('Base.1.0.PropertyNotWriteable',
                         self.task.messages[0].message_id)
        self.assertEqual('Property %1 is read only.',
                         self.task.messages[0].message)
        self.assertEqual(res_cons.Severity.WARNING,
                         self.task.messages[0].severity)

    def test_is_processing_true(self):
        self.task.status_code = http_client.ACCEPTED
        self.assertTrue(self.task.is_processing)

    def test_is_processing_false(self):
        self.task.status_code = http_client.OK
        self.assertFalse(self.task.is_processing)

    def test_parse_messages(self):
        self.task.parse_messages()
        self.assertEqual('Property SKU is read only.',
                         self.task.messages[0].message)


class TaskCollectionTestCase(base.TestCase):

    def setUp(self):
        super().setUp()
        self.conn = mock.Mock()
        with open('sushy/tests/unit/json_samples/'
                  'task_collection.json') as f:
            self.json_doc = json.load(f)

        self.conn.get.return_value.json.return_value = self.json_doc

        self.task_col = task.TaskCollection(
            self.conn, '/redfish/v1/TaskService/Tasks',
            redfish_version='1.0.2')

    def test__parse_attributes(self):
        self.task_col._parse_attributes(self.json_doc)
        self.assertEqual('1.0.2', self.task_col.redfish_version)
        self.assertEqual('Task Collection', self.task_col.name)
        self.assertEqual(('/redfish/v1/TaskService/Tasks/545',
                          '/redfish/v1/TaskService/Tasks/546'),
                         self.task_col.members_identities)

    @mock.patch.object(task, 'Task', autospec=True)
    def test_get_member(self, mock_task):
        self.task_col.get_member(
            '/redfish/v1/TaskService/Tasks/545')
        mock_task.assert_called_once_with(
            self.task_col._conn,
            '/redfish/v1/TaskService/Tasks/545',
            redfish_version=self.task_col.redfish_version, registries=None,
            root=self.task_col.root)

    @mock.patch.object(task, 'Task', autospec=True)
    def test_get_members(self, mock_task):
        members = self.task_col.get_members()
        calls = [
            mock.call(self.task_col._conn,
                      '/redfish/v1/TaskService/Tasks/545',
                      redfish_version=self.task_col.redfish_version,
                      registries=None,
                      root=self.task_col.root),
            mock.call(self.task_col._conn,
                      '/redfish/v1/TaskService/Tasks/546',
                      redfish_version=self.task_col.redfish_version,
                      registries=None,
                      root=self.task_col.root),
        ]
        mock_task.assert_has_calls(calls)
        self.assertIsInstance(members, list)
        self.assertEqual(2, len(members))

    def _setUp_task_summary(self):
        self.conn.get.return_value.json.reset_mock()
        successive_return_values = []
        file_names = ['sushy/tests/unit/json_samples/task.json',
                      'sushy/tests/unit/json_samples/task2.json']
        for file_name in file_names:
            with open(file_name) as f:
                successive_return_values.append(json.load(f))

        self.conn.get.return_value.json.side_effect = successive_return_values

    def test_summary(self):
        # | GIVEN |
        self._setUp_task_summary()
        # | WHEN |
        actual_summary = self.task_col.summary
        # | THEN |
        self.assertEqual({'545': ts_cons.TaskState.COMPLETED,
                          '546': ts_cons.TaskState.PENDING},
                         actual_summary)

        # reset mock
        self.conn.get.return_value.json.reset_mock()

        # | WHEN & THEN |
        # tests for same object on invoking subsequently
        self.assertIs(actual_summary,
                      self.task_col.summary)
        self.conn.get.return_value.json.assert_not_called()

    def test_summary_on_refresh(self):
        # | GIVEN |
        self._setUp_task_summary()
        # | WHEN & THEN |
        self.assertEqual({'545': ts_cons.TaskState.COMPLETED,
                          '546': ts_cons.TaskState.PENDING},
                         self.task_col.summary)

        self.conn.get.return_value.json.side_effect = None
        # On refreshing the task_col instance...
        with open('sushy/tests/unit/json_samples/'
                  'task_collection.json') as f:
            self.conn.get.return_value.json.return_value = json.load(f)
        self.task_col.invalidate()
        self.task_col.refresh(force=False)

        # | GIVEN |
        self._setUp_task_summary()
        # | WHEN & THEN |
        self.assertEqual({'545': ts_cons.TaskState.COMPLETED,
                          '546': ts_cons.TaskState.PENDING},
                         self.task_col.summary)
