actions/src/core/dotnet-tool.ts

import * as fs from "fs";
import * as os from "os";
import * as path from "path";
import * as http from "typed-rest-client/HttpClient";

import { inject, injectable } from "inversify";
import { TYPES, IExecResult, IBuildAgent } from "./models";
import { IVersionManager } from "./versionManager";

export interface IDotnetTool {
    disableTelemetry(): void;
    toolInstall(toolName: string, versionSpec: string, checkLatest: boolean, includePre: boolean): Promise<string>;
}

@injectable()
export class DotnetTool implements IDotnetTool {

    protected buildAgent: IBuildAgent;
    protected versionManager: IVersionManager;
    private httpClient: http.HttpClient;

    constructor(
        @inject(TYPES.IBuildAgent) buildAgent: IBuildAgent,
        @inject(TYPES.IVersionManager) versionManager: IVersionManager,
    ) {
        this.buildAgent = buildAgent;
        this.versionManager = versionManager;
        this.httpClient = new http.HttpClient("dotnet");
    }

    public disableTelemetry(): void {
        this.buildAgent.exportVariable("DOTNET_CLI_TELEMETRY_OPTOUT", "1");
    }

    public execute(cmd: string, args: string[]): Promise<IExecResult> {
        console.log(`Command: ${cmd} ${args.join(' ')}`);
        return this.buildAgent.exec(cmd, args);
    }

    public async toolInstall(toolName: string, versionSpec: string, checkLatest: boolean, includePre: boolean)
    : Promise<string> {
        console.log("");
        console.log("--------------------------");
        console.log(`Installing ${toolName} version ` + versionSpec);
        console.log("--------------------------");

        if (this.versionManager.isExplicitVersion(versionSpec)) {
            checkLatest = false; // check latest doesn't make sense when explicit version
        }

        let toolPath: string;
        if (!checkLatest) {
            //
            // Let's try and resolve the version spec locally first
            //
            toolPath = this.buildAgent.find(toolName, versionSpec);
        }

        if (!toolPath) {
            let version: string;
            if (this.versionManager.isExplicitVersion(versionSpec)) {
                //
                // Explicit version was specified. No need to query for list of versions.
                //
                version = versionSpec;
            } else {
                //
                // Let's query and resolve the latest version for the versionSpec.
                // If the version is an explicit version (1.1.1 or v1.1.1) then no need to query.
                // If your tool doesn't offer a mechanism to query,
                // then it can only support exact version inputs.
                //
                version = await this.queryLatestMatch(toolName, versionSpec, includePre);
                if (!version) {
                    throw new Error(`Unable to find ${toolName} version '${versionSpec}'.`);
                }

                //
                // Check the cache for the resolved version.
                //
                toolPath = this.buildAgent.find(toolName, version);
            }
            if (!toolPath) {
                //
                // Download, extract, cache
                //
                toolPath = await this.acquireTool(toolName, version);
            }
        }

        //
        // Prepend the tools path. This prepends the PATH for the current process and
        // instructs the agent to prepend for each task that follows.
        //
        this.buildAgent.debug(`toolPath: ${toolPath}`);

        if (os.platform() !== "win32" && !this.buildAgent.getVariable("DOTNET_ROOT")) {
            let dotnetPath = await this.buildAgent.which("dotnet");
            dotnetPath = fs.readlinkSync(dotnetPath) || dotnetPath;
            const dotnetRoot = path.dirname(dotnetPath);
            this.buildAgent.exportVariable("DOTNET_ROOT", dotnetRoot);
        }
        this.buildAgent.addPath(toolPath);

        return toolPath;
    }

    private async queryLatestMatch(toolName: string, versionSpec: string, includePrerelease: boolean): Promise<string> {
        this.buildAgent.debug(`querying tool versions for ${toolName}${versionSpec ? `@${versionSpec}` : ""} ${includePrerelease ? "including pre-releases" : ""}`);

        const downloadPath = `https://api-v2v3search-0.nuget.org/query?q=${encodeURIComponent(toolName.toLowerCase())}&prerelease=${includePrerelease ? "true" : "false"}&semVerLevel=2.0.0`;
        const res = await this.httpClient.get(downloadPath);

        if (!res || res.message.statusCode !== 200) {
            return null;
        }

        const body: string = await res.readBody();
        const data = JSON.parse(body).data;

        const versions = (data[0].versions as { version: string }[]).map((x) => x.version);
        if (!versions || !versions.length) {
            return null;
        }

        this.buildAgent.debug(`got versions: ${versions.join(", ")}`);

        return this.versionManager.evaluateVersions(versions, versionSpec);
    }

    private async acquireTool(toolName: string, version: string): Promise<string> {

        const tempDirectory = await this.buildAgent.createTempDir();
        let args = ["tool", "install", toolName, "--tool-path", tempDirectory];

        if (version) {
            version = this.versionManager.cleanVersion(version);
            args = args.concat(["--version", version]);
        }

        const result = await this.execute("dotnet", args);
        const status = result.code === 0 ? "success" : "failure";
        const message = result.code === 0 ? result.stdout : result.stderr;

        this.buildAgent.debug(`tool install result: ${status} ${message}`);

        if (result.code) {
            throw new Error("Error installing tool");
        }

        return await this.buildAgent.cacheDir(tempDirectory, toolName, version);
    }
}