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;
103 for (int i = 0; i < args.size(); i++) {
104 String paramName = null;
105 if (shortOptionMap.containsKey(args.get(i))) {
106 paramName = shortOptionMap.get(args.get(i));
107 } else if (longOptionMap.containsKey(args.get(i))) {
108 paramName = longOptionMap.get(args.get(i));
111 if (paramName != null) {
112 // end of the list or if its option rather than a value
113 if ((i + 1) == args.size() || args.get(i + 1).startsWith("-")) {
114 if (paramMap.get(paramName).getParameterType().equals(OnapCommandParameterType.BOOL)) {
115 paramMap.get(paramName).setValue(true);
118 throw new OnapCliArgumentValueMissing(args.get(i));
121 if (paramMap.get(paramName).getParameterType().equals(OnapCommandParameterType.JSON)) {
122 paramMap.get(paramName).setValue(readJsonStringFromUrl(args.get(i + 1),
123 paramMap.get(paramName).getName()));
127 } else if (paramMap.get(paramName).getParameterType().equals(OnapCommandParameterType.TEXT)) {
128 paramMap.get(paramName).setValue(readTextStringFromUrl(args.get(i + 1),
129 paramMap.get(paramName).getName()));
133 } else if (paramMap.get(paramName).getParameterType().equals(OnapCommandParameterType.YAML)) {
134 String value = readYamlStringFromUrl(args.get(i + 1),
135 paramMap.get(paramName).getName());
136 paramMap.get(paramName).setValue(value);
140 } else if (paramMap.get(paramName).getParameterType().equals(OnapCommandParameterType.BYTE)) {
141 paramMap.get(paramName).setValue(readBytesFromUrl(args.get(i + 1),
142 paramMap.get(paramName).getName()));
146 } else if (paramMap.get(paramName).getParameterType()
147 .equals(OnapCommandParameterType.ARRAY)) {
148 Object value = paramMap.get(paramName).getValue();
149 List<String> list = (List<String>) value;
151 list.add(readTextStringFromUrl(args.get(i + 1), paramMap.get(paramName).getName()));
152 paramMap.get(paramName).setValue(list);
156 } else if (paramMap.get(paramName).getParameterType()
157 .equals(OnapCommandParameterType.MAP)) {
158 Object value = paramMap.get(paramName).getValue();
160 Map<String, String> map = (Map<String, String>) value;
162 String arg = args.get(i + 1);
163 String[] argArr = arg.split("=", 2);
165 if (argArr.length != 2) {
166 throw new OnapCliInvalidArgument(
167 paramMap.get(paramName).getName(),
168 "it should be in the form of <key>=<value>");
171 map.put(argArr[0], argArr[1]);
172 paramMap.get(paramName).setValue(map);
177 paramMap.get(paramName).setValue(args.get(i + 1));
183 // it is positional option
184 // Positional arg is missing from the params
185 if (positionalIdx >= positionArgs.size()) {
186 throw new OnapCliInvalidArgument(
188 "No positional argument is defined for this one");
191 paramMap.get(positionArgs.get(positionalIdx)).setValue(args.get(i));
196 params.addAll(paramMap.values());
199 public static String readJsonStringFromUrl(String input, String argName) throws OnapCliInvalidArgument {
202 File file = new File(input);
204 try(Reader reader = new FileReader(file)){
205 jsonValue = gson.fromJson(reader, JsonElement.class).toString();
208 } else if (input.startsWith("file:") || input.startsWith("http:") || input.startsWith("ftp:")) {
209 URL jsonUrl = new URL(input);
210 try(Reader reader = new InputStreamReader(jsonUrl.openStream())){
211 jsonValue = gson.fromJson(reader, JsonElement.class).toString();
215 return gson.fromJson(input, JsonElement.class).toString();
217 } catch (Exception e) { // NOSONAR
218 throw new OnapCliInvalidArgument(argName, e);
222 public static String readTextStringFromUrl(String input, String argName) throws OnapCliInvalidArgument {
224 File file = new File(input);
226 return FileUtils.readFileToString(file, (Charset) null);
231 } catch (IOException e) {
232 throw new OnapCliInvalidArgument(argName, e);
236 public static String readYamlStringFromUrl(String input, String argName) throws OnapCliInvalidArgument {
238 File file = new File(input);
240 String value = FileUtils.readFileToString(file, (Charset) null);
241 YamlReader reader = new YamlReader(value);
242 value = (String) reader.read();
248 } catch (IOException e) {
249 throw new OnapCliInvalidArgument(argName, e);
253 public static String readBytesFromUrl(String input, String argName) throws OnapCliInvalidArgument {
255 File file = new File(input);
257 byte[] encodeBase64 = Base64.encodeBase64(FileUtils.readFileToByteArray(file));
258 return new String(encodeBase64);
260 byte[] encodeBase64 = Base64.encodeBase64(input.getBytes());
261 return new String(encodeBase64);
263 } catch (IOException e) {
264 throw new OnapCliInvalidArgument(argName, e);
268 public static List<String> convertJsonToListString(String arg, String json) throws OnapCliInvalidArgument {
269 TypeToken<List<String>> mapType = new TypeToken<List<String>>() {
272 return gson.fromJson(json, mapType.getType());
273 } catch (Exception e) { // NOSONAR
274 throw new OnapCliInvalidArgument(arg, e);
278 public static Map<String, String> convertJsonToMapString(String arg, String json) throws OnapCliInvalidArgument {
279 TypeToken<Map<String, String>> mapType = new TypeToken<Map<String, String>>() {
282 return gson.fromJson(json, mapType.getType());
283 } catch (Exception e) { // NOSONAR
284 throw new OnapCliInvalidArgument(arg, e);