com.intuit.karate.job.JobConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of karate-core Show documentation
The newest version!
/*
 * The MIT License
 *
 * Copyright 2022 Karate Labs Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.intuit.karate.job;

import com.intuit.karate.Constants;
import com.intuit.karate.FileUtils;
import java.io.File;
import java.util.Collections;
import java.util.List;
import java.util.Map;

/**
 *
 * @author pthomas3
 */
public interface JobConfig {

    String getHost();

    int getPort();

    int getExecutorCount();

    T handleUpload(JobChunk chunk, File file);

    default int getTimeoutMinutes() {
        return -1;
    }

    default String getSourcePath() {
        return "";
    }

    default String getExecutorDir() {
        return FileUtils.getBuildDir() + File.separator + Constants.KARATE_REPORTS;
    }

    String getExecutorCommand(String jobId, String jobUrl, int index);    

    void onStart(String jobId, String jobUrl);

    void onStop();

    Map getEnvironment();

    List getStartupCommands();

    default List getShutdownCommands() {
        return Collections.EMPTY_LIST;
    }

    List getMainCommands(JobChunk jc);

    default List getPreCommands(JobChunk jc) {
        return Collections.EMPTY_LIST;
    }

    default List getPostCommands(JobChunk jc) {
        return Collections.EMPTY_LIST;
    }

    default List getInitialChunks() {
        return Collections.EMPTY_LIST;
    }

}