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.util.ArrayList;
23 import java.util.HashMap;
24 import java.util.List;
28 import org.apache.commons.io.FileUtils;
29 import org.onap.cli.fw.error.OnapCommandException;
30 import org.onap.cli.fw.error.OnapCommandInvalidParameterValue;
31 import org.onap.cli.fw.input.OnapCommandParameter;
32 import org.onap.cli.fw.input.OnapCommandParameterType;
33 import org.onap.cli.main.error.OnapCliArgumentValueMissing;
34 import org.onap.cli.main.error.OnapCliInvalidArgument;
36 import com.fasterxml.jackson.core.type.TypeReference;
37 import com.fasterxml.jackson.databind.ObjectMapper;
39 import net.minidev.json.JSONObject;
42 * Oclip CLI utilities.
45 public class OnapCliArgsParser {
48 * private Constructor.
50 private OnapCliArgsParser() {
55 * It read thru the args and populate the given params for short optional, long option and postional args the idx of
56 * positional args, is calculated based on the position at which it present in the params and args.
59 * List of command paramters
62 * @throws OnapCliArgumentValueMissing
63 * ArgumentValueMissing exception
64 * @throws OnapCliInvalidArgument
65 * Invalid argument exception
66 * @throws OnapCommandInvalidParameterValue
69 public static void populateParams(Set<OnapCommandParameter> params, List<String> args)
70 throws OnapCommandException {
71 Map<String, String> shortOptionMap = new HashMap<>();
72 Map<String, String> longOptionMap = new HashMap<>();
73 List<String> positionArgs = new ArrayList<>();
74 Map<String, OnapCommandParameter> paramMap = new HashMap<>();
76 for (OnapCommandParameter param : params) {
77 boolean positional = true;
78 if (param.getShortOption() != null) {
79 shortOptionMap.put(OnapCommandParameter.printShortOption(param.getShortOption()), param.getName());
82 if (param.getLongOption() != null) {
83 longOptionMap.put(OnapCommandParameter.printLongOption(param.getLongOption()), param.getName());
88 positionArgs.add(param.getName());
91 paramMap.put(param.getName(), param);
94 int positionalIdx = 0;
95 // Skip the first args oclip cmd name, so start from 1
96 for (int i = 1; i < args.size(); i++) {
97 String paramName = null;
98 if (shortOptionMap.containsKey(args.get(i))) {
99 paramName = shortOptionMap.get(args.get(i));
100 } else if (longOptionMap.containsKey(args.get(i))) {
101 paramName = longOptionMap.get(args.get(i));
104 if (paramName != null) {
105 // end of the list or if its option rather than a value
106 if ((i + 1) == args.size() || args.get(i + 1).startsWith("-")) {
107 if (paramMap.get(paramName).getParameterType().equals(OnapCommandParameterType.BOOL)) {
108 paramMap.get(paramName).setValue(true);
111 throw new OnapCliArgumentValueMissing(args.get(i));
114 if (paramMap.get(paramName).getParameterType().equals(OnapCommandParameterType.JSON)) {
115 paramMap.get(paramName).setValue(readJsonStringFromUrl(args.get(i + 1),
116 paramMap.get(paramName).getName()));
120 } if (paramMap.get(paramName).getParameterType().equals(OnapCommandParameterType.TEXT)) {
121 paramMap.get(paramName).setValue(readTextStringFromUrl(args.get(i + 1),
122 paramMap.get(paramName).getName()));
126 } else if (paramMap.get(paramName).getParameterType()
127 .equals(OnapCommandParameterType.ARRAY)) {
128 Object value = paramMap.get(paramName).getValue();
129 List<String> list = (List<String>) value;
131 list.add(readTextStringFromUrl(args.get(i + 1), paramMap.get(paramName).getName()));
132 paramMap.get(paramName).setValue(list);
136 } else if (paramMap.get(paramName).getParameterType()
137 .equals(OnapCommandParameterType.MAP)) {
138 Object value = paramMap.get(paramName).getValue();
140 Map<String, String> map = (Map<String, String>) value;
142 String arg = args.get(i + 1);
143 String[] argArr = arg.split("=", 2);
145 if (argArr.length != 2) {
146 throw new OnapCliInvalidArgument(
147 paramMap.get(paramName).getName(),
148 "it should be in the form of <key>=<value>");
151 //Make sure to read values from file, in case file path is given.
152 map.put(argArr[0], readTextStringFromUrl(argArr[1], paramMap.get(paramName).getName()));
153 paramMap.get(paramName).setValue(map);
158 paramMap.get(paramName).setValue(args.get(i + 1));
164 // it is positional option
165 // Positional arg is missing from the params
166 if (positionalIdx >= positionArgs.size()) {
167 throw new OnapCliInvalidArgument(
169 "No positional argument is defined for this one");
172 paramMap.get(positionArgs.get(positionalIdx)).setValue(args.get(i));
177 params.addAll(paramMap.values());
180 private static String readJsonStringFromUrl(String input, String argName) throws OnapCliInvalidArgument {
181 ObjectMapper mapper = new ObjectMapper();
183 File file = new File(input);
185 return mapper.readValue(file, JSONObject.class).toJSONString();
186 } else if (input.startsWith("file:") || input.startsWith("http:") || input.startsWith("ftp:")) {
187 URL jsonUrl = new URL(input);
188 return mapper.readValue(jsonUrl, JSONObject.class).toJSONString();
190 return mapper.readValue(input, JSONObject.class).toJSONString();
192 } catch (IOException e) {
193 throw new OnapCliInvalidArgument(argName, e);
197 private static String readTextStringFromUrl(String input, String argName) throws OnapCliInvalidArgument {
199 File file = new File(input);
201 return FileUtils.readFileToString(file);
206 } catch (IOException e) {
207 throw new OnapCliInvalidArgument(argName, e);
211 private static List<String> convertJsonToListString(String arg, String json) throws OnapCliInvalidArgument {
212 TypeReference<List<String>> mapType = new TypeReference<List<String>>() {
215 return new ObjectMapper().readValue(json, mapType);
216 } catch (IOException e) {
217 throw new OnapCliInvalidArgument(arg, e);
221 private static Map<String, String> convertJsonToMapString(String arg, String json) throws OnapCliInvalidArgument {
222 TypeReference<Map<String, String>> mapType = new TypeReference<Map<String, String>>() {
225 return new ObjectMapper().readValue(json, mapType);
226 } catch (IOException e) {
227 throw new OnapCliInvalidArgument(arg, e);