org.citrusframework.container.Parallel Maven / Gradle / Ivy

Go to download
/*
 * Copyright the original author or authors.
 *
 * 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 org.citrusframework.container;

import java.util.ArrayList;
import java.util.List;
import java.util.Stack;
import java.util.function.Consumer;

import org.citrusframework.AbstractTestContainerBuilder;
import org.citrusframework.TestAction;
import org.citrusframework.TestActionBuilder;
import org.citrusframework.context.TestContext;
import org.citrusframework.exceptions.CitrusRuntimeException;
import org.citrusframework.exceptions.ParallelContainerException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Test action will execute nested actions in parallel. Each action is executed in a
 * separate thread. Container joins all threads and waiting for them to end successfully.
 *
 */
public class Parallel extends AbstractActionContainer {

    /** Store created threads in stack */
    private final Stack threads = new Stack<>();

    /** Collect exceptions in list */
    private final List exceptions = new ArrayList<>();

    /** Logger */
    private static final Logger logger = LoggerFactory.getLogger(Parallel.class);

    /**
     * Default constructor.
     */
    public Parallel(Builder builder) {
        super("parallel", builder);
    }

    @Override
    public void doExecute(TestContext context) {
        for (TestActionBuilder actionBuilder : actions) {
            final TestAction action = actionBuilder.build();
            Thread t = new Thread(new ActionRunner(ctx -> executeAction(action, ctx), context, exceptions::add));
            threads.push(t);
            t.start();
        }

        while (!threads.isEmpty()) {
            try {
                threads.pop().join();
            } catch (InterruptedException e) {
                logger.error("Unable to join thread", e);
            }
        }

        if (!exceptions.isEmpty()) {
            if (exceptions.size() == 1) {
                throw exceptions.get(0);
            } else {
                throw new ParallelContainerException(exceptions);
            }
        }
    }

    /**
     * Runnable wrapper for executing an action in separate Thread.
     */
    private static class ActionRunner implements Runnable {
        /** Test action to execute */
        private final TestAction action;

        /** Test context */
        private final TestContext context;

        /** Exception handler */
        private final Consumer exceptionHandler;

        public ActionRunner(TestAction action, TestContext context, Consumer exceptionHandler) {
            this.action = action;
            this.context = context;
            this.exceptionHandler = exceptionHandler;
        }

        /**
         * Run the test action
         */
        public void run() {
            try {
                action.execute(context);
            } catch (CitrusRuntimeException e) {
                logger.error("Parallel test action raised error", e);
                exceptionHandler.accept(e);
            } catch (Exception | Error e) {
                logger.error("Parallel test action raised error", e);
                exceptionHandler.accept(new CitrusRuntimeException(e));
            }
        }
    }

    /**
     * Action builder.
     */
    public static class Builder extends AbstractTestContainerBuilder {

        /**
         * Fluent API action building entry method used in Java DSL.
         * @return
         */
        public static Builder parallel() {
            return new Builder();
        }

        @Override
        public Parallel doBuild() {
            return new Parallel(this);
        }
    }
}