diff options
Diffstat (limited to 'appc-dg/appc-dg-shared/appc-dg-ssh')
9 files changed, 604 insertions, 0 deletions
diff --git a/appc-dg/appc-dg-shared/appc-dg-ssh/.gitignore b/appc-dg/appc-dg-shared/appc-dg-ssh/.gitignore new file mode 100644 index 000000000..b83d22266 --- /dev/null +++ b/appc-dg/appc-dg-shared/appc-dg-ssh/.gitignore @@ -0,0 +1 @@ +/target/ diff --git a/appc-dg/appc-dg-shared/appc-dg-ssh/.settings/org.eclipse.wst.common.project.facet.core.xml b/appc-dg/appc-dg-shared/appc-dg-ssh/.settings/org.eclipse.wst.common.project.facet.core.xml new file mode 100644 index 000000000..f4ef8aa0a --- /dev/null +++ b/appc-dg/appc-dg-shared/appc-dg-ssh/.settings/org.eclipse.wst.common.project.facet.core.xml @@ -0,0 +1,4 @@ +<?xml version="1.0" encoding="UTF-8"?> +<faceted-project> + <installed facet="java" version="1.8"/> +</faceted-project> diff --git a/appc-dg/appc-dg-shared/appc-dg-ssh/pom.xml b/appc-dg/appc-dg-shared/appc-dg-ssh/pom.xml new file mode 100644 index 000000000..8a4315503 --- /dev/null +++ b/appc-dg/appc-dg-shared/appc-dg-ssh/pom.xml @@ -0,0 +1,69 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + <modelVersion>4.0.0</modelVersion> + <parent> + <groupId>org.openecomp.appc</groupId> + <artifactId>appc-dg-shared</artifactId> + <version>1.0.0</version> + </parent> + <artifactId>appc-dg-ssh</artifactId> + <packaging>bundle</packaging> + + <dependencies> + <dependency> + <groupId>org.openecomp.appc</groupId> + <artifactId>appc-common</artifactId> + <version>${project.version}</version> + </dependency> + <dependency> + <groupId>org.openecomp.appc</groupId> + <artifactId>appc-ssh-adapter-api</artifactId> + <version>${project.version}</version> + <scope>provided</scope> + </dependency> + <dependency> + <groupId>org.openecomp.appc</groupId> + <artifactId>appc-dg-common</artifactId> + <version>${project.version}</version> + <scope>provided</scope> + </dependency> + + <dependency> + <groupId>org.openecomp.sdnc.core</groupId> + <artifactId>sli-common</artifactId> + <scope>compile</scope> + </dependency> + + <dependency> + <groupId>junit</groupId> + <artifactId>junit</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.openecomp.appc</groupId> + <artifactId>appc-ssh-adapter-tests</artifactId> + <version>${project.version}</version> + <scope>test</scope> + </dependency> + </dependencies> + + <build> + <plugins> + <plugin> + <groupId>org.apache.felix</groupId> + <artifactId>maven-bundle-plugin</artifactId> + <extensions>true</extensions> + <configuration> + <instructions> + <Bundle-SymbolicName>appc-dg-ssh</Bundle-SymbolicName> + <Export-Package>org.openecomp.appc.dg.ssh</Export-Package> + <Private-Package>org.openecomp.appc.dg.ssh.impl.*</Private-Package> + <Import-Package>!org.apache.log,!org.apache.commons.logging,!groovy.lang,!javax.jms,!org.codehaus.commons.compiler,!org.codehaus.groovy.*,!org.codehaus.janino,!com.ibm.icu.*,!com.sun.faces.*,!org.jasypt.*,*</Import-Package> + <Embed-Dependency>appc-common,eelf-core,logback-core,logback-classic;scope=compile|runtime;inline=false</Embed-Dependency> + <Embed-Transitive>true</Embed-Transitive> + </instructions> + </configuration> + </plugin> + </plugins> + </build> +</project> diff --git a/appc-dg/appc-dg-shared/appc-dg-ssh/src/main/java/org/openecomp/appc/dg/ssh/SshDBPlugin.java b/appc-dg/appc-dg-shared/appc-dg-ssh/src/main/java/org/openecomp/appc/dg/ssh/SshDBPlugin.java new file mode 100644 index 000000000..71569bc7b --- /dev/null +++ b/appc-dg/appc-dg-shared/appc-dg-ssh/src/main/java/org/openecomp/appc/dg/ssh/SshDBPlugin.java @@ -0,0 +1,32 @@ +/*- + * ============LICENSE_START======================================================= + * openECOMP : APP-C + * ================================================================================ + * Copyright (C) 2017 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. + * ============LICENSE_END========================================================= + */ + +package org.openecomp.appc.dg.ssh; + +import java.util.Map; + +import org.openecomp.appc.exceptions.APPCException; +import org.openecomp.sdnc.sli.SvcLogicContext; +import org.openecomp.sdnc.sli.SvcLogicJavaPlugin; + +public interface SshDBPlugin extends SvcLogicJavaPlugin { + void retrieveConnectionDetails(Map<String, String> params, SvcLogicContext ctx) throws APPCException; +} diff --git a/appc-dg/appc-dg-shared/appc-dg-ssh/src/main/java/org/openecomp/appc/dg/ssh/SshService.java b/appc-dg/appc-dg-shared/appc-dg-ssh/src/main/java/org/openecomp/appc/dg/ssh/SshService.java new file mode 100644 index 000000000..0d2927ec3 --- /dev/null +++ b/appc-dg/appc-dg-shared/appc-dg-ssh/src/main/java/org/openecomp/appc/dg/ssh/SshService.java @@ -0,0 +1,106 @@ +/*- + * ============LICENSE_START======================================================= + * openECOMP : APP-C + * ================================================================================ + * Copyright (C) 2017 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. + * ============LICENSE_END========================================================= + */ + +package org.openecomp.appc.dg.ssh; + +import java.util.Map; + +import org.openecomp.appc.exceptions.APPCException; +import org.openecomp.sdnc.sli.SvcLogicContext; +import org.openecomp.sdnc.sli.SvcLogicJavaPlugin; + +/** + * Set of common methods that can be called from DG. + */ +public interface SshService extends SvcLogicJavaPlugin { + + /** + * Input parameter for SHH connection details + */ + String PARAM_IN_connection_details = "connection_details"; + + /** + * Input parameter for SSH command to be executed. + */ + String PARAM_IN_command = "command"; + + /* + String PARAM_IN_host = "host"; + String PARAM_IN_port = "port"; + String PARAM_IN_username = "username"; + String PARAM_IN_password = "password"; + */ + + /** + * Input parameter for SSH command timeout + */ + String PARAM_IN_timeout = "timeout"; + + /** + * Output parameter - SSH command execution status. + */ + String PARAM_OUT_status = "status"; + + /** + * Output parameter - content of SSH command stdout. + */ + String PARAM_OUT_stdout = "stdout"; + + /** + * Output parameter - content of SSH command stderr. + */ + String PARAM_OUT_stderr = "stderr"; + + /** + * Default SSH connection port. + */ + int DEF_port = 22; + + /** + * Default SSH command timeout + */ + long DEF_timeout = 120000; + + /** + * Default success status. + */ + int DEF_SUCCESS_STATUS = 0; + + /** + * Execute remote command over SSH. + * + * @param params contains list of input parameters required for the implementation + * @param ctx SLI service logic context + * @throws APPCException + */ + void exec(Map<String, String> params, SvcLogicContext ctx) throws APPCException; + + /** + * Execute remote command over SSH and check return status assuming that success status is 0. + * If non-zero status is returned - fail the execution by throwing exception with content written + * by command to stderr. + * + * @param params contains list of input parameters required for the implementation + * @param ctx SLI service logic context + * @throws APPCException + */ + void execWithStatusCheck(Map<String, String> params, SvcLogicContext ctx) throws APPCException; +} diff --git a/appc-dg/appc-dg-shared/appc-dg-ssh/src/main/java/org/openecomp/appc/dg/ssh/impl/SshDBPluginImpl.java b/appc-dg/appc-dg-shared/appc-dg-ssh/src/main/java/org/openecomp/appc/dg/ssh/impl/SshDBPluginImpl.java new file mode 100644 index 000000000..382d41894 --- /dev/null +++ b/appc-dg/appc-dg-shared/appc-dg-ssh/src/main/java/org/openecomp/appc/dg/ssh/impl/SshDBPluginImpl.java @@ -0,0 +1,74 @@ +/*- + * ============LICENSE_START======================================================= + * openECOMP : APP-C + * ================================================================================ + * Copyright (C) 2017 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. + * ============LICENSE_END========================================================= + */ + +package org.openecomp.appc.dg.ssh.impl; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.ObjectMapper; + +import java.util.Map; + +import org.openecomp.appc.adapter.ssh.Constants; +import org.openecomp.appc.adapter.ssh.SshConnectionDetails; +import org.openecomp.appc.adapter.ssh.SshDataAccessException; +import org.openecomp.appc.adapter.ssh.SshDataAccessService; +import org.openecomp.appc.dg.ssh.SshDBPlugin; +import org.openecomp.appc.exceptions.APPCException; +import com.att.eelf.configuration.EELFLogger; +import com.att.eelf.configuration.EELFManager; +import org.openecomp.sdnc.sli.SvcLogicContext; + +public class SshDBPluginImpl implements SshDBPlugin { + + private static EELFLogger logger = EELFManager.getInstance().getApplicationLogger(); + private static ObjectMapper mapper = new ObjectMapper(); + + private SshDataAccessService dataAccessService; + + public void setDataAccessService(SshDataAccessService dataAccessService) { + this.dataAccessService = dataAccessService; + } + + public void retrieveConnectionDetails(Map<String, String> params, SvcLogicContext ctx) throws APPCException { + SshConnectionDetails connectionDetails = new SshConnectionDetails(); + String vnfType = ctx.getAttribute("aai.prefix")+"."+"vnf-type"; + try { + if (!dataAccessService.retrieveConnectionDetails(ctx.getAttribute(vnfType), connectionDetails)) { + logger.error("Missing configuration for " + params.get(vnfType)); + throw new APPCException("Missing configuration for " + params.get(vnfType) + " in " + Constants.DEVICE_AUTHENTICATION_TABLE_NAME); + } + connectionDetails.setHost(params.get(Constants.VNF_HOST_IP_ADDRESS_FIELD_NAME)); + ctx.setAttribute(Constants.CONNECTION_DETAILS_FIELD_NAME, mapper.writeValueAsString(connectionDetails)); + } catch(APPCException e) { + ctx.setAttribute(Constants.DG_OUTPUT_STATUS_MESSAGE, e.getMessage()); + throw e; + } catch(SshDataAccessException e) { + logger.error("Error " + e.getMessage()); + ctx.setAttribute(Constants.DG_OUTPUT_STATUS_MESSAGE, e.getMessage()); + throw e; + } catch (JsonProcessingException e) { + logger.error("Error " + e.getMessage()); + ctx.setAttribute(Constants.DG_OUTPUT_STATUS_MESSAGE, e.getMessage()); + throw new APPCException(e); + } + } + +} diff --git a/appc-dg/appc-dg-shared/appc-dg-ssh/src/main/java/org/openecomp/appc/dg/ssh/impl/SshServiceImpl.java b/appc-dg/appc-dg-shared/appc-dg-ssh/src/main/java/org/openecomp/appc/dg/ssh/impl/SshServiceImpl.java new file mode 100644 index 000000000..5066f0a6f --- /dev/null +++ b/appc-dg/appc-dg-shared/appc-dg-ssh/src/main/java/org/openecomp/appc/dg/ssh/impl/SshServiceImpl.java @@ -0,0 +1,106 @@ +/*- + * ============LICENSE_START======================================================= + * openECOMP : APP-C + * ================================================================================ + * Copyright (C) 2017 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. + * ============LICENSE_END========================================================= + */ + +package org.openecomp.appc.dg.ssh.impl; + +import com.fasterxml.jackson.databind.ObjectMapper; + +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.util.Map; + +import org.openecomp.appc.adapter.ssh.SshAdapter; +import org.openecomp.appc.adapter.ssh.SshConnection; +import org.openecomp.appc.adapter.ssh.SshConnectionDetails; +import org.openecomp.appc.dg.ssh.SshService; +import org.openecomp.appc.exceptions.APPCException; +import com.att.eelf.configuration.EELFLogger; +import com.att.eelf.configuration.EELFManager; +import org.openecomp.sdnc.sli.SvcLogicContext; + + +public class SshServiceImpl implements SshService { + + private static final EELFLogger logger = EELFManager.getInstance().getApplicationLogger(); + private static final ObjectMapper mapper = new ObjectMapper(); + + private SshAdapter sshAdapter; + + public void setSshAdapter(SshAdapter sshAdapter) { + this.sshAdapter = sshAdapter; + } + + @Override + public void exec(Map<String, String> params, SvcLogicContext ctx) throws APPCException { + SshConnectionDetails connectionDetails = resolveConnectionDetails(params.get(PARAM_IN_connection_details)); + String command = params.get(PARAM_IN_command); + logger.debug("=> Connecting to SSH server..."); + SshConnection sshConnection = sshAdapter.getConnection(connectionDetails.getHost(), connectionDetails.getPort(), connectionDetails.getUsername(), connectionDetails.getPassword()); + sshConnection.connect(); + try { + logger.debug("=> Connected to SSH server..."); + logger.debug("=> Running SSH command..."); + long timeout = DEF_timeout; + String stimeout = params.get(PARAM_IN_timeout); + if ((stimeout != null && !stimeout.isEmpty())) { + timeout = Long.parseLong(stimeout); + } + sshConnection.setExecTimeout(timeout); + ByteArrayOutputStream stdout = new ByteArrayOutputStream(); + ByteArrayOutputStream stderr = new ByteArrayOutputStream(); + int status = sshConnection.execCommand(command, stdout, stderr); + String stdoutRes = stdout.toString(); + String stderrRes = stderr.toString(); + logger.debug("=> executed SSH command"); + ctx.setAttribute(PARAM_OUT_status, String.format("%01d", status)); + ctx.setAttribute(PARAM_OUT_stdout, stdoutRes); + ctx.setAttribute(PARAM_OUT_stderr, stderrRes); + } finally { + sshConnection.disconnect(); + } + } + + private SshConnectionDetails resolveConnectionDetails(String connectionDetailsStr) throws APPCException { + SshConnectionDetails connectionDetails = null; + try { + connectionDetails = mapper.readValue(connectionDetailsStr, SshConnectionDetails.class); + if (0 == connectionDetails.getPort()) connectionDetails.setPort(DEF_port); + } catch (IOException e) { + throw new APPCException(e); + } + return connectionDetails; + } + + @Override + public void execWithStatusCheck(Map<String, String> params, SvcLogicContext ctx) throws APPCException { + exec(params, ctx); + int status = Integer.parseInt(ctx.getAttribute(PARAM_OUT_status)); + if(status != DEF_SUCCESS_STATUS) { + StringBuilder errmsg = new StringBuilder(); + errmsg.append("SSH command returned error status [").append(status).append(']'); + String stderr = ctx.getAttribute(PARAM_OUT_stderr); + if((stderr != null) && !stderr.isEmpty()) { + errmsg.append(". Error: [").append(stderr).append(']'); + } + throw new APPCException(errmsg.toString()); + } + } +} diff --git a/appc-dg/appc-dg-shared/appc-dg-ssh/src/main/resources/OSGI-INF/blueprint/blueprint.xml b/appc-dg/appc-dg-shared/appc-dg-ssh/src/main/resources/OSGI-INF/blueprint/blueprint.xml new file mode 100644 index 000000000..11ab24025 --- /dev/null +++ b/appc-dg/appc-dg-shared/appc-dg-ssh/src/main/resources/OSGI-INF/blueprint/blueprint.xml @@ -0,0 +1,42 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ============LICENSE_START======================================================= + openECOMP : APP-C + ================================================================================ + Copyright (C) 2017 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. + ============LICENSE_END========================================================= + --> + +<!-- + Starter Blueprint Camel Definition appc-aai-adapter-blueprint +--> +<blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://www.osgi.org/xmlns/blueprint/v1.0.0 http://www.osgi.org/xmlns/blueprint/v1.0.0/blueprint.xsd"> + + <reference id="sshAdapterRef" availability="mandatory" activation="eager" interface="org.openecomp.appc.adapter.ssh.SshAdapter" /> + <bean id="sshServiceBean" class="org.openecomp.appc.dg.ssh.impl.SshServiceImpl" scope="singleton"> + <property name="sshAdapter" ref="sshAdapterRef" /> + </bean> + <service id="sshService" interface="org.openecomp.appc.dg.ssh.SshService" ref="sshServiceBean"/> + + <reference id="sshDAServiceRef" availability="mandatory" activation="eager" interface="org.openecomp.appc.adapter.ssh.SshDataAccessService" /> + <bean id="sshDBPluginBean" class="org.openecomp.appc.dg.ssh.impl.SshDBPluginImpl" scope="singleton"> + <property name="dataAccessService" ref="sshDAServiceRef" /> + </bean> + <service id="sshDBPlugin" interface="org.openecomp.appc.dg.ssh.SshDBPlugin" ref="sshDBPluginBean"/> + +</blueprint> diff --git a/appc-dg/appc-dg-shared/appc-dg-ssh/src/test/java/org/openecomp/appc/dg/ssh/impl/SshServiceImplTest.java b/appc-dg/appc-dg-shared/appc-dg-ssh/src/test/java/org/openecomp/appc/dg/ssh/impl/SshServiceImplTest.java new file mode 100644 index 000000000..a00d21100 --- /dev/null +++ b/appc-dg/appc-dg-shared/appc-dg-ssh/src/test/java/org/openecomp/appc/dg/ssh/impl/SshServiceImplTest.java @@ -0,0 +1,170 @@ +/*- + * ============LICENSE_START======================================================= + * openECOMP : APP-C + * ================================================================================ + * Copyright (C) 2017 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. + * ============LICENSE_END========================================================= + */ + +package org.openecomp.appc.dg.ssh.impl; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.ObjectMapper; +import org.hamcrest.CoreMatchers; +import org.junit.Assert; +import org.junit.Rule; +import org.junit.Test; +import org.junit.rules.ExpectedException; +import org.openecomp.appc.adapter.ssh.SshAdapterMock; +import org.openecomp.appc.adapter.ssh.SshConnectionDetails; +import org.openecomp.appc.adapter.ssh.SshConnectionMock; +import org.openecomp.appc.dg.ssh.SshService; +import org.openecomp.appc.dg.ssh.impl.SshServiceImpl; +import org.openecomp.appc.exceptions.APPCException; +import org.openecomp.sdnc.sli.SvcLogicContext; + +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Properties; + +public class SshServiceImplTest { + + private static final ObjectMapper mapper = new ObjectMapper(); + + @Rule + public ExpectedException thrown = ExpectedException.none(); + + @Test + public void testExec() throws APPCException, JsonProcessingException { + String host = "testhost"; + String username = "testuser"; + String password = "testpassword"; + String command = "cat keystonerc_Test"; + + SshServiceImpl sshService = new SshServiceImpl(); + SshAdapterMock sshAdapterMock = new SshAdapterMock(); + sshService.setSshAdapter(sshAdapterMock); + + System.out.println("=> Executing SSH command [" + command + "]..."); + + Map<String, String> params = new HashMap<>(); + params.put(SshService.PARAM_IN_connection_details, createConnectionDetails(host,username,password)); + params.put(SshService.PARAM_IN_command, command); + SvcLogicContext svcLogicContext = new SvcLogicContext(new Properties()); + sshService.exec(params, svcLogicContext); + int status = Integer.parseInt(svcLogicContext.getAttribute(SshService.PARAM_OUT_status)); + String stdout = svcLogicContext.getAttribute(SshService.PARAM_OUT_stdout); + String stderr = svcLogicContext.getAttribute(SshService.PARAM_OUT_stderr); + System.out.println("=> SSH command [" + command + "] status is [" + status + "]. stdout is [" + stdout + "]. stderr is [" + stderr + "]"); + + List<SshConnectionMock> connectionMocks = sshAdapterMock.getConnectionMocks(); + Assert.assertEquals(1, connectionMocks.size()); + SshConnectionMock connectionMock = connectionMocks.get(0); + Assert.assertNotNull(connectionMock); + Assert.assertEquals(host, connectionMock.getHost()); + Assert.assertEquals(SshService.DEF_port, connectionMock.getPort()); + Assert.assertEquals(username, connectionMock.getUsername()); + Assert.assertEquals(password, connectionMock.getPassword()); + Assert.assertEquals(1, connectionMock.getConnectCallCount()); + Assert.assertEquals(1, connectionMock.getDisconnectCallCount()); + List<String> executedCommands = connectionMock.getExecutedCommands(); + Assert.assertEquals(1, executedCommands.size()); + String executedCommand = executedCommands.get(0); + Assert.assertEquals(command, executedCommand); + } + + @Test + public void testExecWithStatusCheck() throws APPCException, JsonProcessingException { + String host = "testhost"; + String username = "testuser"; + String password = "testpassword"; + String command = "cat keystonerc_Test"; + + SshServiceImpl sshService = new SshServiceImpl(); + SshAdapterMock sshAdapterMock = new SshAdapterMock(); + sshService.setSshAdapter(sshAdapterMock); + + System.out.println("=> Executing SSH command [" + command + "]..."); + Map<String, String> params = new HashMap<>(); + params.put(SshService.PARAM_IN_connection_details, createConnectionDetails(host,username,password)); + params.put(SshService.PARAM_IN_command, command); + SvcLogicContext svcLogicContext = new SvcLogicContext(new Properties()); + sshService.execWithStatusCheck(params, svcLogicContext); + int status = Integer.parseInt(svcLogicContext.getAttribute(SshService.PARAM_OUT_status)); + String stdout = svcLogicContext.getAttribute(SshService.PARAM_OUT_stdout); + String stderr = svcLogicContext.getAttribute(SshService.PARAM_OUT_stderr); + System.out.println("=> SSH command [" + command + "] status is [" + status + "]. stdout is [" + stdout + "]. stderr is [" + stderr + "]"); + + List<SshConnectionMock> connectionMocks = sshAdapterMock.getConnectionMocks(); + Assert.assertEquals(1, connectionMocks.size()); + SshConnectionMock connectionMock = connectionMocks.get(0); + Assert.assertNotNull(connectionMock); + Assert.assertEquals(host, connectionMock.getHost()); + Assert.assertEquals(SshService.DEF_port, connectionMock.getPort()); + Assert.assertEquals(username, connectionMock.getUsername()); + Assert.assertEquals(password, connectionMock.getPassword()); + Assert.assertEquals(1, connectionMock.getConnectCallCount()); + Assert.assertEquals(1, connectionMock.getDisconnectCallCount()); + List<String> executedCommands = connectionMock.getExecutedCommands(); + Assert.assertEquals(1, executedCommands.size()); + String executedCommand = executedCommands.get(0); + Assert.assertEquals(command, executedCommand); + } + + /** + * Checks that execWithStatusCheck() throws appropriate exception if execution status != 0. + * + * @throws APPCException + * @throws JsonProcessingException + */ + @Test + public void testExecWithStatusCheckFail() throws APPCException, JsonProcessingException { + String host = "testhost"; + String username = "testuser"; + String password = "testpassword"; + String command = "cat keystonerc_Test"; + + int expectedStatus = 2; + String expectedErr = "Test failure"; + + SshServiceImpl sshService = new SshServiceImpl(); + SshAdapterMock sshAdapterMock = new SshAdapterMock(); + sshAdapterMock.setReturnStatus(expectedStatus); + sshAdapterMock.setReturnStderr(expectedErr); + sshService.setSshAdapter(sshAdapterMock); + + thrown.expect(APPCException.class); + thrown.expectMessage(CoreMatchers.containsString(expectedErr)); + + System.out.println("=> Executing SSH command [" + command + "]..."); + Map<String, String> params = new HashMap<>(); + params.put(SshService.PARAM_IN_connection_details, createConnectionDetails(host,username,password)); + params.put(SshService.PARAM_IN_command, command); + SvcLogicContext svcLogicContext = new SvcLogicContext(new Properties()); + // should fail, no need to perform further assertions + sshService.execWithStatusCheck(params, svcLogicContext); + } + + private String createConnectionDetails(String host, String username, String password) throws JsonProcessingException { + SshConnectionDetails connDetails = new SshConnectionDetails(); + connDetails.setHost(host); + connDetails.setUsername(username); + connDetails.setPassword(password); + return mapper.writeValueAsString(connDetails); + } + +} |