X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=rapp-manager-models%2Fsrc%2Fmain%2Fjava%2Fcom%2Foransc%2Frappmanager%2Fmodels%2Fcsar%2FRappCsarConfigurationHandler.java;h=9e2f953360fd6e27885cf936888c364c2b4f8dc3;hb=acb1b85ddb80af9c7243abb949ac49c241ef8f33;hp=bbf59bbf885ef01caef1c23934aad38be9d0bead;hpb=77d91d4af1b3845fc8a3ef20cd6e54e9e6ff5a37;p=nonrtric%2Fplt%2Frappmanager.git diff --git a/rapp-manager-models/src/main/java/com/oransc/rappmanager/models/csar/RappCsarConfigurationHandler.java b/rapp-manager-models/src/main/java/com/oransc/rappmanager/models/csar/RappCsarConfigurationHandler.java index bbf59bb..9e2f953 100755 --- a/rapp-manager-models/src/main/java/com/oransc/rappmanager/models/csar/RappCsarConfigurationHandler.java +++ b/rapp-manager-models/src/main/java/com/oransc/rappmanager/models/csar/RappCsarConfigurationHandler.java @@ -1,6 +1,7 @@ /*- * ============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. @@ -18,6 +19,14 @@ 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; @@ -27,49 +36,70 @@ import java.io.File; 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 java.util.zip.ZipInputStream; +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) { - return multipartFile != null && multipartFile.getOriginalFilename() != null - && multipartFile.getOriginalFilename().endsWith(".csar") && isFileExistsInCsar(multipartFile, - ACM_COMPOSITION_JSON_LOCATION); + String originalFilename = multipartFile.getOriginalFilename(); + if (originalFilename != null) { + return originalFilename.endsWith(".csar") && isFileExistsInCsar(multipartFile, + ACM_COMPOSITION_JSON_LOCATION) && isFileExistsInCsar(multipartFile, TOSCA_METADATA_LOCATION) + && containsValidArtifactDefinition(multipartFile); + } + return false; } boolean isFileExistsInCsar(MultipartFile multipartFile, String fileLocation) { - try (ZipInputStream zipInputStream = new ZipInputStream(multipartFile.getInputStream())) { - ZipEntry zipEntry; - while ((zipEntry = zipInputStream.getNextEntry()) != null) { + try (ZipArchiveInputStream zipArchiveInputStream = new ZipArchiveInputStream(multipartFile.getInputStream())) { + ArchiveEntry zipEntry; + while ((zipEntry = zipArchiveInputStream.getNextEntry()) != null) { if (zipEntry.getName().matches(fileLocation)) { 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); } } @@ -82,10 +112,18 @@ public class RappCsarConfigurationHandler { "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) { @@ -93,26 +131,110 @@ public class RappCsarConfigurationHandler { 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); - ZipInputStream zipInputStream = new ZipInputStream(fileInputStream)) { - ZipEntry entry; - while ((entry = zipInputStream.getNextEntry()) != null) { + 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)) { byte[] buffer = new byte[1024]; int bytesRead; - while ((bytesRead = zipInputStream.read(buffer)) != -1) { + while ((bytesRead = zipArchiveInputStream.read(buffer)) != -1) { byteArrayOutputStream.write(buffer, 0, bytesRead); } } } } 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 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 getDeploymentItems(Rapp rApp) { + List 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())); @@ -131,6 +253,22 @@ public class RappCsarConfigurationHandler { 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"; } @@ -141,14 +279,18 @@ public class RappCsarConfigurationHandler { File csarFile = getCsarFile(rapp); if (csarFile.exists()) { rappResources.setAcm(RappResources.ACMResources.builder().compositionDefinitions( - getFileListFromCsar(csarFile, ACM_DEFINITION_LOCATION).get(0)) - .compositionInstances(getFileListFromCsar(csarFile, ACM_INSTANCES_LOCATION)) - .build()); - rappResources.setSme(RappResources.SMEResources.builder() - .providerFunctions(getFileListFromCsar(csarFile, - SME_PROVIDER_FUNCS_LOCATION)) + 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); @@ -156,14 +298,15 @@ public class RappCsarConfigurationHandler { return rappResources; } - List getFileListFromCsar(File csarFile, String dirLocation) { + Set 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(); } }