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