aboutsummaryrefslogtreecommitdiffstats
path: root/lib/policy.js
blob: d471cffe6a6c34c2f2141bc010f0a7818fe85cfa (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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
/*
Copyright(c) 2017-2018 AT&T Intellectual Property. 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.
*/

/**
 * handling policy updates
 */

"use strict";

const POLICY_UPDATE_OPERATION = "dcae.interfaces.policy.policy_update";

const config = process.mainModule.exports.config;
const createError = require('./dispatcher-error').createDispatcherError;
const logger = require('./logging').getLogger();

var cloudify = require("./cloudify.js");

// Set config for cloudify interface library
cloudify.setAPIAddress(config.cloudify.url);
cloudify.setCredentials(config.cloudify.user, config.cloudify.password);
cloudify.setLogger(logger);

/**
 * receive the policy-updated message from the policy-handler
 */
function policyUpdate(req, res, next) {

    const policy_update = {
        catch_up : req.body && req.body.catch_up,
        latest_policies : JSON.stringify((req.body && req.body.latest_policies) || {}),
        removed_policies : JSON.stringify((req.body && req.body.removed_policies) || {}),
        errored_policies : JSON.stringify((req.body && req.body.errored_policies) || {}),
        errored_scopes : JSON.stringify((req.body && req.body.errored_scopes) || []),
        scope_prefixes : JSON.stringify((req.body && req.body.scope_prefixes) || []),
        policy_deployments : {},
        updated_policy_ids : {},
        added_policy_ids : {},
        removed_policy_ids : {}
    };

    logger.debug(req.dcaeReqId, "policyUpdate "
                + req.method + ' ' + req.protocol + '://' + req.get('host') + req.originalUrl
                + " catch_up: " + policy_update.catch_up
                + " latest_policies: " + policy_update.latest_policies
                + " removed_policies: " + policy_update.removed_policies
                + " errored_policies: " + policy_update.errored_policies
                + " errored_scopes: " + policy_update.errored_scopes
                + " scope_prefixes: " + policy_update.scope_prefixes
                );
    /**
     * reply to and free up the policy_handler
     */
    const response = {"requestID": req.dcaeReqId};
    response.started = new Date();
    response.server_instance_uuid = process.mainModule.exports.config.server_instance_uuid;
    res.json(response);

    policy_update.latest_policies = JSON.parse(policy_update.latest_policies);
    policy_update.removed_policies = JSON.parse(policy_update.removed_policies);
    policy_update.errored_policies = JSON.parse(policy_update.errored_policies);
    policy_update.errored_scopes = JSON.parse(policy_update.errored_scopes);
    policy_update.scope_prefixes = JSON.parse(policy_update.scope_prefixes);

    const is_policy_in_scopes = function(policy_id) {
        return policy_update.scope_prefixes.some(scope_prefix => {
            return policy_id.startsWith(scope_prefix);
        });
    };

    const is_policy_in_errored_scopes = function(policy_id) {
        return policy_update.errored_scopes.some(errored_scope => {
            return policy_id.startsWith(errored_scope);
        });
    };
    /**
     * filter out the policies to what is deployed in components and needs updating (new policyVersion)
     */
    const collect_policy_deployments = function(node_instances) {
        node_instances.forEach(node_instance => {
            if (!node_instance.runtime_properties
            || (!node_instance.runtime_properties.policies
                && !node_instance.runtime_properties.policy_filters)) {
                return;
            }
            logger.debug(req.dcaeReqId, "checking policies on node_instance: " + JSON.stringify(node_instance));

            const deployment = policy_update.policy_deployments[node_instance.deployment_id] || {
                "deployment_id": node_instance.deployment_id,
                "updated_policies": {},
                "added_policies": {},
                "removed_policy_ids": {},
                "node_instance_ids": [],
                "is_deployment_busy": cloudify.exeQueue.isDeploymentBusy(node_instance.deployment_id)
            };

            var have_policies = false;
            const deployed_policies = node_instance.runtime_properties.policies || {};

            Object.keys(deployed_policies).forEach(policy_id => {
                const deployed_policy = deployed_policies[policy_id];
                const latest_policy = policy_update.latest_policies[policy_id];
                if (policy_update.removed_policies[policy_id]
                  || (policy_update.catch_up
                    && (deployed_policy.policy_body || deployment.is_deployment_busy)
                    && !latest_policy
                    && !policy_update.errored_policies[policy_id]
                    && !is_policy_in_errored_scopes(policy_id)
                    && is_policy_in_scopes(policy_id))) {
                    have_policies = true;
                    deployment.removed_policy_ids[policy_id] = true;
                    policy_update.removed_policy_ids[policy_id] = true;
                    logger.debug(req.dcaeReqId, "going to remove policy " + policy_id + " from node_instance: " + JSON.stringify(node_instance));
                    return;
                }

                if (!latest_policy || !latest_policy.policy_body
                || isNaN(latest_policy.policy_body.policyVersion)) {return;}

                if (!deployment.is_deployment_busy && latest_policy.policy_body.policyVersion
                === (deployed_policy.policy_body && deployed_policy.policy_body.policyVersion)) {return;}

                have_policies = true;
                deployment.updated_policies[policy_id] = latest_policy;
                policy_update.updated_policy_ids[policy_id] = true;
                logger.debug(req.dcaeReqId, "going to update policy " + policy_id + " on node_instance: " + JSON.stringify(node_instance));
            });

            const policy_filters = node_instance.runtime_properties.policy_filters || {};
            const policy_filter_ids = Object.keys(policy_filters);
            if (policy_filter_ids.length) {
                logger.debug(req.dcaeReqId, "matching latest policies to policy_filters[" + policy_filter_ids.length + "] on node_instance: " + JSON.stringify(node_instance));
                try {
                    Object.keys(policy_update.latest_policies).forEach(policy_id => {
                        if (!deployment.is_deployment_busy && deployed_policies[policy_id]) {return;}

                        const latest_policy = policy_update.latest_policies[policy_id];
                        const policy_body = latest_policy && latest_policy.policy_body;
                        if (!policy_body || isNaN(policy_body.policyVersion)) {return;}
                        const policy_name = policy_body.policyName;
                        if (!policy_name) {return;}
                        const matching_conditions = policy_body.matchingConditions || {};

                        logger.debug(req.dcaeReqId, "matching policy " + JSON.stringify(latest_policy));
                        policy_filter_ids.some(policy_filter_id => {
                            const policy_filter = policy_filters[policy_filter_id].policy_filter;
                            if (!policy_filter || !policy_filter.policyName) {return false;}

                            logger.debug(req.dcaeReqId, "matching to policy_filter " + JSON.stringify(policy_filter));

                            if (!!policy_filter.onapName
                            && policy_filter.onapName !== matching_conditions.ONAPName) {
                                logger.debug(req.dcaeReqId, "not match policy_filter_id " + policy_filter_id
                                    + " by ONAPName: "
                                    + policy_filter.onapName + " !== " + matching_conditions.ONAPName);
                                return false;
                            }
                            if (!!policy_filter.configName
                            && policy_filter.configName !== matching_conditions.ConfigName) {
                                logger.debug(req.dcaeReqId, "not match policy_filter_id " + policy_filter_id
                                    + " by configName: "
                                    + policy_filter.configName + " !== " + matching_conditions.ConfigName);
                                return false;
                            }

                            if (policy_filter.configAttributes
                            && !Object.keys(policy_filter.configAttributes).every(filter_key => {
                                    return (matching_conditions.hasOwnProperty(filter_key)
                                        && policy_filter.configAttributes[filter_key]
                                       === matching_conditions[filter_key]);
                                })) {
                                logger.debug(req.dcaeReqId, "not match policy_filter_id " + policy_filter_id
                                    + " by configAttributes: "
                                    + JSON.stringify(policy_filter.configAttributes) + " !== " + JSON.stringify(matching_conditions));
                                return false;
                            }

                            if (policy_filter.policyName !== policy_id && policy_filter.policyName !== policy_name) {
                                const match_policy_name = new RegExp(policy_filter.policyName);
                                if (!match_policy_name.test(policy_name)) {
                                    logger.debug(req.dcaeReqId, "not match policy_filter_id " + policy_filter_id
                                        + " by policyName: "
                                        + policy_filter.policyName + " versus " + policy_name);
                                    return false;
                                }
                            }

                            have_policies = true;
                            if (!deployment.added_policies[policy_filter_id]) {
                                deployment.added_policies[policy_filter_id] = {
                                    "policy_filter_id" : policy_filter_id,
                                    "policies" : {}
                                };
                            }
                            deployment.added_policies[policy_filter_id].policies[policy_id] = latest_policy;
                            policy_update.added_policy_ids[policy_id] = true;
                            logger.debug(req.dcaeReqId, "going to add policy " + JSON.stringify(latest_policy)
                                + " per policy_filter_id " + policy_filter_id
                                + " on node_instance: " + JSON.stringify(node_instance));
                            return true;
                        });
                    });
                } catch (e) {
                    const error_msg = "error on matching policy to filter " + (e.message || "")
                        + " " + (e.stack || "").replace(/\n/g, " ")
                    logger.error(createError(error_msg, 500, "api", 553, 'deployment-handler'), req);
                }
            }

            if (have_policies) {
                deployment.node_instance_ids.push(node_instance.id);
                policy_update.policy_deployments[deployment.deployment_id] = deployment;
            }
        });

        logger.debug(req.dcaeReqId, "collected policy_deployments to update " + JSON.stringify(policy_update.policy_deployments));
    };

    const update_policies_on_deployments = function(result) {
        logger.debug(req.dcaeReqId, "finished loading policy_deployments" + JSON.stringify(result));
        if (result.status !== 200) {
            const error_msg = "failed to retrieve component policies from cloudify " + result.message;
            logger.error(createError(error_msg, result.status, "api", 502, 'cloudify-manager'), req);
            logger.audit(req, result.status, error_msg);
            return;
        }

        const deployment_ids = Object.keys(policy_update.policy_deployments);
        if (!deployment_ids.length) {
            const audit_msg = "no updated policies to apply to deployments";
            logger.debug(req.dcaeReqId, audit_msg);
            logger.audit(req, result.status, audit_msg);
            return;
        }
        const audit_msg = "going to apply updated policies[" + Object.keys(policy_update.updated_policy_ids).length
                        + "] and added policies[" + Object.keys(policy_update.added_policy_ids).length
                        + "] and removed policies[" + Object.keys(policy_update.removed_policy_ids).length
                        + "] to deployments[" + deployment_ids.length + "]";
        logger.debug(req.dcaeReqId, audit_msg + ": " + JSON.stringify(deployment_ids));
        logger.audit(req, result.status, audit_msg);
        deployment_ids.forEach(deployment_id => {
            const deployment = policy_update.policy_deployments[deployment_id];
            deployment.updated_policies = Object.keys(deployment.updated_policies).map(policy_id => {
                return deployment.updated_policies[policy_id];
            });
            deployment.removed_policy_ids = Object.keys(deployment.removed_policy_ids);

            logger.debug(req.dcaeReqId, "ready to execute-operation policy-update on deployment " + JSON.stringify(deployment));
            cloudify.executeOperation(req, deployment.deployment_id, POLICY_UPDATE_OPERATION,
                {
                    'updated_policies': deployment.updated_policies,
                    'added_policies': deployment.added_policies,
                    'removed_policies': deployment.removed_policy_ids
                },
                deployment.node_instance_ids
            );
        });
    };

    cloudify.getNodeInstances(req, collect_policy_deployments).then(update_policies_on_deployments);
}

/**
 * retrieve all component-policies from cloudify
 */
function getComponentPoliciesFromCloudify(req, res, next) {
    logger.debug(req.dcaeReqId, "getComponentPoliciesFromCloudify " + req.originalUrl);
    const response = {"requestID": req.dcaeReqId};
    response.started = new Date();
    response.server_instance_uuid = process.mainModule.exports.config.server_instance_uuid;
    response.node_instance_ids = [];
    response.component_policies = [];
    response.component_policy_filters = [];
    response.node_instances = [];

    cloudify.getNodeInstances(req, function(node_instances) {
        Array.prototype.push.apply(response.node_instances, node_instances);
        node_instances.forEach(node_instance => {
            if (!node_instance.runtime_properties
            || (!node_instance.runtime_properties.policies
             && !node_instance.runtime_properties.policy_filters)) {
                return;
            }

            var policies_count = 0;
            var policy_filters_count = 0;
            if (node_instance.runtime_properties.policies) {
                Object.keys(node_instance.runtime_properties.policies).forEach(policy_id => {
                    ++policies_count;
                    const policy = node_instance.runtime_properties.policies[policy_id];
                    policy.component_id = node_instance.id;
                    policy.deployment_id = node_instance.deployment_id;
                    response.component_policies.push(policy);
                });
            }
            if (node_instance.runtime_properties.policy_filters) {
                Object.keys(node_instance.runtime_properties.policy_filters).forEach(policy_filter => {
                    ++policy_filters_count;
                    policy_filter = node_instance.runtime_properties.policy_filters[policy_filter];
                    policy_filter.component_id = node_instance.id;
                    policy_filter.deployment_id = node_instance.deployment_id;
                    response.component_policy_filters.push(policy_filter);
                });
            }
            if (policies_count + policy_filters_count) {
                response.node_instance_ids.push({
                    "node_instance_id" : node_instance.id,
                    "deployment_id" : node_instance.deployment_id,
                    "policies_count" : policies_count,
                    "policy_filters_count" : policy_filters_count
                });
            }
        });

        logger.debug(req.dcaeReqId, "collected " + response.node_instance_ids.length
                    + " node_instance_ids: " + JSON.stringify(response.node_instance_ids)
                    + " component_policies: " + JSON.stringify(response.component_policies)
                    + " component_policy_filters: " + JSON.stringify(response.component_policy_filters)
        );
    })
    .then(function(result) {
        response.ended = new Date();
        response.status = result.status;
        response.message = result.message;
        logger.debug(req.dcaeReqId, result.message);
        if (result.status !== 200) {
            logger.error(createError(result.message, result.status, "api", 502, 'cloudify-manager'), req);
        }
        res.status(result.status).json(response);
        logger.audit(req, result.status, result.message);
    });
}

// ========================================================

const app = require('express')();
app.set('x-powered-by', false);
app.set('etag', false);
app.use(require('./middleware').checkType('application/json'));
app.use(require('body-parser').json({strict: true}));
app.use(function(req, res, next) {
	logger.debug(req.dcaeReqId,
		"new req: " + req.method + " " + req.originalUrl +
		" from: " + req.ip + " body: " + JSON.stringify(req.body)
	);
	next();
});

app.post('/', policyUpdate);
app.get('/components', getComponentPoliciesFromCloudify);

module.exports = app;