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
|
/*-
* ============LICENSE_START=======================================================
* ONAP CLAMP
* ================================================================================
* Copyright (C) 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.
* ============LICENSE_END============================================
* ===================================================================
*
*/
package org.onap.policy.clamp.clds.sdc.controller.installer;
import com.att.eelf.configuration.EELFLogger;
import com.att.eelf.configuration.EELFManager;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.zip.ZipEntry;
import java.util.zip.ZipFile;
import org.apache.commons.io.IOUtils;
import org.codehaus.plexus.util.StringUtils;
import org.onap.policy.clamp.clds.exception.sdc.controller.CsarHandlerException;
import org.onap.policy.clamp.clds.exception.sdc.controller.SdcArtifactInstallerException;
import org.onap.sdc.api.notification.IArtifactInfo;
import org.onap.sdc.api.notification.INotificationData;
import org.onap.sdc.api.notification.IResourceInstance;
import org.onap.sdc.api.results.IDistributionClientDownloadResult;
import org.onap.sdc.tosca.parser.api.ISdcCsarHelper;
import org.onap.sdc.tosca.parser.exceptions.SdcToscaParserException;
import org.onap.sdc.tosca.parser.impl.SdcToscaParserFactory;
/**
* CsarDescriptor that will be used to deploy file in CLAMP file system. Some
* methods can also be used to get some data from it.
*/
public class CsarHandler {
private static final EELFLogger logger = EELFManager.getInstance().getLogger(CsarHandler.class);
private IArtifactInfo artifactElement;
private String csarFilePath;
private String controllerName;
private SdcToscaParserFactory factory = SdcToscaParserFactory.getInstance();
private ISdcCsarHelper sdcCsarHelper;
private Map<String, BlueprintArtifact> mapOfBlueprints = new HashMap<>();
public static final String CSAR_TYPE = "TOSCA_CSAR";
public static final String BLUEPRINT_TYPE = "DCAE_INVENTORY_BLUEPRINT";
private INotificationData sdcNotification;
public static final String RESOURCE_INSTANCE_NAME_PREFIX = "/Artifacts/Resources/";
public static final String RESOURCE_INSTANCE_NAME_SUFFIX = "/Deployment/";
public static final String POLICY_DEFINITION_NAME_SUFFIX = "Definitions/policies.yml";
public static final String DATA_DEFINITION_NAME_SUFFIX = "Definitions/data.yml";
public static final String DATA_DEFINITION_KEY = "data_types:";
/**
* Constructor for CsarHandler taking sdc notification in input.
*/
public CsarHandler(INotificationData data, String controller, String clampCsarPath) throws CsarHandlerException {
this.sdcNotification = data;
this.controllerName = controller;
this.artifactElement = searchForUniqueCsar(data);
this.csarFilePath = buildFilePathForCsar(artifactElement, clampCsarPath);
}
private String buildFilePathForCsar(IArtifactInfo artifactElement, String clampCsarPath) {
return clampCsarPath + "/" + controllerName + "/" + artifactElement.getArtifactName();
}
private IArtifactInfo searchForUniqueCsar(INotificationData notificationData) throws CsarHandlerException {
List<IArtifactInfo> serviceArtifacts = notificationData.getServiceArtifacts();
for (IArtifactInfo artifact : serviceArtifacts) {
if (artifact.getArtifactType().equals(CSAR_TYPE)) {
return artifact;
}
}
throw new CsarHandlerException("Unable to find a CSAR in the Sdc Notification");
}
/**
* This saves the notification to disk and database.
*
* @param resultArtifact The artifact to install
* @throws SdcArtifactInstallerException In case of issues with the installation
* @throws SdcToscaParserException In case of issues with the parsing of
* the CSAR
*/
public synchronized void save(IDistributionClientDownloadResult resultArtifact)
throws SdcArtifactInstallerException, SdcToscaParserException {
try {
logger.info("Writing CSAR file to: " + csarFilePath + " UUID " + artifactElement.getArtifactUUID() + ")");
Path path = Paths.get(csarFilePath);
Files.createDirectories(path.getParent());
// Create or replace the file
try (OutputStream out = Files.newOutputStream(path)) {
out.write(resultArtifact.getArtifactPayload(), 0, resultArtifact.getArtifactPayload().length);
}
sdcCsarHelper = factory.getSdcCsarHelper(csarFilePath);
this.loadDcaeBlueprint();
} catch (IOException e) {
throw new SdcArtifactInstallerException(
"Exception caught when trying to write the CSAR on the file system to " + csarFilePath, e);
}
}
private IResourceInstance searchForResourceByInstanceName(String blueprintResourceInstanceName)
throws SdcArtifactInstallerException {
for (IResourceInstance resource : this.sdcNotification.getResources()) {
String filteredString = resource.getResourceInstanceName().replaceAll("-", "");
filteredString = filteredString.replaceAll(" ", "");
if (filteredString.equalsIgnoreCase(blueprintResourceInstanceName)) {
return resource;
}
}
throw new SdcArtifactInstallerException("Error when searching for " + blueprintResourceInstanceName
+ " as ResourceInstanceName in Sdc notification and did not find it");
}
private void loadDcaeBlueprint() throws IOException, SdcArtifactInstallerException {
try (ZipFile zipFile = new ZipFile(csarFilePath)) {
Enumeration<? extends ZipEntry> entries = zipFile.entries();
while (entries.hasMoreElements()) {
ZipEntry entry = entries.nextElement();
if (!entry.isDirectory() && entry.getName().contains(BLUEPRINT_TYPE)) {
BlueprintArtifact blueprintArtifact = new BlueprintArtifact();
blueprintArtifact.setBlueprintArtifactName(
entry.getName().substring(entry.getName().lastIndexOf('/') + 1, entry.getName().length()));
blueprintArtifact
.setBlueprintInvariantServiceUuid(this.getSdcNotification().getServiceInvariantUUID());
try (InputStream stream = zipFile.getInputStream(entry)) {
blueprintArtifact.setDcaeBlueprint(IOUtils.toString(stream, StandardCharsets.UTF_8));
}
blueprintArtifact.setResourceAttached(searchForResourceByInstanceName(entry.getName().substring(
entry.getName().indexOf(RESOURCE_INSTANCE_NAME_PREFIX)
+ RESOURCE_INSTANCE_NAME_PREFIX.length(),
entry.getName().indexOf(RESOURCE_INSTANCE_NAME_SUFFIX))));
this.mapOfBlueprints.put(blueprintArtifact.getBlueprintArtifactName(), blueprintArtifact);
logger.info("Found a blueprint entry in the CSAR " + blueprintArtifact.getBlueprintArtifactName()
+ " for resource instance Name "
+ blueprintArtifact.getResourceAttached().getResourceInstanceName());
}
}
logger.info(this.mapOfBlueprints.size() + " blueprint(s) will be converted to closed loop");
}
}
public IArtifactInfo getArtifactElement() {
return artifactElement;
}
public String getFilePath() {
return csarFilePath;
}
public String setFilePath(String newPath) {
return csarFilePath = newPath;
}
public synchronized ISdcCsarHelper getSdcCsarHelper() {
return sdcCsarHelper;
}
public INotificationData getSdcNotification() {
return sdcNotification;
}
public Map<String, BlueprintArtifact> getMapOfBlueprints() {
return mapOfBlueprints;
}
/**
* Get the whole policy model Yaml. It combines the content of policies.yaml and
* data.yaml.
*
* @return The whole policy model yaml
* @throws IOException The IO Exception
*/
public Optional<String> getPolicyModelYaml() throws IOException {
String result = null;
try (ZipFile zipFile = new ZipFile(csarFilePath)) {
ZipEntry entry = zipFile.getEntry(POLICY_DEFINITION_NAME_SUFFIX);
if (entry != null) {
ZipEntry data = zipFile.getEntry(DATA_DEFINITION_NAME_SUFFIX);
if (data != null) {
String dataStr = IOUtils.toString(zipFile.getInputStream(data), StandardCharsets.UTF_8);
String dataStrWithoutHeader = dataStr.substring(dataStr.indexOf(DATA_DEFINITION_KEY));
String policyStr = IOUtils.toString(zipFile.getInputStream(entry), StandardCharsets.UTF_8);
StringUtils.chomp(policyStr);
result = policyStr.concat(dataStrWithoutHeader);
} else {
result = IOUtils.toString(zipFile.getInputStream(entry), StandardCharsets.UTF_8);
}
} else {
logger.info("Policy model not found inside the CSAR file: " + csarFilePath);
}
return Optional.ofNullable(result);
}
}
}
|
