com.vmware.operations.DelayOp Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of test-operations Show documentation
There is a newer version: 1.2.1
/*
 * Copyright (c) 2015-2018 VMware, Inc. All Rights Reserved.
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * 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.
 */

package com.vmware.operations;

import java.time.Duration;
import java.util.concurrent.atomic.AtomicBoolean;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * A generic operation implementation that uses dynamic function calls
 * for execute and revert.
 * 
 * This allows for dynamic operations, or linking two operations together.
 */
public class DelayOp extends OperationSyncBase {
    private static final Logger logger = LoggerFactory.getLogger(DelayOp.class);

    // Maximum delay is 100 minutes
    private static final long maximumDelayMs = 100 * 60 * 1000L;

    private long executeDelayMs;
    private long revertDelayMs;
    private AtomicBoolean isExecuted = new AtomicBoolean();

    /**
     * Constructor of the delay operation.
     */
    public DelayOp() {
        super(Operations.getExecutorService());
        executeDelayMs = 0L;
        revertDelayMs = 0L;
    }

    /**
     * Alternate constructor for the most basic case of delaying the execution.
     *
     * @param d delay time expressed as a {@link java.time.Duration}
     */
    public DelayOp(Duration d) {
        super(Operations.getExecutorService());

        this.executeDelay(d);
        revertDelayMs = 0L;
    }

    /**
     * Set the delay during execution.
     *
     * @param d delay time expressed as a {@link java.time.Duration}
     * @return fluent operation returns itself
     */
    public DelayOp executeDelay(Duration d) {
        long millis = d.toMillis();
        if (millis < 0L) {
            logger.error("delay must be greater than 0 ms.");
            millis = 0;
        } else if (millis > maximumDelayMs) {
            logger.error("delay must be less than " + maximumDelayMs + " ms.");
            millis = maximumDelayMs;
        }
        this.executeDelayMs = millis;
        return this;
    }

    /**
     * Get the delay during execution.
     * @return Duration value for the execution delay
     */
    public Duration getExecuteDelay() {
        return Duration.ofMillis(executeDelayMs);
    }

    /**
     * Set the delay during revert.
     *
     * @param d delay time expressed as a {@link java.time.Duration}
     * @return fluent operation returns itself
     */
    public DelayOp revertDelay(Duration d) {
        long millis = d.toMillis();
        if (millis < 0L) {
            logger.error("delay must be greater than 0 ms.");
            millis = 0;
        } else if (millis > maximumDelayMs) {
            logger.error("delay must be less than " + maximumDelayMs + " ms.");
            millis = maximumDelayMs;
        }
        this.revertDelayMs = millis;
        return this;
    }

    /**
     * Get the delay during revert.
     * @return Duration value for the revert delay
     */
    public Duration getRevertDelay() {
        return Duration.ofMillis(revertDelayMs);
    }

    @Override
    public boolean isExecuted() {
        return isExecuted.get();
    }

    @Override
    public void executeImpl() throws InterruptedException {
        logger.info("Executing {} for {} ms", toString(), executeDelayMs);

        throwIfExecuted();
        if (executeDelayMs > 0L) {
            Thread.sleep(executeDelayMs);
        }

        if (!isExecuted.compareAndSet(false, true)) {
            throw new AssertionError("Error setting isExecuted true");
        }
    }

    @Override
    public void revertImpl() throws InterruptedException {
        logger.info("Executing {} for {} ms", toString(), revertDelayMs);

        throwIfNotExecuted();
        if (revertDelayMs > 0) {
            Thread.sleep(revertDelayMs);
        }

        if (!isExecuted.compareAndSet(true, false)) {
            throw new AssertionError("Error setting isExecuted false");
        }
    }


    @Override
    public String toString() {
        return getClass().getSimpleName();
    }
}