appc-adapters/appc-iaas-adapter/appc-iaas-adapter-bundle/src/main/java/org/openecomp/appc/adapter/iaas/provider/operation/impl/RestartServer.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.openecomp.appc.adapter.iaas.provider.operation.impl;
  26
  27 import com.att.cdp.exceptions.ResourceNotFoundException;
  28 import com.att.cdp.exceptions.ZoneException;
  29 import com.att.cdp.zones.Context;
  30 import com.att.cdp.zones.model.ModelObject;
  31 import com.att.cdp.zones.model.Server;
  32 import com.att.eelf.configuration.EELFLogger;
  33 import com.att.eelf.configuration.EELFManager;
  34 import com.att.eelf.i18n.EELFResourceManager;
  35 import org.glassfish.grizzly.http.util.HttpStatus;
  36 import org.openecomp.appc.Constants;
  37 import org.openecomp.appc.adapter.iaas.ProviderAdapter;
  38 import org.openecomp.appc.adapter.iaas.impl.IdentityURL;
  39 import org.openecomp.appc.adapter.iaas.impl.RequestContext;
  40 import org.openecomp.appc.adapter.iaas.impl.RequestFailedException;
  41 import org.openecomp.appc.adapter.iaas.impl.VMURL;
  42 import org.openecomp.appc.adapter.iaas.provider.operation.common.enums.Outcome;
  43 import org.openecomp.appc.adapter.iaas.provider.operation.impl.base.ProviderServerOperation;
  44 import org.openecomp.appc.exceptions.UnknownProviderException;
  45 import org.openecomp.appc.i18n.Msg;
  46 import org.openecomp.sdnc.sli.SvcLogicContext;
  47 import org.slf4j.MDC;
  48
  49 import java.text.DateFormat;
  50 import java.text.SimpleDateFormat;
  51 import java.util.Date;
  52 import java.util.Map;
  53 import java.util.TimeZone;
  54
  55 import static org.openecomp.appc.adapter.iaas.provider.operation.common.enums.Operation.RESTART_SERVICE;
  56 import static org.openecomp.appc.adapter.utils.Constants.ADAPTER_NAME;
  57
  58 public class RestartServer extends ProviderServerOperation {
  59
  60     private static final EELFLogger logger = EELFManager.getInstance().getLogger(RestartServer.class);
  61     private static EELFLogger metricsLogger = EELFManager.getInstance().getMetricsLogger();
  62
  63
  64     /**
  65      * This method handles the case of restarting a server once we have found the server and have obtained the abstract
  66      * representation of the server via the context (i.e., the "Server" object from the CDP-Zones abstraction).
  67      *
  68      * @param rc     The request context that manages the state and recovery of the request for the life of
  69      *               its processing.
  70      * @param server The server object representing the server we want to operate on
  71      * @throws ZoneException when error occurs.
  72      * @throws RequestFailedException when server status is error.
  73      */
  74     @SuppressWarnings("nls")
  75     private void restartServer(RequestContext rc, Server server, SvcLogicContext ctx)
  76             throws ZoneException, RequestFailedException {
  77         /*
  78          * Pending is a bit of a special case. If we find the server is in a
  79          * pending state, then the provider is in the process of changing state
  80          * of the server. So, lets try to wait a little bit and see if the state
  81          * settles down to one we can deal with. If not, then we have to fail
  82          * the request.
  83          */
  84         String msg;
  85         if (server.getStatus().equals(Server.Status.PENDING)) {
  86             waitForStateChange(rc, server, Server.Status.READY, Server.Status.RUNNING, Server.Status.ERROR,
  87                     Server.Status.SUSPENDED, Server.Status.PAUSED);
  88         }
  89
  90         setTimeForMetricsLogger("restart server");
  91
  92         String skipHypervisorCheck = null;
  93         if (ctx != null) {
  94             skipHypervisorCheck = ctx.getAttribute(ProviderAdapter.SKIP_HYPERVISOR_CHECK);
  95         }
  96
  97         // Always perform Virtual Machine/Hypervisor Status/Network checks
  98         // unless the skip is set to true
  99         if (skipHypervisorCheck == null || (!skipHypervisorCheck.equalsIgnoreCase("true"))) {
 100             // Check of the Hypervisor for the VM Server is UP and reachable
 101             checkHypervisor(server);
 102         }
 103
 104         /*
 105          * We determine what to do based on the current state of the server
 106          */
 107         switch (server.getStatus()) {
 108             case DELETED:
 109                 // Nothing to do, the server is gone
 110                 msg = EELFResourceManager.format(Msg.SERVER_DELETED, server.getName(), server.getId(),
 111                         server.getTenantId(), "restarted");
 112                 generateEvent(rc, false, msg);
 113                 logger.error(msg);
 114                 metricsLogger.error(msg);
 115                 break;
 116
 117             case RUNNING:
 118                 // Attempt to stop and start the server
 119                 stopServer(rc, server);
 120                 startServer(rc, server);
 121                 generateEvent(rc, true, Outcome.SUCCESS.toString());
 122                 metricsLogger.info("Server status: RUNNING");
 123                 break;
 124
 125             case ERROR:
 126                 msg = EELFResourceManager.format(Msg.SERVER_ERROR_STATE, server.getName(), server.getId(),
 127                         server.getTenantId(), "rebuild");
 128                 generateEvent(rc, false, msg);
 129                 logger.error(msg);
 130                 metricsLogger.error(msg);
 131                 throw new RequestFailedException("Rebuild Server", msg, HttpStatus.METHOD_NOT_ALLOWED_405, server);
 132
 133             case READY:
 134                 // Attempt to start the server
 135                 startServer(rc, server);
 136                 generateEvent(rc, true, Outcome.SUCCESS.toString());
 137                 metricsLogger.info("Server status: READY");
 138                 break;
 139
 140             case PAUSED:
 141                 // if paused, un-pause it
 142                 unpauseServer(rc, server);
 143                 generateEvent(rc, true, Outcome.SUCCESS.toString());
 144                 metricsLogger.info("Server status: PAUSED");
 145                 break;
 146
 147             case SUSPENDED:
 148                 // Attempt to resume the suspended server
 149                 resumeServer(rc, server);
 150                 generateEvent(rc, true, Outcome.SUCCESS.toString());
 151                 metricsLogger.info("Server status: SUSPENDED");
 152                 break;
 153
 154             default:
 155                 // Hmmm, unknown status, should never occur
 156                 msg = EELFResourceManager.format(Msg.UNKNOWN_SERVER_STATE, server.getName(), server.getId(),
 157                         server.getTenantId(), server.getStatus().name());
 158                 generateEvent(rc, false, msg);
 159                 logger.error(msg);
 160                 metricsLogger.error(msg);
 161                 break;
 162         }
 163
 164
 165     }
 166
 167     /**
 168      * This method is used to restart an existing virtual machine given the fully qualified URL of the machine.
 169      * <p>
 170      * The fully qualified URL contains enough information to locate the appropriate server. The URL is of the form
 171      * <pre>
 172      *  [scheme]://[host[:port]] / [path] / [tenant_id] / servers / [vm_id]
 173      * </pre> Where the various parts of the URL can be parsed and extracted and used to locate the appropriate service
 174      * in the provider service catalog. This then allows us to open a context using the CDP abstraction, obtain the
 175      * server by its UUID, and then perform the restart.
 176      * </p>
 177      *
 178      * @throws UnknownProviderException If the provider cannot be found
 179      * @throws IllegalArgumentException if the expected argument(s) are not defined or are invalid
 180      * @see org.openecomp.appc.adapter.iaas.ProviderAdapter#restartServer(java.util.Map, org.openecomp.sdnc.sli.SvcLogicContext)
 181      */
 182     @SuppressWarnings("nls")
 183     private Server restartServer(Map<String, String> params, SvcLogicContext ctx)
 184             throws UnknownProviderException, IllegalArgumentException {
 185         Server server = null;
 186         RequestContext rc = new RequestContext(ctx);
 187         rc.isAlive();
 188
 189         String appName = configuration.getProperty(Constants.PROPERTY_APPLICATION_NAME);
 190
 191         /*
 192          * Set Time for Metrics Logger
 193          */
 194         setTimeForMetricsLogger("GET server status");
 195
 196         ctx.setAttribute("RESTART_STATUS", "ERROR");
 197         try {
 198             validateParametersExist(params, ProviderAdapter.PROPERTY_INSTANCE_URL,
 199                     ProviderAdapter.PROPERTY_PROVIDER_NAME);
 200
 201             String vm_url = params.get(ProviderAdapter.PROPERTY_INSTANCE_URL);
 202
 203             VMURL vm = VMURL.parseURL(vm_url);
 204             if (validateVM(rc, appName, vm_url, vm)) return null;
 205
 206             IdentityURL ident = IdentityURL.parseURL(params.get(ProviderAdapter.PROPERTY_IDENTITY_URL));
 207             String identStr = (ident == null) ? null : ident.toString();
 208
 209             Context context = null;
 210             try {
 211                 context = getContext(rc, vm_url, identStr);
 212                 if (context != null) {
 213                     rc.reset();
 214                     server = lookupServer(rc, context, vm.getServerId());
 215                     logger.debug(Msg.SERVER_FOUND, vm_url, context.getTenantName(), server.getStatus().toString());
 216                     rc.reset();
 217                     restartServer(rc, server, ctx);
 218                     context.close();
 219                     doSuccess(rc);
 220                     ctx.setAttribute("RESTART_STATUS", "SUCCESS");
 221                     String msg = EELFResourceManager.format(Msg.SUCCESS_EVENT_MESSAGE,
 222                             "RestartServer", vm_url);
 223                     ctx.setAttribute(org.openecomp.appc.Constants.ATTRIBUTE_SUCCESS_MESSAGE, msg);
 224                 }
 225             } catch (RequestFailedException e) {
 226                 doFailure(rc, e.getStatus(), e.getMessage());
 227             } catch (ResourceNotFoundException e) {
 228                 String msg = EELFResourceManager.format(Msg.SERVER_NOT_FOUND, e, vm_url);
 229                 logger.error(msg);
 230                 metricsLogger.error(msg);
 231                 doFailure(rc, HttpStatus.NOT_FOUND_404, msg);
 232             } catch (Exception e1) {
 233                 String msg = EELFResourceManager.format(Msg.SERVER_OPERATION_EXCEPTION, e1, e1.getClass().getSimpleName(),
 234                         RESTART_SERVICE.toString(), vm_url, context == null ? "Unknown" : context.getTenantName());
 235                 logger.error(msg, e1);
 236                 metricsLogger.error(msg, e1);
 237                 doFailure(rc, HttpStatus.INTERNAL_SERVER_ERROR_500, msg);
 238             }
 239         } catch (RequestFailedException e) {
 240             doFailure(rc, e.getStatus(), e.getMessage());
 241         }
 242
 243         return server;
 244     }
 245
 246     @Override
 247     protected ModelObject executeProviderOperation(Map<String, String> params, SvcLogicContext context)
 248             throws UnknownProviderException {
 249         setMDC(RESTART_SERVICE.toString(), "App-C IaaS Adapter:Restart", ADAPTER_NAME);
 250         logOperation(Msg.RESTARTING_SERVER, params, context);
 251
 252         setTimeForMetricsLogger("execute restart");
 253
 254         metricsLogger.info("Executing Provider Operation: Restart");
 255
 256         return restartServer(params, context);
 257     }
 258
 259     private void setTimeForMetricsLogger(String targetServiceName) {
 260         long startTime = System.currentTimeMillis();
 261         TimeZone tz = TimeZone.getTimeZone("UTC");
 262         DateFormat df = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ssZ");
 263         df.setTimeZone(tz);
 264         long endTime = System.currentTimeMillis();
 265         long duration = endTime - startTime;
 266         String durationStr = String.valueOf(duration);
 267         String endTimeStrUTC = df.format(new Date());
 268         MDC.put("EndTimestamp", endTimeStrUTC);
 269         MDC.put("ElapsedTime", durationStr);
 270         MDC.put("TargetEntity", "cdp");
 271         MDC.put("TargetServiceName", targetServiceName);
 272         MDC.put("ClassName", "org.openecomp.appc.adapter.iaas.provider.operation.impl.RestartServer");
 273     }
 274 }