aboutsummaryrefslogtreecommitdiffstats
path: root/src/main/java/org/onap/aai/babel/xml/generator/ModelGenerator.java
blob: 66952417a79fee5890152ade32d3e2cfffac0757 (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
/**
 * ============LICENSE_START=======================================================
 * org.onap.aai
 * ================================================================================
 * Copyright (c) 2017-2019 AT&T Intellectual Property. All rights reserved.
 * Copyright (c) 2017-2019 European Software Marketing Ltd.
 * ================================================================================
 * 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.
 * ============LICENSE_END=========================================================
 */

package org.onap.aai.babel.xml.generator;

import java.util.Base64;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
import org.onap.aai.babel.logging.ApplicationMsgs;
import org.onap.aai.babel.logging.LogHelper;
import org.onap.aai.babel.service.data.BabelArtifact;
import org.onap.aai.babel.service.data.BabelArtifact.ArtifactType;
import org.onap.aai.babel.xml.generator.api.AaiArtifactGenerator;
import org.onap.aai.babel.xml.generator.data.AdditionalParams;
import org.onap.aai.babel.xml.generator.data.Artifact;
import org.onap.aai.babel.xml.generator.data.GenerationData;
import org.onap.aai.babel.xml.generator.data.GeneratorUtil;
import org.onap.aai.babel.xml.generator.data.GroupType;
import org.onap.aai.cl.api.Logger;

/**
 * This class is responsible for generating XML model artifacts from a collection of CSAR artifacts.
 */
public class ModelGenerator implements ArtifactGenerator {

    private static final Logger logger = LogHelper.INSTANCE;

    private static final String DEFAULT_SERVICE_VERSION = "1.0";

    /**
     * Invokes the TOSCA artifact generator API with the input artifacts.
     *
     * @param csarArchive
     * @param csarArtifacts
     *            the input artifacts
     * @return {@link List} of output artifacts
     * @throws XmlArtifactGenerationException
     *             if there is an error trying to generate XML artifacts
     */
    @Override
    public List<BabelArtifact> generateArtifacts(byte[] csarArchive, List<Artifact> csarArtifacts)
            throws XmlArtifactGenerationException {
        logger.info(ApplicationMsgs.DISTRIBUTION_EVENT,
                "Generating XML for " + csarArtifacts.size() + " CSAR artifacts.");

        // Get the service version to pass into the generator
        String toscaVersion = csarArtifacts.get(0).getVersion();
        String serviceVersion = getServiceVersion(toscaVersion);
        logger.debug("The service version is " + serviceVersion);
        Map<String, String> additionalParams = new HashMap<>();
        additionalParams.put(AdditionalParams.SERVICE_VERSION.getName(), serviceVersion);

        // Call ArtifactGenerator API
        logger.debug("Obtaining instance of ArtifactGenerationService");
        org.onap.aai.babel.xml.generator.api.ArtifactGenerator generator = new AaiArtifactGenerator();
        logger.debug("About to call generationService.generateArtifact()");
        GenerationData data = generator.generateArtifact(csarArchive, csarArtifacts, additionalParams);
        logger.debug("Call generationService.generateArtifact() has finished");

        // Convert results into BabelArtifacts
        if (data.getErrorData().isEmpty()) {
            return data.getResultData().stream().map(a -> new BabelArtifact(a.getName(), ArtifactType.MODEL,
                    new String(Base64.getDecoder().decode(a.getPayload())))).collect(Collectors.toList());
        } else {
            throw new XmlArtifactGenerationException(
                    "Error occurred during artifact generation: " + data.getErrorData().toString());
        }
    }

    /**
     * Creates an instance of an input artifact for the generator.
     *
     * @param payload
     *            the payload downloaded from SDC
     * @param artifactName
     *            name of the artifact to create
     * @param artifactVersion
     *            version of the artifact to create
     * @return an {@link Artifact} object constructed from the payload and artifactInfo
     */
    public static Artifact createArtifact(byte[] payload, String artifactName, String artifactVersion) {
        logger.info(ApplicationMsgs.DISTRIBUTION_EVENT, "Creating artifact for: " + artifactName);

        // Convert payload into an input Artifact
        String checksum = GeneratorUtil.checkSum(payload);
        byte[] encodedPayload = GeneratorUtil.encode(payload);
        Artifact artifact = new Artifact("TOSCA", GroupType.DEPLOYMENT.name(), checksum, encodedPayload);
        artifact.setName(artifactName);
        artifact.setLabel(artifactName);
        artifact.setDescription(artifactName);
        artifact.setVersion(artifactVersion);
        return artifact;
    }

    private static String getServiceVersion(String artifactVersion) {
        logger.debug("Artifact version=" + artifactVersion);
        try {
            return String.valueOf(Float.parseFloat(artifactVersion));
        } catch (Exception e) {
            logger.warn(ApplicationMsgs.DISTRIBUTION_EVENT,
                    "Error generating service version from artifact version: " + artifactVersion
                            + ". Using default service version of: " + DEFAULT_SERVICE_VERSION + ". Error details: "
                            + e);
            return DEFAULT_SERVICE_VERSION;
        }
    }
}