@atomist/sdm/src/lib/api/goal/support/GoalScheduler.ts

Atomist Software Delivery Machine SDK

/*
 * Copyright © 2019 Atomist, Inc.
 *
 * 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.
 */

import { Configuration } from "@atomist/automation-client/lib/configuration";
import { ExecuteGoalResult } from "../ExecuteGoalResult";
import { GoalInvocation } from "../GoalInvocation";

/**
 * Schedule a goal in an environment (container or process) for fulfillment.
 */
export interface GoalScheduler {

    /**
     * Optionally initialize the GoalScheduler
     * @param configuration
     */
    initialize?(configuration: Configuration): Promise<void>;

    /**
     * Indicate if this GoalScheduler supports scheduling provided goal
     * @param gi
     */
    supports(gi: GoalInvocation): Promise<boolean>;

    /**
     * Schedule the provided goal
     * @param gi
     */
    schedule(gi: GoalInvocation): Promise<ExecuteGoalResult>;
}