@atomist/sdm/src/lib/api-helper/goal/progress/progress.ts

Atomist Software Delivery Machine SDK

/*
 * Copyright © 2018 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 { ReportProgress } from "../../../api/goal/progress/ReportProgress";

/**
 * Simple test to map between a RegExp and a phase.
 */
export interface ProgressTest {
    test: RegExp;
    phase: string;
}

/**
 * ReportProgress implementation that uses RexExp tests to extract progess
 * @param {ProgressTest} tests
 * @returns {ReportProgress}
 */
export function testProgressReporter(...tests: ProgressTest[]): ReportProgress {
    return log => {
        const test = tests.find(t => t.test.test(log));
        if (test) {
            let phase = test.phase;
            // Bail early
            if (!phase.includes("$1")) {
                return { phase };
            }

            const match = test.test.exec(log);
            let counter = 1;
            while (phase.includes(`$${counter}`) && match.length > counter) {
                phase = phase.replace(new RegExp( `\\$${counter}`, "gi"), match[counter]);
                counter++;
            }

            return { phase };
        }
        return {};
    };
}