tools/model-generator/src/main/java/org/onap/policy/apex/tools/model/generator/model2cli/Model2Cli.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
   4  *  Modifications Copyright (C) 2019 Samsung Electronics Co., Ltd.
   5  * ================================================================================
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  * SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.apex.tools.model.generator.model2cli;
  23
  24 import java.io.IOException;
  25 import java.io.Writer;
  26 import java.util.ArrayList;
  27 import java.util.Collection;
  28 import java.util.Collections;
  29 import java.util.List;
  30 import java.util.Map;
  31 import java.util.Map.Entry;
  32 import java.util.Properties;
  33
  34 import org.apache.commons.lang3.Validate;
  35 import org.onap.policy.apex.auth.clicodegen.CodeGenCliEditorBuilder;
  36 import org.onap.policy.apex.auth.clicodegen.CodeGeneratorCliEditor;
  37 import org.onap.policy.apex.auth.clicodegen.EventDeclarationBuilder;
  38 import org.onap.policy.apex.auth.clicodegen.PolicyStateDefBuilder;
  39 import org.onap.policy.apex.auth.clicodegen.PolicyStateTaskBuilder;
  40 import org.onap.policy.apex.auth.clicodegen.TaskDeclarationBuilder;
  41 import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
  42 import org.onap.policy.apex.model.basicmodel.concepts.AxReferenceKey;
  43 import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult;
  44 import org.onap.policy.apex.model.contextmodel.concepts.AxContextAlbum;
  45 import org.onap.policy.apex.model.contextmodel.concepts.AxContextSchema;
  46 import org.onap.policy.apex.model.eventmodel.concepts.AxEvent;
  47 import org.onap.policy.apex.model.eventmodel.concepts.AxField;
  48 import org.onap.policy.apex.model.modelapi.ApexApiResult;
  49 import org.onap.policy.apex.model.modelapi.ApexModel;
  50 import org.onap.policy.apex.model.modelapi.ApexModelFactory;
  51 import org.onap.policy.apex.model.policymodel.concepts.AxPolicy;
  52 import org.onap.policy.apex.model.policymodel.concepts.AxPolicyModel;
  53 import org.onap.policy.apex.model.policymodel.concepts.AxState;
  54 import org.onap.policy.apex.model.policymodel.concepts.AxStateFinalizerLogic;
  55 import org.onap.policy.apex.model.policymodel.concepts.AxStateOutput;
  56 import org.onap.policy.apex.model.policymodel.concepts.AxStateTaskReference;
  57 import org.onap.policy.apex.model.policymodel.concepts.AxTask;
  58 import org.onap.policy.apex.model.policymodel.concepts.AxTaskLogic;
  59 import org.onap.policy.apex.model.policymodel.concepts.AxTaskParameter;
  60 import org.onap.policy.apex.model.policymodel.concepts.AxTaskSelectionLogic;
  61 import org.onap.policy.apex.tools.common.OutputFile;
  62 import org.onap.policy.apex.tools.model.generator.KeyInfoGetter;
  63 import org.slf4j.ext.XLogger;
  64 import org.slf4j.ext.XLoggerFactory;
  65 import org.stringtemplate.v4.ST;
  66
  67 /**
  68  * Takes a model and generates the JSON event schemas.
  69  *
  70  * @author Sven van der Meer (sven.van.der.meer@ericsson.com)
  71  */
  72 public class Model2Cli {
  73     // Logger for this class
  74     private static final XLogger LOGGER = XLoggerFactory.getXLogger(Model2Cli.class);
  75
  76     /** Application name, used as prompt. */
  77     private final String appName;
  78
  79     /** The file name of the policy model. */
  80     private final String modelFile;
  81
  82     /** The output file, if any. */
  83     private final OutputFile outFile;
  84
  85     /** Pre-validate the model. */
  86     private final boolean validate;
  87
  88     /** utility for getting key information and parsing keys etc.. */
  89     private KeyInfoGetter kig = null;
  90
  91     /**
  92      * Creates a new model to CLI commands generator.
  93      *
  94      * @param modelFile the model file to be used
  95      * @param outFile the out file
  96      * @param validate true for model validation, false otherwise
  97      * @param appName application name for printouts
  98      */
  99     public Model2Cli(final String modelFile, final OutputFile outFile, final boolean validate, final String appName) {
 100         Validate.notNull(modelFile, "Model2Cli: given model file name was blank");
 101         Validate.notNull(appName, "Model2Cli: given application name was blank");
 102
 103         this.modelFile = modelFile;
 104         this.outFile = outFile;
 105         this.appName = appName;
 106         this.validate = validate;
 107     }
 108
 109     /**
 110      * Runs the application.
 111      *
 112      * @return status of the application execution, 0 for success, positive integer for exit condition (such as help or
 113      *         version), negative integer for errors
 114      */
 115     public int runApp() {
 116         final CodeGeneratorCliEditor codeGen = new CodeGeneratorCliEditor();
 117
 118         final ApexModelFactory factory = new ApexModelFactory();
 119         final ApexModel model = factory.createApexModel(new Properties(), true);
 120
 121         final ApexApiResult result = model.loadFromFile(modelFile);
 122         if (result.isNok()) {
 123             final String message = appName + ": " + result.getMessage();
 124             LOGGER.error(message);
 125             return -1;
 126         }
 127
 128         final AxPolicyModel policyModel = model.getPolicyModel();
 129         policyModel.register();
 130
 131         if (validate) {
 132             final AxValidationResult val = new AxValidationResult();
 133             policyModel.validate(val);
 134             if (!val.isOk()) {
 135                 final String message = "Cannot translate the model. The model is not valid: \n" + val.toString();
 136                 LOGGER.error(message);
 137                 return -1;
 138             }
 139         }
 140
 141         return generateCli(codeGen, policyModel);
 142     }
 143
 144     /**
 145      * Generate the CLI from the model.
 146      *
 147      * @param codeGen the code generator
 148      * @param policyModel the policy model
 149      */
 150     private int generateCli(final CodeGeneratorCliEditor codeGen, final AxPolicyModel policyModel) {
 151         kig = new KeyInfoGetter(policyModel);
 152
 153         // Order is important. 0: model, 1: context schemas, 2: tasks, 3: events, 4: ContextAlbums, 5: Policies
 154         // 0: model
 155         final AxArtifactKey pmkey = policyModel.getKey();
 156         codeGen.addModelParams(kig.getName(pmkey), kig.getVersion(pmkey), kig.getUuid(pmkey), kig.getDesc(pmkey));
 157
 158         // 1: Context Schemas
 159         for (final AxContextSchema s : policyModel.getSchemas().getSchemasMap().values()) {
 160             final AxArtifactKey key = s.getKey();
 161
 162             codeGen.addSchemaDeclaration(kig.getName(key), kig.getVersion(key), kig.getUuid(key), kig.getDesc(key),
 163                     s.getSchemaFlavour(), s.getSchema());
 164         }
 165
 166         // 2: tasks
 167         for (final AxTask t : policyModel.getTasks().getTaskMap().values()) {
 168             final AxArtifactKey key = t.getKey();
 169             final List<ST> infields = getInfieldsForTask(codeGen, t);
 170             final List<ST> outfields = getOutfieldsForTask(codeGen, t);
 171             final ST logic = getLogicForTask(codeGen, t);
 172             final List<ST> parameters = getParametersForTask(codeGen, t);
 173             final List<ST> contextRefs = getCtxtRefsForTask(codeGen, t);
 174
 175             codeGen.addTaskDeclaration(new TaskDeclarationBuilder().setName(kig.getName(key))
 176                     .setVersion(kig.getVersion(key)).setUuid(kig.getUuid(key))
 177                     .setDescription(kig.getDesc(key)).setInfields(infields).setOutfields(outfields)
 178                     .setLogic(logic).setParameters(parameters).setContextRefs(contextRefs));
 179         }
 180
 181         // 3: events
 182         for (final AxEvent e : policyModel.getEvents().getEventMap().values()) {
 183             final AxArtifactKey key = e.getKey();
 184             final List<ST> fields = getParametersForEvent(codeGen, e);
 185
 186             codeGen.addEventDeclaration(
 187                     new EventDeclarationBuilder()
 188                             .setName(kig.getName(key))
 189                             .setVersion(kig.getVersion(key))
 190                             .setUuid(kig.getUuid(key))
 191                             .setDescription(kig.getDesc(key))
 192                             .setNameSpace(e.getNameSpace())
 193                             .setSource(e.getSource())
 194                             .setTarget(e.getTarget())
 195                             .setFields(fields));
 196         }
 197
 198         // 4: context albums
 199         for (final AxContextAlbum a : policyModel.getAlbums().getAlbumsMap().values()) {
 200             final AxArtifactKey key = a.getKey();
 201
 202             codeGen.addContextAlbumDeclaration(new CodeGenCliEditorBuilder().setName(kig.getName(key))
 203                     .setVersion(kig.getVersion(key)).setUuid(kig.getUuid(key)).setDescription(kig.getDesc(key))
 204                     .setScope(a.getScope()).setWritable(a.isWritable()).setSchemaName(kig.getName(a.getItemSchema()))
 205                     .setSchemaVersion(kig.getVersion(a.getItemSchema())));
 206         }
 207
 208         // 5: policies
 209         for (final AxPolicy p : policyModel.getPolicies().getPolicyMap().values()) {
 210             final AxArtifactKey key = p.getKey();
 211             final List<ST> states = getStatesForPolicy(codeGen, p);
 212             codeGen.addPolicyDefinition(kig.getName(key), kig.getVersion(key), kig.getUuid(key), kig.getDesc(key),
 213                     p.getTemplate(), p.getFirstState(), states);
 214         }
 215
 216         final String out = codeGen.getModel().render();
 217         if (outFile != null) {
 218             final String message = "Error writing output to file " + outFile;
 219             try {
 220                 final Writer w = outFile.toWriter();
 221                 if (w == null) {
 222                     LOGGER.error(message);
 223                     return -1;
 224                 }
 225                 w.write(out);
 226                 w.close();
 227             } catch (final IOException e) {
 228                 LOGGER.error(message, e);
 229                 return -1;
 230             }
 231         } else {
 232             LOGGER.error(out);
 233         }
 234
 235         return 0;
 236     }
 237
 238     /**
 239      * Gets the parameters for event.
 240      *
 241      * @param cg the code generator
 242      * @param event the event
 243      * @return the parameters for event
 244      */
 245     private List<ST> getParametersForEvent(final CodeGeneratorCliEditor cg, final AxEvent event) {
 246         final Collection<AxField> fields = event.getFields();
 247         final List<ST> ret = new ArrayList<>(fields.size());
 248         for (final AxField f : fields) {
 249             final AxReferenceKey fkey = f.getKey();
 250
 251             final ST val = cg.createEventFieldDefinition(kig.getPName(fkey), kig.getPVersion(fkey), kig.getLName(fkey),
 252                     kig.getName(f.getSchema()), kig.getVersion(f.getSchema()), f.getOptional());
 253
 254             ret.add(val);
 255         }
 256         return ret;
 257     }
 258
 259     /**
 260      * Gets the context references for task.
 261      *
 262      * @param cg the code generator
 263      * @param task the task
 264      * @return the context references for task
 265      */
 266     private List<ST> getCtxtRefsForTask(final CodeGeneratorCliEditor cg, final AxTask task) {
 267         final Collection<AxArtifactKey> ctxs = task.getContextAlbumReferences();
 268         final List<ST> ret = new ArrayList<>(ctxs.size());
 269         final AxArtifactKey tkey = task.getKey();
 270         for (final AxArtifactKey ckey : ctxs) {
 271
 272             final ST val = cg.createTaskDefinitionContextRef(kig.getName(tkey), kig.getVersion(tkey), kig.getName(ckey),
 273                     kig.getVersion(ckey));
 274
 275             ret.add(val);
 276         }
 277         return ret;
 278     }
 279
 280     /**
 281      * Gets the parameters for task.
 282      *
 283      * @param cg the code generator
 284      * @param task the task
 285      * @return the parameters for task
 286      */
 287     private List<ST> getParametersForTask(final CodeGeneratorCliEditor cg, final AxTask task) {
 288         final Collection<AxTaskParameter> pars = task.getTaskParameters().values();
 289         final List<ST> ret = new ArrayList<>(pars.size());
 290         for (final AxTaskParameter p : pars) {
 291             final AxReferenceKey pkey = p.getKey();
 292
 293             final ST val = cg.createTaskDefinitionParameters(kig.getPName(pkey), kig.getPVersion(pkey),
 294                     kig.getLName(pkey), p.getTaskParameterValue());
 295
 296             ret.add(val);
 297         }
 298         return ret;
 299     }
 300
 301     /**
 302      * Gets the logic for task.
 303      *
 304      * @param cg the code generator
 305      * @param task the task
 306      * @return the logic for task
 307      */
 308     private ST getLogicForTask(final CodeGeneratorCliEditor cg, final AxTask task) {
 309         final AxArtifactKey tkey = task.getKey();
 310         final AxTaskLogic tl = task.getTaskLogic();
 311
 312         return cg.createTaskDefLogic(kig.getName(tkey), kig.getVersion(tkey), tl.getLogicFlavour(), tl.getLogic());
 313     }
 314
 315     /**
 316      * Gets the output fields for task.
 317      *
 318      * @param cg the code generator
 319      * @param task the task
 320      * @return the output fields for task
 321      */
 322     private List<ST> getOutfieldsForTask(final CodeGeneratorCliEditor cg, final AxTask task) {
 323         final Collection<? extends AxField> fields = task.getOutputFields().values();
 324         final List<ST> ret = new ArrayList<>(fields.size());
 325         for (final AxField f : fields) {
 326             final AxReferenceKey fkey = f.getKey();
 327
 328             final ST val = cg.createTaskDefinitionOutfields(kig.getPName(fkey), kig.getPVersion(fkey),
 329                     kig.getLName(fkey), kig.getName(f.getSchema()), kig.getVersion(f.getSchema()));
 330
 331             ret.add(val);
 332         }
 333         return ret;
 334     }
 335
 336     /**
 337      * Gets the input fields for task.
 338      *
 339      * @param cg the code generator
 340      * @param task the task
 341      * @return the input fields for task
 342      */
 343     private List<ST> getInfieldsForTask(final CodeGeneratorCliEditor cg, final AxTask task) {
 344         final Collection<? extends AxField> fields = task.getInputFields().values();
 345         final List<ST> ret = new ArrayList<>(fields.size());
 346         for (final AxField f : fields) {
 347             final AxReferenceKey fkey = f.getKey();
 348
 349             final ST val = cg.createTaskDefinitionInfields(kig.getPName(fkey), kig.getPVersion(fkey),
 350                     kig.getLName(fkey), kig.getName(f.getSchema()), kig.getVersion(f.getSchema()));
 351
 352             ret.add(val);
 353         }
 354         return ret;
 355     }
 356
 357     /**
 358      * Gets the states for policy.
 359      *
 360      * @param cg the code generator
 361      * @param pol the policy
 362      * @return the states for policy
 363      */
 364     private List<ST> getStatesForPolicy(final CodeGeneratorCliEditor cg, final AxPolicy pol) {
 365         final Collection<AxState> states = pol.getStateMap().values();
 366         final List<ST> ret = new ArrayList<>(states.size());
 367         for (final AxState st : states) {
 368             final AxReferenceKey skey = st.getKey();
 369             final List<ST> outputs = getStateOutputsForState(cg, st);
 370             final List<ST> finalizerLogics = getFinalizersForState(cg, st);
 371             final List<ST> tasks = getTaskRefsForState(cg, st);
 372             final List<ST> tsLogic = getTslForState(cg, st);
 373             final List<ST> ctxRefs = getCtxtRefsForState(cg, st);
 374
 375             final ST val = cg.createPolicyStateDef(new PolicyStateDefBuilder()
 376                     .setPolicyName(kig.getPName(skey)).setVersion(kig.getPVersion(skey))
 377                     .setStateName(kig.getLName(skey)).setTriggerName(kig.getName(st.getTrigger()))
 378                     .setTriggerVersion(kig.getVersion(st.getTrigger()))
 379                     .setDefaultTask(kig.getName(st.getDefaultTask()))
 380                     .setDefaultTaskVersion(kig.getVersion(st.getDefaultTask())).setOutputs(outputs)
 381                     .setTasks(tasks).setTsLogic(tsLogic).setFinalizerLogics(finalizerLogics)
 382                     .setCtxRefs(ctxRefs));
 383
 384             ret.add(val);
 385         }
 386         return ret;
 387     }
 388
 389     /**
 390      * Gets the finalizers for state.
 391      *
 392      * @param cg the code generator
 393      * @param st the state
 394      * @return the finalizers for state
 395      */
 396     private List<ST> getFinalizersForState(final CodeGeneratorCliEditor cg, final AxState st) {
 397         final Collection<AxStateFinalizerLogic> fins = st.getStateFinalizerLogicMap().values();
 398         final List<ST> ret = new ArrayList<>(fins.size());
 399         final AxReferenceKey skey = st.getKey();
 400         for (final AxStateFinalizerLogic fin : fins) {
 401             final AxReferenceKey finkey = fin.getKey();
 402
 403             final ST val = cg.createPolicyStateDefFinalizerLogic(kig.getPName(skey), kig.getPVersion(skey),
 404                     kig.getLName(skey), kig.getLName(finkey), fin.getLogicFlavour(), fin.getLogic());
 405
 406             ret.add(val);
 407         }
 408         return ret;
 409     }
 410
 411     /**
 412      * Gets the context references for state.
 413      *
 414      * @param cg the code generator
 415      * @param st the state
 416      * @return the context references for state
 417      */
 418     private List<ST> getCtxtRefsForState(final CodeGeneratorCliEditor cg, final AxState st) {
 419         final Collection<AxArtifactKey> ctxs = st.getContextAlbumReferences();
 420         final List<ST> ret = new ArrayList<>(ctxs.size());
 421         final AxReferenceKey skey = st.getKey();
 422         for (final AxArtifactKey ctx : ctxs) {
 423
 424             final ST val = cg.createPolicyStateDefContextRef(kig.getPName(skey), kig.getPVersion(skey),
 425                     kig.getLName(skey), kig.getName(ctx), kig.getVersion(ctx));
 426
 427             ret.add(val);
 428         }
 429         return ret;
 430     }
 431
 432     /**
 433      * Gets the Task Selection Logic for state.
 434      *
 435      * @param cg the code generator
 436      * @param st the state
 437      * @return the TSL for state (if any) in a list
 438      */
 439     private List<ST> getTslForState(final CodeGeneratorCliEditor cg, final AxState st) {
 440         final AxReferenceKey skey = st.getKey();
 441         if (st.checkSetTaskSelectionLogic()) {
 442             final AxTaskSelectionLogic tsl = st.getTaskSelectionLogic();
 443             final ST val = cg.createPolicyStateDefTaskSelLogic(kig.getPName(skey), kig.getPVersion(skey),
 444                     kig.getLName(skey), tsl.getLogicFlavour(), tsl.getLogic());
 445             return Collections.singletonList(val);
 446         } else {
 447             return Collections.emptyList();
 448         }
 449     }
 450
 451     /**
 452      * Gets the task references for state.
 453      *
 454      * @param cg the code generator
 455      * @param st the state
 456      * @return the task references for state
 457      */
 458     private List<ST> getTaskRefsForState(final CodeGeneratorCliEditor cg, final AxState st) {
 459         final Map<AxArtifactKey, AxStateTaskReference> taskrefs = st.getTaskReferences();
 460         final List<ST> ret = new ArrayList<>(taskrefs.size());
 461         final AxReferenceKey skey = st.getKey();
 462         for (final Entry<AxArtifactKey, AxStateTaskReference> e : taskrefs.entrySet()) {
 463             final AxArtifactKey tkey = e.getKey();
 464             final AxStateTaskReference tr = e.getValue();
 465             final AxReferenceKey trkey = tr.getKey();
 466
 467             final ST val = cg.createPolicyStateTask(new PolicyStateTaskBuilder()
 468                     .setPolicyName(kig.getPName(skey)).setVersion(kig.getPVersion(skey))
 469                     .setStateName(kig.getLName(skey)).setTaskLocalName(kig.getLName(trkey))
 470                     .setTaskName(kig.getName(tkey)).setTaskVersion(kig.getVersion(tkey))
 471                     .setOutputType(tr.getStateTaskOutputType().name())
 472                     .setOutputName(kig.getLName(tr.getOutput())));
 473
 474             ret.add(val);
 475         }
 476         return ret;
 477     }
 478
 479     /**
 480      * Gets the state outputs for state.
 481      *
 482      * @param cg the code generator
 483      * @param st the state
 484      * @return the state outputs for state
 485      */
 486     private List<ST> getStateOutputsForState(final CodeGeneratorCliEditor cg, final AxState st) {
 487         final Collection<AxStateOutput> outs = st.getStateOutputs().values();
 488         final List<ST> ret = new ArrayList<>(outs.size());
 489         final AxReferenceKey skey = st.getKey();
 490         for (final AxStateOutput out : outs) {
 491             final AxReferenceKey outkey = out.getKey();
 492
 493             final ST val = cg.createPolicyStateOutput(kig.getPName(skey), kig.getPVersion(skey), kig.getLName(skey),
 494                     kig.getLName(outkey), kig.getName(out.getOutgingEvent()), kig.getVersion(out.getOutgingEvent()),
 495                     kig.getLName(out.getNextState()));
 496
 497             ret.add(val);
 498         }
 499         return ret;
 500     }
 501
 502 }