Source code for contrail_api_cli.commands.schema

# -*- coding: utf-8 -*-
from __future__ import unicode_literals
from six import string_types, text_type

from ..command import Command, Arg, Option
from ..schema import create_schema_from_version, list_available_schema_version, SchemaVersionNotAvailable, ResourceNotDefined, get_last_schema_version
from ..utils import format_tree
from ..exceptions import CommandError


class Schema(Command):
    """View resources links using contrail schema definition.

    .. code-block:: bash

        admin@localhost:/> schema -v 2.21 virtual-network
        virtual-network
        ├── parent
        │   └── project
        ├── children
        │   ├── access-control-list
        │   ├── routing-instance
        │   ├── alias-ip-pool
        │   └── floating-ip-pool
        ├── refs
        │   ├── route-table
        │   ├── network-policy
        │   ├── qos-config
        │   └── network-ipam
        ├── back_refs
        │   ├── instance-ip
        │   ├── physical-router
        │   ├── logical-router
        │   └── virtual-machine-interface
        └── properties
            ├── import-route-target-list
            ├── export-route-target-list
            ├── provider-properties
            ├── multi-policy-service-chains-enabled
            ├── flood-unknown-unicast
            ├── virtual-network-network-id
            ├── router-external
            ├── virtual-network-properties
            ├── route-target-list
            ├── is-shared
            ├── external-ipam
            ├── id-perms
            ├── perms2
            └── display-name
    """
    description = "Explore schema resources"
    schema_version = Option('-v',
                            type=str,
                            default=get_last_schema_version(),
                            choices=list_available_schema_version(),
                            help="schema version to use (default='%(default)s')")
    list_version = Option('-l',
                          action="store_true",
                          help="list available schema versions")
    resource_name = Arg(nargs="?", help="Schema resource name",
                        metavar='resource_name',
                        complete='collections::type')

    def _list_resources(self, schema):
        return "\n".join(schema.all_resources())

    def _resource(self, schema, resource_name):
        try:
            resource = schema.resource(resource_name)
        except ResourceNotDefined as e:
            raise CommandError(text_type(e))
        tree = {
            'node': resource_name,
            'childs': []
        }
        parents = getattr(resource, "parents")
        if parents:
            tree['childs'].append({
                'node': "parent",
                'childs': [{'node': " | ".join(parents)}]
            })
        for type in ('children', 'refs', 'back_refs', 'properties'):
            childs = getattr(resource, type)
            if not childs:
                continue
            if isinstance(childs, string_types):
                childs = [childs]
            tree['childs'].append({
                'node': type,
                'childs': [{'node': '%s' % c} for c in childs]
            })
        return format_tree(tree)

    def __call__(self, schema_version=None,
                 list_version=False, resource_name=None):

        if list_version:
            versions = " ".join(list_available_schema_version())
            return "Available schema versions are: %s" % versions

        else:
            try:
                schema = create_schema_from_version(schema_version)
            except SchemaVersionNotAvailable as e:
                raise CommandError(text_type(e))

            if resource_name is None:
                return self._list_resources(schema)
            else:
                return self._resource(schema, resource_name)