com.tascape.reactor.SuiteRunner Maven / Gradle / Ivy

/*
 * Copyright 2015 - 2016 Nebula Bay.
 *
 * 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.tascape.reactor;

import com.google.common.util.concurrent.ThreadFactoryBuilder;
import com.tascape.reactor.db.DbHandler;
import com.tascape.reactor.db.SuiteProperty;
import com.tascape.reactor.db.TaskCase;
import com.tascape.reactor.db.CaseResult;
import com.tascape.reactor.exception.SuiteEnvironmentException;
import com.tascape.reactor.suite.AbstractSuite;
import java.io.File;
import java.io.IOException;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.CompletionService;
import java.util.concurrent.ExecutorCompletionService;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.concurrent.ThreadFactory;
import javax.xml.stream.XMLStreamException;
import org.apache.commons.io.FileUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 *
 * @author linsong wang
 */
public class SuiteRunner {
    private static final Logger LOG = LoggerFactory.getLogger(SuiteRunner.class);

    private TaskSuite ts = null;

    private DbHandler db = null;

    private final SystemConfiguration SYS_CONFIG = SystemConfiguration.getInstance();

    private final String execId = SYS_CONFIG.getExecId();

    private static final Map UNSUPPORTED_CASES = new HashMap<>();

    public synchronized static void addUnspportedCase(TaskCase tc) {
        UNSUPPORTED_CASES.put(tc.format(), tc);
    }

    public SuiteRunner(TaskSuite taskSuite) throws Exception {
        LOG.debug("Run suite with execution id {}", execId);
        this.ts = taskSuite;

        this.db = DbHandler.getInstance();
        db.queueSuiteExecution(ts, this.execId);
    }

    @SuppressWarnings("UseSpecificCatch")
    public int runCases() throws IOException, InterruptedException, SQLException, XMLStreamException {
        File dir = SYS_CONFIG.getLogPath().resolve(execId).toFile();
        LOG.debug("Create suite execution log directory {}", dir);
        if (!dir.exists() && !dir.mkdirs()) {
            throw new IOException("Cannot create directory " + dir);
        }
        ExecutorService executorService = this.getExecutorService();
        CompletionService completionService = new ExecutorCompletionService<>(executorService);

        this.saveExectionProperties(dir);
        LOG.debug("Start to acquire cases to execute");
        int loadLimit = SYS_CONFIG.getCaseLoadLimit();
        LOG.debug("Load queued cases {} per round", loadLimit);

        int numberOfFailures = 0;
        try {
            List tcrs = this.filter(this.db.getQueuedCaseResults(this.execId, loadLimit));
            while (!tcrs.isEmpty()) {
                List> futures = new ArrayList<>();

                for (CaseResult tcr : tcrs) {
                    LOG.debug("Submit case {}", tcr.getTaskCase().format());
                    futures.add(completionService.submit(new CaseRunnerJUnit4(db, tcr)));
                }
                LOG.debug("Total {} cases submitted", futures.size());

                for (Future f : futures) {
                    try {
                        Future future = completionService.take();
                        CaseResult tcr = future.get();
                        String result = tcr.getResult().result();
                        LOG.debug("Get result of case {} - {}", tcr.getTaskCase().format(), result);
                        if (!ExecutionResult.PASS.getName().equals(result) && !result.endsWith("/0")) {
                            numberOfFailures++;
                        }
                    } catch (Throwable ex) {
                        LOG.error("Error executing case thread", ex);
                        numberOfFailures++;
                    }
                }

                tcrs = this.filter(this.db.getQueuedCaseResults(this.execId, 100));
            }
            String productUnderTask = "NA";
            try {
                LOG.debug("Getting suite-under-task");
                if (AbstractSuite.getSuites().isEmpty()) {
                    throw new SuiteEnvironmentException("Cannot setup suite environment");
                }
                productUnderTask = AbstractSuite.getSuites().get(0).getProductUnderTask();
            } catch (Exception ex) {
                LOG.warn("Cannot get product-under-task", ex);
            } finally {
                LOG.debug("No more case to run on this host, updating suite execution result");
                this.db.updateSuiteExecutionResult(this.execId, productUnderTask);
                this.db.adjustSuiteExecutionResult(execId);
            }
        } finally {
            AbstractSuite.getSuites().stream().forEach((AbstractSuite suite) -> {
                try {
                    suite.tearDown();
                } catch (Exception ex) {
                    LOG.warn("Error tearing down suite {}", suite.getClass(), ex);
                }
            });
        }
        executorService.shutdown();

        this.db.exportToJson(this.execId);
        this.db.saveJunitXml(this.execId);
        return numberOfFailures;
    }

    private void saveExectionProperties(File dir) throws IOException, SQLException {
        File props = new File(dir, "execution.properties");
        SYS_CONFIG.getProperties().store(FileUtils.openOutputStream(props), Reactor.class.getName());

        List sps = new ArrayList<>();
        SYS_CONFIG.getProperties().entrySet().stream()
            .filter(key -> !key.toString().startsWith("reactor.db."))
            .forEach(entry -> {
                SuiteProperty sp = new SuiteProperty();
                sp.setSuiteResultId(this.execId);
                sp.setPropertyName(entry.getKey().toString());
                sp.setPropertyValue(entry.getValue().toString());
                sps.add(sp);
            });
        this.db.setSuiteExecutionProperties(sps);
    }

    private ExecutorService getExecutorService() {
        int tc = SYS_CONFIG.getExecutionThreadCount();
        LOG.debug("thread count {}", tc);
        if (tc < 0) {
            throw new RuntimeException("Invalid execution thread number");
        }
        int env = ts.getNumberOfEnvs();
        LOG.debug("number of environment(s) {}", env);
        if (env < 0) {
            throw new RuntimeException("Invalid execution environment number");
        }
        int threadCount = (tc == 0) ? (env == 0 ? 1 : env) : (env == 0 ? tc : Math.min(tc, env));
        LOG.debug("Start execution engine with {} thread(s)", threadCount);
        SYS_CONFIG.setExecutionThreadCount(threadCount);
        int len = ((threadCount - 1) + "").length();
        ThreadFactory namedThreadFactory = new ThreadFactoryBuilder().setNameFormat("th%0" + len + "d").build();
        ExecutorService executorService = Executors.newFixedThreadPool(threadCount, namedThreadFactory);
        return executorService;
    }

    private List filter(List tcrs) {
        List tcrs0 = new ArrayList<>();
        tcrs.stream().filter((tcr) -> (UNSUPPORTED_CASES.get(tcr.getTaskCase().format()) == null)).forEach((tcr) -> {
            tcrs0.add(tcr);
        });

        if (SystemConfiguration.getInstance().isShuffleCases()) {
            LOG.debug("do case shuffle");
            Collections.shuffle(tcrs0);
        }
        return tcrs0;
    }
}