154 lines
4.7 KiB
Python
154 lines
4.7 KiB
Python
# Copyright 2019 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 copy
|
|
|
|
from sushy.resources import base
|
|
from sushy import utils
|
|
|
|
from rsd_lib import utils as rsd_lib_utils
|
|
|
|
|
|
class DynamicField(base.Field):
|
|
"""Base class for fields consisting of several dynamic attributes."""
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
super(DynamicField, self).__init__(*args, **kwargs)
|
|
self._subfields = None
|
|
|
|
def _load(self, body, resource, nested_in=None):
|
|
"""Load the all attributes.
|
|
|
|
:param body: parent JSON body.
|
|
:param resource: parent resource.
|
|
:param nested_in: parent resource name (for error reporting only).
|
|
:returns: a new object with sub-fields attached to it.
|
|
"""
|
|
nested_in = (nested_in or []) + self._path
|
|
value = super(DynamicField, self)._load(body, resource)
|
|
if value is None:
|
|
return None
|
|
|
|
# We need a new instance, as this method is called a singleton instance
|
|
# that is attached to a class (not instance) of a resource or another
|
|
# CompositeField. We don't want to end up modifying this instance.
|
|
instance = copy.copy(self)
|
|
for name, attr in value.items():
|
|
setattr(
|
|
instance,
|
|
rsd_lib_utils.camelcase_to_underscore_joined(name),
|
|
attr,
|
|
)
|
|
|
|
return instance
|
|
|
|
|
|
class StatusField(base.CompositeField):
|
|
"""This Field describes the status of a resource and its children."""
|
|
|
|
health = base.Field("Health")
|
|
"""Represents health of resource w/o considering its dependent resources"""
|
|
|
|
health_rollup = base.Field("HealthRollup")
|
|
"""Represents health state of resource and its dependent resources"""
|
|
|
|
state = base.Field("State")
|
|
"""Indicates the known state of the resource, such as if it is enabled."""
|
|
|
|
|
|
class LocationField(base.CompositeField):
|
|
|
|
info = base.Field("Info")
|
|
"""This indicates the location of the resource."""
|
|
|
|
info_format = base.Field("InfoFormat")
|
|
"""This represents the format of the Info property."""
|
|
|
|
|
|
class ReferenceableMemberField(base.ListField):
|
|
|
|
member_id = base.Field("MemberId")
|
|
"""This is the identifier for the member within the collection."""
|
|
|
|
|
|
class IdentifierField(base.CompositeField):
|
|
|
|
durable_name = base.Field("DurableName")
|
|
"""This indicates the world wide, persistent name of the resource."""
|
|
|
|
durable_name_format = base.Field("DurableNameFormat")
|
|
"""This represents the format of the DurableName property."""
|
|
|
|
|
|
class RedundancyCollectionField(ReferenceableMemberField):
|
|
"""Redundancy field
|
|
|
|
This is the redundancy definition to be used in other resource schemas.
|
|
"""
|
|
|
|
name = base.Field("Name")
|
|
"""The name of the resource or array element."""
|
|
|
|
mode = base.Field("Mode")
|
|
"""This is the redundancy mode of the group."""
|
|
|
|
max_num_supported = base.Field(
|
|
"MaxNumSupported", adapter=rsd_lib_utils.num_or_none
|
|
)
|
|
"""This is the maximum number of members allowable for this particular
|
|
redundancy group.
|
|
"""
|
|
|
|
min_num_needed = base.Field(
|
|
"MinNumNeeded", adapter=rsd_lib_utils.num_or_none
|
|
)
|
|
"""This is the minumum number of members needed for this group to be
|
|
redundant.
|
|
"""
|
|
|
|
status = StatusField("Status")
|
|
"""This indicates the known state of the resource, such as if it is
|
|
enabled.
|
|
"""
|
|
|
|
redundancy_set = base.Field(
|
|
"RedundancySet", adapter=utils.get_members_identities
|
|
)
|
|
"""Contains any ids that represent components of this redundancy set."""
|
|
|
|
redundancy_enabled = base.Field("RedundancyEnabled", adapter=bool)
|
|
"""This indicates whether redundancy is enabled."""
|
|
|
|
|
|
class ResourceBase(base.ResourceBase):
|
|
|
|
identity = base.Field("Id", required=True)
|
|
"""The resource identity string"""
|
|
|
|
name = base.Field("Name")
|
|
"""The resource name"""
|
|
|
|
description = base.Field("Description")
|
|
"""The resource description"""
|
|
|
|
|
|
class ResourceCollectionBase(base.ResourceCollectionBase):
|
|
|
|
name = base.Field("Name")
|
|
"""The resource collection name"""
|
|
|
|
description = base.Field("Description")
|
|
"""The resource collection description"""
|