Method downloadIncludeComponent

src/parser-includes.ts:405–450

(opts: ParserIncludesInitOptions, project: string, ref: string, componentName: string)

    }

    static async downloadIncludeComponent (opts: ParserIncludesInitOptions, project: string, ref: string, componentName: string): Promise<void> {
        const {cwd, stateDir, gitData, fetchIncludes, writeStreams} = opts;
        const remote = gitData.remote;
        const files = [`${componentName}.yml`, `${componentName}/template.yml`];
        let tmpDir = null;
        try {
            const target = `${stateDir}/includes/${remote.host}/${project}/${ref}`;

            if (!fetchIncludes && (await fs.pathExists(`${cwd}/${target}/${files[0]}`) || await fs.pathExists(`${cwd}/${target}/${files[1]}`))) return;
            const time = process.hrtime();

            if (remote.schema.startsWith("http")) {
                const ext = "tmp-" + Math.random();
                await fs.mkdirp(path.dirname(`${cwd}/${target}/templates`));
                tmpDir = `${cwd}/${target}.${ext}`;

                const gitCloneBranch = (ref === "HEAD") ? "" : `--branch ${ref}`;
                await Utils.bashMulti([
                    `cd ${cwd}/${stateDir}`,
                    `git clone ${gitCloneBranch} -n --depth=1 --filter=tree:0 ${remote.schema}://${remote.host}:${remote.port}/${project}.git ${tmpDir}`,
                    `cd ${tmpDir}`,
                    `git sparse-checkout set --no-cone ${files[0]} ${files[1]}`,
                    "git checkout",
                    `cd ${cwd}/${stateDir}`,
                    `mkdir -p ${tmpDir}/templates`, // create templates subdir (if it doesn't exist), as the check out may not create it
                    `cp -r ${tmpDir}/templates ${cwd}/${target}`,
                ], cwd);
            } else {
                // git archive fails if the paths do not exist, to work around this we use a wildcard "templates/component*.yml"
                // this resolves to either "templates/component.yml" or "templates/component/template.yml"
                // if both exist "templates/component.yml" will be pulled
                // Drawback: also pulls all other .yml files from templates/component/ directory
                const componentWildcard = `${componentName}*.yml`;
                await fs.mkdirp(`${cwd}/${target}`);
                await Utils.bash(`set -eou pipefail; git archive --remote=ssh://git@${remote.host}:${remote.port}/${project}.git ${ref} ${componentWildcard} | tar -f - -xC ${target}/`, cwd);
            }
            writeStreams.stderr(chalk`{grey downloaded ${project} ${ref} ${componentName} in ${prettyHrtime(process.hrtime(time))}}\n`);
        } catch (e) {
            throw new AssertionError({message: `Component include could not be fetched { project: ${project}, ref: ${ref}, file: ${files} }\n${e}`});
        } finally {
            if (tmpDir !== null) {
                // always cleanup temporary directory (if created)
                await fs.rm(tmpDir, {recursive: true, force: true});
            }
        }
    }

    static readonly memoLocalRepoFiles = (() => {
        const cache = new Map<string, string[]>();