diff options
author | Jessica Wagantall <jwagantall@linuxfoundation.org> | 2020-12-01 11:26:31 -0800 |
---|---|---|
committer | Jessica Wagantall <jwagantall@linuxfoundation.org> | 2020-12-01 11:27:11 -0800 |
commit | 11510b43c277b8e1dd7e58d79785544810118c8e (patch) | |
tree | b88a497c999d24b5f357ea9b26bc93e0990fd5e7 /ansible-adapter/ansible-adapter-bundle/src/main/java | |
parent | 5d2eab72fc4442f14108b41800cec88126913823 (diff) |
Migrate sli-adaptor files
Migrate sli-adaptor repo files into
a new "adaptors" directory.
Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org>
Diffstat (limited to 'ansible-adapter/ansible-adapter-bundle/src/main/java')
9 files changed, 0 insertions, 1582 deletions
diff --git a/ansible-adapter/ansible-adapter-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/AnsibleAdapter.java b/ansible-adapter/ansible-adapter-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/AnsibleAdapter.java deleted file mode 100644 index e43d3e3c3..000000000 --- a/ansible-adapter/ansible-adapter-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/AnsibleAdapter.java +++ /dev/null @@ -1,55 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * ONAP : APPC - * ================================================================================ - * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. - * ================================================================================ - * Copyright (C) 2017 Amdocs - * ============================================================================= - * 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 adapter exposes. - * - */ -public interface AnsibleAdapter extends SvcLogicJavaPlugin { - /** - * Returns the symbolic name of the adapter - * - * @return The adapter name - */ - String getAdapterName(); - - /* 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/ansible-adapter/ansible-adapter-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/AnsibleAdapterPropertiesProvider.java b/ansible-adapter/ansible-adapter-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/AnsibleAdapterPropertiesProvider.java deleted file mode 100755 index 6d9f4f12c..000000000 --- a/ansible-adapter/ansible-adapter-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/AnsibleAdapterPropertiesProvider.java +++ /dev/null @@ -1,28 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * onap - * ================================================================================ - * Copyright (C) 2016 - 2017 ONAP - * ================================================================================ - * 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. - * ============LICENSE_END========================================================= - */ - -package org.onap.ccsdk.sli.adaptors.ansible; - -import java.util.Properties; - -public interface AnsibleAdapterPropertiesProvider { - - public Properties getProperties(); -} diff --git a/ansible-adapter/ansible-adapter-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/impl/AnsibleAdapterImpl.java b/ansible-adapter/ansible-adapter-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/impl/AnsibleAdapterImpl.java deleted file mode 100644 index 2361feebd..000000000 --- a/ansible-adapter/ansible-adapter-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/impl/AnsibleAdapterImpl.java +++ /dev/null @@ -1,460 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * ONAP : APPC - * ================================================================================ - * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. - * ================================================================================ - * Copyright (C) 2017 Amdocs - * ============================================================================= - * 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.util.Map; -import java.util.Properties; -import org.apache.commons.lang.StringUtils; -import org.json.JSONException; -import org.json.JSONObject; -import org.onap.ccsdk.sli.adaptors.ansible.AnsibleAdapter; -import org.onap.ccsdk.sli.adaptors.ansible.AnsibleAdapterPropertiesProvider; -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 com.att.eelf.configuration.EELFLogger; -import com.att.eelf.configuration.EELFManager; - -/** - * This class implements the {@link AnsibleAdapter} interface. This interface defines the behaviors - * that our service provides. - */ -public class AnsibleAdapterImpl implements AnsibleAdapter { - - - /** - * The constant used to define the service name in the mapped diagnostic context - */ - @SuppressWarnings("nls") - public static final String MDC_SERVICE = "service"; - - /** - * The constant for the status code for a failed outcome - */ - @SuppressWarnings("nls") - public static final String OUTCOME_FAILURE = "failure"; - - /** - * The constant for the status code for a successful outcome - */ - @SuppressWarnings("nls") - public static final String OUTCOME_SUCCESS = "success"; - - /** - * Adapter Name - */ - private static final String ADAPTER_NAME = "Ansible Adapter"; - private static final String APPC_EXCEPTION_CAUGHT = "APPCException caught"; - - private static final String RESULT_CODE_ATTRIBUTE_NAME = "org.onap.appc.adapter.ansible.result.code"; - private static final String MESSAGE_ATTRIBUTE_NAME = "org.onap.appc.adapter.ansible.message"; - private static final String RESULTS_ATTRIBUTE_NAME = "org.onap.appc.adapter.ansible.results"; - private static final String ID_ATTRIBUTE_NAME = "org.onap.appc.adapter.ansible.Id"; - private static final String LOG_ATTRIBUTE_NAME = "org.onap.appc.adapter.ansible.log"; - private static final String OUTPUT_ATTRIBUTE_NAME = "org.onap.appc.adapter.ansible.output"; - - private static final String CLIENT_TYPE_PROPERTY_NAME = "org.onap.appc.adapter.ansible.clientType"; - private static final String TRUSTSTORE_PROPERTY_NAME = "org.onap.appc.adapter.ansible.trustStore"; - private static final String TRUSTPASSD_PROPERTY_NAME = "org.onap.appc.adapter.ansible.trustStore.trustPasswd"; - - private static final String PASSD = "Password"; - - /** - * The logger to be used - */ - private static final EELFLogger logger = EELFManager.getInstance().getLogger(AnsibleAdapterImpl.class); - - - /** - * Connection object - **/ - private ConnectionBuilder httpClient; - - /** - * 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 AnsibleAdapterImpl() { - initialize(new AnsibleAdapterPropertiesProviderImpl()); - } - public AnsibleAdapterImpl(AnsibleAdapterPropertiesProvider propProvider) { - initialize(propProvider); - } - - /** - * Used for jUnit test and testing interface - */ - public AnsibleAdapterImpl(boolean mode) { - testMode = mode; - testServer = new AnsibleServerEmulator(); - messageProcessor = new AnsibleMessageParser(); - } - - /** - * Returns the symbolic name of the adapter - * - * @return The adapter name - * @see org.onap.appc.adapter.rest.AnsibleAdapter#getAdapterName() - */ - @Override - public String getAdapterName() { - return ADAPTER_NAME; - } - - /** - * @param rc Method posts info to Context memory in case of an error and throws a - * SvcLogicException causing SLI to register this as a failure - */ - @SuppressWarnings("static-method") - private void doFailure(SvcLogicContext svcLogic, int code, String message) throws SvcLogicException { - - svcLogic.setStatus(OUTCOME_FAILURE); - svcLogic.setAttribute(RESULT_CODE_ATTRIBUTE_NAME, Integer.toString(code)); - svcLogic.setAttribute(MESSAGE_ATTRIBUTE_NAME, message); - - throw new SvcLogicException("Ansible Adapter Error = " + message); - } - - /** - * initialize the Ansible adapter based on default and over-ride configuration data - */ - private void initialize(AnsibleAdapterPropertiesProvider propProvider) { - - - Properties props = propProvider.getProperties(); - - // Create the message processor instance - messageProcessor = new AnsibleMessageParser(); - - // Create the http client instance - // type of client is extracted from the property file parameter - // org.onap.appc.adapter.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 - - 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"); - httpClient = new ConnectionBuilder(1); - } else if ("TRUST_CERT".equals(clientType)) { - // set path to keystore file - String trustStoreFile = props.getProperty(TRUSTSTORE_PROPERTY_NAME); - String key = props.getProperty(TRUSTPASSD_PROPERTY_NAME); - char[] trustStorePasswd = key.toCharArray(); - logger.info("Creating http client with trustmanager from " + trustStoreFile); - httpClient = new ConnectionBuilder(trustStoreFile, trustStorePasswd); - } else { - logger.info("Creating http client with default behaviour"); - httpClient = new ConnectionBuilder(0); - } - } catch (Exception e) { - logger.error("Error Initializing Ansible Adapter due to Unknown Exception", e); - } - - logger.info("Initialized Ansible Adapter"); - } - - // Public Method to post request to execute playbook. Posts the following back - // to Svc context memory - // org.onap.appc.adapter.ansible.req.code : 100 if successful - // org.onap.appc.adapter.ansible.req.messge : any message - // org.onap.appc.adapter.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 password = StringUtils.EMPTY; - String id = StringUtils.EMPTY; - - JSONObject jsonPayload; - - try { - // create json object to send request - jsonPayload = messageProcessor.reqMessage(params); - - agentUrl = (String) jsonPayload.remove("AgentUrl"); - user = (String) jsonPayload.remove("User"); - password = (String) jsonPayload.remove(PASSD); - id = jsonPayload.getString("Id"); - payload = jsonPayload.toString(); - logger.info("Updated Payload = " + payload); - } 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 request = " + payload + " to url = " + agentUrl); - AnsibleResult testResult = postExecRequest(agentUrl, payload, user, password); - - // 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(); - - // Check status of test request returned by Agent - if (code == AnsibleResultCodes.PENDING.getValue()) { - logger.info(String.format("Submission of Test %s successful.", playbookName)); - // test request accepted. We are in asynchronous case - } else { - doFailure(ctx, code, "Request for execution of playbook rejected. Reason = " + message); - } - } 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); - } - - /** - * 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.AnsibleAdapter#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 = StringUtils.EMPTY; - - try { - 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 = -1; - String message = StringUtils.EMPTY; - String results = StringUtils.EMPTY; - - try { - // Try to retrieve the test results (modify the URL for that) - AnsibleResult testResult = queryServer(reqUri, params.get("User"), params.get(PASSD)); - code = testResult.getStatusCode(); - message = testResult.getStatusMessage(); - - if (code == 200) { - logger.info("Parsing response from Server = " + message); - // Valid HTTP. process the Ansible message - testResult = messageProcessor.parseGetResponse(message); - code = testResult.getStatusCode(); - message = testResult.getStatusMessage(); - results = testResult.getResults(); - } - - logger.info("Request response = " + message); - } catch (SvcLogicException e) { - logger.error(APPC_EXCEPTION_CAUGHT, e); - 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"), - OUTCOME_SUCCESS, message); - logger.info(message); - } else { - logger.info(String.format("Ansible Request %s finished with Result %s, Message = %s", params.get("Id"), - OUTCOME_FAILURE, message)); - ctx.setAttribute(RESULTS_ATTRIBUTE_NAME, results); - doFailure(ctx, code, message); - return; - } - - ctx.setAttribute(RESULT_CODE_ATTRIBUTE_NAME, Integer.toString(400)); - ctx.setAttribute(MESSAGE_ATTRIBUTE_NAME, message); - ctx.setAttribute(RESULTS_ATTRIBUTE_NAME, results); - ctx.setStatus(OUTCOME_SUCCESS); - } - - /** - * Public method to get logs from playbook execution for a specific request - * - * 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.adapter.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()); - } - - String message = StringUtils.EMPTY; - try { - // Try to retrieve the test results (modify the url for that) - AnsibleResult testResult = queryServer(reqUri, params.get("User"), params.get(PASSD)); - message = testResult.getStatusMessage(); - logger.info("Request output = " + message); - ctx.setAttribute(LOG_ATTRIBUTE_NAME, message); - ctx.setStatus(OUTCOME_SUCCESS); - } catch (Exception e) { - logger.error("Exception caught", e); - doFailure(ctx, AnsibleResultCodes.UNKNOWN_EXCEPTION.getValue(), - "Exception encountered retreiving output : " + e.getMessage()); - } - } - - /** - * Public method to get output from playbook execution for a specific request - * - * 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.adapter.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()); - } - - String message = StringUtils.EMPTY; - try { - // Try to retrieve the test results (modify the url for that) - AnsibleResult testResult = queryServer(reqUri, params.get("User"), params.get(PASSD)); - message = testResult.getStatusMessage(); - logger.info("Request output = " + message); - ctx.setAttribute(OUTPUT_ATTRIBUTE_NAME, message); - ctx.setStatus(OUTCOME_SUCCESS); - } catch (Exception e) { - logger.error("Exception caught", e); - doFailure(ctx, AnsibleResultCodes.UNKNOWN_EXCEPTION.getValue(), - "Exception encountered retreiving output : " + e.getMessage()); - } - } - - /** - * Method that posts the request - */ - private AnsibleResult postExecRequest(String agentUrl, String payload, String user, String password) { - - AnsibleResult testResult; - - if (!testMode) { - httpClient.setHttpContext(user, password); - testResult = httpClient.post(agentUrl, payload); - } else { - testResult = testServer.Post(agentUrl, payload); - } - return testResult; - } - - /** - * Method to query Ansible server - */ - private AnsibleResult queryServer(String agentUrl, String user, String password) { - - AnsibleResult testResult; - - logger.info("Querying url = " + agentUrl); - - if (!testMode) { - testResult = httpClient.get(agentUrl); - } else { - testResult = testServer.Get(agentUrl); - } - - return testResult; - } -} diff --git a/ansible-adapter/ansible-adapter-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/impl/AnsibleAdapterPropertiesProviderImpl.java b/ansible-adapter/ansible-adapter-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/impl/AnsibleAdapterPropertiesProviderImpl.java deleted file mode 100755 index 482aaf8e5..000000000 --- a/ansible-adapter/ansible-adapter-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/impl/AnsibleAdapterPropertiesProviderImpl.java +++ /dev/null @@ -1,191 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * onap - * ================================================================================ - * Copyright (C) 2016 - 2017 ONAP - * ================================================================================ - * 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. - * ============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.Optional; -import java.util.Properties; -import java.util.Vector; -import org.onap.ccsdk.sli.adaptors.ansible.AnsibleAdapterPropertiesProvider; -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.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 AnsibleAdapterPropertiesProviderImpl implements AnsibleAdapterPropertiesProvider { - - private static final Logger LOG = LoggerFactory.getLogger(AnsibleAdapterPropertiesProviderImpl.class); - - /** - * The name of the properties file for database configuration - */ - private static final String ANSIBLEADAPTER_PROP_FILE_NAME = "ansible-adapter.properties"; - - /** - * A prioritized list of strategies for resolving sql-resource properties files. - */ - private Vector<PropertiesFileResolver> ansibleAdapterPropertiesFileResolvers = new Vector<>(); - - /** - * The configuration properties for the db connection. - */ - private Properties properties; - - /** - * Set up the prioritized list of strategies for resolving dblib properties - * files. - */ - public AnsibleAdapterPropertiesProviderImpl() { - ansibleAdapterPropertiesFileResolvers - .add(new SdncConfigEnvVarFileResolver("Using property file (1) from environment variable")); - ansibleAdapterPropertiesFileResolvers.add(new CoreDefaultFileResolver("Using property file (2) from default directory")); - - ansibleAdapterPropertiesFileResolvers.add( - new JREFileResolver("Using property file (3) from JRE argument", AnsibleAdapterPropertiesProviderImpl.class)); - ansibleAdapterPropertiesFileResolvers.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(this); - if (propertiesFile != null) { - try (FileInputStream fileInputStream = new FileInputStream(propertiesFile)) { - properties = new Properties(); - properties.load(fileInputStream); - } catch (final IOException e) { - LOG.error("Failed to load properties for file: {}", propertiesFile.toString(), - new ConfigurationException("Failed to load properties for file: " + propertiesFile.toString(), - e)); - } - } else { - // Try to read properties as resource - - InputStream propStr = getClass().getResourceAsStream("/" + ANSIBLEADAPTER_PROP_FILE_NAME); - if (propStr != null) { - properties = new Properties(); - try { - properties.load(propStr); - propStr.close(); - } catch (IOException e) { - properties = null; - } - } - - } - - if (properties == null) { - reportFailure("Missing configuration properties resource(3)", new ConfigurationException( - "Missing configuration properties resource(3): " + ANSIBLEADAPTER_PROP_FILE_NAME)); - - LOG.info("Defaulting org.onap.appc.adapter.ansible.clientType to TRUST_ALL"); - - properties = new Properties(); - properties.setProperty("org.onap.appc.adapter.ansible.clientType", "TRUST_ALL"); - } - } - - /** - * Extract svclogic config properties. - * - * @return the svclogic config properties - */ - public Properties getProperties() { - return properties; - } - - /** - * 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 message - * An appropriate fatal error message - * @param configurationException - * An exception describing what went wrong during resolution - */ - private static void reportFailure(final String message, final ConfigurationException configurationException) { - - LOG.error("{}", message, configurationException); - } - - /** - * 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(final AnsibleAdapterPropertiesProviderImpl resourceProvider) { - - for (final PropertiesFileResolver sliPropertiesFileResolver : ansibleAdapterPropertiesFileResolvers) { - final Optional<File> fileOptional = sliPropertiesFileResolver.resolveFile(ANSIBLEADAPTER_PROP_FILE_NAME); - if (fileOptional.isPresent()) { - return reportSuccess(sliPropertiesFileResolver.getSuccessfulResolutionMessage(), fileOptional); - } - } - - return null; - } -} diff --git a/ansible-adapter/ansible-adapter-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/impl/ConnectionBuilder.java b/ansible-adapter/ansible-adapter-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/impl/ConnectionBuilder.java deleted file mode 100644 index 672e0df67..000000000 --- a/ansible-adapter/ansible-adapter-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/impl/ConnectionBuilder.java +++ /dev/null @@ -1,205 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * ONAP : APPC - * ================================================================================ - * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. - * ================================================================================ - * Copyright (C) 2017 Amdocs - * ================================================================================ - * Modifications Copyright © 2018 IBM. - * ============================================================================= - * 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.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.http.HttpEntity; -import org.apache.http.HttpResponse; -import org.apache.http.auth.AuthScope; -import org.apache.http.auth.UsernamePasswordCredentials; -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.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.onap.ccsdk.sli.adaptors.ansible.model.AnsibleResult; -import org.onap.ccsdk.sli.adaptors.ansible.model.AnsibleResultCodes; -import org.onap.ccsdk.sli.core.utils.PathValidator; - -import com.att.eelf.configuration.EELFLogger; -import com.att.eelf.configuration.EELFManager; - -/** - * 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 { - - private static final EELFLogger logger = EELFManager.getInstance().getLogger(ConnectionBuilder.class); - - private CloseableHttpClient httpClient = null; - private HttpClientContext httpContext = new HttpClientContext(); - - /** - * Constructor that initializes an http client based on certificate - **/ - public ConnectionBuilder(String certFile) 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); - - httpClient = HttpClients.custom().setSSLSocketFactory(factory).build(); - } - } - - /** - * Constructor which trusts all certificates in a specific java keystore file (assumes a JKS - * file) - **/ - public ConnectionBuilder(String trustStoreFile, char[] trustStorePasswd) 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); - - SSLContext sslcontext = SSLContexts.custom().loadTrustMaterial(keystore).build(); - SSLConnectionSocketFactory factory = new SSLConnectionSocketFactory(sslcontext, - SSLConnectionSocketFactory.BROWSER_COMPATIBLE_HOSTNAME_VERIFIER); - - httpClient = HttpClients.custom().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) - throws NoSuchAlgorithmException, KeyStoreException, KeyManagementException { - 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().setSSLSocketFactory(factory).build(); - } else { - httpClient = HttpClients.createDefault(); - } - } - - // Use to create an http context with auth headers - public void setHttpContext(String user, String myPassword) { - - // Are credential provided ? If so, set the context to be used - if (user != null && !user.isEmpty() && myPassword != null && !myPassword.isEmpty()) { - UsernamePasswordCredentials credentials = new UsernamePasswordCredentials(user, myPassword); - 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(); - 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; - } -} diff --git a/ansible-adapter/ansible-adapter-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/model/AnsibleMessageParser.java b/ansible-adapter/ansible-adapter-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/model/AnsibleMessageParser.java deleted file mode 100644 index 5f6342d94..000000000 --- a/ansible-adapter/ansible-adapter-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/model/AnsibleMessageParser.java +++ /dev/null @@ -1,332 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * ONAP : APPC - * ================================================================================ - * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved. - * ================================================================================ - * Copyright (C) 2017 Amdocs - * ============================================================================= - * Modifications Copyright (C) 2018 IBM. - * ================================================================================ - * 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; - -/** - * This module implements the APP-C/Ansible Server interface - * based on the REST API specifications - */ -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.json.JSONArray; -import org.json.JSONException; -import org.json.JSONObject; -import org.onap.ccsdk.sli.core.sli.SvcLogicException; -import com.google.common.base.Strings; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -/** - * Class that validates and constructs requests sent/received from - * Ansible Server - */ -public class AnsibleMessageParser { - - private static final String STATUS_MESSAGE_KEY = "StatusMessage"; - private static final String STATUS_CODE_KEY = "StatusCode"; - - private static final String PLAYBOOK_NAME_KEY = "PlaybookName"; - private static final String AGENT_URL_KEY = "AgentUrl"; - private static final String PASS_KEY = "Password"; - private static final String USER_KEY = "User"; - private static final String ID_KEY = "Id"; - - private static final String LOCAL_PARAMETERS_OPT_KEY = "LocalParameters"; - private static final String FILE_PARAMETERS_OPT_KEY = "FileParameters"; - private static final String ENV_PARAMETERS_OPT_KEY = "EnvParameters"; - private static final String NODE_LIST_OPT_KEY = "NodeList"; - private static final String TIMEOUT_OPT_KEY = "Timeout"; - private static final String VERSION_OPT_KEY = "Version"; - private static final String ACTION_OPT_KEY = "Action"; - - private String jsonException = "JSON exception"; - 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. - * - * Mandatory parameters, that must be in the supplied information to the Ansible Adapter - * 1. URL to connect to - * 2. credentials for URL (assume username password for now) - * 3. Playbook name - * - */ - public JSONObject reqMessage(Map<String, String> params) throws SvcLogicException { - final String[] mandatoryTestParams = {AGENT_URL_KEY, PLAYBOOK_NAME_KEY, USER_KEY, PASS_KEY}; - final String[] optionalTestParams = {ENV_PARAMETERS_OPT_KEY, NODE_LIST_OPT_KEY, LOCAL_PARAMETERS_OPT_KEY, - TIMEOUT_OPT_KEY, VERSION_OPT_KEY, FILE_PARAMETERS_OPT_KEY, ACTION_OPT_KEY}; - - 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_KEY, 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_KEY, ID_KEY, USER_KEY, PASS_KEY}; - - for (String key : mandatoryTestParams) { - throwIfMissingMandatoryParam(params, key); - } - return params.get(AGENT_URL_KEY) + "?Id=" + params.get(ID_KEY) + "&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_KEY, ID_KEY, USER_KEY, PASS_KEY}; - - for (String mandatoryParam : mandatoryTestParams) { - throwIfMissingMandatoryParam(params, mandatoryParam); - } - return params.get(AGENT_URL_KEY) + "?Id=" + params.get(ID_KEY) + "&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_KEY, ID_KEY, USER_KEY, PASS_KEY}; - - for (String mandatoryParam : mandatoryTestParams) { - throwIfMissingMandatoryParam(params, mandatoryParam); - } - return params.get(AGENT_URL_KEY) + "?Id=" + params.get(ID_KEY) + "&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_KEY); - String msg = postResponse.getString(STATUS_MESSAGE_KEY); - - int initResponseValue = AnsibleResultCodes.INITRESPONSE.getValue(); - boolean validCode = AnsibleResultCodes.CODE.checkValidCode(initResponseValue, code); - if (!validCode) { - throw new SvcLogicException("Invalid InitResponse code = " + code + " received. MUST be one of " - + AnsibleResultCodes.CODE.getValidCodes(initResponseValue)); - } - - ansibleResult = new AnsibleResult(code, msg); - - } catch (JSONException e) { - LOGGER.error(jsonException, 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); - ansibleResult = parseGetResponseNested(ansibleResult, postResponse); - } catch (JSONException e) { - LOGGER.error(jsonException, e); - ansibleResult = new AnsibleResult(AnsibleResultCodes.INVALID_PAYLOAD.getValue(), - "Error parsing response = " + input + ". Error = " + e.getMessage(), ""); - } - return ansibleResult; - } - - private AnsibleResult parseGetResponseNested(AnsibleResult ansibleResult, JSONObject postRsp) throws SvcLogicException { - - int codeStatus = postRsp.getInt(STATUS_CODE_KEY); - String messageStatus = postRsp.getString(STATUS_MESSAGE_KEY); - int finalCode = AnsibleResultCodes.FINAL_SUCCESS.getValue(); - - boolean valCode = - AnsibleResultCodes.CODE.checkValidCode(AnsibleResultCodes.FINALRESPONSE.getValue(), codeStatus); - - if (!valCode) { - throw new SvcLogicException("Invalid FinalResponse code = " + codeStatus + " received. MUST be one of " - + AnsibleResultCodes.CODE.getValidCodes(AnsibleResultCodes.FINALRESPONSE.getValue())); - } - - ansibleResult.setStatusCode(codeStatus); - ansibleResult.setStatusMessage(messageStatus); - 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 .."); - Iterator<String> hosts = results.keys(); - LOGGER.info("Iterating through hosts"); - - while (hosts.hasNext()) { - String host = hosts.next(); - LOGGER.info("Processing host = {}", host); - - try { - JSONObject hostResponse = results.getJSONObject(host); - int subCode = hostResponse.getInt(STATUS_CODE_KEY); - String message = hostResponse.getString(STATUS_MESSAGE_KEY); - - LOGGER.info("Code = {}, Message = {}", subCode, message); - - if (subCode != 200 || !("SUCCESS").equals(message)) { - finalCode = AnsibleResultCodes.REQ_FAILURE.getValue(); - } - } catch (JSONException e) { - LOGGER.error(jsonException, 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"); - } - return ansibleResult; - } - - 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_OPT_KEY: - int timeout = Integer.parseInt(payload); - if (timeout < 0) { - throw new NumberFormatException(" : specified negative integer for timeout = " + payload); - } - jsonPayload.put(key, payload); - break; - - case VERSION_OPT_KEY: - jsonPayload.put(key, payload); - break; - - case LOCAL_PARAMETERS_OPT_KEY: - case ENV_PARAMETERS_OPT_KEY: - JSONObject paramsJson = new JSONObject(payload); - jsonPayload.put(key, paramsJson); - break; - - case NODE_LIST_OPT_KEY: - JSONArray paramsArray = new JSONArray(payload); - jsonPayload.put(key, paramsArray); - break; - - case FILE_PARAMETERS_OPT_KEY: - 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 AnsibleAdapter key %s not found in parameters provided by calling agent !", - key)); - } - if (Strings.isNullOrEmpty(params.get(key))) { - throw new SvcLogicException(String.format( - "Ansible: Mandatory AnsibleAdapter key %s not found in parameters provided by calling agent !", - key)); - } - } -} diff --git a/ansible-adapter/ansible-adapter-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/model/AnsibleResult.java b/ansible-adapter/ansible-adapter-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/model/AnsibleResult.java deleted file mode 100644 index 3d1b3cfab..000000000 --- a/ansible-adapter/ansible-adapter-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/model/AnsibleResult.java +++ /dev/null @@ -1,81 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * ONAP : APPC - * ================================================================================ - * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. - * ================================================================================ - * Copyright (C) 2017 Amdocs - * ============================================================================= - * 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; - - 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 void setStatusCode(int code) { - this.statusCode = code; - } - - public void setStatusMessage(String message) { - this.statusMessage = message; - } - - public void setResults(String results) { - this.results = results; - } - - void set(int code, String message, String results) { - this.statusCode = code; - this.statusMessage = message; - this.results = results; - } - - public int getStatusCode() { - return this.statusCode; - } - - public String getStatusMessage() { - return this.statusMessage; - } - - public String getResults() { - return this.results; - } -} diff --git a/ansible-adapter/ansible-adapter-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/model/AnsibleResultCodes.java b/ansible-adapter/ansible-adapter-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/model/AnsibleResultCodes.java deleted file mode 100644 index a529e4a0c..000000000 --- a/ansible-adapter/ansible-adapter-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/model/AnsibleResultCodes.java +++ /dev/null @@ -1,93 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * ONAP : APPC - * ================================================================================ - * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. - * ================================================================================ - * Copyright (C) 2017 Amdocs - * ============================================================================= - * 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).stream().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.stream().forEach(s -> sb.append(s).append(",")); - return sb.append("]").toString(); - } -} diff --git a/ansible-adapter/ansible-adapter-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/model/AnsibleServerEmulator.java b/ansible-adapter/ansible-adapter-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/model/AnsibleServerEmulator.java deleted file mode 100644 index 993c70062..000000000 --- a/ansible-adapter/ansible-adapter-bundle/src/main/java/org/onap/ccsdk/sli/adaptors/ansible/model/AnsibleServerEmulator.java +++ /dev/null @@ -1,137 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * ONAP : APPC - * ================================================================================ - * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. - * ================================================================================ - * Copyright (C) 2017 Amdocs - * ============================================================================= - * 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========================================================= - */ - - - -/* - * Class to emulate responses from the Ansible Server that is compliant with the APP-C Ansible Server - * Interface. Used for jUnit tests to verify code is working. In tests it can be used - * as a replacement for methods from ConnectionBuilder class - */ - -package org.onap.ccsdk.sli.adaptors.ansible.model; - -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 com.att.eelf.configuration.EELFLogger; -import com.att.eelf.configuration.EELFManager; - -public class AnsibleServerEmulator { - - private final EELFLogger logger = EELFManager.getInstance().getLogger(AnsibleServerEmulator.class); - - private static final String PLAYBOOK_NAME = "PlaybookName"; - private static final String STATUS_CODE = "StatusCode"; - private static final String STATUS_MESSAGE = "StatusMessage"; - - private String playbookName = "test_playbook.yaml"; - - /** - * 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 agentUrl, String payload) { - AnsibleResult result = new AnsibleResult(); - - try { - // Request must be a JSON object - - JSONObject message = new JSONObject(payload); - 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 |