diff options
author | Singal, Kapil (ks220y) <ks220y@att.com> | 2021-03-16 00:30:22 -0400 |
---|---|---|
committer | Singal, Kapil (ks220y) <ks220y@att.com> | 2021-03-16 00:30:22 -0400 |
commit | cb07500090e0c50929e7543a63b42ff5b8dc12e3 (patch) | |
tree | c59f3b344e6a8c0b535f158c3637b114332b46c7 /adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main | |
parent | 82e92c482efe0ac20353f630cda7cb052d8ff4b5 (diff) |
Renaming ansible and saltstanck adapter to adaptor
Issue-ID: CCSDK-3212
Signed-off-by: Singal, Kapil (ks220y) <ks220y@att.com>
Change-Id: Ibf0366b31a37173050602bd692627647f4f29bb7
Diffstat (limited to 'adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main')
13 files changed, 2018 insertions, 0 deletions
diff --git a/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/AnsibleAdaptor.java b/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/AnsibleAdaptor.java new file mode 100644 index 000000000..55dbc4257 --- /dev/null +++ b/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/AnsibleAdaptor.java @@ -0,0 +1,53 @@ +/*- + * ============LICENSE_START======================================================= + * ONAP : SLI + * ================================================================================ + * Copyright (C) 2021 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + * ============LICENSE_END========================================================= + */ + +package org.onap.ccsdk.sli.adaptors.ansible; + +import java.util.Map; +import org.onap.ccsdk.sli.core.sli.SvcLogicContext; +import org.onap.ccsdk.sli.core.sli.SvcLogicException; +import org.onap.ccsdk.sli.core.sli.SvcLogicJavaPlugin; + +/** + * This interface defines the operations that the Ansible adaptor exposes. + */ +public interface AnsibleAdaptor extends SvcLogicJavaPlugin { + /** + * Returns the symbolic name of the adaptor + * + * @return The adaptor name + */ + String getAdaptorName(); + + /* Method to post request for execution of Playbook */ + void reqExec(Map<String, String> params, SvcLogicContext ctx) throws SvcLogicException; + + /* Method to get result of a playbook execution request */ + void reqExecResult(Map<String, String> params, SvcLogicContext ctx) throws SvcLogicException; + + /* Method to get log of a playbook execution request */ + void reqExecLog(Map<String, String> params, SvcLogicContext ctx) throws SvcLogicException; + + /* Method to get output of a playbook execution request */ + void reqExecOutput(Map<String, String> params, SvcLogicContext ctx) throws SvcLogicException; + +} diff --git a/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/AnsibleAdaptorConstants.java b/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/AnsibleAdaptorConstants.java new file mode 100644 index 000000000..e10e35a04 --- /dev/null +++ b/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/AnsibleAdaptorConstants.java @@ -0,0 +1,50 @@ +package org.onap.ccsdk.sli.adaptors.ansible; + +public class AnsibleAdaptorConstants { + + public static final String ID = "Id"; + public static final String USER = "User"; + public static final String PSWD = "Password"; + public static final String SERVERIP = "ServerIP"; + public static final String AGENT_URL = "AgentUrl"; + public static final String NODE_LIST = "NodeList"; + public static final String ANSIBLE_SERVER = "AnsibleServer"; + + public static final String APPC_PROPS = "/appc.properties"; + public static final String SDNC_CONFIG_DIR = "SDNC_CONFIG_DIR"; + public static final String PROPDIR = System.getenv(SDNC_CONFIG_DIR); + + public static final String ACTION = "Action"; + public static final String OUTPUT = "Output"; + public static final String TIMEOUT = "Timeout"; + public static final String VERSION = "Version"; + + public static final String FAILURE = "failure"; + public static final String SUCCESS = "success"; + public static final String STATUS_CODE = "StatusCode"; + public static final String STATUS_MESSAGE = "StatusMessage"; + + public static final String EXTRA_VARS = "ExtraVars"; + public static final String PLAYBOOK_NAME = "PlaybookName"; + public static final String AUTO_NODE_LIST = "AutoNodeList"; + public static final String ENV_PARAMETERS = "EnvParameters"; + public static final String FILE_PARAMETERS = "FileParameters"; + public static final String INVENTORY_NAMES = "InventoryNames"; + public static final String LOCAL_PARAMETERS = "LocalParameters"; + + public static final String ID_ATTRIBUTE_NAME = "org.onap.appc.adaptor.ansible.Id"; + public static final String LOG_ATTRIBUTE_NAME = "org.onap.appc.adaptor.ansible.log"; + public static final String OUTPUT_ATTRIBUTE_NAME = "org.onap.appc.adaptor.ansible.output"; + public static final String TIMEOUT_PROPERTY_NAME = "org.onap.appc.adaptor.ansible.timeout"; + public static final String MESSAGE_ATTRIBUTE_NAME = "org.onap.appc.adaptor.ansible.message"; + public static final String RESULTS_ATTRIBUTE_NAME = "org.onap.appc.adaptor.ansible.results"; + public static final String RESULT_CODE_ATTRIBUTE_NAME = "org.onap.appc.adaptor.ansible.result.code"; + + public static final String TRUSTSTORE_PROPERTY_NAME = "org.onap.appc.adaptor.ansible.trustStore"; + public static final String CLIENT_TYPE_PROPERTY_NAME = "org.onap.appc.adaptor.ansible.clientType"; + public static final String POLL_INTERVAL_PROPERTY_NAME = "org.onap.appc.adaptor.ansible.pollInterval"; + public static final String SOCKET_TIMEOUT_PROPERTY_NAME = "org.onap.appc.adaptor.ansible.socketTimeout"; + public static final String TRUSTSTORE_PASS_PROPERTY_NAME = "org.onap.appc.adaptor.ansible.trustStore.trustPasswd"; + + +} diff --git a/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/AnsibleAdaptorPropertiesProvider.java b/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/AnsibleAdaptorPropertiesProvider.java new file mode 100644 index 000000000..024215ae3 --- /dev/null +++ b/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/AnsibleAdaptorPropertiesProvider.java @@ -0,0 +1,31 @@ +/*- + * ============LICENSE_START======================================================= + * ONAP : SLI + * ================================================================================ + * Copyright (C) 2021 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + * ============LICENSE_END========================================================= + */ + +package org.onap.ccsdk.sli.adaptors.ansible; + +import java.util.Properties; + +public interface AnsibleAdaptorPropertiesProvider { + + Properties getProperties(); + +} diff --git a/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/impl/AnsibleAdaptorImpl.java b/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/impl/AnsibleAdaptorImpl.java new file mode 100644 index 000000000..790b10f92 --- /dev/null +++ b/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/impl/AnsibleAdaptorImpl.java @@ -0,0 +1,620 @@ +/*- + * ============LICENSE_START======================================================= + * ONAP : SLI + * ================================================================================ + * Copyright (C) 2021 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + * ============LICENSE_END========================================================= + */ + +package org.onap.ccsdk.sli.adaptors.ansible.impl; + +import com.att.eelf.configuration.EELFLogger; +import com.att.eelf.configuration.EELFManager; +import java.io.File; +import java.io.FileInputStream; +import java.io.InputStream; +import java.util.HashMap; +import java.util.Map; +import java.util.Properties; +import org.apache.commons.lang.StringUtils; +import org.json.JSONArray; +import org.json.JSONException; +import org.json.JSONObject; +import org.onap.ccsdk.sli.adaptors.ansible.AnsibleAdaptor; +import org.onap.ccsdk.sli.adaptors.ansible.AnsibleAdaptorPropertiesProvider; +import org.onap.ccsdk.sli.adaptors.ansible.model.AnsibleMessageParser; +import org.onap.ccsdk.sli.adaptors.ansible.model.AnsibleResult; +import org.onap.ccsdk.sli.adaptors.ansible.model.AnsibleResultCodes; +import org.onap.ccsdk.sli.adaptors.ansible.model.AnsibleServerEmulator; +import org.onap.ccsdk.sli.core.sli.SvcLogicContext; +import org.onap.ccsdk.sli.core.sli.SvcLogicException; +import org.onap.ccsdk.sli.core.utils.encryption.EncryptionTool; + +import static org.onap.ccsdk.sli.adaptors.ansible.AnsibleAdaptorConstants.*; + +/** + * This class implements the {@link AnsibleAdaptor} interface. This interface defines the behaviors + * that our service provides. + */ +public class AnsibleAdaptorImpl implements AnsibleAdaptor { + + /** + * Adaptor Name + */ + private static final String Adaptor_NAME = "Ansible Adaptor"; + private static final String APPC_EXCEPTION_CAUGHT = "APPCException caught"; + + /** + * The logger to be used + */ + private static final EELFLogger logger = EELFManager.getInstance().getLogger(AnsibleAdaptorImpl.class); + private int defaultTimeout = 600 * 1000; + private int defaultSocketTimeout = 60 * 1000; + private int defaultPollInterval = 60 * 1000; + /** + * Ansible API Message Handlers + **/ + private AnsibleMessageParser messageProcessor; + + /** + * indicator whether in test mode + **/ + private boolean testMode = false; + + /** + * server emulator object to be used if in test mode + **/ + private AnsibleServerEmulator testServer; + + /** + * This default constructor is used as a work around because the activator wasn't getting called + */ + public AnsibleAdaptorImpl() { + initialize(new AnsibleAdaptorPropertiesProviderImpl()); + } + + /** + * Instantiates a new Ansible adaptor. + * + * @param propProvider the prop provider + */ + public AnsibleAdaptorImpl(AnsibleAdaptorPropertiesProvider propProvider) { + initialize(propProvider); + } + + /** + * Used for jUnit test and testing interface + * + * @param mode the mode + */ + public AnsibleAdaptorImpl(boolean mode) { + testMode = mode; + testServer = new AnsibleServerEmulator(); + messageProcessor = new AnsibleMessageParser(); + } + + /** + * Returns the symbolic name of the adaptor + * + * @return The adaptor name + */ + @Override + public String getAdaptorName() { + return Adaptor_NAME; + } + + @SuppressWarnings("static-method") + private void doFailure(SvcLogicContext svcLogic, int code, String message) throws SvcLogicException { + svcLogic.markFailed(); + svcLogic.setAttribute(RESULT_CODE_ATTRIBUTE_NAME, Integer.toString(code)); + svcLogic.setAttribute(MESSAGE_ATTRIBUTE_NAME, message); + throw new SvcLogicException("Ansible Adaptor Error = " + message); + } + + /** + * initialize the Ansible adaptor based on default and over-ride configuration data + */ + private void initialize(AnsibleAdaptorPropertiesProvider propProvider) { + Properties props = propProvider.getProperties(); + // Create the message processor instance + messageProcessor = new AnsibleMessageParser(); + + //continuing for checking defaultTimeout + try { + String timeoutStr = props.getProperty(TIMEOUT_PROPERTY_NAME); + defaultTimeout = Integer.parseInt(timeoutStr) * 1000; + } catch (Exception e) { + defaultTimeout = 600 * 1000; + logger.error("Error while reading time out property", e); + } + //continuing for checking defaultSocketTimeout + try { + String timeoutStr = props.getProperty(SOCKET_TIMEOUT_PROPERTY_NAME); + defaultSocketTimeout = Integer.parseInt(timeoutStr) * 1000; + } catch (Exception e) { + defaultSocketTimeout = 60 * 1000; + logger.error("Error while reading socket time out property", e); + } + //continuing for checking defaultPollInterval + try { + String timeoutStr = props.getProperty(POLL_INTERVAL_PROPERTY_NAME); + defaultPollInterval = Integer.parseInt(timeoutStr) * 1000; + } catch (Exception e) { + defaultPollInterval = 60 * 1000; + logger.error("Error while reading poll interval property", e); + } + logger.info("Initialized Ansible Adaptor"); + } + + private ConnectionBuilder getHttpConn(int timeout, String serverIP) { + String path = PROPDIR + APPC_PROPS; + File propFile = new File(path); + Properties props = new Properties(); + InputStream input; + try { + input = new FileInputStream(propFile); + props.load(input); + } catch (Exception ex) { + logger.error("Error while reading appc.properties file {}", ex.getMessage()); + } + // Create the http client instance + // type of client is extracted from the property file parameter + // org.onap.appc.adaptor.ansible.clientType + // It can be : + // 1. TRUST_ALL (trust all SSL certs). To be used ONLY in dev + // 2. TRUST_CERT (trust only those whose certificates have been stored in the trustStore file) + // 3. DEFAULT (trust only well known certificates). This is standard behavior to which it will + // revert. To be used in PROD + ConnectionBuilder httpClientLocal = null; + try { + String clientType = props.getProperty(CLIENT_TYPE_PROPERTY_NAME); + logger.info("Ansible http client type set to {}", clientType); + if ("TRUST_ALL".equals(clientType)) { + logger.info("Creating http client to trust ALL ssl certificates. WARNING. This should be done only in dev environments"); + httpClientLocal = new ConnectionBuilder(1, timeout); + } else if ("TRUST_CERT".equals(clientType)) { + // set path to keystore file + String trustStoreFile = props.getProperty(TRUSTSTORE_PROPERTY_NAME); + String key = props.getProperty(TRUSTSTORE_PASS_PROPERTY_NAME); + char[] trustStorePasswd = EncryptionTool.getInstance().decrypt(key).toCharArray(); + logger.info("Creating http client with trust manager from {}", trustStoreFile); + httpClientLocal = new ConnectionBuilder(trustStoreFile, trustStorePasswd, timeout, serverIP); + } else { + logger.info("Creating http client with default behaviour"); + httpClientLocal = new ConnectionBuilder(0, timeout); + } + } catch (Exception e) { + logger.error("Error Getting HTTP Connection Builder due to Unknown Exception", e); + } + + logger.info("Got HTTP Connection Builder"); + return httpClientLocal; + } + + // Public Method to post request to execute playbook. Posts the following back + // to Svc context memory + // org.onap.appc.adaptor.ansible.req.code : 100 if successful + // org.onap.appc.adaptor.ansible.req.messge : any message + // org.onap.appc.adaptor.ansible.req.Id : a unique uuid to reference the request + @Override + public void reqExec(Map<String, String> params, SvcLogicContext ctx) throws SvcLogicException { + String playbookName = StringUtils.EMPTY; + String payload = StringUtils.EMPTY; + String agentUrl = StringUtils.EMPTY; + String user = StringUtils.EMPTY; + String pswd = StringUtils.EMPTY; + String id = StringUtils.EMPTY; + + try { + // create json object to send request + JSONObject jsonPayload = messageProcessor.reqMessage(params); + logger.info("Initial Payload = {}", jsonPayload.toString()); + + agentUrl = (String) jsonPayload.remove("AgentUrl"); + id = jsonPayload.getString("Id"); + user = (String) jsonPayload.remove(USER); + pswd = (String) jsonPayload.remove(PSWD); + if (StringUtils.isNotBlank(pswd)) { + pswd = EncryptionTool.getInstance().decrypt(pswd); + } + String timeout = jsonPayload.getString("Timeout"); + if (StringUtils.isBlank(timeout)) { + timeout = "600"; + } + + String autoNodeList = (String) jsonPayload.remove("AutoNodeList"); + if (Boolean.parseBoolean(autoNodeList)) { + JSONArray generatedNodeList = generateNodeList(params, ctx); + if (generatedNodeList.length() > 0) { + jsonPayload.put("NodeList", generatedNodeList); + jsonPayload.put("InventoryNames", "VM"); + } else { + doFailure(ctx, AnsibleResultCodes.INVALID_PAYLOAD.getValue(), + "Auto generation of Node List Failed - no elements on the list"); + } + } else { + logger.debug("Auto Node List is DISABLED"); + } + + payload = jsonPayload.toString(); + ctx.setAttribute("AnsibleTimeout", timeout); + logger.info("Updated Payload = {} timeout = {}", payload, timeout); + } catch (SvcLogicException e) { + logger.error(APPC_EXCEPTION_CAUGHT, e); + doFailure(ctx, AnsibleResultCodes.INVALID_PAYLOAD.getValue(), + "Error constructing request for execution of playbook due to missing mandatory parameters. Reason = " + + e.getMessage()); + } catch (JSONException e) { + logger.error("JSONException caught", e); + doFailure(ctx, AnsibleResultCodes.INVALID_PAYLOAD.getValue(), + "Error constructing request for execution of playbook due to invalid JSON block. Reason = " + + e.getMessage()); + } catch (NumberFormatException e) { + logger.error("NumberFormatException caught", e); + doFailure(ctx, AnsibleResultCodes.INVALID_PAYLOAD.getValue(), + "Error constructing request for execution of playbook due to invalid parameter values. Reason = " + + e.getMessage()); + } + + int code = -1; + String message = StringUtils.EMPTY; + + try { + // post the test request + logger.info("Posting ansible request = {} to url = {}", payload, agentUrl); + AnsibleResult testResult = postExecRequest(agentUrl, payload, user, pswd); + if (testResult != null) { + logger.info("Received response on ansible post request {}", testResult.getStatusMessage()); + // Process if HTTP was successful + if (testResult.getStatusCode() == 200) { + testResult = messageProcessor.parsePostResponse(testResult.getStatusMessage()); + } else { + doFailure(ctx, testResult.getStatusCode(), + "Error posting request. Reason = " + testResult.getStatusMessage()); + } + + code = testResult.getStatusCode(); + message = testResult.getStatusMessage(); + ctx.setAttribute(OUTPUT_ATTRIBUTE_NAME, testResult.getOutput()); + ctx.setAttribute(SERVERIP, StringUtils.defaultIfBlank(testResult.getServerIp(), "")); + // Check status of test request returned by Agent + if (code == AnsibleResultCodes.PENDING.getValue()) { + logger.info("Submission of Test {} successful.", playbookName); + // test request accepted. We are in asynchronous case + } else { + doFailure(ctx, code, "Request for execution of playbook rejected. Reason = " + message); + } + } else { + doFailure(ctx, code, "Ansible Test result is null"); + } + } catch (SvcLogicException e) { + logger.error(APPC_EXCEPTION_CAUGHT, e); + doFailure(ctx, AnsibleResultCodes.UNKNOWN_EXCEPTION.getValue(), + "Exception encountered when posting request for execution of playbook. Reason = " + e.getMessage()); + } + + ctx.setAttribute(RESULT_CODE_ATTRIBUTE_NAME, Integer.toString(code)); + ctx.setAttribute(MESSAGE_ATTRIBUTE_NAME, message); + ctx.setAttribute(ID_ATTRIBUTE_NAME, id); + } + + /** + * Method is used to automatically generate NodeList section base on the svc context + */ + private JSONArray generateNodeList(Map<String, String> params, SvcLogicContext ctx) throws SvcLogicException { + String vfModuleId = StringUtils.trimToNull(params.get("vf-module-id")); + String vnfcName = StringUtils.trimToNull(params.get("vnfc-name")); + String vServerId = StringUtils.trimToNull(params.get("vserver-id")); + String vnfcType = StringUtils.trimToNull(params.get("vnfc-type")); + + JSONArray result = new JSONArray(); + logger.info("GENERATING NODE LIST"); + logger.debug("Auto Node List filtering parameter vserver-id {} | vnfc-name {} | vnfc-type {} | vf-module-id {}", + vServerId, vnfcName, vnfcType, vfModuleId); + + Map<String, JSONObject> candidates = new HashMap<>(); + for (int i = 0; ; i++) { + String vmKey = "tmp.vnfInfo.vm[" + i + "]"; + logger.info("Looking for attributes of: {}", vmKey); + if (ctx.getAttribute(vmKey + ".vnfc-name") != null) { + String debugText = "Auto Node List candidate "; + String vmVnfcName = ctx.getAttribute(vmKey + ".vnfc-name"); + String vmVnfcIpv4Address = ctx.getAttribute(vmKey + ".vnfc-ipaddress-v4-oam-vip"); + String vmVnfcType = ctx.getAttribute(vmKey + ".vnfc-type"); + + if (vmVnfcName != null && vmVnfcIpv4Address != null && vmVnfcType != null + && !vmVnfcName.equals("") && !vmVnfcIpv4Address.equals("") && !vmVnfcType.equals("")) { + if (vServerId != null) { + String vmVserverId = ctx.getAttribute(vmKey + ".vserver-id"); + if (!vServerId.equals(vmVserverId)) { + logger.debug("{}{} dropped. vserver-id mismatch", debugText, vmVnfcName); + continue; + } + } + if (vfModuleId != null) { + String vmVfModuleId = ctx.getAttribute(vmKey + ".vf-module-id"); + if (!vfModuleId.equals(vmVfModuleId)) { + logger.debug("{}{} dropped. vf-module-id mismatch", debugText, vmVnfcName); + continue; + } + } + if (vnfcName != null && !vmVnfcName.equals(vnfcName)) { + logger.debug("{}{} dropped. vnfc-name mismatch", debugText, vmVnfcName); + continue; + } + if (vnfcType != null && !vmVnfcType.equals(vnfcType)) { + logger.debug("{}{} dropped. vnfc-type mismatch", debugText, vmVnfcType); + continue; + } + + logger.info("{}{} [{},{}]", debugText, vmVnfcName, vmVnfcIpv4Address, vmVnfcType); + + JSONObject vnfTypeCandidates; + JSONArray vmList; + if (!candidates.containsKey(vmVnfcType)) { + vnfTypeCandidates = new JSONObject(); + vmList = new JSONArray(); + vnfTypeCandidates.put("site", "site"); + vnfTypeCandidates.put("vnfc-type", vmVnfcType); + vnfTypeCandidates.put("vm-info", vmList); + candidates.put(vmVnfcType, vnfTypeCandidates); + } else { + vnfTypeCandidates = candidates.get(vmVnfcType); + vmList = (JSONArray) vnfTypeCandidates.get("vm-info"); + } + + JSONObject candidate = new JSONObject(); + candidate.put("ne_id", vmVnfcName); + candidate.put("fixed_ip_address", vmVnfcIpv4Address); + vmList.put(candidate); + } else { + logger.warn("Incomplete information for Auto Node List candidate {}", vmKey); + } + } else { + break; + } + } + + for (JSONObject vnfcCandidates : candidates.values()) { + result.put(vnfcCandidates); + } + + logger.info("GENERATING NODE LIST COMPLETED"); + return result; + } + + /** + * Public method to query status of a specific request It blocks till the Ansible Server + * responds or the session times out (non-Javadoc) + * + * @see org.onap.ccsdk.sli.adaptors.ansible.AnsibleAdaptor#reqExecResult(java.util.Map, + * org.onap.ccsdk.sli.core.sli.SvcLogicContext) + */ + @Override + public void reqExecResult(Map<String, String> params, SvcLogicContext ctx) throws SvcLogicException { + // Get URI + String reqUri; + + try { + String serverIp = ctx.getAttribute(SERVERIP); + if (StringUtils.isNotBlank(serverIp)) { + reqUri = messageProcessor.reqUriResultWithIP(params, serverIp); + } else { + reqUri = messageProcessor.reqUriResult(params); + } + logger.info("Got uri {}", reqUri); + } catch (SvcLogicException e) { + logger.error(APPC_EXCEPTION_CAUGHT, e); + doFailure(ctx, AnsibleResultCodes.INVALID_PAYLOAD.getValue(), + "Error constructing request to retrieve result due to missing parameters. Reason = " + + e.getMessage()); + return; + } catch (NumberFormatException e) { + logger.error("NumberFormatException caught", e); + doFailure(ctx, AnsibleResultCodes.INVALID_PAYLOAD.getValue(), + "Error constructing request to retrieve result due to invalid parameters value. Reason = " + + e.getMessage()); + return; + } + + int code; + String message; + String output; + String configData; + String results = StringUtils.EMPTY; + String finalResponse = StringUtils.EMPTY; + try { + // Try to retrieve the test results (modify the URL for that) + AnsibleResult testResult = queryServer(reqUri, params.get(USER), + EncryptionTool.getInstance().decrypt(params.get(PSWD)), ctx); + code = testResult.getStatusCode(); + message = testResult.getStatusMessage(); + + if (code == 200 || code == 400 || "FINISHED".equalsIgnoreCase(message)) { + logger.info("Parsing response from ansible Server = {}", message); + // Valid HTTP. process the Ansible message + testResult = messageProcessor.parseGetResponse(message); + code = testResult.getStatusCode(); + message = testResult.getStatusMessage(); + results = testResult.getResults(); + output = testResult.getOutput(); + configData = testResult.getConfigData(); + if ((StringUtils.isBlank(output)) || (output.trim().equalsIgnoreCase("{}"))) { + finalResponse = results; + } else { + finalResponse = output; + } + logger.info("configData from ansible's response = {}", configData); + ctx.setAttribute("device-running-config", configData); + } + logger.info("Request response = " + message); + } catch (SvcLogicException e) { + logger.error(APPC_EXCEPTION_CAUGHT, e); + ctx.setAttribute(RESULTS_ATTRIBUTE_NAME, results); + ctx.setAttribute(OUTPUT_ATTRIBUTE_NAME, finalResponse); + doFailure(ctx, AnsibleResultCodes.UNKNOWN_EXCEPTION.getValue(), + "Exception encountered retrieving result : " + e.getMessage()); + return; + } + + // We were able to get and process the results. Determine if playbook succeeded + + if (code == AnsibleResultCodes.FINAL_SUCCESS.getValue()) { + message = String.format("Ansible Request %s finished with Result = %s, Message = %s", params.get("Id"), + SUCCESS, message); + logger.info(message); + } else { + logger.info(String.format("Ansible Request %s finished with Result %s, Message = %s", params.get("Id"), + FAILURE, message)); + ctx.setAttribute(RESULTS_ATTRIBUTE_NAME, results); + ctx.setAttribute(OUTPUT_ATTRIBUTE_NAME, finalResponse); + doFailure(ctx, code, message); + return; + } + + // In case of 200, 400, FINISHED return 400 + ctx.setAttribute(RESULT_CODE_ATTRIBUTE_NAME, Integer.toString(400)); + ctx.setAttribute(MESSAGE_ATTRIBUTE_NAME, message); + ctx.setAttribute(RESULTS_ATTRIBUTE_NAME, results); + ctx.setAttribute(OUTPUT_ATTRIBUTE_NAME, finalResponse); + ctx.markSuccess(); + } + + /** + * Public method to get logs from playbook execution for a specific request + * <p> + * It blocks till the Ansible Server responds or the session times out very similar to + * reqExecResult logs are returned in the DG context variable org.onap.appc.adaptor.ansible.log + */ + @Override + public void reqExecLog(Map<String, String> params, SvcLogicContext ctx) throws SvcLogicException { + String reqUri = StringUtils.EMPTY; + try { + reqUri = messageProcessor.reqUriLog(params); + logger.info("Retrieving results from {}", reqUri); + } catch (Exception e) { + logger.error("Exception caught", e); + doFailure(ctx, AnsibleResultCodes.INVALID_PAYLOAD.getValue(), e.getMessage()); + } + + queryServerAndProcessResult(params, ctx, reqUri, LOG_ATTRIBUTE_NAME); + } + + /** + * Public method to get output from playbook execution for a specific request + * <p> + * It blocks till the Ansible Server responds or the session times out very similar to + * reqExecResult and output is returned in the DG context variable org.onap.appc.adaptor.ansible.output + */ + @Override + public void reqExecOutput(Map<String, String> params, SvcLogicContext ctx) throws SvcLogicException { + String reqUri = StringUtils.EMPTY; + try { + reqUri = messageProcessor.reqUriOutput(params); + logger.info("Retrieving results from {}", reqUri); + } catch (Exception e) { + logger.error("Exception caught", e); + doFailure(ctx, AnsibleResultCodes.INVALID_PAYLOAD.getValue(), e.getMessage()); + } + + queryServerAndProcessResult(params, ctx, reqUri, OUTPUT_ATTRIBUTE_NAME); + } + + /** + * Method that posts the request + */ + private AnsibleResult postExecRequest(String agentUrl, String payload, String user, String pswd) { + AnsibleResult testResult = null; + ConnectionBuilder httpClientLocal = getHttpConn(defaultSocketTimeout, ""); + if (!testMode) { + if (httpClientLocal != null) { + httpClientLocal.setHttpContext(user, pswd); + testResult = httpClientLocal.post(agentUrl, payload); + httpClientLocal.close(); + } + } else { + testResult = testServer.post(payload); + } + return testResult; + } + + private void queryServerAndProcessResult(Map<String, String> params, SvcLogicContext ctx, String reqUri, String attributeName) + throws SvcLogicException { + try { + // Try to retrieve the test results (modify the url for that) + AnsibleResult testResult = queryServer(reqUri, params.get(USER), + EncryptionTool.getInstance().decrypt(params.get(PSWD)), ctx); + String message = testResult.getStatusMessage(); + logger.info("Request output = {}", message); + ctx.setAttribute(attributeName, message); + ctx.markSuccess(); + } catch (Exception e) { + logger.error("Exception caught: {}", e.getMessage(), e); + doFailure(ctx, AnsibleResultCodes.UNKNOWN_EXCEPTION.getValue(), + String.format("Exception encountered retrieving output: %s", e.getMessage())); + } + } + + /** + * Method to query Ansible server + */ + private AnsibleResult queryServer(String agentUrl, String user, String pswd, SvcLogicContext ctx) { + AnsibleResult testResult = new AnsibleResult(); + int timeout; + try { + timeout = Integer.parseInt(ctx.getAttribute("AnsibleTimeout")) * 1000; + } catch (Exception e) { + timeout = defaultTimeout; + } + long endTime = System.currentTimeMillis() + timeout; + + while (System.currentTimeMillis() < endTime) { + String serverIP = ctx.getAttribute(SERVERIP); + ConnectionBuilder httpClientLocal = getHttpConn(defaultSocketTimeout, serverIP); + logger.info("Querying ansible GetResult URL = {}", agentUrl); + + if (!testMode) { + if (httpClientLocal != null) { + httpClientLocal.setHttpContext(user, pswd); + testResult = httpClientLocal.get(agentUrl); + httpClientLocal.close(); + } + } else { + testResult = testServer.get(agentUrl); + } + if (testResult.getStatusCode() != AnsibleResultCodes.IO_EXCEPTION.getValue() + && testResult.getStatusCode() != AnsibleResultCodes.PENDING.getValue()) { + break; + } + + try { + Thread.sleep(defaultPollInterval); + } catch (InterruptedException ex) { + logger.error("Thread Interrupted Exception", ex); + Thread.currentThread().interrupt(); + } + + } + if (testResult.getStatusCode() == AnsibleResultCodes.PENDING.getValue()) { + testResult.setStatusCode(AnsibleResultCodes.IO_EXCEPTION.getValue()); + testResult.setStatusMessage("Request timed out"); + } + + return testResult; + } + +} diff --git a/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/impl/AnsibleAdaptorPropertiesProviderImpl.java b/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/impl/AnsibleAdaptorPropertiesProviderImpl.java new file mode 100644 index 000000000..d33fdd855 --- /dev/null +++ b/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/impl/AnsibleAdaptorPropertiesProviderImpl.java @@ -0,0 +1,208 @@ +/*- + * ============LICENSE_START======================================================= + * ONAP : SLI + * ================================================================================ + * Copyright (C) 2021 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + * ============LICENSE_END========================================================= + */ + +package org.onap.ccsdk.sli.adaptors.ansible.impl; + +import java.io.File; +import java.io.FileInputStream; +import java.io.IOException; +import java.io.InputStream; +import java.util.ArrayList; +import java.util.List; +import java.util.Optional; +import java.util.Properties; +import org.onap.ccsdk.sli.adaptors.ansible.AnsibleAdaptorPropertiesProvider; +import org.onap.ccsdk.sli.core.sli.ConfigurationException; +import org.onap.ccsdk.sli.core.utils.JREFileResolver; +import org.onap.ccsdk.sli.core.utils.KarafRootFileResolver; +import org.onap.ccsdk.sli.core.utils.PropertiesFileResolver; +import org.onap.ccsdk.sli.core.utils.common.CoreDefaultFileResolver; +import org.onap.ccsdk.sli.core.utils.common.EnvProperties; +import org.onap.ccsdk.sli.core.utils.common.SdncConfigEnvVarFileResolver; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * Responsible for determining the properties file to use and instantiating the + * <code>SqlResource</code> Service. The priority for properties file + * resolution is as follows: + * + * <ol> + * <li>A directory identified by the system environment variable + * <code>SDNC_CONFIG_DIR</code></li> + * <li>The default directory <code>DEFAULT_DBLIB_PROP_DIR</code></li> + * <li>A directory identified by the JRE argument + * <code>sql-resource.properties</code></li> + * <li>A <code>sql-resource.properties</code> file located in the karaf root + * directory</li> + * </ol> + */ +public class AnsibleAdaptorPropertiesProviderImpl implements AnsibleAdaptorPropertiesProvider { + + private static final Logger LOG = LoggerFactory.getLogger(AnsibleAdaptorPropertiesProviderImpl.class); + + /** + * The name of the properties file for database configuration + */ + private static final String ANSIBLE_Adaptor_PROPERTIES = "ansible-adaptor.properties"; + + /** + * A prioritized list of strategies for resolving sql-resource properties files. + */ + private final List<PropertiesFileResolver> ansibleAdaptorPropertiesFileResolvers = new ArrayList<>(); + + /** + * The configuration properties for the db connection. + */ + private Properties properties; + + /** + * Set up the prioritized list of strategies for resolving dblib properties + * files. + */ + public AnsibleAdaptorPropertiesProviderImpl() { + ansibleAdaptorPropertiesFileResolvers + .add(new SdncConfigEnvVarFileResolver("Using property file (1) from environment variable")); + ansibleAdaptorPropertiesFileResolvers + .add(new CoreDefaultFileResolver("Using property file (2) from default directory")); + ansibleAdaptorPropertiesFileResolvers + .add(new JREFileResolver("Using property file (3) from JRE argument", AnsibleAdaptorPropertiesProviderImpl.class)); + ansibleAdaptorPropertiesFileResolvers + .add(new KarafRootFileResolver("Using property file (4) from karaf root", this)); + + // determines properties file as according to the priority described in the + // class header comment + final File propertiesFile = determinePropertiesFile(); + if (propertiesFile != null) { + try (FileInputStream fileInputStream = new FileInputStream(propertiesFile)) { + properties = new EnvProperties(); + properties.load(fileInputStream); + } catch (final IOException e) { + LOG.error("Failed to load properties for file: {}", propertiesFile, + new ConfigurationException("Failed to load properties for file: " + propertiesFile, e)); + } + } else { + // Try to read properties as resource + InputStream propStr = getClass().getResourceAsStream("/" + ANSIBLE_Adaptor_PROPERTIES); + if (propStr != null) { + properties = new EnvProperties(); + try { + properties.load(propStr); + propStr.close(); + } catch (IOException e) { + properties = null; + } + } + } + if (properties == null) { + reportFailure(new ConfigurationException( + "Missing configuration properties resource(3): " + ANSIBLE_Adaptor_PROPERTIES)); + LOG.info("Defaulting org.onap.appc.adaptor.ansible.clientType to TRUST_ALL"); + properties = new Properties(); + properties.setProperty("org.onap.appc.adaptor.ansible.clientType", "TRUST_ALL"); + } + + } + + /** + * Instantiates a new Ansible adaptor properties provider. + * + * @param configFilePath the config file path + */ + public AnsibleAdaptorPropertiesProviderImpl(String configFilePath) { + properties = new EnvProperties(); + try { + properties.load(new FileInputStream(configFilePath)); + } catch (IOException e) { + properties = null; + } + if (properties == null) { + reportFailure(new ConfigurationException( + "Missing configuration properties resource(3): " + ANSIBLE_Adaptor_PROPERTIES)); + LOG.info("Defaulting org.onap.appc.adaptor.ansible.clientType to TRUST_ALL"); + properties = new Properties(); + properties.setProperty("org.onap.appc.adaptor.ansible.clientType", "TRUST_ALL"); + } + + } + + /** + * Reports the method chosen for properties resolution to the + * <code>Logger</code>. + * + * @param message Some user friendly message + * @param fileOptional The file location of the chosen properties file + * + * @return the file location of the chosen properties file + */ + private static File reportSuccess(final String message, final Optional<File> fileOptional) { + if (fileOptional.isPresent()) { + final File file = fileOptional.get(); + LOG.info("{} {}", message, file.getPath()); + return file; + } + return null; + } + + /** + * Reports fatal errors. This is the case in which no properties file could be + * found. + * + * @param configurationException An exception describing what went wrong during resolution + */ + private static void reportFailure(final ConfigurationException configurationException) { + LOG.error("{}", "Missing configuration properties resource(3)", configurationException); + } + + /** + * Extract svclogic config properties. + * + * @return the svclogic config properties + */ + public Properties getProperties() { + return properties; + } + + /** + * Determines the sql-resource properties file to use based on the following priority: + * <ol> + * <li>A directory identified by the system environment variable + * <code>SDNC_CONFIG_DIR</code></li> + * <li>The default directory <code>DEFAULT_DBLIB_PROP_DIR</code></li> + * <li>A directory identified by the JRE argument + * <code>sql-resource.properties</code></li> + * <li>A <code>sql-resource.properties</code> file located in the karaf root + * directory</li> + * </ol> + */ + File determinePropertiesFile() { + for (final PropertiesFileResolver propertiesFileResolver : ansibleAdaptorPropertiesFileResolvers) { + final Optional<File> fileOptional = propertiesFileResolver.resolveFile(ANSIBLE_Adaptor_PROPERTIES); + if (fileOptional.isPresent()) { + return reportSuccess(propertiesFileResolver.getSuccessfulResolutionMessage(), fileOptional); + } + } + + return null; + } + +} diff --git a/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/impl/ConnectionBuilder.java b/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/impl/ConnectionBuilder.java new file mode 100644 index 000000000..1fbf20633 --- /dev/null +++ b/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/impl/ConnectionBuilder.java @@ -0,0 +1,235 @@ +/*- + * ============LICENSE_START======================================================= + * ONAP : SLI + * ================================================================================ + * Copyright (C) 2021 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + * ============LICENSE_END========================================================= + */ + +package org.onap.ccsdk.sli.adaptors.ansible.impl; + +import com.att.eelf.configuration.EELFLogger; +import com.att.eelf.configuration.EELFManager; +import java.io.Closeable; +import java.io.FileInputStream; +import java.io.IOException; +import java.security.KeyManagementException; +import java.security.KeyStore; +import java.security.KeyStoreException; +import java.security.NoSuchAlgorithmException; +import java.security.cert.CertificateException; +import java.security.cert.CertificateFactory; +import java.security.cert.X509Certificate; +import javax.net.ssl.SSLContext; +import org.apache.commons.lang.StringUtils; +import org.apache.http.HttpEntity; +import org.apache.http.HttpResponse; +import org.apache.http.auth.AuthScope; +import org.apache.http.auth.UsernamePasswordCredentials; +import org.apache.http.client.config.RequestConfig; +import org.apache.http.client.methods.HttpGet; +import org.apache.http.client.methods.HttpPost; +import org.apache.http.client.protocol.HttpClientContext; +import org.apache.http.conn.ssl.NoopHostnameVerifier; +import org.apache.http.conn.ssl.SSLConnectionSocketFactory; +import org.apache.http.conn.ssl.SSLContexts; +import org.apache.http.conn.ssl.TrustSelfSignedStrategy; +import org.apache.http.entity.StringEntity; +import org.apache.http.impl.client.BasicCredentialsProvider; +import org.apache.http.impl.client.CloseableHttpClient; +import org.apache.http.impl.client.HttpClients; +import org.apache.http.util.EntityUtils; +import org.json.JSONObject; +import org.onap.ccsdk.sli.adaptors.ansible.model.AnsibleResult; +import org.onap.ccsdk.sli.adaptors.ansible.model.AnsibleResultCodes; +import org.onap.ccsdk.sli.core.utils.PathValidator; + +/** + * Returns a custom http client + * - based on options + * - can create one with ssl using an X509 certificate that does NOT have a known CA + * - create one which trusts ALL SSL certificates + * - return default httpclient (which only trusts known CAs from default cacerts file for process) this is the default + * option + **/ + +public class ConnectionBuilder implements Closeable { + private static final String STATUS_CODE_KEY = "StatusCode"; + private static final EELFLogger logger = EELFManager.getInstance().getLogger(ConnectionBuilder.class); + + private final CloseableHttpClient httpClient; + private final HttpClientContext httpContext = new HttpClientContext(); + + /** + * Constructor that initializes an http client based on certificate + **/ + public ConnectionBuilder(String certFile, int timeout) throws KeyStoreException, CertificateException, IOException, + KeyManagementException, NoSuchAlgorithmException { + + /* Point to the certificate */ + try (FileInputStream fs = new FileInputStream(certFile)) { + /* Generate a certificate from the X509 */ + CertificateFactory cf = CertificateFactory.getInstance("X.509"); + X509Certificate cert = (X509Certificate) cf.generateCertificate(fs); + + /* Create a keystore object and load the certificate there */ + KeyStore keystore = KeyStore.getInstance(KeyStore.getDefaultType()); + keystore.load(null, null); + keystore.setCertificateEntry("cacert", cert); + + SSLContext sslcontext = SSLContexts.custom().loadTrustMaterial(keystore).build(); + SSLConnectionSocketFactory factory = new SSLConnectionSocketFactory(sslcontext, + SSLConnectionSocketFactory.BROWSER_COMPATIBLE_HOSTNAME_VERIFIER); + + RequestConfig config = RequestConfig.custom().setSocketTimeout(timeout).build(); + httpClient = HttpClients.custom().setDefaultRequestConfig(config).setSSLSocketFactory(factory).build(); + } + } + + /** + * Constructor which trusts all certificates in a specific java keystore file (assumes a JKS + * file) + **/ + public ConnectionBuilder(String trustStoreFile, char[] trustStorePasswd, int timeout, String serverIP) + throws KeyStoreException, IOException, KeyManagementException, NoSuchAlgorithmException, + CertificateException { + if (!PathValidator.isValidFilePath(trustStoreFile)) { + throw new IOException("Invalid trust store file path"); + } + + /* Load the specified trustStore */ + KeyStore keystore = KeyStore.getInstance("JKS"); + FileInputStream readStream = new FileInputStream(trustStoreFile); + keystore.load(readStream, trustStorePasswd); + if (StringUtils.isNotBlank(serverIP)) { + SSLContext sslcontext = SSLContexts.custom().loadTrustMaterial(null, new TrustSelfSignedStrategy()).build(); + SSLConnectionSocketFactory factory = new SSLConnectionSocketFactory(sslcontext, new NoopHostnameVerifier()); + + RequestConfig config = RequestConfig.custom().setSocketTimeout(timeout).build(); + httpClient = HttpClients.custom().setDefaultRequestConfig(config).setSSLSocketFactory(factory).build(); + } else { + SSLContext sslcontext = SSLContexts.custom().loadTrustMaterial(keystore).build(); + SSLConnectionSocketFactory factory = new SSLConnectionSocketFactory(sslcontext, + SSLConnectionSocketFactory.BROWSER_COMPATIBLE_HOSTNAME_VERIFIER); + RequestConfig config = RequestConfig.custom().setSocketTimeout(timeout).build(); + httpClient = HttpClients.custom().setDefaultRequestConfig(config).setSSLSocketFactory(factory).build(); + } + } + + /** + * Constructor that trusts ALL SSl certificates (NOTE : ONLY FOR DEV TESTING) if Mode == 1 or + * Default if Mode == 0 + */ + public ConnectionBuilder(int mode, int timeout) + throws NoSuchAlgorithmException, KeyStoreException, KeyManagementException { + RequestConfig config = RequestConfig.custom().setSocketTimeout(timeout).build(); + if (mode == 1) { + SSLContext sslcontext = SSLContexts.custom().loadTrustMaterial(null, new TrustSelfSignedStrategy()).build(); + SSLConnectionSocketFactory factory = new SSLConnectionSocketFactory(sslcontext, + SSLConnectionSocketFactory.BROWSER_COMPATIBLE_HOSTNAME_VERIFIER); + + httpClient = HttpClients.custom().setDefaultRequestConfig(config).setSSLSocketFactory(factory).build(); + } else { + httpClient = HttpClients.custom().setDefaultRequestConfig(config).build(); + } + } + + // Use to create an http context with auth headers + public void setHttpContext(String user, String pswd) { + + // Are credential provided ? If so, set the context to be used + if (user != null && !user.isEmpty() && pswd != null && !pswd.isEmpty()) { + UsernamePasswordCredentials credentials = new UsernamePasswordCredentials(user, pswd); + AuthScope authscope = new AuthScope(AuthScope.ANY_HOST, AuthScope.ANY_PORT); + BasicCredentialsProvider credsprovider = new BasicCredentialsProvider(); + credsprovider.setCredentials(authscope, credentials); + httpContext.setCredentialsProvider(credsprovider); + } + } + + // Method posts to the ansible server and writes out response to + // Ansible result object + public AnsibleResult post(String agentUrl, String payload) { + + AnsibleResult result = new AnsibleResult(); + try { + + HttpPost postObj = new HttpPost(agentUrl); + StringEntity bodyParams = new StringEntity(payload, "UTF-8"); + postObj.setEntity(bodyParams); + postObj.addHeader("Content-type", "application/json"); + + HttpResponse response = httpClient.execute(postObj, httpContext); + HttpEntity entity = response.getEntity(); + String responseOutput = entity != null ? EntityUtils.toString(entity) : null; + int responseCode = response.getStatusLine().getStatusCode(); + result.setStatusCode(responseCode); + result.setStatusMessage(responseOutput); + } catch (IOException io) { + logger.error("Caught IOException", io); + result.setStatusCode(AnsibleResultCodes.IO_EXCEPTION.getValue()); + result.setStatusMessage(io.getMessage()); + } + return result; + } + + // Method gets information from an Ansible server and writes out response to + // Ansible result object + + public AnsibleResult get(String agentUrl) { + + AnsibleResult result = new AnsibleResult(); + + try { + HttpGet getObj = new HttpGet(agentUrl); + HttpResponse response = httpClient.execute(getObj, httpContext); + HttpEntity entity = response.getEntity(); + String responseOutput = entity != null ? EntityUtils.toString(entity) : null; + int responseCode = response.getStatusLine().getStatusCode(); + logger.info("GetResult response for ansible GET URL" + agentUrl + " returned " + responseOutput); + JSONObject postResponse = new JSONObject(responseOutput); + if (postResponse.has(STATUS_CODE_KEY)) { + int codeStatus = postResponse.getInt(STATUS_CODE_KEY); + if (codeStatus == AnsibleResultCodes.PENDING.getValue()) { + result.setStatusCode(codeStatus); + } else { + result.setStatusCode(responseCode); + } + } else { + result.setStatusCode(responseCode); + } + result.setStatusMessage(responseOutput); + } catch (IOException io) { + result.setStatusCode(AnsibleResultCodes.IO_EXCEPTION.getValue()); + result.setStatusMessage(io.getMessage()); + logger.error("Caught IOException", io); + } + return result; + } + + @Override + public void close() { + try { + if (httpClient != null) { + httpClient.close(); + } + } catch (IOException e) { + logger.error("Caught IOException during httpClient close", e); + } + } + +} diff --git a/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/model/AnsibleMessageParser.java b/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/model/AnsibleMessageParser.java new file mode 100644 index 000000000..3294fabad --- /dev/null +++ b/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/model/AnsibleMessageParser.java @@ -0,0 +1,367 @@ +/*- + * ============LICENSE_START======================================================= + * ONAP : SLI + * ================================================================================ + * Copyright (C) 2021 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + * ============LICENSE_END========================================================= + */ + +package org.onap.ccsdk.sli.adaptors.ansible.model; + +import com.google.common.base.Strings; +import java.util.Collections; +import java.util.HashSet; +import java.util.Iterator; +import java.util.Map; +import java.util.Set; +import java.util.UUID; +import org.apache.commons.lang.StringUtils; +import org.json.JSONArray; +import org.json.JSONException; +import org.json.JSONObject; +import org.onap.ccsdk.sli.adaptors.ansible.AnsibleAdaptorConstants; +import org.onap.ccsdk.sli.core.sli.SvcLogicException; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import static org.onap.ccsdk.sli.adaptors.ansible.AnsibleAdaptorConstants.*; + +/** + * Class that validates and constructs requests sent/received from + * Ansible Server + */ +public class AnsibleMessageParser { + + + private static final String JSON_ERROR_MESSAGE = "JSONException: Error parsing response"; + + private static final Logger LOGGER = LoggerFactory.getLogger(AnsibleMessageParser.class); + + /** + * Accepts a map of strings and + * a) validates if all parameters are appropriate (else, throws an exception) and + * b) if correct returns a JSON object with appropriate key-value pairs to send to the server. + * <p> + * Mandatory parameters, that must be in the supplied information to the Ansible Adaptor + * 1. URL to connect to + * 2. credentials for URL (assume user pswd for now) + * 3. Playbook name + */ + public JSONObject reqMessage(Map<String, String> params) throws SvcLogicException { + final String[] mandatoryTestParams = {AGENT_URL, PLAYBOOK_NAME, USER, PSWD}; + final String[] optionalTestParams = {ENV_PARAMETERS, NODE_LIST, LOCAL_PARAMETERS, TIMEOUT, VERSION, FILE_PARAMETERS, + ACTION, INVENTORY_NAMES, AUTO_NODE_LIST}; + JSONObject jsonPayload = new JSONObject(); + + for (String key : mandatoryTestParams) { + throwIfMissingMandatoryParam(params, key); + jsonPayload.put(key, params.get(key)); + } + + parseOptionalParams(params, optionalTestParams, jsonPayload); + + // Generate a unique uuid for the test + String reqId = UUID.randomUUID().toString(); + jsonPayload.put(ID, reqId); + return jsonPayload; + } + + /** + * Method that validates that the Map has enough information + * to query Ansible server for a result. If so, it returns + * the appropriate url, else an empty string. + */ + public String reqUriResult(Map<String, String> params) throws SvcLogicException { + final String[] mandatoryTestParams = {AGENT_URL, ID, USER, PSWD}; + for (String key : mandatoryTestParams) { + throwIfMissingMandatoryParam(params, key); + } + return params.get(AGENT_URL) + "?Id=" + params.get(ID) + "&Type=GetResult"; + } + + /** + * Method that validates that the Map has enough information to query Ansible + * server for a result. If so, it returns the appropriate url, else an empty + * string. + */ + public String reqUriResultWithIP(Map<String, String> params, String serverIP) throws SvcLogicException { + final String[] mandatoryTestParams = {AGENT_URL, ID, USER, PSWD}; + for (String key : mandatoryTestParams) { + throwIfMissingMandatoryParam(params, key); + } + String[] arr1 = params.get(AGENT_URL).split("//", 2); + String[] arr2 = arr1[1].split(":", 2); + return arr1[0] + "//" + serverIP + ":" + arr2[1] + "?Id=" + params.get(ID) + "&Type=GetResult"; + } + + /** + * Method that validates that the Map has enough information to query Ansible + * server for logs. If so, it populates the appropriate returns the appropriate + * url, else an empty string. + */ + public String reqUriLog(Map<String, String> params) throws SvcLogicException { + final String[] mandatoryTestParams = {AGENT_URL, ID, USER, PSWD}; + for (String mandatoryParam : mandatoryTestParams) { + throwIfMissingMandatoryParam(params, mandatoryParam); + } + return params.get(AGENT_URL) + "?Id=" + params.get(ID) + "&Type=GetLog"; + } + + /** + * Method that validates that the Map has enough information + * to query Ansible server for an output. If so, it returns + * the appropriate url, else an empty string. + */ + public String reqUriOutput(Map<String, String> params) throws SvcLogicException { + final String[] mandatoryTestParams = {AGENT_URL, ID, USER, PSWD}; + for (String mandatoryParam : mandatoryTestParams) { + throwIfMissingMandatoryParam(params, mandatoryParam); + } + return params.get(AGENT_URL) + "?Id=" + params.get(ID) + "&Type=GetOutput"; + } + + /** + * This method parses response from the Ansible Server when we do a post + * and returns an AnsibleResult object. + */ + public AnsibleResult parsePostResponse(String input) throws SvcLogicException { + AnsibleResult ansibleResult; + try { + JSONObject postResponse = new JSONObject(input); + int code = postResponse.getInt(STATUS_CODE); + int initResponseValue = AnsibleResultCodes.INITRESPONSE.getValue(); + boolean validCode = AnsibleResultCodes.CODE.checkValidCode(initResponseValue, code); + if (!validCode) { + throw new SvcLogicException(String.format("Invalid InitResponse code = %s received. MUST be one of %s", + code, AnsibleResultCodes.CODE.getValidCodes(initResponseValue))); + } + + ansibleResult = new AnsibleResult(code, postResponse.getString(STATUS_MESSAGE)); + if (postResponse.has(ANSIBLE_SERVER) && StringUtils.isNotBlank(postResponse.getString(ANSIBLE_SERVER))) { + ansibleResult.setServerIp(postResponse.getString(ANSIBLE_SERVER)); + } + if (!postResponse.isNull(OUTPUT)) { + LOGGER.info("Processing results-output in post response"); + JSONObject output = postResponse.getJSONObject(OUTPUT); + ansibleResult.setOutput(output.toString()); + } + } catch (JSONException e) { + LOGGER.error(JSON_ERROR_MESSAGE, e); + ansibleResult = new AnsibleResult(600, "Error parsing response = " + input + ". Error = " + e.getMessage()); + } + return ansibleResult; + } + + /** + * This method parses response from an Ansible server when we do a GET for a result + * and returns an AnsibleResult object. + **/ + public AnsibleResult parseGetResponse(String input) throws SvcLogicException { + AnsibleResult ansibleResult = new AnsibleResult(); + try { + JSONObject postResponse = new JSONObject(input); + parseGetResponseNested(ansibleResult, postResponse); + } catch (JSONException e) { + LOGGER.error(JSON_ERROR_MESSAGE, e); + ansibleResult = new AnsibleResult(AnsibleResultCodes.INVALID_PAYLOAD.getValue(), + "Error parsing response = " + input + ". Error = " + e.getMessage(), ""); + } + return ansibleResult; + } + + private void parseGetResponseNested(AnsibleResult ansibleResult, JSONObject postRsp) throws SvcLogicException { + String messageStatus = postRsp.getString(STATUS_MESSAGE); + int codeStatus = postRsp.getInt(STATUS_CODE); + int finalCode = AnsibleResultCodes.FINAL_SUCCESS.getValue(); + boolean valCode = AnsibleResultCodes.CODE.checkValidCode(AnsibleResultCodes.FINALRESPONSE.getValue(), codeStatus); + if (!valCode) { + throw new SvcLogicException(String.format("Invalid InitResponse code = %s received. MUST be one of %s", + codeStatus, AnsibleResultCodes.CODE.getValidCodes(AnsibleResultCodes.FINALRESPONSE.getValue()))); + } + + ansibleResult.setStatusCode(codeStatus); + ansibleResult.setStatusMessage(messageStatus); + ansibleResult.setConfigData("UNKNOWN"); + LOGGER.info("Received response with code = {}, Message = {}", codeStatus, messageStatus); + + if (!postRsp.isNull("Results")) { + + // Results are available. process them + // Results is a dictionary of the form + + LOGGER.info("Processing results in response"); + JSONObject results = postRsp.getJSONObject("Results"); + + LOGGER.info("Get JSON dictionary from Results by Iterating through hosts"); + Iterator<String> hosts = results.keys(); + while (hosts.hasNext()) { + String host = hosts.next(); + LOGGER.info("Processing host = {}", + (host.matches("^[\\w\\-.]+$")) ? host : "[unexpected value, logging suppressed]"); + try { + JSONObject hostResponse = results.getJSONObject(host); + int subCode = hostResponse.getInt(STATUS_CODE); + String message = hostResponse.getString(STATUS_MESSAGE); + + LOGGER.info("Code = {}, Message = {}", subCode, message); + + if (subCode != 200 || !"SUCCESS".equals(message)) { + finalCode = AnsibleResultCodes.REQ_FAILURE.getValue(); + } + if ((hostResponse.optJSONObject(OUTPUT)) != null) { + JSONObject hostResponseObjectInfo = hostResponse.optJSONObject(OUTPUT).optJSONObject("info"); + JSONObject hostResponseConfigData = hostResponseObjectInfo.optJSONObject("configData"); + if (hostResponseConfigData != null) { + ansibleResult.setConfigData(hostResponseConfigData.toString()); + } + } + } catch (JSONException e) { + LOGGER.error(JSON_ERROR_MESSAGE, e); + ansibleResult.setStatusCode(AnsibleResultCodes.INVALID_RESPONSE.getValue()); + ansibleResult.setStatusMessage(String.format("Error processing response message = %s from host %s", + results.getString(host), host)); + break; + } + } + ansibleResult.setStatusCode(finalCode); + + // We return entire Results object as message + ansibleResult.setResults(results.toString()); + } else { + ansibleResult.setStatusCode(AnsibleResultCodes.INVALID_RESPONSE.getValue()); + ansibleResult.setStatusMessage("Results not found in GET for response"); + } + if (!postRsp.isNull(OUTPUT)) { + LOGGER.info("Processing results-output in response"); + JSONObject output = postRsp.getJSONObject(OUTPUT); + ansibleResult.setOutput(output.toString()); + } + } + + private void parseOptionalParams(Map<String, String> params, String[] optionalTestParams, JSONObject jsonPayload) { + + Set<String> optionalParamsSet = new HashSet<>(); + Collections.addAll(optionalParamsSet, optionalTestParams); + + //@formatter:off + params.entrySet().stream().filter(entry -> optionalParamsSet.contains(entry.getKey())) + .filter(entry -> !Strings.isNullOrEmpty(entry.getValue())) + .forEach(entry -> parseOptionalParam(entry, jsonPayload)); + //@formatter:on + } + + private void parseOptionalParam(Map.Entry<String, String> params, JSONObject jsonPayload) { + String key = params.getKey(); + String payload = params.getValue(); + + switch (key) { + case TIMEOUT: + if (dataIsVariable(payload)) { + break; + } + int timeout = Integer.parseInt(payload); + if (timeout < 0) { + throw new NumberFormatException(" : specified negative integer for timeout = " + payload); + } + jsonPayload.put(key, payload); + break; + case AUTO_NODE_LIST: + if (payload.equalsIgnoreCase("true") || payload.equalsIgnoreCase("false")) { + jsonPayload.put(key, payload); + } else { + throw new IllegalArgumentException(" : specified invalid boolean value of AutoNodeList = " + payload); + } + break; + case VERSION: + if (dataIsVariable(payload)) { + break; + } + case INVENTORY_NAMES: + jsonPayload.put(key, payload); + break; + + case LOCAL_PARAMETERS: + case ENV_PARAMETERS: + case EXTRA_VARS: + JSONObject paramsJson = new JSONObject(payload); + jsonDataIsVariable(paramsJson); + jsonPayload.put(key, paramsJson); + break; + + case NODE_LIST: + if (payload.startsWith("$")) { + break; + } + JSONArray paramsArray = new JSONArray(payload); + jsonPayload.put(key, paramsArray); + break; + + case FILE_PARAMETERS: + if (dataIsVariable(payload)) { + break; + } + jsonPayload.put(key, getFilePayload(payload)); + break; + + default: + break; + } + } + + /** + * Return payload with escaped newlines + */ + private JSONObject getFilePayload(String payload) { + String formattedPayload = payload.replace("\n", "\\n").replace("\r", "\\r"); + return new JSONObject(formattedPayload); + } + + private void throwIfMissingMandatoryParam(Map<String, String> params, String key) throws SvcLogicException { + if (!params.containsKey(key)) { + throw new SvcLogicException(String.format( + "Ansible: Mandatory AnsibleAdaptor key %s not found in parameters provided by calling agent !", key)); + } + if (Strings.isNullOrEmpty(params.get(key))) { + throw new SvcLogicException(String.format( + "Ansible: Mandatory AnsibleAdaptor key %s not found in parameters provided by calling agent !", key)); + } + if (StringUtils.startsWith(params.get(key), "$")) { + throw new SvcLogicException(String.format( + "Ansible: Mandatory AnsibleAdaptor key %s is a variable", key)); + } + } + + private boolean dataIsVariable(String payload) { + return StringUtils.startsWith(payload, "$") || StringUtils.isEmpty(payload); + } + + private void jsonDataIsVariable(JSONObject paramsJson) { + LOGGER.info("input json is " + paramsJson); + String[] keys = JSONObject.getNames(paramsJson); + for (String k : keys) { + Object a = paramsJson.get(k); + if (a instanceof String) { + if (StringUtils.startsWith(a.toString(), "$") || StringUtils.isEmpty(a.toString())) { + LOGGER.info("removing key " + k); + paramsJson.remove(k); + } + } + } + LOGGER.info("returning json as {}", paramsJson); + } + +} diff --git a/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/model/AnsibleResult.java b/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/model/AnsibleResult.java new file mode 100644 index 000000000..bad0f5e20 --- /dev/null +++ b/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/model/AnsibleResult.java @@ -0,0 +1,115 @@ +/*- + * ============LICENSE_START======================================================= + * ONAP : SLI + * ================================================================================ + * Copyright (C) 2021 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + * ============LICENSE_END========================================================= + */ + +package org.onap.ccsdk.sli.adaptors.ansible.model; + +/** + * Simple class to store code and message returned by POST/GET to an Ansible Server + */ +public class AnsibleResult { + + private static final String EMPTY_VALUE = "UNKNOWN"; + + private int statusCode; + private String statusMessage; + private String results; + private String output; + private String serverIp; + private String configData; + + public AnsibleResult() { + this(-1, EMPTY_VALUE, EMPTY_VALUE); + } + + public AnsibleResult(int code, String message) { + this(code, message, EMPTY_VALUE); + } + + public AnsibleResult(int code, String message, String result) { + statusCode = code; + statusMessage = message; + results = result; + } + + public AnsibleResult(int code, String message, String result, String outputData) { + statusCode = code; + statusMessage = message; + results = result; + output = outputData; + } + + public String getOutput() { + return output; + } + + public void setOutput(String output) { + this.output = output; + } + + void set(int code, String message, String results, String output) { + this.statusCode = code; + this.statusMessage = message; + this.results = results; + this.output = output; + } + + public int getStatusCode() { + return this.statusCode; + } + + public void setStatusCode(int code) { + this.statusCode = code; + } + + public String getStatusMessage() { + return this.statusMessage; + } + + public void setStatusMessage(String message) { + this.statusMessage = message; + } + + public String getResults() { + return this.results; + } + + public void setResults(String results) { + this.results = results; + } + + public String getServerIp() { + return this.serverIp; + } + + public void setServerIp(String serverIp) { + this.serverIp = serverIp; + } + + public String getConfigData() { + return this.configData; + } + + public void setConfigData(String configData) { + this.configData = configData; + } + +} diff --git a/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/model/AnsibleResultCodes.java b/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/model/AnsibleResultCodes.java new file mode 100644 index 000000000..55a1e7086 --- /dev/null +++ b/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/model/AnsibleResultCodes.java @@ -0,0 +1,91 @@ +/*- + * ============LICENSE_START======================================================= + * ONAP : SLI + * ================================================================================ + * Copyright (C) 2021 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + * ============LICENSE_END========================================================= + */ + +package org.onap.ccsdk.sli.adaptors.ansible.model; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.HashSet; +import java.util.Set; + +/** + * enum of the various codes that APP-C uses to resolve different + * status of response from Ansible Server + **/ + +public enum AnsibleResultCodes { + + // @formatter:off + SUCCESS(400), + KEYSTORE_EXCEPTION(622), + CERTIFICATE_ERROR(610), + IO_EXCEPTION(611), + HOST_UNKNOWN(625), + USER_UNAUTHORIZED(613), + UNKNOWN_EXCEPTION(699), + SSL_EXCEPTION(697), + INVALID_PAYLOAD(698), + INVALID_RESPONSE(601), + PENDING(100), + REJECTED(101), + FINAL_SUCCESS(200), + REQ_FAILURE(401), + MESSAGE(1), + CODE(0), + INITRESPONSE(0), + FINALRESPONSE(1); + // @formatter:on + + private final Set<Integer> initCodes = new HashSet<>(Arrays.asList(100, 101)); + private final Set<Integer> finalCodes = new HashSet<>(Arrays.asList(200, 500)); + private final ArrayList<Set<Integer>> codeSets = new ArrayList<>(Arrays.asList(initCodes, finalCodes)); + private final Set<String> messageSet = new HashSet<>(Arrays.asList("PENDING", "FINISHED", "TERMINATED")); + private final int value; + + AnsibleResultCodes(int value) { + this.value = value; + } + + public int getValue() { + return value; + } + + public boolean checkValidCode(int type, int code) { + return codeSets.get(type).contains(code); + } + + public String getValidCodes(int type) { + StringBuilder sb = new StringBuilder("[ "); + codeSets.get(type).forEach(s -> sb.append(s).append(",")); + return sb.append("]").toString(); + } + + public boolean checkValidMessage(String message) { + return messageSet.contains(message); + } + + public String getValidMessages() { + StringBuilder sb = new StringBuilder("[ "); + messageSet.forEach(s -> sb.append(s).append(",")); + return sb.append("]").toString(); + } +} diff --git a/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/model/AnsibleServerEmulator.java b/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/model/AnsibleServerEmulator.java new file mode 100644 index 000000000..b850f3f65 --- /dev/null +++ b/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/model/AnsibleServerEmulator.java @@ -0,0 +1,126 @@ +/*- + * ============LICENSE_START======================================================= + * ONAP : SLI + * ================================================================================ + * Copyright (C) 2021 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + * ============LICENSE_END========================================================= + */ + +package org.onap.ccsdk.sli.adaptors.ansible.model; + +import com.att.eelf.configuration.EELFLogger; +import com.att.eelf.configuration.EELFManager; +import java.util.regex.Matcher; +import java.util.regex.Pattern; +import org.apache.commons.lang.StringUtils; +import org.json.JSONException; +import org.json.JSONObject; + +import static org.onap.ccsdk.sli.adaptors.ansible.AnsibleAdaptorConstants.PLAYBOOK_NAME; +import static org.onap.ccsdk.sli.adaptors.ansible.AnsibleAdaptorConstants.STATUS_CODE; +import static org.onap.ccsdk.sli.adaptors.ansible.AnsibleAdaptorConstants.STATUS_MESSAGE; + +public class AnsibleServerEmulator { + + private final EELFLogger logger = EELFManager.getInstance().getLogger(AnsibleServerEmulator.class); + + /** + * Method that emulates the response from an Ansible Server + * when presented with a request to execute a playbook + * Returns an ansible object result. The response code is always the http code 200 (i.e connection successful) + * payload is json string as would be sent back by Ansible Server + **/ + public AnsibleResult post(String payload) { + AnsibleResult result = new AnsibleResult(); + + try { + // Request must be a JSON object + + JSONObject message = new JSONObject(payload); + String playbookName = "test_playbook.yaml"; + if (message.isNull("Id")) { + rejectRequest(result, "Must provide a valid Id"); + } else if (message.isNull(PLAYBOOK_NAME)) { + rejectRequest(result, "Must provide a playbook Name"); + } else if (!message.getString(PLAYBOOK_NAME).equals(playbookName)) { + rejectRequest(result, "Playbook " + message.getString(PLAYBOOK_NAME) + " not found in catalog"); + } else { + acceptRequest(result); + } + } catch (JSONException e) { + logger.error("JSONException caught", e); + rejectRequest(result, e.getMessage()); + } + return result; + } + + /** + * Method to emulate response from an Ansible + * Server when presented with a GET request + * Returns an ansibl object result. The response code is always the http code 200 (i.e connection successful) + * payload is json string as would be sent back by Ansible Server + **/ + public AnsibleResult get(String agentUrl) { + + Pattern pattern = Pattern.compile(".*?\\?Id=(.*?)&Type.*"); + Matcher matcher = pattern.matcher(agentUrl); + String id = StringUtils.EMPTY; + String vmAddress = "192.168.1.10"; + + if (matcher.find()) { + id = matcher.group(1); + } + + AnsibleResult getResult = new AnsibleResult(); + + JSONObject response = new JSONObject(); + response.put(STATUS_CODE, 200); + response.put(STATUS_MESSAGE, "FINISHED"); + + JSONObject results = new JSONObject(); + + JSONObject vmResults = new JSONObject(); + vmResults.put(STATUS_CODE, 200); + vmResults.put(STATUS_MESSAGE, "SUCCESS"); + vmResults.put("Id", id); + results.put(vmAddress, vmResults); + + response.put("Results", results); + + getResult.setStatusCode(200); + getResult.setStatusMessage(response.toString()); + + return getResult; + } + + private void rejectRequest(AnsibleResult result, String Message) { + result.setStatusCode(200); + JSONObject response = new JSONObject(); + response.put(STATUS_CODE, AnsibleResultCodes.REJECTED.getValue()); + response.put(STATUS_MESSAGE, Message); + result.setStatusMessage(response.toString()); + } + + private void acceptRequest(AnsibleResult result) { + result.setStatusCode(200); + JSONObject response = new JSONObject(); + response.put(STATUS_CODE, AnsibleResultCodes.PENDING.getValue()); + response.put(STATUS_MESSAGE, "PENDING"); + result.setStatusMessage(response.toString()); + } + +}
\ No newline at end of file diff --git a/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/resources/OSGI-INF/blueprint/ansible-adaptor-blueprint.xml b/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/resources/OSGI-INF/blueprint/ansible-adaptor-blueprint.xml new file mode 100644 index 000000000..45e5ba48f --- /dev/null +++ b/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/resources/OSGI-INF/blueprint/ansible-adaptor-blueprint.xml @@ -0,0 +1,40 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ============LICENSE_START======================================================= + ONAP : SLI + ================================================================================ + Copyright (C) 2021 AT&T Intellectual Property. All rights reserved. + ================================================================================ + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + ECOMP is a trademark and service mark of AT&T Intellectual Property. + ============LICENSE_END========================================================= + --> + +<blueprint xmlns:odl="http://opendaylight.org/xmlns/blueprint/v1.0.0" + xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0" + odl:use-default-for-reference-types="true"> + + <bean id="propProvider" class="org.onap.ccsdk.sli.adaptors.ansible.impl.AnsibleAdaptorPropertiesProviderImpl"/> + + <bean id="ansibleAdaptorInstance" class="org.onap.ccsdk.sli.adaptors.ansible.impl.AnsibleAdaptorImpl"> + <argument ref="propProvider"/> + </bean> + + <service ref="ansibleAdaptorInstance"> + <interfaces> + <value>org.onap.ccsdk.sli.adaptors.ansible.AnsibleAdaptor</value> + </interfaces> + </service> + +</blueprint> diff --git a/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/resources/ansible-adaptor.properties b/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/resources/ansible-adaptor.properties new file mode 100644 index 000000000..ace7e8556 --- /dev/null +++ b/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/resources/ansible-adaptor.properties @@ -0,0 +1,42 @@ +### +# ============LICENSE_START======================================================= +# ONAP : SLI +# ================================================================================ +# Copyright (C) 2021 AT&T Intellectual Property. All rights reserved. +# ================================================================================ +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# ECOMP is a trademark and service mark of AT&T Intellectual Property. +# ============LICENSE_END========================================================= + +### +# +# Default properties for the APP-C Provider Adaptor +# +# ------------------------------------------------------------------------------------------------- +# +# Define the name and path of any user-provided configuration (bootstrap) file that can be loaded +# to supply configuration options +org.onap.appc.bootstrap.file=appc.properties +org.onap.appc.bootstrap.path=${user.home},/opt/opendaylight/current/properties,. +appc.application.name=APPC +# +# Define the message resource bundle name to be loaded +org.onap.appc.resources=org/onap/appc/i18n/MessageResources +# +# The name of the adaptor. +org.onap.appc.provider.adaptor.name=org.onap.appc.appc_ansible_adaptor +# Default truststore path and password +org.onap.appc.adaptor.ansible.trustStore=/opt/opendaylight/tls-client/mykeystore.js +org.onap.appc.adaptor.ansible.trustStore.trustPasswd=changeit +org.onap.appc.adaptor.ansible.clientType=TRUST_ALL diff --git a/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/resources/org/opendaylight/blueprint/ansible-adaptor-blueprint.xml b/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/resources/org/opendaylight/blueprint/ansible-adaptor-blueprint.xml new file mode 100644 index 000000000..45e5ba48f --- /dev/null +++ b/adaptors/ansible-adaptor/ansible-adaptor-bundle/src/main/resources/org/opendaylight/blueprint/ansible-adaptor-blueprint.xml @@ -0,0 +1,40 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ============LICENSE_START======================================================= + ONAP : SLI + ================================================================================ + Copyright (C) 2021 AT&T Intellectual Property. All rights reserved. + ================================================================================ + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + ECOMP is a trademark and service mark of AT&T Intellectual Property. + ============LICENSE_END========================================================= + --> + +<blueprint xmlns:odl="http://opendaylight.org/xmlns/blueprint/v1.0.0" + xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0" + odl:use-default-for-reference-types="true"> + + <bean id="propProvider" class="org.onap.ccsdk.sli.adaptors.ansible.impl.AnsibleAdaptorPropertiesProviderImpl"/> + + <bean id="ansibleAdaptorInstance" class="org.onap.ccsdk.sli.adaptors.ansible.impl.AnsibleAdaptorImpl"> + <argument ref="propProvider"/> + </bean> + + <service ref="ansibleAdaptorInstance"> + <interfaces> + <value>org.onap.ccsdk.sli.adaptors.ansible.AnsibleAdaptor</value> + </interfaces> + </service> + +</blueprint> |