253 lines
8.0 KiB
Python
253 lines
8.0 KiB
Python
# Copyright 2014 Huawei Technologies Co. Ltd
|
|
#
|
|
# 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.
|
|
|
|
"""Metadata related object holder."""
|
|
import logging
|
|
|
|
from compass.db.api import database
|
|
from compass.db.api import metadata as metadata_api
|
|
from compass.db.api import permission
|
|
from compass.db.api import user as user_api
|
|
from compass.db.api import utils
|
|
from compass.db import exception
|
|
|
|
|
|
RESP_METADATA_FIELDS = [
|
|
'os_config', 'package_config'
|
|
]
|
|
|
|
|
|
@database.run_in_session()
|
|
def load_metadatas(session):
|
|
load_os_metadatas_internal(session)
|
|
load_package_metadatas_internal(session)
|
|
|
|
|
|
def load_os_metadatas_internal(session):
|
|
global OS_METADATA_MAPPING
|
|
logging.info('load os metadatas into memory')
|
|
OS_METADATA_MAPPING = metadata_api.get_os_metadatas_internal(session)
|
|
|
|
|
|
def load_package_metadatas_internal(session):
|
|
global PACKAGE_METADATA_MAPPING
|
|
logging.info('load package metadatas into memory')
|
|
PACKAGE_METADATA_MAPPING = (
|
|
metadata_api.get_package_metadatas_internal(session)
|
|
)
|
|
|
|
|
|
OS_METADATA_MAPPING = {}
|
|
PACKAGE_METADATA_MAPPING = {}
|
|
|
|
|
|
def _validate_config(
|
|
config, id, id_name, metadata_mapping, whole_check, **kwargs
|
|
):
|
|
if id not in metadata_mapping:
|
|
raise exception.InvalidParameter(
|
|
'%s id %s is not found in metadata mapping' % (id_name, id)
|
|
)
|
|
metadatas = metadata_mapping[id]
|
|
metadata_api.validate_config_internal(
|
|
config, metadatas, whole_check, **kwargs
|
|
)
|
|
|
|
|
|
def validate_os_config(
|
|
session, config, os_id, whole_check=False, **kwargs
|
|
):
|
|
if not OS_METADATA_MAPPING:
|
|
load_os_metadatas_internal(session)
|
|
_validate_config(
|
|
config, os_id, 'os', OS_METADATA_MAPPING,
|
|
whole_check, session=session, **kwargs
|
|
)
|
|
|
|
|
|
def validate_package_config(
|
|
session, config, adapter_id, whole_check=False, **kwargs
|
|
):
|
|
if not PACKAGE_METADATA_MAPPING:
|
|
load_package_metadatas_internal(session)
|
|
_validate_config(
|
|
config, adapter_id, 'adapter', PACKAGE_METADATA_MAPPING,
|
|
whole_check, session=session, **kwargs
|
|
)
|
|
|
|
|
|
def _filter_metadata(metadata, **kwargs):
|
|
if not isinstance(metadata, dict):
|
|
return metadata
|
|
filtered_metadata = {}
|
|
for key, value in metadata.items():
|
|
if key == '_self':
|
|
filtered_metadata['_self'] = {}
|
|
default_value = value.get('default_value', None)
|
|
if default_value is None:
|
|
default_callback_params = value.get(
|
|
'default_callback_params', {}
|
|
)
|
|
callback_params = dict(kwargs)
|
|
if default_callback_params:
|
|
callback_params.update(default_callback_params)
|
|
default_callback = value.get('default_callback', None)
|
|
if default_callback:
|
|
default_value = default_callback(key, **callback_params)
|
|
options = value.get('options', None)
|
|
if options is None:
|
|
options_callback_params = value.get(
|
|
'options_callback_params', {}
|
|
)
|
|
callback_params = dict(kwargs)
|
|
if options_callback_params:
|
|
callback_params.update(options_callback_params)
|
|
|
|
options_callback = value.get('options_callback', None)
|
|
if options_callback:
|
|
options = options_callback(key, **callback_params)
|
|
filtered_metadata[key] = {
|
|
'name': value['name'],
|
|
'description': value.get('description', None),
|
|
'default_value': default_value,
|
|
'is_required': value.get(
|
|
'is_required', False),
|
|
'required_in_whole_config': value.get(
|
|
'required_in_whole_config', False),
|
|
'js_validator': value.get('js_validator', None),
|
|
'options': options,
|
|
'required_in_options': value.get(
|
|
'required_in_options', False),
|
|
'field_type': value.get(
|
|
'field_type_data', 'str'),
|
|
'display_type': value.get('display_type', None),
|
|
'mapping_to': value.get('mapping_to', None)
|
|
}
|
|
else:
|
|
filtered_metadata[key] = _filter_metadata(value)
|
|
return filtered_metadata
|
|
|
|
|
|
def get_package_metadata_internal(session, adapter_id):
|
|
"""get package metadata internal."""
|
|
if not PACKAGE_METADATA_MAPPING:
|
|
load_package_metadatas_internal(session)
|
|
if adapter_id not in PACKAGE_METADATA_MAPPING:
|
|
raise exception.RecordNotExists(
|
|
'adpater %s does not exist' % adapter_id
|
|
)
|
|
return _filter_metadata(
|
|
PACKAGE_METADATA_MAPPING[adapter_id], session=session
|
|
)
|
|
|
|
|
|
@utils.supported_filters([])
|
|
@database.run_in_session()
|
|
@user_api.check_user_permission_in_session(
|
|
permission.PERMISSION_LIST_METADATAS
|
|
)
|
|
@utils.wrap_to_dict(RESP_METADATA_FIELDS)
|
|
def get_package_metadata(session, getter, adapter_id, **kwargs):
|
|
return {
|
|
'package_config': get_package_metadata_internal(session, adapter_id)
|
|
}
|
|
|
|
|
|
def get_os_metadata_internal(session, os_id):
|
|
"""get os metadata internal."""
|
|
if not OS_METADATA_MAPPING:
|
|
load_os_metadatas_internal(session)
|
|
if os_id not in OS_METADATA_MAPPING:
|
|
raise exception.RecordNotExists(
|
|
'os %s does not exist' % os_id
|
|
)
|
|
return _filter_metadata(
|
|
OS_METADATA_MAPPING[os_id], session=session
|
|
)
|
|
|
|
|
|
@utils.supported_filters([])
|
|
@database.run_in_session()
|
|
@user_api.check_user_permission_in_session(
|
|
permission.PERMISSION_LIST_METADATAS
|
|
)
|
|
@utils.wrap_to_dict(RESP_METADATA_FIELDS)
|
|
def get_os_metadata(session, getter, os_id, **kwargs):
|
|
"""get os metadatas."""
|
|
return {'os_config': get_os_metadata_internal(session, os_id)}
|
|
|
|
|
|
@utils.supported_filters([])
|
|
@database.run_in_session()
|
|
@user_api.check_user_permission_in_session(
|
|
permission.PERMISSION_LIST_METADATAS
|
|
)
|
|
@utils.wrap_to_dict(RESP_METADATA_FIELDS)
|
|
def get_package_os_metadata(session, getter, adapter_id, os_id, **kwargs):
|
|
from compass.db.api import adapter_holder as adapter_api
|
|
adapter = adapter_api.get_adapter_internal(session, adapter_id)
|
|
os_ids = [os['os_id'] for os in adapter['supported_oses']]
|
|
if os_id not in os_ids:
|
|
raise exception.InvalidParameter(
|
|
'os %s is not in the supported os list of adapter %s' % (
|
|
os_id, adapter_id
|
|
)
|
|
)
|
|
metadatas = {}
|
|
metadatas['os_config'] = get_os_metadata_internal(
|
|
session, os_id
|
|
)
|
|
metadatas['package_config'] = get_package_metadata_internal(
|
|
session, adapter_id
|
|
)
|
|
return metadatas
|
|
|
|
|
|
def _autofill_config(
|
|
config, id, id_name, metadata_mapping, **kwargs
|
|
):
|
|
if id not in metadata_mapping:
|
|
raise exception.InvalidParameter(
|
|
'%s id %s is not found in metadata mapping' % (id_name, id)
|
|
)
|
|
metadatas = metadata_mapping[id]
|
|
logging.debug(
|
|
'auto fill %s config %s by metadata %s',
|
|
id_name, config, metadatas
|
|
)
|
|
return metadata_api.autofill_config_internal(
|
|
config, metadatas, **kwargs
|
|
)
|
|
|
|
|
|
def autofill_os_config(
|
|
session, config, os_id, **kwargs
|
|
):
|
|
if not OS_METADATA_MAPPING:
|
|
load_os_metadatas_internal(session)
|
|
return _autofill_config(
|
|
config, os_id, 'os', OS_METADATA_MAPPING, session=session, **kwargs
|
|
)
|
|
|
|
|
|
def autofill_package_config(
|
|
session, config, adapter_id, **kwargs
|
|
):
|
|
if not PACKAGE_METADATA_MAPPING:
|
|
load_package_metadatas_internal(session)
|
|
return _autofill_config(
|
|
config, adapter_id, 'adapter', PACKAGE_METADATA_MAPPING,
|
|
session=session, **kwargs
|
|
)
|