gerrit.onap Code Review - ccsdk/sli/adaptors.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP : APPC
   4  * ================================================================================
   5  * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Copyright (C) 2017 Amdocs
   8  * =============================================================================
   9  * Modifications Copyright (C) 2018 IBM.
  10  * ================================================================================
  11  * Licensed under the Apache License, Version 2.0 (the "License");
  12  * you may not use this file except in compliance with the License.
  13  * You may obtain a copy of the License at
  14  *
  15  *      http://www.apache.org/licenses/LICENSE-2.0
  16  *
  17  * Unless required by applicable law or agreed to in writing, software
  18  * distributed under the License is distributed on an "AS IS" BASIS,
  19  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  20  * See the License for the specific language governing permissions and
  21  * limitations under the License.
  22  *
  23  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  24  * ============LICENSE_END=========================================================
  25  */
  26
  27 package org.onap.ccsdk.sli.adaptors.ansible.model;
  28
  29 /**
  30  * This module implements the APP-C/Ansible Server interface
  31  * based on the REST API specifications
  32  */
  33 import java.util.Collections;
  34 import java.util.HashSet;
  35 import java.util.Iterator;
  36 import java.util.Map;
  37 import java.util.Set;
  38 import java.util.UUID;
  39 import org.json.JSONArray;
  40 import org.json.JSONException;
  41 import org.json.JSONObject;
  42 import org.onap.ccsdk.sli.core.sli.SvcLogicException;
  43 import com.google.common.base.Strings;
  44 import org.slf4j.Logger;
  45 import org.slf4j.LoggerFactory;
  46
  47 /**
  48  * Class that validates and constructs requests sent/received from
  49  * Ansible Server
  50  */
  51 public class AnsibleMessageParser {
  52
  53     private static final String STATUS_MESSAGE_KEY = "StatusMessage";
  54     private static final String STATUS_CODE_KEY = "StatusCode";
  55
  56     private static final String PLAYBOOK_NAME_KEY = "PlaybookName";
  57     private static final String AGENT_URL_KEY = "AgentUrl";
  58     private static final String PASS_KEY = "Password";
  59     private static final String USER_KEY = "User";
  60     private static final String ID_KEY = "Id";
  61
  62     private static final String LOCAL_PARAMETERS_OPT_KEY = "LocalParameters";
  63     private static final String FILE_PARAMETERS_OPT_KEY = "FileParameters";
  64     private static final String ENV_PARAMETERS_OPT_KEY = "EnvParameters";
  65     private static final String NODE_LIST_OPT_KEY = "NodeList";
  66     private static final String TIMEOUT_OPT_KEY = "Timeout";
  67     private static final String VERSION_OPT_KEY = "Version";
  68     private static final String ACTION_OPT_KEY = "Action";
  69
  70     private String jsonException = "JSON exception";
  71     private static final Logger LOGGER = LoggerFactory.getLogger(AnsibleMessageParser.class);
  72
  73     /**
  74      * Accepts a map of strings and
  75      * a) validates if all parameters are appropriate (else, throws an exception) and
  76      * b) if correct returns a JSON object with appropriate key-value pairs to send to the server.
  77      *
  78      * Mandatory parameters, that must be in the supplied information to the Ansible Adapter
  79      * 1. URL to connect to
  80      * 2. credentials for URL (assume username password for now)
  81      * 3. Playbook name
  82      *
  83      */
  84     public JSONObject reqMessage(Map<String, String> params) throws SvcLogicException {
  85         final String[] mandatoryTestParams = {AGENT_URL_KEY, PLAYBOOK_NAME_KEY, USER_KEY, PASS_KEY};
  86         final String[] optionalTestParams = {ENV_PARAMETERS_OPT_KEY, NODE_LIST_OPT_KEY, LOCAL_PARAMETERS_OPT_KEY,
  87                 TIMEOUT_OPT_KEY, VERSION_OPT_KEY, FILE_PARAMETERS_OPT_KEY, ACTION_OPT_KEY};
  88
  89         JSONObject jsonPayload = new JSONObject();
  90
  91         for (String key : mandatoryTestParams) {
  92             throwIfMissingMandatoryParam(params, key);
  93             jsonPayload.put(key, params.get(key));
  94         }
  95
  96         parseOptionalParams(params, optionalTestParams, jsonPayload);
  97
  98         // Generate a unique uuid for the test
  99         String reqId = UUID.randomUUID().toString();
 100         jsonPayload.put(ID_KEY, reqId);
 101
 102         return jsonPayload;
 103     }
 104
 105     /**
 106      * Method that validates that the Map has enough information
 107      * to query Ansible server for a result. If so, it returns
 108      * the appropriate url, else an empty string.
 109      */
 110     public String reqUriResult(Map<String, String> params) throws SvcLogicException {
 111
 112         final String[] mandatoryTestParams = {AGENT_URL_KEY, ID_KEY, USER_KEY, PASS_KEY};
 113
 114         for (String key : mandatoryTestParams) {
 115             throwIfMissingMandatoryParam(params, key);
 116         }
 117         return params.get(AGENT_URL_KEY) + "?Id=" + params.get(ID_KEY) + "&Type=GetResult";
 118     }
 119
 120     /**
 121      * Method that validates that the Map has enough information
 122      * to query Ansible server for logs. If so, it populates the appropriate
 123      * returns the appropriate url, else an empty string.
 124      */
 125     public String reqUriLog(Map<String, String> params) throws SvcLogicException {
 126
 127         final String[] mandatoryTestParams = {AGENT_URL_KEY, ID_KEY, USER_KEY, PASS_KEY};
 128
 129         for (String mandatoryParam : mandatoryTestParams) {
 130             throwIfMissingMandatoryParam(params, mandatoryParam);
 131         }
 132         return params.get(AGENT_URL_KEY) + "?Id=" + params.get(ID_KEY) + "&Type=GetLog";
 133     }
 134
 135     /**
 136      * This method parses response from the Ansible Server when we do a post
 137      * and returns an AnsibleResult object.
 138      */
 139     public AnsibleResult parsePostResponse(String input) throws SvcLogicException {
 140         AnsibleResult ansibleResult;
 141         try {
 142             JSONObject postResponse = new JSONObject(input);
 143
 144             int code = postResponse.getInt(STATUS_CODE_KEY);
 145             String msg = postResponse.getString(STATUS_MESSAGE_KEY);
 146
 147             int initResponseValue = AnsibleResultCodes.INITRESPONSE.getValue();
 148             boolean validCode = AnsibleResultCodes.CODE.checkValidCode(initResponseValue, code);
 149             if (!validCode) {
 150                 throw new SvcLogicException("Invalid InitResponse code  = " + code + " received. MUST be one of "
 151                         + AnsibleResultCodes.CODE.getValidCodes(initResponseValue));
 152             }
 153
 154             ansibleResult = new AnsibleResult(code, msg);
 155
 156         } catch (JSONException e) {
 157             LOGGER.error(jsonException, e);
 158             ansibleResult = new AnsibleResult(600, "Error parsing response = " + input + ". Error = " + e.getMessage());
 159         }
 160         return ansibleResult;
 161     }
 162
 163     /**
 164      * This method parses response from an Ansible server when we do a GET for a result
 165      * and returns an AnsibleResult object.
 166      **/
 167     public AnsibleResult parseGetResponse(String input) throws SvcLogicException {
 168
 169         AnsibleResult ansibleResult = new AnsibleResult();
 170
 171         try {
 172             JSONObject postResponse = new JSONObject(input);
 173             ansibleResult = parseGetResponseNested(ansibleResult, postResponse);
 174         } catch (JSONException e) {
 175             LOGGER.error(jsonException, e);
 176             ansibleResult = new AnsibleResult(AnsibleResultCodes.INVALID_PAYLOAD.getValue(),
 177                     "Error parsing response = " + input + ". Error = " + e.getMessage(), "");
 178         }
 179         return ansibleResult;
 180     }
 181
 182     private AnsibleResult parseGetResponseNested(AnsibleResult ansibleResult, JSONObject postRsp) throws SvcLogicException  {
 183
 184         int codeStatus = postRsp.getInt(STATUS_CODE_KEY);
 185         String messageStatus = postRsp.getString(STATUS_MESSAGE_KEY);
 186         int finalCode = AnsibleResultCodes.FINAL_SUCCESS.getValue();
 187
 188         boolean valCode =
 189                 AnsibleResultCodes.CODE.checkValidCode(AnsibleResultCodes.FINALRESPONSE.getValue(), codeStatus);
 190
 191         if (!valCode) {
 192             throw new SvcLogicException("Invalid FinalResponse code  = " + codeStatus + " received. MUST be one of "
 193                     + AnsibleResultCodes.CODE.getValidCodes(AnsibleResultCodes.FINALRESPONSE.getValue()));
 194         }
 195
 196         ansibleResult.setStatusCode(codeStatus);
 197         ansibleResult.setStatusMessage(messageStatus);
 198         LOGGER.info("Received response with code = {}, Message = {}", codeStatus, messageStatus);
 199
 200         if (!postRsp.isNull("Results")) {
 201
 202             // Results are available. process them
 203             // Results is a dictionary of the form
 204
 205             LOGGER.info("Processing results in response");
 206             JSONObject results = postRsp.getJSONObject("Results");
 207             LOGGER.info("Get JSON dictionary from Results ..");
 208             Iterator<String> hosts = results.keys();
 209             LOGGER.info("Iterating through hosts");
 210
 211             while (hosts.hasNext()) {
 212                 String host = hosts.next();
 213                 LOGGER.info("Processing host = {}", host);
 214
 215                 try {
 216                     JSONObject hostResponse = results.getJSONObject(host);
 217                     int subCode = hostResponse.getInt(STATUS_CODE_KEY);
 218                     String message = hostResponse.getString(STATUS_MESSAGE_KEY);
 219
 220                     LOGGER.info("Code = {}, Message = {}", subCode, message);
 221
 222                     if (subCode != 200 || !("SUCCESS").equals(message)) {
 223                         finalCode = AnsibleResultCodes.REQ_FAILURE.getValue();
 224                     }
 225                 } catch (JSONException e) {
 226                     LOGGER.error(jsonException, e);
 227                     ansibleResult.setStatusCode(AnsibleResultCodes.INVALID_RESPONSE.getValue());
 228                     ansibleResult.setStatusMessage(String.format(
 229                             "Error processing response message = %s from host %s", results.getString(host), host));
 230                     break;
 231                 }
 232             }
 233
 234             ansibleResult.setStatusCode(finalCode);
 235
 236             // We return entire Results object as message
 237             ansibleResult.setResults(results.toString());
 238
 239         } else {
 240             ansibleResult.setStatusCode(AnsibleResultCodes.INVALID_RESPONSE.getValue());
 241             ansibleResult.setStatusMessage("Results not found in GET for response");
 242         }
 243         return ansibleResult;
 244     }
 245
 246     private void parseOptionalParams(Map<String, String> params, String[] optionalTestParams, JSONObject jsonPayload) {
 247
 248         Set<String> optionalParamsSet = new HashSet<>();
 249         Collections.addAll(optionalParamsSet, optionalTestParams);
 250
 251         //@formatter:off
 252         params.entrySet()
 253             .stream()
 254             .filter(entry -> optionalParamsSet.contains(entry.getKey()))
 255             .filter(entry -> !Strings.isNullOrEmpty(entry.getValue()))
 256              .forEach(entry -> parseOptionalParam(entry, jsonPayload));
 257         //@formatter:on
 258     }
 259
 260     private void parseOptionalParam(Map.Entry<String, String> params, JSONObject jsonPayload) {
 261         String key = params.getKey();
 262         String payload = params.getValue();
 263
 264         switch (key) {
 265             case TIMEOUT_OPT_KEY:
 266                 int timeout = Integer.parseInt(payload);
 267                 if (timeout < 0) {
 268                     throw new NumberFormatException(" : specified negative integer for timeout = " + payload);
 269                 }
 270                 jsonPayload.put(key, payload);
 271                 break;
 272
 273             case VERSION_OPT_KEY:
 274                 jsonPayload.put(key, payload);
 275                 break;
 276
 277             case LOCAL_PARAMETERS_OPT_KEY:
 278             case ENV_PARAMETERS_OPT_KEY:
 279                 JSONObject paramsJson = new JSONObject(payload);
 280                 jsonPayload.put(key, paramsJson);
 281                 break;
 282
 283             case NODE_LIST_OPT_KEY:
 284                 JSONArray paramsArray = new JSONArray(payload);
 285                 jsonPayload.put(key, paramsArray);
 286                 break;
 287
 288             case FILE_PARAMETERS_OPT_KEY:
 289                 jsonPayload.put(key, getFilePayload(payload));
 290                 break;
 291
 292             default:
 293                 break;
 294         }
 295     }
 296
 297     /**
 298      * Return payload with escaped newlines
 299      */
 300     private JSONObject getFilePayload(String payload) {
 301         String formattedPayload = payload.replace("\n", "\\n").replace("\r", "\\r");
 302         return new JSONObject(formattedPayload);
 303     }
 304
 305     private void throwIfMissingMandatoryParam(Map<String, String> params, String key) throws SvcLogicException {
 306         if (!params.containsKey(key)) {
 307             throw new SvcLogicException(String.format(
 308                     "Ansible: Mandatory AnsibleAdapter key %s not found in parameters provided by calling agent !",
 309                     key));
 310         }
 311         if (Strings.isNullOrEmpty(params.get(key))) {
 312             throw new SvcLogicException(String.format(
 313                     "Ansible: Mandatory AnsibleAdapter key %s not found in parameters provided by calling agent !",
 314                     key));
 315         }
 316     }
 317 }