rapp-manager-models/src/main/java/com/oransc/rappmanager/models/csar/RappCsarConfigurationHandler.java

   1 /*-
   2  * ============LICENSE_START======================================================================
   3  * Copyright (C) 2023 Nordix Foundation. All rights reserved.
   4  * ===============================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  * ============LICENSE_END========================================================================
  17  */
  18
  19 package com.oransc.rappmanager.models.csar;
  20
  21 import com.oransc.rappmanager.models.rapp.Rapp;
  22 import com.oransc.rappmanager.models.rapp.RappResources;
  23 import com.oransc.rappmanager.models.rappinstance.RappACMInstance;
  24 import com.oransc.rappmanager.models.rappinstance.RappSMEInstance;
  25 import java.io.ByteArrayOutputStream;
  26 import java.io.File;
  27 import java.io.FileInputStream;
  28 import java.io.IOException;
  29 import java.nio.file.Path;
  30 import java.util.Set;
  31 import java.util.UUID;
  32 import java.util.function.Predicate;
  33 import java.util.stream.Collectors;
  34 import java.util.zip.ZipEntry;
  35 import java.util.zip.ZipFile;
  36 import org.apache.commons.compress.archivers.ArchiveEntry;
  37 import org.apache.commons.compress.archivers.zip.ZipArchiveInputStream;
  38 import org.slf4j.Logger;
  39 import org.slf4j.LoggerFactory;
  40 import org.springframework.stereotype.Service;
  41 import org.springframework.web.multipart.MultipartFile;
  42
  43 @Service
  44 public class RappCsarConfigurationHandler {
  45
  46     Logger logger = LoggerFactory.getLogger(RappCsarConfigurationHandler.class);
  47     private static final String ACM_COMPOSITION_JSON_LOCATION = "Files/Acm/definition/compositions.json";
  48     private static final String ACM_DEFINITION_LOCATION = "Files/Acm/definition";
  49     private static final String ACM_INSTANCES_LOCATION = "Files/Acm/instances";
  50     private static final String SME_PROVIDER_FUNCS_LOCATION = "Files/Sme/providers";
  51     private static final String SME_SERVICE_APIS_LOCATION = "Files/Sme/serviceapis";
  52     private static final String SME_INVOKERS_LOCATION = "Files/Sme/invokers";
  53     private static final String DME_INFO_TYPES_LOCATION = "Files/Dme/infotypes";
  54     private static final String DME_INFO_PRODUCERS_LOCATION = "Files/Dme/infoproducers";
  55     private static final String DME_INFO_CONSUMERS_LOCATION = "Files/Dme/infoconsumers";
  56
  57
  58     public boolean isValidRappPackage(MultipartFile multipartFile) {
  59         String originalFilename = multipartFile.getOriginalFilename();
  60         if (originalFilename != null) {
  61             return originalFilename.endsWith(".csar") && isFileExistsInCsar(multipartFile,
  62                     ACM_COMPOSITION_JSON_LOCATION);
  63         }
  64         return false;
  65     }
  66
  67     boolean isFileExistsInCsar(MultipartFile multipartFile, String fileLocation) {
  68         try (ZipArchiveInputStream zipArchiveInputStream = new ZipArchiveInputStream(multipartFile.getInputStream())) {
  69             ArchiveEntry zipEntry;
  70             while ((zipEntry = zipArchiveInputStream.getNextEntry()) != null) {
  71                 if (zipEntry.getName().matches(fileLocation)) {
  72                     return Boolean.TRUE;
  73                 }
  74             }
  75             return Boolean.FALSE;
  76         } catch (IOException e) {
  77             logger.error("Unable to find the CSAR file", e);
  78             return Boolean.FALSE;
  79         }
  80     }
  81
  82     public Path getRappPackageLocation(String csarLocation, String rappId, String fileName) {
  83         return Path.of(csarLocation, rappId, fileName);
  84     }
  85
  86     public String getInstantiationPayload(Rapp rapp, RappACMInstance rappACMInstance, UUID compositionId) {
  87         return getPayload(rapp, getResourceUri(ACM_INSTANCES_LOCATION, rappACMInstance.getInstance())).replaceAll(
  88                 "COMPOSITIONID", String.valueOf(compositionId));
  89     }
  90
  91     String getPayload(Rapp rapp, String location) {
  92         logger.debug("Getting payload for {} from {}", rapp.getRappId(), location);
  93         File csarFile = getCsarFile(rapp);
  94         return getFileFromCsar(csarFile, location).toString();
  95     }
  96
  97     File getCsarFile(Rapp rapp) {
  98         return new File(
  99                 getRappPackageLocation(rapp.getPackageLocation(), rapp.getName(), rapp.getPackageName()).toUri());
 100     }
 101
 102     ByteArrayOutputStream getFileFromCsar(File csarFile, String fileLocation) {
 103         ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
 104         try (FileInputStream fileInputStream = new FileInputStream(csarFile);
 105              ZipArchiveInputStream zipArchiveInputStream = new ZipArchiveInputStream(fileInputStream)) {
 106             ArchiveEntry entry;
 107             while ((entry = zipArchiveInputStream.getNextEntry()) != null) {
 108                 if (!entry.isDirectory() && entry.getName().equals(fileLocation)) {
 109                     byte[] buffer = new byte[1024];
 110                     int bytesRead;
 111                     while ((bytesRead = zipArchiveInputStream.read(buffer)) != -1) {
 112                         byteArrayOutputStream.write(buffer, 0, bytesRead);
 113                     }
 114                 }
 115             }
 116         } catch (IOException e) {
 117             logger.error("Unable to find the CSAR file", e);
 118         }
 119         return byteArrayOutputStream;
 120     }
 121
 122
 123     public String getSmeProviderDomainPayload(Rapp rapp, RappSMEInstance rappSMEInstance) {
 124         return getPayload(rapp, getResourceUri(SME_PROVIDER_FUNCS_LOCATION, rappSMEInstance.getProviderFunction()));
 125     }
 126
 127     public String getSmeProviderApiPayload(Rapp rapp, RappSMEInstance rappSMEInstance) {
 128         return getPayload(rapp, getResourceUri(SME_SERVICE_APIS_LOCATION, rappSMEInstance.getServiceApis()));
 129     }
 130
 131     public String getSmeInvokerPayload(Rapp rapp, RappSMEInstance rappSMEInstance) {
 132         return getPayload(rapp, getResourceUri(SME_INVOKERS_LOCATION, rappSMEInstance.getInvokers()));
 133     }
 134
 135     public String getAcmCompositionPayload(Rapp rapp) {
 136         return getPayload(rapp,
 137                 getResourceUri(ACM_DEFINITION_LOCATION, rapp.getRappResources().getAcm().getCompositionDefinitions()));
 138     }
 139
 140     public String getDmeInfoProducerPayload(Rapp rapp, String producerIdentifier) {
 141         return getPayload(rapp, getResourceUri(DME_INFO_PRODUCERS_LOCATION, producerIdentifier));
 142     }
 143
 144     public String getDmeInfoTypePayload(Rapp rapp, String infoTypeIdentifier) {
 145         return getPayload(rapp, getResourceUri(DME_INFO_TYPES_LOCATION, infoTypeIdentifier));
 146     }
 147
 148     public String getDmeInfoConsumerPayload(Rapp rapp, String infoConsumerIdentifier) {
 149         return getPayload(rapp, getResourceUri(DME_INFO_CONSUMERS_LOCATION, infoConsumerIdentifier));
 150     }
 151
 152     String getResourceUri(String resourceLocation, String resource) {
 153         return resourceLocation + "/" + resource + ".json";
 154     }
 155
 156     public RappResources getRappResource(Rapp rapp) {
 157         RappResources rappResources = new RappResources();
 158         try {
 159             File csarFile = getCsarFile(rapp);
 160             if (csarFile.exists()) {
 161                 rappResources.setAcm(RappResources.ACMResources.builder().compositionDefinitions(
 162                         getFileListFromCsar(csarFile, ACM_DEFINITION_LOCATION).iterator().next()).compositionInstances(
 163                         getFileListFromCsar(csarFile, ACM_INSTANCES_LOCATION)).build());
 164                 rappResources.setSme(RappResources.SMEResources.builder().providerFunctions(
 165                                 getFileListFromCsar(csarFile, SME_PROVIDER_FUNCS_LOCATION))
 166                                              .serviceApis(getFileListFromCsar(csarFile, SME_SERVICE_APIS_LOCATION))
 167                                              .invokers(getFileListFromCsar(csarFile, SME_INVOKERS_LOCATION)).build());
 168                 rappResources.setDme(RappResources.DMEResources.builder()
 169                                              .infoTypes(getFileListFromCsar(csarFile, DME_INFO_TYPES_LOCATION))
 170                                              .infoProducers(getFileListFromCsar(csarFile, DME_INFO_PRODUCERS_LOCATION))
 171                                              .infoConsumers(getFileListFromCsar(csarFile, DME_INFO_CONSUMERS_LOCATION)).build());
 172             }
 173         } catch (Exception e) {
 174             logger.warn("Error in getting the rapp resources", e);
 175         }
 176         return rappResources;
 177     }
 178
 179     Set<String> getFileListFromCsar(File csarFile, String dirLocation) {
 180         try (ZipFile zipFile = new ZipFile(csarFile)) {
 181             return zipFile.stream().filter(Predicate.not(ZipEntry::isDirectory)).map(ZipEntry::getName)
 182                            .filter(name -> name.startsWith(dirLocation))
 183                            .map(name -> name.substring(name.lastIndexOf("/") + 1, name.lastIndexOf(".")))
 184                            .collect(Collectors.toSet());
 185         } catch (IOException e) {
 186             logger.warn("Error in listing the files from csar", e);
 187         }
 188         return Set.of();
 189     }
 190 }