2 * Copyright 2017 Huawei Technologies Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 package org.onap.cli.main.utils;
20 import java.io.IOException;
22 import java.nio.charset.Charset;
23 import java.util.ArrayList;
24 import java.util.HashMap;
25 import java.util.List;
29 import org.apache.commons.codec.binary.Base64;
30 import org.apache.commons.io.FileUtils;
31 import org.onap.cli.fw.error.OnapCommandException;
32 import org.onap.cli.fw.error.OnapCommandInvalidParameterValue;
33 import org.onap.cli.fw.input.OnapCommandParameter;
34 import org.onap.cli.fw.input.OnapCommandParameterType;
35 import org.onap.cli.main.error.OnapCliArgumentValueMissing;
36 import org.onap.cli.main.error.OnapCliInvalidArgument;
37 import com.esotericsoftware.yamlbeans.YamlReader;
39 import com.google.gson.Gson;
40 import com.google.gson.GsonBuilder;
41 import com.google.gson.JsonElement;
42 import com.google.gson.reflect.TypeToken;
44 import java.io.Reader;
45 import java.io.InputStreamReader;
46 import java.io.FileReader;
49 * Oclip CLI utilities.
52 public class OnapCliArgsParser {
53 private static Gson gson = new GsonBuilder().serializeNulls().create();
56 * private Constructor.
58 private OnapCliArgsParser() {
63 * It read thru the args and populate the given params for short optional, long option and postional args the idx of
64 * positional args, is calculated based on the position at which it present in the params and args.
67 * List of command paramters
70 * @throws OnapCliArgumentValueMissing
71 * ArgumentValueMissing exception
72 * @throws OnapCliInvalidArgument
73 * Invalid argument exception
74 * @throws OnapCommandInvalidParameterValue
77 public static void populateParams(Set<OnapCommandParameter> params, List<String> args)
78 throws OnapCommandException {
79 Map<String, String> shortOptionMap = new HashMap<>();
80 Map<String, String> longOptionMap = new HashMap<>();
81 List<String> positionArgs = new ArrayList<>();
82 Map<String, OnapCommandParameter> paramMap = new HashMap<>();
84 for (OnapCommandParameter param : params) {
85 boolean positional = true;
86 if (param.getShortOption() != null) {
87 shortOptionMap.put(OnapCommandParameter.printShortOption(param.getShortOption()), param.getName());
90 if (param.getLongOption() != null) {
91 longOptionMap.put(OnapCommandParameter.printLongOption(param.getLongOption()), param.getName());
96 positionArgs.add(param.getName());
99 paramMap.put(param.getName(), param);
102 int positionalIdx = 0;
104 while(i < args.size()) {
105 String paramName = null;
106 if (shortOptionMap.containsKey(args.get(i))) {
107 paramName = shortOptionMap.get(args.get(i));
108 } else if (longOptionMap.containsKey(args.get(i))) {
109 paramName = longOptionMap.get(args.get(i));
112 if (paramName != null) {
113 // end of the list or if its option rather than a value
114 if ((i + 1) == args.size() || args.get(i + 1).startsWith("-")) {
115 if (paramMap.get(paramName).getParameterType().equals(OnapCommandParameterType.BOOL)) {
116 paramMap.get(paramName).setValue(true);
120 throw new OnapCliArgumentValueMissing(args.get(i));
123 if (paramMap.get(paramName).getParameterType().equals(OnapCommandParameterType.JSON)) {
124 paramMap.get(paramName).setValue(readJsonStringFromUrl(args.get(i + 1),
125 paramMap.get(paramName).getName()));
129 } else if (paramMap.get(paramName).getParameterType().equals(OnapCommandParameterType.TEXT)) {
130 paramMap.get(paramName).setValue(readTextStringFromUrl(args.get(i + 1),
131 paramMap.get(paramName).getName()));
135 } else if (paramMap.get(paramName).getParameterType().equals(OnapCommandParameterType.YAML)) {
136 String value = readYamlStringFromUrl(args.get(i + 1),
137 paramMap.get(paramName).getName());
138 paramMap.get(paramName).setValue(value);
142 } else if (paramMap.get(paramName).getParameterType().equals(OnapCommandParameterType.BYTE)) {
143 paramMap.get(paramName).setValue(readBytesFromUrl(args.get(i + 1),
144 paramMap.get(paramName).getName()));
148 } else if (paramMap.get(paramName).getParameterType()
149 .equals(OnapCommandParameterType.ARRAY)) {
150 Object value = paramMap.get(paramName).getValue();
151 List<String> list = (List<String>) value;
153 list.add(readTextStringFromUrl(args.get(i + 1), paramMap.get(paramName).getName()));
154 paramMap.get(paramName).setValue(list);
158 } else if (paramMap.get(paramName).getParameterType()
159 .equals(OnapCommandParameterType.MAP)) {
160 Object value = paramMap.get(paramName).getValue();
162 Map<String, String> map = (Map<String, String>) value;
164 String arg = args.get(i + 1);
165 String[] argArr = arg.split("=", 2);
167 if (argArr.length != 2) {
168 throw new OnapCliInvalidArgument(
169 paramMap.get(paramName).getName(),
170 "it should be in the form of <key>=<value>");
173 map.put(argArr[0], argArr[1]);
174 paramMap.get(paramName).setValue(map);
179 paramMap.get(paramName).setValue(args.get(i + 1));
185 // it is positional option
186 // Positional arg is missing from the params
187 if (positionalIdx >= positionArgs.size()) {
188 throw new OnapCliInvalidArgument(
190 "No positional argument is defined for this one");
193 paramMap.get(positionArgs.get(positionalIdx)).setValue(args.get(i));
199 params.addAll(paramMap.values());
202 public static String readJsonStringFromUrl(String input, String argName) throws OnapCliInvalidArgument {
205 File file = new File(input);
207 try(Reader reader = new FileReader(file)){
208 jsonValue = gson.fromJson(reader, JsonElement.class).toString();
211 } else if (input.startsWith("file:") || input.startsWith("http:") || input.startsWith("ftp:")) {
212 URL jsonUrl = new URL(input);
213 try(Reader reader = new InputStreamReader(jsonUrl.openStream())){
214 jsonValue = gson.fromJson(reader, JsonElement.class).toString();
218 return gson.fromJson(input, JsonElement.class).toString();
220 } catch (Exception e) { // NOSONAR
221 throw new OnapCliInvalidArgument(argName, e);
225 public static String readTextStringFromUrl(String input, String argName) throws OnapCliInvalidArgument {
227 File file = new File(input);
229 return FileUtils.readFileToString(file, (Charset) null);
234 } catch (IOException e) {
235 throw new OnapCliInvalidArgument(argName, e);
239 public static String readYamlStringFromUrl(String input, String argName) throws OnapCliInvalidArgument {
241 File file = new File(input);
243 String value = FileUtils.readFileToString(file, (Charset) null);
244 YamlReader reader = new YamlReader(value);
245 value = (String) reader.read();
251 } catch (IOException e) {
252 throw new OnapCliInvalidArgument(argName, e);
256 public static String readBytesFromUrl(String input, String argName) throws OnapCliInvalidArgument {
258 File file = new File(input);
260 byte[] encodeBase64 = Base64.encodeBase64(FileUtils.readFileToByteArray(file));
261 return new String(encodeBase64);
263 byte[] encodeBase64 = Base64.encodeBase64(input.getBytes());
264 return new String(encodeBase64);
266 } catch (IOException e) {
267 throw new OnapCliInvalidArgument(argName, e);
271 public static List<String> convertJsonToListString(String arg, String json) throws OnapCliInvalidArgument {
272 TypeToken<List<String>> mapType = new TypeToken<List<String>>() {
275 return gson.fromJson(json, mapType.getType());
276 } catch (Exception e) { // NOSONAR
277 throw new OnapCliInvalidArgument(arg, e);
281 public static Map<String, String> convertJsonToMapString(String arg, String json) throws OnapCliInvalidArgument {
282 TypeToken<Map<String, String>> mapType = new TypeToken<Map<String, String>>() {
285 return gson.fromJson(json, mapType.getType());
286 } catch (Exception e) { // NOSONAR
287 throw new OnapCliInvalidArgument(arg, e);