saltstack-adapter/saltstack-adapter-provider/src/main/java/org/onap/ccsdk/sli/adaptors/saltstack/impl/SaltstackAdapterImpl.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP : APPC
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Copyright (C) 2017 Amdocs
   8  * =============================================================================
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  *
  21  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  22  * ============LICENSE_END=========================================================
  23  */
  24
  25 package org.onap.ccsdk.sli.adaptors.saltstack.impl;
  26
  27 import com.att.eelf.configuration.EELFLogger;
  28 import com.att.eelf.configuration.EELFManager;
  29 import org.onap.ccsdk.sli.adaptors.saltstack.SaltstackAdapter;
  30 import org.onap.ccsdk.sli.adaptors.saltstack.SaltstackAdapterPropertiesProvider;
  31 import org.onap.ccsdk.sli.adaptors.saltstack.model.SaltstackMessageParser;
  32 import org.onap.ccsdk.sli.adaptors.saltstack.model.SaltstackResult;
  33 import org.onap.ccsdk.sli.adaptors.saltstack.model.SaltstackResultCodes;
  34 import org.onap.ccsdk.sli.adaptors.saltstack.model.SaltstackServerEmulator;
  35 import org.onap.ccsdk.sli.core.sli.SvcLogicContext;
  36 import org.onap.ccsdk.sli.core.sli.SvcLogicException;
  37
  38 import java.io.File;
  39 import java.io.FileInputStream;
  40 import java.io.FileNotFoundException;
  41 import java.io.IOException;
  42 import java.io.InputStream;
  43 import java.util.Map;
  44 import java.util.Properties;
  45
  46 /**
  47  * This class implements the {@link SaltstackAdapter} interface. This interface defines the behaviors
  48  * that our service provides.
  49  */
  50 public class SaltstackAdapterImpl implements SaltstackAdapter {
  51
  52     /**
  53      * The constant used to define the service name in the mapped diagnostic context
  54      */
  55     @SuppressWarnings("nls")
  56     public static final String MDC_SERVICE = "service";
  57     /**
  58      * The constant for the status code for a failed outcome
  59      */
  60     @SuppressWarnings("nls")
  61     public static final String OUTCOME_FAILURE = "failure";
  62     /**
  63      * The constant for the status code for a successful outcome
  64      */
  65     @SuppressWarnings("nls")
  66     public static final String OUTCOME_SUCCESS = "success";
  67     public static final String CONNECTION_RETRY_DELAY = "retryDelay";
  68     public static final String CONNECTION_RETRY_COUNT = "retryCount";
  69     private static final long EXEC_TIMEOUT = 120000;
  70     /**
  71      * Adapter Name
  72      */
  73     private static final String ADAPTER_NAME = "Saltstack Adapter";
  74     private static final String APPC_EXCEPTION_CAUGHT = "APPCException caught";
  75     private static final String RESULT_CODE_ATTRIBUTE_NAME = "org.onap.appc.adapter.saltstack.result.code";
  76     private static final String MESSAGE_ATTRIBUTE_NAME = "org.onap.appc.adapter.saltstack.message";
  77     private static final String RESULTS_ATTRIBUTE_NAME = "org.onap.appc.adapter.saltstack.results";
  78     private static final String ID_ATTRIBUTE_NAME = "org.onap.appc.adapter.saltstack.Id";
  79     private static final String LOG_ATTRIBUTE_NAME = "org.onap.appc.adapter.saltstack.log";
  80     private static final String CLIENT_TYPE_PROPERTY_NAME = "org.onap.appc.adapter.saltstack.clientType";
  81     private static final String SS_SERVER_HOSTNAME = "org.onap.appc.adapter.saltstack.host";
  82     private static final String SS_SERVER_PORT = "org.onap.appc.adapter.saltstack.port";
  83     private static final String SS_SERVER_USERNAME = "org.onap.appc.adapter.saltstack.userName";
  84     private static final String SS_SERVER_PASSWORD = "org.onap.appc.adapter.saltstack.userPasswd";
  85     private static final String SS_SERVER_SSH_KEY = "org.onap.appc.adapter.saltstack.sshKey";
  86     /**
  87      * The logger to be used
  88      */
  89     private static final EELFLogger logger = EELFManager.getInstance().getLogger(SaltstackAdapterImpl.class);
  90     private long timeout = EXEC_TIMEOUT;
  91     /**
  92      * Connection object
  93      **/
  94     private ConnectionBuilder sshClient;
  95
  96     /**
  97      * Saltstack API Message Handlers
  98      **/
  99     private SaltstackMessageParser messageProcessor;
 100
 101     /**
 102      * indicator whether in test mode
 103      **/
 104     private boolean testMode = false;
 105
 106     /**
 107      * server emulator object to be used if in test mode
 108      **/
 109     private SaltstackServerEmulator testServer;
 110
 111     /**
 112      * This default constructor is used as a work around because the activator wasn't getting called
 113      */
 114     public SaltstackAdapterImpl() {
 115         initialize(new SaltstackAdapterPropertiesProviderImpl());
 116     }
 117
 118     public SaltstackAdapterImpl(SaltstackAdapterPropertiesProvider propProvider) {
 119         initialize(propProvider);
 120     }
 121
 122     /**
 123      * Used for jUnit test and testing interface
 124      */
 125     public SaltstackAdapterImpl(boolean mode) {
 126         testMode = mode;
 127         testServer = new SaltstackServerEmulator();
 128         messageProcessor = new SaltstackMessageParser();
 129     }
 130
 131     /**
 132      * Returns the symbolic name of the adapter
 133      *
 134      * @return The adapter name
 135      * @see SaltstackAdapter#getAdapterName()
 136      */
 137     @Override
 138     public String getAdapterName() {
 139         return ADAPTER_NAME;
 140     }
 141
 142     @Override
 143     public void setExecTimeout(long timeout) {
 144         this.timeout = timeout;
 145     }
 146
 147     /**
 148      * Method posts info to Context memory in case of an error and throws a
 149      * SvcLogicException causing SLI to register this as a failure
 150      */
 151     @SuppressWarnings("static-method")
 152     private void doFailure(SvcLogicContext svcLogic, int code, String message) throws SvcLogicException {
 153
 154         svcLogic.setStatus(OUTCOME_FAILURE);
 155         svcLogic.setAttribute(RESULT_CODE_ATTRIBUTE_NAME, Integer.toString(code));
 156         svcLogic.setAttribute(MESSAGE_ATTRIBUTE_NAME, message);
 157         throw new SvcLogicException("Saltstack Adapter Error = " + message);
 158     }
 159
 160     /**
 161      * initialize the Saltstack adapter based on default and over-ride configuration data
 162      */
 163     private void initialize(SaltstackAdapterPropertiesProvider propProvider) {
 164
 165
 166         Properties props = propProvider.getProperties();
 167
 168         // Create the message processor instance
 169         messageProcessor = new SaltstackMessageParser();
 170
 171         // Create the ssh client instance
 172         // type of client is extracted from the property file parameter
 173         // org.onap.appc.adapter.saltstack.clientType
 174         // It can be :
 175         // 1. BASIC. SSH Connection using username and password
 176         // 2. SSH_CERT (trust only those whose certificates have been stored in the SSH KEY file)
 177         // 3. DEFAULT SSH Connection without any authentication
 178
 179         try {
 180             String clientType = props.getProperty(CLIENT_TYPE_PROPERTY_NAME);
 181             logger.info("Saltstack ssh client type set to " + clientType);
 182
 183             if ("BASIC".equalsIgnoreCase(clientType)) {
 184                 logger.info("Creating ssh client connection");
 185                 // set path to keystore file
 186                 String sshHost = props.getProperty(SS_SERVER_HOSTNAME);
 187                 String sshPort = props.getProperty(SS_SERVER_PORT);
 188                 String sshUserName = props.getProperty(SS_SERVER_USERNAME);
 189                 String sshPassword = props.getProperty(SS_SERVER_PASSWORD);
 190                 sshClient = new ConnectionBuilder(sshHost, sshPort, sshUserName, sshPassword);
 191             } else if ("SSH_CERT".equalsIgnoreCase(clientType)) {
 192                 // set path to keystore file
 193                 String sshKey = props.getProperty(SS_SERVER_SSH_KEY);
 194                 String sshHost = props.getProperty(SS_SERVER_HOSTNAME);
 195                 String sshPort = props.getProperty(SS_SERVER_PORT);
 196                 logger.info("Creating ssh client with ssh KEY from " + sshKey);
 197                 sshClient = new ConnectionBuilder(sshHost, sshPort, sshKey);
 198             } else if ("BOTH".equalsIgnoreCase(clientType)) {
 199                 // set path to keystore file
 200                 String sshKey = props.getProperty(SS_SERVER_SSH_KEY);
 201                 String sshHost = props.getProperty(SS_SERVER_HOSTNAME);
 202                 String sshUserName = props.getProperty(SS_SERVER_USERNAME);
 203                 String sshPassword = props.getProperty(SS_SERVER_PASSWORD);
 204                 String sshPort = props.getProperty(SS_SERVER_PORT);
 205                 logger.info("Creating ssh client with ssh KEY from " + sshKey);
 206                 sshClient = new ConnectionBuilder(sshHost, sshPort, sshUserName, sshPassword, sshKey);
 207             } else {
 208                 logger.info("No saltstack-adapter.properties defined so reading from DG props");
 209                 sshClient = null;
 210             }
 211         } catch (Exception e) {
 212             logger.error("Error Initializing Saltstack Adapter due to Unknown Exception", e);
 213         }
 214
 215         logger.info("Initialized Saltstack Adapter");
 216     }
 217
 218     private void setSSHClient(Map<String, String> params) throws SvcLogicException {
 219         if (sshClient == null) {
 220             logger.info("saltstack-adapter.properties not defined so reading saltstack host and " +
 221                                 "auth details from DG's parameters");
 222             String sshHost = messageProcessor.reqHostNameResult(params);
 223             String sshPort = messageProcessor.reqPortResult(params);
 224             String sshUserName = messageProcessor.reqUserNameResult(params);
 225             String sshPassword = messageProcessor.reqPasswordResult(params);
 226             logger.info("Creating ssh client with BASIC Auth");
 227             if (!testMode) {
 228                 sshClient = new ConnectionBuilder(sshHost, sshPort, sshUserName, sshPassword);
 229             }
 230         }
 231     }
 232
 233     private String putToCommands(SvcLogicContext ctx, String slsFileName,
 234                                  String reqID, String applyTo) throws SvcLogicException {
 235         String constructedCommand = "";
 236         try {
 237             File file = new File(slsFileName);
 238             InputStream in = new FileInputStream(file);
 239             byte[] data = new byte[(int) file.length()];
 240             in.read(data);
 241             String str = new String(data, "UTF-8");
 242             in.close();
 243             constructedCommand = "echo "+str+" > /srv/salt/"+reqID+".sls; salt '"+applyTo+"' state.apply "+reqID+" --out=json --static";
 244         } catch (FileNotFoundException e) {
 245             doFailure(ctx, SaltstackResultCodes.IO_EXCEPTION.getValue(), "Input SLS file " +
 246                     "not found in path : " + slsFileName+". "+ e.getMessage());
 247         } catch (IOException e) {
 248             doFailure(ctx, SaltstackResultCodes.IO_EXCEPTION.getValue(), "Input SLS file " +
 249                     "error in path : " + slsFileName +". "+ e.getMessage());
 250         }
 251         logger.info("Command to be executed on server : " + constructedCommand);
 252         return constructedCommand;
 253     }
 254
 255     private String putToCommands(String slsName, String applyTo) {
 256         String
 257             constructedCommand = "cd /srv/salt/; salt '"+applyTo+"' state.apply "+slsName+" --out=json --static";
 258
 259         logger.info("Command to be executed on server : " + constructedCommand);
 260         return constructedCommand;
 261     }
 262
 263     private void checkResponseStatus(SaltstackResult testResult, SvcLogicContext ctx, String reqID, boolean slsExec)
 264             throws SvcLogicException {
 265
 266         // Check status of test request returned by Agent
 267         if (testResult.getStatusCode() != SaltstackResultCodes.FINAL_SUCCESS.getValue()) {
 268             doFailure(ctx, testResult.getStatusCode(), "Request for execution of command failed. Reason = " + testResult.getStatusMessage());
 269             ctx.setAttribute(ID_ATTRIBUTE_NAME, reqID);
 270             return;
 271         } else {
 272             logger.info(String.format("Execution of request : successful."));
 273             if (slsExec) {
 274                 ctx.setAttribute(RESULT_CODE_ATTRIBUTE_NAME, Integer.toString(testResult.getStatusCode()));
 275                 ctx.setAttribute(MESSAGE_ATTRIBUTE_NAME, "success");
 276             } else {
 277                 ctx.setAttribute(RESULT_CODE_ATTRIBUTE_NAME, Integer.toString(SaltstackResultCodes.CHECK_CTX_FOR_CMD_SUCCESS.getValue()));
 278                 ctx.setAttribute(MESSAGE_ATTRIBUTE_NAME, "check context for execution status");
 279             }
 280             ctx.setAttribute(ID_ATTRIBUTE_NAME, reqID);
 281         }
 282     }
 283
 284     // Public Method to post single command request to execute saltState. Posts the following back
 285     // to Svc context memory
 286     //  org.onap.appc.adapter.saltstack.req.code : 100 if successful
 287     //  org.onap.appc.adapter.saltstack.req.messge : any message
 288     //  org.onap.appc.adapter.saltstack.req.Id : a unique uuid to reference the request
 289     @Override
 290     public void reqExecCommand(Map<String, String> params, SvcLogicContext ctx) throws SvcLogicException {
 291         String reqID;
 292         boolean slsExec;
 293         SaltstackResult testResult;
 294         setSSHClient(params);
 295         reqID = messageProcessor.reqId(params);
 296         String commandToExecute = messageProcessor.reqCmd(params);
 297         slsExec = messageProcessor.reqIsSLSExec(params);
 298         testResult = execCommand(params, commandToExecute);
 299         testResult = messageProcessor.parseResponse(ctx, reqID, testResult, slsExec);
 300         checkResponseStatus(testResult, ctx, reqID, slsExec);
 301     }
 302
 303     /**
 304      * Public Method to post SLS command request to execute saltState on server. Posts the following back
 305      * to Svc context memory
 306      * <p>
 307      * org.onap.appc.adapter.saltstack.req.code : 200 if successful
 308      * org.onap.appc.adapter.saltstack.req.messge : any message
 309      * org.onap.appc.adapter.saltstack.req.Id : a unique uuid to reference the request
 310      */
 311     @Override
 312     public void reqExecSLS(Map<String, String> params, SvcLogicContext ctx) throws SvcLogicException {
 313         String reqID;
 314         SaltstackResult testResult;
 315         setSSHClient(params);
 316         reqID = messageProcessor.reqId(params);
 317         String slsName = messageProcessor.reqSlsName(params);
 318         String applyTo = messageProcessor.reqApplyToDevices(params);
 319         String commandToExecute = putToCommands(slsName, applyTo);
 320         testResult = execCommand(params, commandToExecute);
 321         testResult = messageProcessor.parseResponse(ctx, reqID, testResult, true);
 322         checkResponseStatus(testResult, ctx, reqID, true);
 323     }
 324
 325     /**
 326      * Public Method to post SLS file request to execute saltState. Posts the following back
 327      * to Svc context memory
 328      * <p>
 329      * org.onap.appc.adapter.saltstack.req.code : 100 if successful
 330      * org.onap.appc.adapter.saltstack.req.messge : any message
 331      * org.onap.appc.adapter.saltstack.req.Id : a unique uuid to reference the request
 332      */
 333     @Override
 334     public void reqExecSLSFile(Map<String, String> params, SvcLogicContext ctx) throws SvcLogicException {
 335         String reqID;
 336         SaltstackResult testResult;
 337         setSSHClient(params);
 338         reqID = messageProcessor.reqId(params);
 339         String slsFile = messageProcessor.reqSlsFile(params);
 340         String applyTo = messageProcessor.reqApplyToDevices(params);
 341         String commandToExecute = putToCommands(ctx, slsFile, reqID, applyTo);
 342         testResult = execCommand(params, commandToExecute);
 343         testResult = messageProcessor.parseResponse(ctx, reqID, testResult, true);
 344         checkResponseStatus(testResult, ctx, reqID, true);
 345     }
 346
 347     /**
 348      * Public method to get logs from saltState execution for a specific request Posts the following back
 349      * to Svc context memory
 350      * <p>
 351      * It blocks till the Saltstack Server responds or the session times out very similar to
 352      * reqExecResult logs are returned in the DG context variable org.onap.appc.adapter.saltstack.log
 353      */
 354     @Override
 355     public void reqExecLog(Map<String, String> params, SvcLogicContext ctx) throws SvcLogicException {
 356         //TODO: to implement
 357
 358     }
 359
 360     public SaltstackResult execCommand(Map<String, String> params, String commandToExecute) {
 361         SaltstackResult testResult;
 362         if (params.get(CONNECTION_RETRY_DELAY) != null && params.get(CONNECTION_RETRY_COUNT) != null) {
 363             int retryDelay = Integer.parseInt(params.get(CONNECTION_RETRY_DELAY));
 364             int retryCount = Integer.parseInt(params.get(CONNECTION_RETRY_COUNT));
 365             if (!testMode) {
 366                 testResult = sshClient.connectNExecute(commandToExecute, retryCount, retryDelay);
 367             } else {
 368                 testResult = testServer.MockReqExec(params);
 369             }
 370         } else {
 371             if (!testMode) {
 372                 testResult = sshClient.connectNExecute(commandToExecute);
 373             } else {
 374                 testResult = testServer.MockReqExec(params);
 375             }
 376         }
 377         return testResult;
 378     }
 379 }