/*-
* ============LICENSE_START======================================================================
* Copyright (C) 2023 Nordix Foundation. All rights reserved.
+ * Copyright (C) 2024 OpenInfra Foundation Europe. 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.
package com.oransc.rappmanager.models.csar;
+import static com.google.common.base.Splitter.on;
+import static com.google.common.collect.Iterables.filter;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.google.gson.Gson;
+import com.oransc.rappmanager.models.exception.RappHandlerException;
import com.oransc.rappmanager.models.rapp.Rapp;
import com.oransc.rappmanager.models.rapp.RappResources;
import com.oransc.rappmanager.models.rappinstance.RappACMInstance;
import java.io.FileInputStream;
import java.io.IOException;
import java.nio.file.Path;
+import java.util.ArrayList;
import java.util.List;
+import java.util.Set;
import java.util.UUID;
import java.util.function.Predicate;
+import java.util.stream.Collectors;
import java.util.zip.ZipEntry;
import java.util.zip.ZipFile;
+import lombok.RequiredArgsConstructor;
import org.apache.commons.compress.archivers.ArchiveEntry;
import org.apache.commons.compress.archivers.zip.ZipArchiveInputStream;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+import org.springframework.core.io.ByteArrayResource;
+import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Service;
import org.springframework.web.multipart.MultipartFile;
+import org.yaml.snakeyaml.Yaml;
@Service
+@RequiredArgsConstructor
public class RappCsarConfigurationHandler {
Logger logger = LoggerFactory.getLogger(RappCsarConfigurationHandler.class);
+
+ private final ObjectMapper objectMapper;
+ private static final String TOSCA_METADATA_LOCATION = "TOSCA-Metadata/TOSCA.meta";
+ private static final String ENTRY_DEFINITIONS_INDEX = "Entry-Definitions";
private static final String ACM_COMPOSITION_JSON_LOCATION = "Files/Acm/definition/compositions.json";
private static final String ACM_DEFINITION_LOCATION = "Files/Acm/definition";
private static final String ACM_INSTANCES_LOCATION = "Files/Acm/instances";
-
private static final String SME_PROVIDER_FUNCS_LOCATION = "Files/Sme/providers";
private static final String SME_SERVICE_APIS_LOCATION = "Files/Sme/serviceapis";
-
private static final String SME_INVOKERS_LOCATION = "Files/Sme/invokers";
+ private static final String DME_PRODUCER_INFO_TYPES_LOCATION = "Files/Dme/producerinfotypes";
+ private static final String DME_CONSUMER_INFO_TYPES_LOCATION = "Files/Dme/consumerinfotypes";
+ private static final String DME_INFO_PRODUCERS_LOCATION = "Files/Dme/infoproducers";
+ private static final String DME_INFO_CONSUMERS_LOCATION = "Files/Dme/infoconsumers";
+ private static final String ARTIFACTS_LOCATION_JSON_POINTER =
+ "/topology_template/node_templates/applicationServiceDescriptor/artifacts";
public boolean isValidRappPackage(MultipartFile multipartFile) {
String originalFilename = multipartFile.getOriginalFilename();
if (originalFilename != null) {
return originalFilename.endsWith(".csar") && isFileExistsInCsar(multipartFile,
- ACM_COMPOSITION_JSON_LOCATION);
+ ACM_COMPOSITION_JSON_LOCATION) && isFileExistsInCsar(multipartFile, TOSCA_METADATA_LOCATION)
+ && containsValidArtifactDefinition(multipartFile);
}
return false;
}
return Boolean.TRUE;
}
}
- return Boolean.FALSE;
+ throw new RappHandlerException(HttpStatus.BAD_REQUEST, "rApp package missing a file " + fileLocation);
} catch (IOException e) {
logger.error("Unable to find the CSAR file", e);
- return Boolean.FALSE;
+ throw new RappHandlerException(HttpStatus.BAD_REQUEST, "rApp package missing a file " + fileLocation);
}
}
"COMPOSITIONID", String.valueOf(compositionId));
}
+ public ByteArrayResource getArtifactPayload(Rapp rapp, String location) {
+ return new ByteArrayResource(getByteArrayStreamPayload(rapp, location).toByteArray());
+ }
+
String getPayload(Rapp rapp, String location) {
- logger.info("Getting payload for {} from {}", rapp.getRappId(), location);
+ return getByteArrayStreamPayload(rapp, location).toString();
+ }
+
+ ByteArrayOutputStream getByteArrayStreamPayload(Rapp rapp, String location) {
+ logger.debug("Getting payload for {} from {}", rapp.getRappId(), location);
File csarFile = getCsarFile(rapp);
- return getFileFromCsar(csarFile, location).toString();
+ return getFileFromCsar(csarFile, location);
}
File getCsarFile(Rapp rapp) {
getRappPackageLocation(rapp.getPackageLocation(), rapp.getName(), rapp.getPackageName()).toUri());
}
+ ByteArrayOutputStream getFileFromCsar(MultipartFile multipartFile, String fileLocation) {
+ ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
+ try (ZipArchiveInputStream zipArchiveInputStream = new ZipArchiveInputStream(multipartFile.getInputStream())) {
+ byteArrayOutputStream = getFileFromCsar(zipArchiveInputStream, fileLocation);
+ } catch (IOException e) {
+ logger.info("Unable to get file {} from the multipart CSAR file", fileLocation, e);
+ }
+ return byteArrayOutputStream;
+ }
+
ByteArrayOutputStream getFileFromCsar(File csarFile, String fileLocation) {
ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
try (FileInputStream fileInputStream = new FileInputStream(csarFile);
ZipArchiveInputStream zipArchiveInputStream = new ZipArchiveInputStream(fileInputStream)) {
+ byteArrayOutputStream = getFileFromCsar(zipArchiveInputStream, fileLocation);
+ } catch (IOException e) {
+ logger.info("Unable to get file {} from the CSAR file", fileLocation, e);
+ }
+ return byteArrayOutputStream;
+ }
+
+ ByteArrayOutputStream getFileFromCsar(ZipArchiveInputStream zipArchiveInputStream, String fileLocation) {
+ ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
+ try {
ArchiveEntry entry;
while ((entry = zipArchiveInputStream.getNextEntry()) != null) {
if (!entry.isDirectory() && entry.getName().equals(fileLocation)) {
}
}
} catch (IOException e) {
- logger.error("Unable to find the CSAR file", e);
+ logger.info("Unable to get file {} from the zip archive CSAR file", fileLocation, e);
}
return byteArrayOutputStream;
}
+ boolean containsValidArtifactDefinition(MultipartFile multipartFile) {
+ String asdLocation = getAsdDefinitionLocation(multipartFile);
+ if (asdLocation != null && !asdLocation.isEmpty() && isFileExistsInCsar(multipartFile, asdLocation)) {
+ try {
+ String asdContent = getFileFromCsar(multipartFile, asdLocation).toString();
+ JsonNode jsonNode = getAsdContentNode(asdContent);
+ List<String> artifactFileList = jsonNode.at(ARTIFACTS_LOCATION_JSON_POINTER).findValuesAsText("file");
+ return artifactFileList.stream()
+ .allMatch(artifactFile -> isFileExistsInCsar(multipartFile, artifactFile));
+ } catch (RappHandlerException e) {
+ throw e;
+ } catch (Exception e) {
+ logger.warn("Unable to validate artifact definition", e);
+ throw new RappHandlerException(HttpStatus.BAD_REQUEST, "ASD definition in rApp package is invalid.");
+ }
+ }
+ throw new RappHandlerException(HttpStatus.BAD_REQUEST, "ASD definition in rApp package is invalid.");
+ }
+
+ JsonNode getAsdContentNode(String asdContent) throws JsonProcessingException {
+ return objectMapper.readTree(new Gson().toJsonTree(new Yaml().load(asdContent)).toString());
+ }
+
+ String getAsdDefinitionLocation(final File csarFile) {
+ return getAsdDefinitionLocation(getFileFromCsar(csarFile, TOSCA_METADATA_LOCATION).toString());
+ }
+
+ String getAsdDefinitionLocation(final MultipartFile multipartFile) {
+ return getAsdDefinitionLocation(getFileFromCsar(multipartFile, TOSCA_METADATA_LOCATION).toString());
+ }
+
+ String getAsdDefinitionLocation(final String toscaMetadata) {
+ String asdLocation = "";
+ if (toscaMetadata != null && !toscaMetadata.isEmpty()) {
+ final String entry =
+ filter(on("\n").split(toscaMetadata), line -> line.contains(ENTRY_DEFINITIONS_INDEX)).iterator()
+ .next();
+ asdLocation = entry.replace(ENTRY_DEFINITIONS_INDEX + ":", "").trim();
+ }
+ return asdLocation;
+ }
+
+ public List<DeploymentItem> getDeploymentItems(Rapp rApp) {
+ List<DeploymentItem> deploymentItems = new ArrayList<>();
+ File csarFile = getCsarFile(rApp);
+ String asdDefinitionLocation = getAsdDefinitionLocation(csarFile);
+ if (asdDefinitionLocation != null && !asdDefinitionLocation.isEmpty()) {
+ try {
+ String asdContent = getFileFromCsar(csarFile, asdDefinitionLocation).toString();
+ JsonNode jsonNode = getAsdContentNode(asdContent);
+ JsonNode artifactsJsonNode = jsonNode.at(ARTIFACTS_LOCATION_JSON_POINTER);
+ artifactsJsonNode.forEach(artifactJsonNode -> {
+ DeploymentItem deploymentItem =
+ objectMapper.convertValue(artifactJsonNode.at("/properties"), DeploymentItem.class);
+ deploymentItem.setFile(artifactJsonNode.at("/file").asText());
+ deploymentItems.add(deploymentItem);
+ });
+ } catch (Exception e) {
+ logger.warn("Unable to get the deployment items", e);
+ }
+ }
+ return deploymentItems;
+ }
+
public String getSmeProviderDomainPayload(Rapp rapp, RappSMEInstance rappSMEInstance) {
return getPayload(rapp, getResourceUri(SME_PROVIDER_FUNCS_LOCATION, rappSMEInstance.getProviderFunction()));
getResourceUri(ACM_DEFINITION_LOCATION, rapp.getRappResources().getAcm().getCompositionDefinitions()));
}
+ public String getDmeInfoProducerPayload(Rapp rapp, String producerIdentifier) {
+ return getPayload(rapp, getResourceUri(DME_INFO_PRODUCERS_LOCATION, producerIdentifier));
+ }
+
+ public String getDmeProducerInfoTypePayload(Rapp rapp, String infoTypeIdentifier) {
+ return getPayload(rapp, getResourceUri(DME_PRODUCER_INFO_TYPES_LOCATION, infoTypeIdentifier));
+ }
+
+ public String getDmeConsumerInfoTypePayload(Rapp rapp, String infoTypeIdentifier) {
+ return getPayload(rapp, getResourceUri(DME_CONSUMER_INFO_TYPES_LOCATION, infoTypeIdentifier));
+ }
+
+ public String getDmeInfoConsumerPayload(Rapp rapp, String infoConsumerIdentifier) {
+ return getPayload(rapp, getResourceUri(DME_INFO_CONSUMERS_LOCATION, infoConsumerIdentifier));
+ }
+
String getResourceUri(String resourceLocation, String resource) {
return resourceLocation + "/" + resource + ".json";
}
File csarFile = getCsarFile(rapp);
if (csarFile.exists()) {
rappResources.setAcm(RappResources.ACMResources.builder().compositionDefinitions(
- getFileListFromCsar(csarFile, ACM_DEFINITION_LOCATION).get(0)).compositionInstances(
+ getFileListFromCsar(csarFile, ACM_DEFINITION_LOCATION).iterator().next()).compositionInstances(
getFileListFromCsar(csarFile, ACM_INSTANCES_LOCATION)).build());
rappResources.setSme(RappResources.SMEResources.builder().providerFunctions(
getFileListFromCsar(csarFile, SME_PROVIDER_FUNCS_LOCATION))
.serviceApis(getFileListFromCsar(csarFile, SME_SERVICE_APIS_LOCATION))
.invokers(getFileListFromCsar(csarFile, SME_INVOKERS_LOCATION)).build());
+ rappResources.setDme(RappResources.DMEResources.builder().producerInfoTypes(
+ getFileListFromCsar(csarFile, DME_PRODUCER_INFO_TYPES_LOCATION)).consumerInfoTypes(
+ getFileListFromCsar(csarFile, DME_CONSUMER_INFO_TYPES_LOCATION))
+ .infoProducers(getFileListFromCsar(csarFile, DME_INFO_PRODUCERS_LOCATION))
+ .infoConsumers(getFileListFromCsar(csarFile, DME_INFO_CONSUMERS_LOCATION))
+ .build());
}
} catch (Exception e) {
logger.warn("Error in getting the rapp resources", e);
return rappResources;
}
- List<String> getFileListFromCsar(File csarFile, String dirLocation) {
+ Set<String> getFileListFromCsar(File csarFile, String dirLocation) {
try (ZipFile zipFile = new ZipFile(csarFile)) {
return zipFile.stream().filter(Predicate.not(ZipEntry::isDirectory)).map(ZipEntry::getName)
.filter(name -> name.startsWith(dirLocation))
- .map(name -> name.substring(name.lastIndexOf("/") + 1, name.lastIndexOf("."))).toList();
+ .map(name -> name.substring(name.lastIndexOf("/") + 1, name.lastIndexOf(".")))
+ .collect(Collectors.toSet());
} catch (IOException e) {
logger.warn("Error in listing the files from csar", e);
}
- return List.of();
+ return Set.of();
}
}