@atomist/sdm/src/lib/api-helper/pushtest/materialChangeTest.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 { logger } from "@atomist/automation-client/lib/util/logger";
import * as micromatch from "micromatch";
import { DefaultGoalNameGenerator } from "../../api/goal/GoalNameGenerator";
import {
    pushTest,
    PushTest,
} from "../../api/mapping/PushTest";
import {
    anyFileChangedSuchThat,
    anyFileChangedWithExtension,
    filesChangedSince,
} from "../misc/git/filesChangedSince";

/**
 * Options to pass to the IsMaterialChange push test
 */
export interface MaterialChangeOptions {

    /**
     * File extensions to watch for
     */
    extensions?: string[];

    /**
     * File paths to watch for
     */
    files?: string[];

    /**
     * Directory paths to watch for
     * Note: This matches on subdirectories
     */
    directories?: string[];

    /**
     * Glob patters to watch for
     */
    globs?: string[];
}

/**
 * Check if a Push represents a material change.
 *
 * Material changes are changes to files that should trigger certain activity
 * or goals. Often simple changes to MD or html files should not trigger a full CI/CD process.
 */
export function isMaterialChange(options: MaterialChangeOptions = {}): PushTest {
    return pushTest(DefaultGoalNameGenerator.generateName("material-change"), async pci => {

        const changedFiles = await filesChangedSince(pci.project, pci.push);

        if (!changedFiles) {
            logger.debug(
                "Cannot determine if change is material on '%s/%s'. Failed to enumerate changed files",
                pci.id.owner,
                pci.id.repo);
            return true;
        }

        logger.debug(`Changed files: '${changedFiles.join(", ")}'`);
        if (anyFileChanged(options, changedFiles)) {
            logger.debug("Change is material on '%s/%s'", pci.id.owner, pci.id.repo);
            return true;
        } else {
            logger.debug("Change is immaterial on '%s/%s'", pci.id.owner, pci.id.repo);
        }
        return false;
    });
}

export function anyFileChanged(options: MaterialChangeOptions = {},
                               changedFiles: string[]): boolean {
    return anyFileChangedWithExtension(changedFiles, options.extensions || []) ||
        anyFileChangedSuchThat(changedFiles,
            path => (options.files || []).some(f => path === f)) ||
        anyFileChangedSuchThat(changedFiles,
                               path => (options.directories || []).some(d => path.startsWith(d))) ||
        micromatch(changedFiles, options.globs || []).length > 0;
}