Add zone resource in fabric in RSD 2.3

Change-Id: I28f3f8c5084c609d1c4979adfb47c33e6f4da824
This commit is contained in:
Lin Yang 2018-06-12 21:33:30 -07:00
parent e16a2af697
commit f7824e2586
4 changed files with 283 additions and 0 deletions

View File

@ -0,0 +1,73 @@
# Copyright 2017 Intel, Inc.
# All Rights Reserved.
#
# 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 logging
from rsd_lib.resources.v2_1.fabric import zone as v2_1_zone
LOG = logging.getLogger(__name__)
class Zone(v2_1_zone.Zone):
def update(self, endpoints):
"""Add or remove Endpoints from a Zone
User have to provide a full representation of Endpoints array. A
partial update (single element update/append/detele) is not supported.
:param endpoints: a full representation of Endpoints array
"""
data = {"Links": {"Endpoints": []}}
data['Links']['Endpoints'] = [
{'@odata.id': endpoint} for endpoint in endpoints]
self._conn.patch(self.path, data=data)
def delete(self):
"""Delete this zone"""
self._conn.delete(self.path)
class ZoneCollection(v2_1_zone.ZoneCollection):
@property
def _resource_type(self):
return Zone
def __init__(self, connector, path, redfish_version=None):
"""A class representing a Zone Collection
:param connector: A Connector instance
:param path: The canonical path to the Zone collection resource
:param redfish_version: The version of RedFish. Used to construct
the object according to schema of the given version.
"""
super(ZoneCollection, self).__init__(connector, path,
redfish_version)
def create_zone(self, endpoints):
"""Create a new Zone
:param endpoints: a full representation of Endpoints array
:returns: The uri of the new zone
"""
data = {"Links": {"Endpoints": []}}
data['Links']['Endpoints'] = [
{'@odata.id': endpoint} for endpoint in endpoints]
resp = self._conn.post(self.path, data=data)
LOG.info("Zone created at %s", resp.headers['Location'])
zone_uri = resp.headers['Location']
return zone_uri[zone_uri.find(self._path):]

View File

@ -0,0 +1,24 @@
{
"@odata.context": "/redfish/v1/$metadata#Zone.Zone",
"@odata.id": "/redfish/v1/Fabrics/NVMeoE/Zones/1",
"@odata.type": "#Zone.v1_0_0.Zone",
"Id": "1",
"Name": "Zone 1",
"Description": "Zone 1",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"Links": {
"Endpoints": [
{
"@odata.id": "/redfish/v1/Fabrics/NVMeoE/Endpoints/1"
},
{
"@odata.id": "/redfish/v1/Fabrics/NVMeoE/Endpoints/2"
}
],
"InvolvedSwitches": []
},
"Oem": {}
}

View File

@ -0,0 +1,13 @@
{
"@odata.context": "/redfish/v1/$metadata#ZoneCollection.ZoneCollection",
"@odata.id": "/redfish/v1/Fabrics/NVMeoE/Zones",
"@odata.type": "#ZoneCollection.ZoneCollection",
"Description": "Zone Collection",
"Members": [
{
"@odata.id": "/redfish/v1/Fabrics/NVMeoE/Zones/1"
}
],
"Members@odata.count": 1,
"Name": "Zone Collection"
}

View File

@ -0,0 +1,173 @@
# Copyright 2017 Intel, Inc.
# All Rights Reserved.
#
# 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 json
import mock
import testtools
from rsd_lib.resources.v2_3.fabric import zone
from rsd_lib.tests.unit.fakes import request_fakes
class ZoneTestCase(testtools.TestCase):
def setUp(self):
super(ZoneTestCase, self).setUp()
self.conn = mock.Mock()
with open('rsd_lib/tests/unit/json_samples/v2_3/zone.json',
'r') as f:
self.conn.get.return_value.json.return_value = json.loads(f.read())
self.zone_inst = zone.Zone(
self.conn, '/redfish/v1/Fabrics/NVMeoE/Zones/1',
redfish_version='1.0.2')
def test__parse_attributes(self):
self.zone_inst._parse_attributes()
self.assertEqual('1.0.2', self.zone_inst.redfish_version)
self.assertEqual('Zone 1',
self.zone_inst.description)
self.assertEqual('1', self.zone_inst.identity)
self.assertEqual('Zone 1', self.zone_inst.name)
self.assertEqual(('/redfish/v1/Fabrics/NVMeoE/Endpoints/1',
'/redfish/v1/Fabrics/NVMeoE/Endpoints/2'),
self.zone_inst.links.endpoint_identities)
self.assertEqual('Enabled', self.zone_inst.status.state)
self.assertEqual('OK', self.zone_inst.status.health)
def test_endpoints(self):
# check for the underneath variable value
self.assertIsNone(self.zone_inst._endpoints)
# | GIVEN |
self.conn.get.return_value.json.reset_mock()
with open('rsd_lib/tests/unit/json_samples/v2_3/'
'endpoint_1.json', 'r') as f:
self.conn.get.return_value.json.return_value = json.loads(f.read())
# | WHEN |
actual_endpoints = self.zone_inst.endpoints
# | THEN |
self.assertEqual('1', actual_endpoints[0].identity)
self.assertEqual(2, len(actual_endpoints))
self.conn.get.return_value.json.assert_called_with()
# reset mock
self.conn.get.return_value.json.reset_mock()
# | WHEN & THEN |
# tests for same object on invoking subsequently
self.assertIs(actual_endpoints,
self.zone_inst.endpoints)
self.conn.get.return_value.json.assert_not_called()
def test_endpoints_on_refresh(self):
# | GIVEN |
with open('rsd_lib/tests/unit/json_samples/v2_3/'
'endpoint_1.json', 'r') as f:
self.conn.get.return_value.json.return_value = json.loads(f.read())
# | WHEN & THEN |
self.assertEqual('1', self.zone_inst.endpoints[0].identity)
self.assertEqual(2, len(self.zone_inst.endpoints))
# On refreshing the fabric instance...
with open('rsd_lib/tests/unit/json_samples/v2_3/'
'zone.json', 'r') as f:
self.conn.get.return_value.json.return_value = json.loads(f.read())
self.zone_inst.refresh()
# | WHEN & THEN |
self.assertIsNone(self.zone_inst._endpoints)
# | GIVEN |
with open('rsd_lib/tests/unit/json_samples/v2_3/'
'endpoint_1.json', 'r') as f:
self.conn.get.return_value.json.return_value = json.loads(f.read())
# | WHEN & THEN |
self.assertEqual('1', self.zone_inst.endpoints[0].identity)
self.assertEqual(2, len(self.zone_inst.endpoints))
def test_update(self):
self.zone_inst.update(
['/redfish/v1/Fabrics/NVMeoE/Endpoints/1'])
self.zone_inst._conn.patch.assert_called_once_with(
'/redfish/v1/Fabrics/NVMeoE/Zones/1',
data={"Links": {"Endpoints":
[{"@odata.id": "/redfish/v1/Fabrics/NVMeoE/Endpoints/1"}]}})
self.zone_inst._conn.patch.reset_mock()
self.zone_inst.update(
['/redfish/v1/Fabrics/NVMeoE/Endpoints/2',
'/redfish/v1/Fabrics/NVMeoE/Endpoints/3'])
self.zone_inst._conn.patch.assert_called_once_with(
'/redfish/v1/Fabrics/NVMeoE/Zones/1',
data={"Links": {"Endpoints":
[{"@odata.id": "/redfish/v1/Fabrics/NVMeoE/Endpoints/2"},
{"@odata.id": "/redfish/v1/Fabrics/NVMeoE/Endpoints/3"}]}})
def test_delete(self):
self.zone_inst.delete()
self.zone_inst._conn.delete.assert_called_once()
class ZoneCollectionTestCase(testtools.TestCase):
def setUp(self):
super(ZoneCollectionTestCase, self).setUp()
self.conn = mock.Mock()
with open('rsd_lib/tests/unit/json_samples/v2_3/'
'zone_collection.json', 'r') as f:
self.conn.get.return_value.json.return_value = json.loads(f.read())
self.conn.post.return_value = request_fakes.fake_request_post(
None, headers={"Location": "https://localhost:8443/redfish/v1/"
"Fabrics/NVMeoE/Zones/2"})
self.zone_col = zone.ZoneCollection(
self.conn, '/redfish/v1/Fabrics/NVMeoE/Zones',
redfish_version='1.0.2')
def test__parse_attributes(self):
self.zone_col._parse_attributes()
self.assertEqual('1.0.2', self.zone_col.redfish_version)
self.assertEqual('Zone Collection',
self.zone_col.name)
self.assertEqual(('/redfish/v1/Fabrics/NVMeoE/Zones/1',),
self.zone_col.members_identities)
@mock.patch.object(zone, 'Zone', autospec=True)
def test_get_member(self, mock_zone):
self.zone_col.get_member('/redfish/v1/Fabrics/NVMeoE/Zones/1')
mock_zone.assert_called_once_with(
self.zone_col._conn, '/redfish/v1/Fabrics/NVMeoE/Zones/1',
redfish_version=self.zone_col.redfish_version)
@mock.patch.object(zone, 'Zone', autospec=True)
def test_get_members(self, mock_zone):
members = self.zone_col.get_members()
mock_zone.assert_called_with(
self.zone_col._conn, '/redfish/v1/Fabrics/NVMeoE/Zones/1',
redfish_version=self.zone_col.redfish_version)
self.assertIsInstance(members, list)
self.assertEqual(1, len(members))
def test_create_zone(self):
result = self.zone_col.create_zone(
['/redfish/v1/Fabrics/NVMeoE/Endpoints/2',
'/redfish/v1/Fabrics/NVMeoE/Endpoints/3'])
self.zone_col._conn.post.assert_called_once_with(
'/redfish/v1/Fabrics/NVMeoE/Zones',
data={"Links": {"Endpoints":
[{"@odata.id": "/redfish/v1/Fabrics/NVMeoE/Endpoints/2"},
{"@odata.id": "/redfish/v1/Fabrics/NVMeoE/Endpoints/3"}]}})
self.assertEqual(result,
'/redfish/v1/Fabrics/NVMeoE/Zones/2')