summaryrefslogtreecommitdiffstats
path: root/csarvalidation/src/main/java/org/onap/validation/csar/CsarUtil.java
blob: 7d48b062904067d735af14f222eb45f2886fc762 (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
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
/**
 * Copyright 2017 Huawei Technologies Co., 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.
 */

package org.onap.validation.csar;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.File;
import java.io.FileOutputStream;

import java.io.BufferedOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.HashMap;
import java.util.Enumeration;
import java.util.zip.ZipEntry;
import java.util.zip.ZipFile;
import java.util.Map;

public final class CsarUtil {

   private static final Logger logger = LoggerFactory.getLogger(CsarUtil.class);

   private CsarUtil(){
      //It is made private in order to resolve: Utility classes should not have public constructors
   }
   public static String getUnzipDir(String dirName) {
      File tmpDir = new File(File.separator + dirName);
      return tmpDir.getAbsolutePath().replace(".csar", "");
   }

   /**
   * unzip zip file.
   *
   * @param zipFileName
   *            file name to zip
   * @param extPlace
   *            extPlace
   * @return unzip file names in zip
   * @throws IOException
   *             e1
   * @throws ValidationException
   */
   public static Map<String, String> unzip(String zipFileName, String extPlace) throws IOException {
      HashMap<String, String> unzipFileNames = new HashMap<>();
      InputStream input = null;
      try(ZipFile zipFile = new ZipFile(zipFileName)) {

         Enumeration<?> fileEn = zipFile.entries();
         byte[] buffer = new byte[CommonConstants.BUFFER_SIZE];

         while (fileEn.hasMoreElements()) {
            ZipEntry entry = (ZipEntry) fileEn.nextElement();
            if (entry.isDirectory()) {
               continue;
            }

            input = zipFile.getInputStream(entry);
            File file = new File(extPlace, entry.getName());

            //Currently it does not support xml based VNF descriptors.
            //So skip and proceed to YAML defined files validation only.
            if (file.getAbsolutePath().contains("xml"+System.getProperty("file.separator"))) {
               continue;
            }

            updateUnzipFileNames(input, buffer, unzipFileNames, file);
         }
      } finally {
         closeInputStream(input);
      }
      return unzipFileNames;
   }

   private static void updateUnzipFileNames(InputStream input, byte[] buffer, HashMap<String, String> unzipFileNames, File file) throws IOException {
      if (!file.getParentFile().exists()) {
         FileUtil.createDirectory(file.getParentFile().getAbsolutePath());
      }
      try (BufferedOutputStream bos = new BufferedOutputStream(new FileOutputStream(file))){
         while (true) {
            int length = input.read(buffer);
            if (length == -1) {
               break;
            }
            bos.write(buffer, 0, length);
         }

         unzipFileNames.put(file.getName(), file.getAbsolutePath());
      }
   }

   /**
   * close InputStream.
   *
   * @param inputStream
   *            the inputstream to close
   * @throws ValidationException
   */
   public static void closeInputStream(InputStream inputStream) {
      try {
         if (inputStream != null) {
            inputStream.close();
         }
      } catch (Exception e1) {
         String errCodeMessage = ErrorCodes.FILE_IO+" "+ e1.getMessage();
         logger.error("FILE_IO:close InputStream error! {} {}", errCodeMessage, e1);
         throw new ValidationException(ErrorCodes.FILE_IO);
      }
   }

   /**
   * close OutputStream.
   *
   * @param outputStream
   *            the output stream to close
   * @throws ValidationException
   */
   public static void closeOutputStream(OutputStream outputStream) {
      try {
         if (outputStream != null) {
            outputStream.close();
         }
      } catch (Exception e1) {
         logger.error("FILE_IO:close OutputStream error! {} {}", ErrorCodes.FILE_IO, e1);
         throw new ValidationException(ErrorCodes.FILE_IO);

      }
   }
   /**
   *
   * @param filePath
   * @return HashMap<String, String>
   */
   public static Map<String, String> csarExtract(String filePath) {

      try {
         String tempfolder = CsarUtil.getUnzipDir(filePath);
         return CsarUtil.unzip(filePath, tempfolder);

      } catch (IOException e1) {
         String errCodeMessage = ErrorCodes.FILE_IO+" "+ e1.getMessage();
         logger.error("CSAR_EXTRACTION:CSAR extraction error ! {} {}", errCodeMessage, e1);
         throw new ValidationException(ErrorCodes.FILE_IO);
      }
   }

}