aboutsummaryrefslogtreecommitdiffstats
path: root/app/api/responders/resource/clique_types.py
blob: e2e9e7138722fa88e05ebf043568301a8405f50b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
###############################################################################
# Copyright (c) 2017 Koren Lev (Cisco Systems), Yaron Yogev (Cisco Systems)   #
# and others                                                                  #
#                                                                             #
# All rights reserved. This program and the accompanying materials            #
# are made available under the terms of the Apache License, Version 2.0       #
# which accompanies this distribution, and is available at                    #
# http://www.apache.org/licenses/LICENSE-2.0                                  #
###############################################################################
from api.responders.responder_base import ResponderBase
from api.validation.data_validate import DataValidate
from bson.objectid import ObjectId


class CliqueTypes(ResponderBase):

    COLLECTION = "clique_types"
    ID = "_id"
    PROJECTION = {
        ID: True,
        "focal_point_type": True,
        "link_types": True,
        "environment": True,
        "name": True,
        "distribution": True,
        "distribution_version": True,
        "mechanism_drivers": True,
        "type_drivers": True,
        "use_implicit_links": True
    }
    RESERVED_NAMES = ["ANY"]

    def __init__(self):
        super().__init__()
        self.focal_point_types = self.get_constants_by_name("object_types")
        self.link_types = self.get_constants_by_name("link_types")
        self.mechanism_drivers = self.get_constants_by_name("mechanism_drivers")
        self.type_drivers = self.get_constants_by_name("type_drivers")

    def on_get(self, req, resp):
        self.log.debug("Getting clique types")

        filters = self.parse_query_params(req)
        filters_requirements = {
            'env_name': self.require(str),
            'id': self.require(ObjectId, convert_to_type=True),
            'distribution': self.require(str),
            'distribution_version': self.require(str),
            'mechanism_drivers': self.require(str,
                                              validate=DataValidate.LIST,
                                              requirement=self.mechanism_drivers),
            'type_drivers': self.require(str,
                                         validate=DataValidate.LIST,
                                         requirement=self.type_drivers),
            'focal_point_type': self.require(str,
                                             validate=DataValidate.LIST,
                                             requirement=self.focal_point_types),
            'link_type': self.require([list, str],
                                      validate=DataValidate.LIST,
                                      requirement=self.link_types),
            'name': self.require(str),
            'page': self.require(int, convert_to_type=True),
            'page_size': self.require(int, convert_to_type=True)
        }

        self.validate_query_data(filters, filters_requirements)
        if 'distribution_version' in filters and 'distribution' not in filters:
            self.bad_request("Distribution version without distribution "
                             "is not allowed")

        page, page_size = self.get_pagination(filters)
        query = self.build_query(filters)
        if self.ID in query:
            clique_type = self.get_object_by_id(self.COLLECTION, query,
                                                [ObjectId], self.ID)
            self.set_successful_response(resp, clique_type)
        else:
            clique_types_ids = self.get_objects_list(self.COLLECTION,
                                                     query,
                                                     page, page_size, self.PROJECTION)
            self.set_successful_response(resp,
                                         {"clique_types": clique_types_ids})

    def on_post(self, req, resp):
        self.log.debug("Posting new clique_type")
        error, clique_type = self.get_content_from_request(req)
        if error:
            self.bad_request(error)

        clique_type_requirements = {
            'environment': self.require(str),
            'focal_point_type': self.require(str,
                                             mandatory=True,
                                             validate=DataValidate.LIST,
                                             requirement=self.focal_point_types),
            'link_types': self.require(list,
                                       mandatory=True,
                                       validate=DataValidate.LIST,
                                       requirement=self.link_types),
            'name': self.require(str, mandatory=True),
            'distribution': self.require(str),
            'distribution_version': self.require(str),
            'mechanism_drivers': self.require(str,
                                              validate=DataValidate.LIST,
                                              requirement=self.mechanism_drivers),
            'type_drivers': self.require(str,
                                         validate=DataValidate.LIST,
                                         requirement=self.type_drivers),
            'use_implicit_links': self.require(bool)
        }

        self.validate_query_data(clique_type, clique_type_requirements)
        self.validate_required_fields(clique_type)
        self.validate_focal_point_type(clique_type)
        self.validate_duplicate_configuration(clique_type)

        self.write(clique_type, self.COLLECTION)
        self.set_successful_response(resp,
                                     {"message": "created a new clique_type"},
                                     "201")

    def build_query(self, filters):
        query = {}
        filters_keys = ['name', 'focal_point_type',
                        'distribution', 'distribution_version',
                        'mechanism_drivers', 'type_drivers']
        self.update_query_with_filters(filters, filters_keys, query)

        link_types = filters.get('link_type')
        if link_types:
            if type(link_types) != list:
                link_types = [link_types]
            query['link_types'] = {'$all': link_types}
        _id = filters.get('id')
        if _id:
            query[self.ID] = _id

        env_name = filters.get('env_name')
        if env_name:
            query['environment'] = filters['env_name']
        return query

    def validate_required_fields(self, clique_type):
        env_name = clique_type.get('environment')
        distribution = clique_type.get('distribution')
        distribution_version = clique_type.get('distribution_version')
        if distribution_version and not distribution:
            self.bad_request("Distribution version without distribution "
                             "is not allowed")

        configuration_specified = ((distribution and distribution_version)
                                   or clique_type.get('mechanism_drivers')
                                   or clique_type.get('type_drivers'))
        if env_name:
            if configuration_specified:
                self.bad_request("Either environment or configuration "
                                 "should be specified (not both).")

            if not self.check_environment_name(env_name):
                self.bad_request("Unknown environment: {}".format(env_name))
            elif env_name.upper() in self.RESERVED_NAMES:
                self.bad_request(
                    "Environment name '{}' is reserved".format(env_name))
        elif not configuration_specified:
            self.bad_request("Either environment or configuration "
                             "should be specified.")

    def validate_focal_point_type(self, clique_type):
        focal_point_type = clique_type['focal_point_type']
        environment = clique_type.get('environment')
        if environment:
            env_match = self.read(
                matches={"environment": environment,
                         "focal_point_type": focal_point_type},
                collection="clique_types"
            )
            if env_match:
                self.bad_request("Clique type with focal point {} "
                                 "is already registered for environment {}"
                                 .format(focal_point_type, environment))
        else:
            pass

    def validate_duplicate_configuration(self, clique_type):
        if clique_type.get('environment'):
            return

        search = {'focal_point_type': clique_type['focal_point_type']}
        for field in ['distribution', 'mechanism_drivers', 'type_drivers']:
            value = clique_type.get(field)
            if value:
                search[field] = value
                if field == 'distribution':
                    dv = clique_type.get('distribution_version')
                    if dv:
                        search['distribution_version'] = dv
                # Got a match with higher score, no need to look further
                break

        env_match = self.read(matches=search,
                              collection="clique_types")
        if env_match:
            self.bad_request("Clique type with configuration '{}' "
                             "is already registered"
                             .format(search))