codeql-action/lib/runner.js

"use strict";
var __importStar = (this && this.__importStar) || function (mod) {
    if (mod && mod.__esModule) return mod;
    var result = {};
    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
    result["default"] = mod;
    return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
const commander_1 = require("commander");
const fs = __importStar(require("fs"));
const os = __importStar(require("os"));
const path = __importStar(require("path"));
const analyze_1 = require("./analyze");
const autobuild_1 = require("./autobuild");
const codeql_1 = require("./codeql");
const init_1 = require("./init");
const languages_1 = require("./languages");
const logging_1 = require("./logging");
const repository_1 = require("./repository");
const upload_lib = __importStar(require("./upload-lib"));
const program = new commander_1.Command();
program.version('0.0.1');
function parseGithubUrl(inputUrl) {
    try {
        const url = new URL(inputUrl);
        // If we detect this is trying to be to github.com
        // then return with a fixed canonical URL.
        if (url.hostname === 'github.com' || url.hostname === 'api.github.com') {
            return 'https://github.com';
        }
        // Remove the API prefix if it's present
        if (url.pathname.indexOf('/api/v3') !== -1) {
            url.pathname = url.pathname.substring(0, url.pathname.indexOf('/api/v3'));
        }
        return url.toString();
    }
    catch (e) {
        throw new Error(`"${inputUrl}" is not a valid URL`);
    }
}
function getTempDir(userInput) {
    const tempDir = path.join(userInput || os.tmpdir(), 'codeql-runner-temp');
    if (!fs.existsSync(tempDir)) {
        fs.mkdirSync(tempDir, { recursive: true });
    }
    return tempDir;
}
function getToolsDir(userInput, tmpDir) {
    const toolsDir = path.join(userInput || path.dirname(tmpDir), 'codeql-runner-tools');
    if (!fs.existsSync(toolsDir)) {
        fs.mkdirSync(toolsDir, { recursive: true });
    }
    return toolsDir;
}
const logger = logging_1.getRunnerLogger();
program
    .command('init')
    .description('Initializes CodeQL')
    .requiredOption('--github-url <url>', 'URL of GitHub instance')
    .requiredOption('--github-auth <auth>', 'GitHub Apps token, or of the form "username:token" if using a personal access token')
    .option('--languages <languages>', 'Comma-separated list of languages to analyze. Defaults to trying to detect languages from the repo.')
    .option('--queries <queries>', 'Comma-separated list of additional queries to run. By default, this overrides the same setting in a configuration file.')
    .option('--config-file <file>', 'Path to config file')
    .option('--codeql-path <path>', 'Path to a copy of the CodeQL CLI executable to use. Otherwise downloads a copy.')
    .option('--temp-dir <dir>', 'Directory to use for temporary files. Defaults to OS temp dir.')
    .option('--tools-dir <dir>', 'Directory to use for CodeQL tools and other files to store between runs. Defaults to same as temp dir.')
    .option('--checkout-path <path>', 'Checkout path (default: current working directory)')
    .action(async (cmd) => {
    try {
        const tempDir = getTempDir(cmd.tempDir);
        const toolsDir = getToolsDir(cmd.toolsDir, tempDir);
        // Wipe the temp dir
        fs.rmdirSync(tempDir, { recursive: true });
        fs.mkdirSync(tempDir, { recursive: true });
        let codeql;
        if (cmd.codeqlPath !== undefined) {
            codeql = codeql_1.getCodeQL(cmd.codeqlPath);
        }
        else {
            codeql = await init_1.initCodeQL(undefined, cmd.githubAuth, parseGithubUrl(cmd.githubUrl), tempDir, toolsDir, 'runner', logger);
        }
        const config = await init_1.initConfig(cmd.languages, cmd.queries, cmd.configFile, tempDir, toolsDir, codeql, cmd.checkoutPath || process.cwd(), cmd.githubAuth, parseGithubUrl(cmd.githubUrl), logger);
        await init_1.runInit(codeql, config);
    }
    catch (e) {
        logger.error('Init failed');
        logger.error(e);
        process.exitCode = 1;
    }
});
program
    .command('autobuild')
    .description('Attempts to automatically build code')
    .requiredOption('--language <language>', 'The language to build')
    .option('--temp-dir <dir>', 'Directory to use for temporary files. Defaults to OS temp dir.')
    .action(async (cmd) => {
    try {
        const language = languages_1.parseLanguage(cmd.language);
        if (language === undefined) {
            throw new Error(`"${cmd.language}" is not a recognised language`);
        }
        await autobuild_1.runAutobuild(language, getTempDir(cmd.tempDir), logger);
    }
    catch (e) {
        logger.error('Autobuild failed');
        logger.error(e);
        process.exitCode = 1;
    }
});
program
    .command('analyze')
    .description('Finishes extracting code and runs CodeQL queries')
    .requiredOption('--repository <repository>', 'Repository name')
    .requiredOption('--commit <commit>', 'SHA of commit that was analyzed')
    .requiredOption('--ref <ref>', 'Name of ref that was analyzed')
    .requiredOption('--github-url <url>', 'URL of GitHub instance')
    .requiredOption('--github-auth <auth>', 'GitHub Apps token, or of the form "username:token" if using a personal access token')
    .option('--checkout-path <path>', 'Checkout path (default: current working directory)')
    .option('--no-upload', 'Do not upload results after analysis', false)
    .option('--output-dir <dir>', 'Directory to output SARIF files to. By default will use temp directory.')
    .option('--temp-dir <dir>', 'Directory to use for temporary files. Defaults to OS temp dir.')
    .action(async (cmd) => {
    try {
        const tempDir = getTempDir(cmd.tempDir);
        const outputDir = cmd.outputDir || path.join(tempDir, 'codeql-sarif');
        await analyze_1.runAnalyze(repository_1.parseRepositoryNwo(cmd.repository), cmd.commit, cmd.ref, undefined, undefined, undefined, cmd.checkoutPath || process.cwd(), undefined, cmd.githubAuth, parseGithubUrl(cmd.githubUrl), cmd.upload, 'runner', outputDir, tempDir, logger);
    }
    catch (e) {
        logger.error('Upload failed');
        logger.error(e);
        process.exitCode = 1;
    }
});
program
    .command('upload')
    .description('Uploads a SARIF file, or all SARIF files from a directory, to code scanning')
    .requiredOption('--sarif-file <file>', 'SARIF file to upload; can also be a directory for uploading multiple')
    .requiredOption('--repository <repository>', 'Repository name')
    .requiredOption('--commit <commit>', 'SHA of commit that was analyzed')
    .requiredOption('--ref <ref>', 'Name of ref that was analyzed')
    .requiredOption('--github-url <url>', 'URL of GitHub instance')
    .requiredOption('--github-auth <auth>', 'GitHub Apps token, or of the form "username:token" if using a personal access token')
    .option('--checkout-path <path>', 'Checkout path (default: current working directory)')
    .action(async (cmd) => {
    try {
        await upload_lib.upload(cmd.sarifFile, repository_1.parseRepositoryNwo(cmd.repository), cmd.commit, cmd.ref, undefined, undefined, undefined, cmd.checkoutPath || process.cwd(), undefined, cmd.githubAuth, parseGithubUrl(cmd.githubUrl), 'runner', logger);
    }
    catch (e) {
        logger.error('Upload failed');
        logger.error(e);
        process.exitCode = 1;
    }
});
program.parse(process.argv);
//# sourceMappingURL=runner.js.map