#    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.

import datetime
from unittest import mock

from nova.api.openstack.compute import hypervisors
from nova import objects
from nova.policies import hypervisors as hv_policies
from nova.tests.unit.api.openstack import fakes
from nova.tests.unit.policies import base


class HypervisorsPolicyTest(base.BasePolicyTest):
    """Test os-hypervisors APIs policies with all possible context.
    This class defines the set of context with different roles
    which are allowed and not allowed to pass the policy checks.
    With those set of context, it will call the API operation and
    verify the expected behaviour.
    """

    def setUp(self):
        super(HypervisorsPolicyTest, self).setUp()
        self.controller = hypervisors.HypervisorsController()
        self.req = fakes.HTTPRequest.blank('')
        self.controller._get_compute_nodes_by_name_pattern = mock.MagicMock()
        self.controller.host_api.compute_node_get_all = mock.MagicMock()
        self.controller.host_api.service_get_by_compute_host = mock.MagicMock(
            return_value=objects.Service(
                id=123,
                binary='nova-compute',
                created_at=datetime.datetime(2012, 9, 18, 2, 46, 27),
                disabled=False,
                disabled_reason=None,
                forced_down=False,
                host='foo',
                last_seen_up=None,
            )
        )
        self.controller.host_api.compute_node_get = mock.MagicMock(
            return_value=objects.ComputeNode(
                id=123,
                cpu_info='{}',
                current_workload=1,
                disk_available_least=10,
                free_disk_gb=50,
                free_ram_mb=512,
                host='foo',
                host_ip='1.2.3.4',
                hypervisor_hostname='foo',
                hypervisor_type='libvirt',
                hypervisor_version='123',
                local_gb=1000,
                local_gb_used=10,
                memory_mb=8192,
                memory_mb_used=1024,
                running_vms=1,
                vcpus=16,
                vcpus_used=8,
            ),
        )
        self.controller.host_api.compute_node_statistics = mock.MagicMock(
            return_value={
                'count': 0,
                'current_workload': 0,
                'disk_available_least': 0,
                'free_disk_gb': 0,
                'free_ram_mb': 0,
                'local_gb': 0,
                'local_gb_used': 0,
                'memory_mb': 0,
                'memory_mb_used': 0,
                'running_vms': 0,
                'vcpus': 0,
                'vcpus_used': 0,
            }
        )
        self.controller.host_api.get_host_uptime = mock.MagicMock(
            return_value=None
        )

        # With legacy rule and scope check disabled by default,
        # legacy admin and project admin will be able to perform hypervisors
        # Operations.
        self.project_admin_authorized_contexts = [
            self.legacy_admin_context,
            self.project_admin_context]

    def test_list_hypervisors_policy(self):
        rule_name = hv_policies.BASE_POLICY_NAME % 'list'
        self.common_policy_auth(self.project_admin_authorized_contexts,
                                rule_name, self.controller.index,
                                self.req)

    def test_list_details_hypervisors_policy(self):
        rule_name = hv_policies.BASE_POLICY_NAME % 'list-detail'
        self.common_policy_auth(self.project_admin_authorized_contexts,
                                rule_name, self.controller.detail,
                                self.req)

    def test_show_hypervisors_policy(self):
        rule_name = hv_policies.BASE_POLICY_NAME % 'show'
        self.common_policy_auth(self.project_admin_authorized_contexts,
                                rule_name, self.controller.show,
                                self.req, '123')

    @mock.patch('nova.compute.api.HostAPI.get_host_uptime')
    def test_uptime_hypervisors_policy(self, mock_uptime):
        rule_name = hv_policies.BASE_POLICY_NAME % 'uptime'
        self.common_policy_auth(self.project_admin_authorized_contexts,
                                rule_name, self.controller.uptime,
                                self.req, '123')

    def test_search_hypervisors_policy(self):
        rule_name = hv_policies.BASE_POLICY_NAME % 'search'
        self.common_policy_auth(self.project_admin_authorized_contexts,
                                rule_name, self.controller.search,
                                self.req, '123')

    def test_servers_hypervisors_policy(self):
        rule_name = hv_policies.BASE_POLICY_NAME % 'servers'
        self.common_policy_auth(self.project_admin_authorized_contexts,
                                rule_name, self.controller.servers,
                                self.req, '123')

    def test_statistics_hypervisors_policy(self):
        rule_name = hv_policies.BASE_POLICY_NAME % 'statistics'
        self.common_policy_auth(self.project_admin_authorized_contexts,
                                rule_name, self.controller.statistics,
                                self.req)


class HypervisorsNoLegacyPolicyTest(HypervisorsPolicyTest):
    """Test Hypervisors APIs policies with no legacy deprecated rules
    which means new defaults only. In this case, legacy admin and project
    admin will be able to perform Hypervisors Operations.
    """

    without_deprecated_rules = True
