2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved.
6 * ================================================================================
7 * Copyright (C) 2017 Amdocs
8 * =============================================================================
9 * Licensed under the Apache License, Version 2.0 (the "License");
10 * you may not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
13 * http://www.apache.org/licenses/LICENSE-2.0
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS,
17 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
21 * ============LICENSE_END=========================================================
24 package org.onap.appc.adapter.ansible.model;
27 * This module implements the APP-C/Ansible Server interface
28 * based on the REST API specifications
30 import java.util.Collections;
31 import java.util.HashSet;
32 import java.util.Iterator;
35 import java.util.UUID;
36 import org.json.JSONArray;
37 import org.json.JSONException;
38 import org.json.JSONObject;
39 import org.onap.appc.exceptions.APPCException;
40 import com.google.common.base.Strings;
41 import org.slf4j.Logger;
42 import org.slf4j.LoggerFactory;
45 * Class that validates and constructs requests sent/received from
48 public class AnsibleMessageParser {
50 private static final String STATUS_MESSAGE_KEY = "StatusMessage";
51 private static final String STATUS_CODE_KEY = "StatusCode";
53 private static final String PLAYBOOK_NAME_KEY = "PlaybookName";
54 private static final String AGENT_URL_KEY = "AgentUrl";
55 private static final String PASS_KEY = "Password";
56 private static final String USER_KEY = "User";
57 private static final String ID_KEY = "Id";
59 private static final String LOCAL_PARAMETERS_OPT_KEY = "LocalParameters";
60 private static final String FILE_PARAMETERS_OPT_KEY = "FileParameters";
61 private static final String ENV_PARAMETERS_OPT_KEY = "EnvParameters";
62 private static final String NODE_LIST_OPT_KEY = "NodeList";
63 private static final String TIMEOUT_OPT_KEY = "Timeout";
64 private static final String VERSION_OPT_KEY = "Version";
65 private static final String ACTION_OPT_KEY = "Action";
67 private static final Logger LOGGER = LoggerFactory.getLogger(AnsibleMessageParser.class);
70 * Accepts a map of strings and
71 * a) validates if all parameters are appropriate (else, throws an exception) and
72 * b) if correct returns a JSON object with appropriate key-value pairs to send to the server.
74 * Mandatory parameters, that must be in the supplied information to the Ansible Adapter
75 * 1. URL to connect to
76 * 2. credentials for URL (assume username password for now)
80 public JSONObject reqMessage(Map<String, String> params) throws APPCException {
81 final String[] mandatoryTestParams = {AGENT_URL_KEY, PLAYBOOK_NAME_KEY, USER_KEY, PASS_KEY};
82 final String[] optionalTestParams = {ENV_PARAMETERS_OPT_KEY, NODE_LIST_OPT_KEY, LOCAL_PARAMETERS_OPT_KEY,
83 TIMEOUT_OPT_KEY, VERSION_OPT_KEY, FILE_PARAMETERS_OPT_KEY, ACTION_OPT_KEY};
85 JSONObject jsonPayload = new JSONObject();
87 for (String key : mandatoryTestParams) {
88 throwIfMissingMandatoryParam(params, key);
89 jsonPayload.put(key, params.get(key));
92 parseOptionalParams(params, optionalTestParams, jsonPayload);
94 // Generate a unique uuid for the test
95 String reqId = UUID.randomUUID().toString();
96 jsonPayload.put(ID_KEY, reqId);
102 * Method that validates that the Map has enough information
103 * to query Ansible server for a result. If so, it returns
104 * the appropriate url, else an empty string.
106 public String reqUriResult(Map<String, String> params) throws APPCException {
108 final String[] mandatoryTestParams = {AGENT_URL_KEY, ID_KEY, USER_KEY, PASS_KEY};
110 for (String key : mandatoryTestParams) {
111 throwIfMissingMandatoryParam(params, key);
113 return params.get(AGENT_URL_KEY) + "?Id=" + params.get(ID_KEY) + "&Type=GetResult";
117 * Method that validates that the Map has enough information
118 * to query Ansible server for logs. If so, it populates the appropriate
119 * returns the appropriate url, else an empty string.
121 public String reqUriLog(Map<String, String> params) throws APPCException {
123 final String[] mandatoryTestParams = {AGENT_URL_KEY, ID_KEY, USER_KEY, PASS_KEY};
125 for (String mandatoryParam : mandatoryTestParams) {
126 throwIfMissingMandatoryParam(params, mandatoryParam);
128 return params.get(AGENT_URL_KEY) + "?Id=" + params.get(ID_KEY) + "&Type=GetLog";
132 * This method parses response from the Ansible Server when we do a post
133 * and returns an AnsibleResult object.
135 public AnsibleResult parsePostResponse(String input) throws APPCException {
136 AnsibleResult ansibleResult;
138 JSONObject postResponse = new JSONObject(input);
140 int code = postResponse.getInt(STATUS_CODE_KEY);
141 String msg = postResponse.getString(STATUS_MESSAGE_KEY);
143 int initResponseValue = AnsibleResultCodes.INITRESPONSE.getValue();
144 boolean validCode = AnsibleResultCodes.CODE.checkValidCode(initResponseValue, code);
146 throw new APPCException("Invalid InitResponse code = " + code + " received. MUST be one of "
147 + AnsibleResultCodes.CODE.getValidCodes(initResponseValue));
150 ansibleResult = new AnsibleResult(code, msg);
152 } catch (JSONException e) {
153 ansibleResult = new AnsibleResult(600, "Error parsing response = " + input + ". Error = " + e.getMessage());
155 return ansibleResult;
159 * This method parses response from an Ansible server when we do a GET for a result
160 * and returns an AnsibleResult object.
162 public AnsibleResult parseGetResponse(String input) throws APPCException {
164 AnsibleResult ansibleResult = new AnsibleResult();
167 JSONObject postResponse = new JSONObject(input);
168 ansibleResult = parseGetResponseNested(ansibleResult, postResponse);
169 } catch (JSONException e) {
170 ansibleResult = new AnsibleResult(AnsibleResultCodes.INVALID_PAYLOAD.getValue(),
171 "Error parsing response = " + input + ". Error = " + e.getMessage(), "");
173 return ansibleResult;
176 private AnsibleResult parseGetResponseNested(AnsibleResult ansibleResult, JSONObject postRsp) throws APPCException {
178 int codeStatus = postRsp.getInt(STATUS_CODE_KEY);
179 String messageStatus = postRsp.getString(STATUS_MESSAGE_KEY);
180 int finalCode = AnsibleResultCodes.FINAL_SUCCESS.getValue();
183 AnsibleResultCodes.CODE.checkValidCode(AnsibleResultCodes.FINALRESPONSE.getValue(), codeStatus);
186 throw new APPCException("Invalid FinalResponse code = " + codeStatus + " received. MUST be one of "
187 + AnsibleResultCodes.CODE.getValidCodes(AnsibleResultCodes.FINALRESPONSE.getValue()));
190 ansibleResult.setStatusCode(codeStatus);
191 ansibleResult.setStatusMessage(messageStatus);
192 LOGGER.info("Received response with code = {}, Message = {}", codeStatus, messageStatus);
194 if (!postRsp.isNull("Results")) {
196 // Results are available. process them
197 // Results is a dictionary of the form
198 // {host :{status:s, group:g, message:m, hostname:h}, ...}
199 LOGGER.info("Processing results in response");
200 JSONObject results = postRsp.getJSONObject("Results");
201 LOGGER.info("Get JSON dictionary from Results ..");
202 Iterator<String> hosts = results.keys();
203 LOGGER.info("Iterating through hosts");
205 while (hosts.hasNext()) {
206 String host = hosts.next();
207 LOGGER.info("Processing host = {}", host);
210 JSONObject hostResponse = results.getJSONObject(host);
211 int subCode = hostResponse.getInt(STATUS_CODE_KEY);
212 String message = hostResponse.getString(STATUS_MESSAGE_KEY);
214 LOGGER.info("Code = {}, Message = {}", subCode, message);
216 if (subCode != 200 || !message.equals("SUCCESS")) {
217 finalCode = AnsibleResultCodes.REQ_FAILURE.getValue();
219 } catch (JSONException e) {
220 ansibleResult.setStatusCode(AnsibleResultCodes.INVALID_RESPONSE.getValue());
221 ansibleResult.setStatusMessage(String.format(
222 "Error processing response message = %s from host %s", results.getString(host), host));
227 ansibleResult.setStatusCode(finalCode);
229 // We return entire Results object as message
230 ansibleResult.setResults(results.toString());
233 ansibleResult.setStatusCode(AnsibleResultCodes.INVALID_RESPONSE.getValue());
234 ansibleResult.setStatusMessage("Results not found in GET for response");
236 return ansibleResult;
239 private void parseOptionalParams(Map<String, String> params, String[] optionalTestParams, JSONObject jsonPayload) {
241 Set<String> optionalParamsSet = new HashSet<>();
242 Collections.addAll(optionalParamsSet, optionalTestParams);
247 .filter(entry -> optionalParamsSet.contains(entry.getKey()))
248 .filter(entry -> !Strings.isNullOrEmpty(entry.getValue()))
249 .forEach(entry -> parseOptionalParam(entry, jsonPayload));
253 private void parseOptionalParam(Map.Entry<String, String> params, JSONObject jsonPayload) {
254 String key = params.getKey();
255 String payload = params.getValue();
258 case TIMEOUT_OPT_KEY:
259 int timeout = Integer.parseInt(payload);
261 throw new NumberFormatException(" : specified negative integer for timeout = " + payload);
263 jsonPayload.put(key, payload);
266 case VERSION_OPT_KEY:
267 jsonPayload.put(key, payload);
270 case LOCAL_PARAMETERS_OPT_KEY:
271 case ENV_PARAMETERS_OPT_KEY:
272 JSONObject paramsJson = new JSONObject(payload);
273 jsonPayload.put(key, paramsJson);
276 case NODE_LIST_OPT_KEY:
277 JSONArray paramsArray = new JSONArray(payload);
278 jsonPayload.put(key, paramsArray);
281 case FILE_PARAMETERS_OPT_KEY:
282 jsonPayload.put(key, getFilePayload(payload));
291 * Return payload with escaped newlines
293 private JSONObject getFilePayload(String payload) {
294 String formattedPayload = payload.replace("\n", "\\n").replace("\r", "\\r");
295 return new JSONObject(formattedPayload);
298 private void throwIfMissingMandatoryParam(Map<String, String> params, String key) throws APPCException {
299 if (!params.containsKey(key)) {
300 throw new APPCException(String.format(
301 "Ansible: Mandatory AnsibleAdapter key %s not found in parameters provided by calling agent !",
304 if (Strings.isNullOrEmpty(params.get(key))) {
305 throw new APPCException(String.format(
306 "Ansible: Mandatory AnsibleAdapter key %s not found in parameters provided by calling agent !",