7348129007

Committed 28 Dec 2023 01:32PM UTC coverage: 81.942% (+11.2%) from 70.71%

Build # 7348129007

Build Type

push

github

Committed by

lukka

Commit Message

add support for vcpkg-configuration.json's baseline

Run Details

145 of 197 branches covered (0.0%)

Branch coverage included in aggregate %.

2 of 3 new or added lines in 2 files covered. (66.67%)

9 existing lines in 2 files now uncovered.

336 of 390 relevant lines covered (86.15%)

7.27 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

90.7

/src/vcpkg-utils.ts

// Copyright (c) 2020-2021-2022-2023 Luca Cappa
// Released under the term specified in file LICENSE.txt
// SPDX short identifier: MIT

import * as path from 'path'
import * as fs from 'fs'
import * as runvcpkglib from '@lukka/run-vcpkg-lib'
import * as baselib from '@lukka/base-lib'
import * as baseutillib from '@lukka/base-util-lib'
import * as cache from '@actions/cache'

export class Utils {

  public static isExactKeyMatch(key: string, cacheKey?: string): boolean {
    if (cacheKey)
      return cacheKey.localeCompare(key, undefined, { sensitivity: "accent" }) === 0;
    else
      return false;
  }

  /**
   * Retrieve the commit id of the Git repository at vcpkgDirectory.
   * Returns [undefined, undefined] when the provided path is not the root of a Git repository.
   * @static
   * @param {baseutillib.BaseUtilLib} baseUtils
   * @param {string} vcpkgDirectory
   * @returns {(Promise<[string | undefined, boolean | undefined]>)}
   * @memberof Utils
   */
  public static async getVcpkgCommitId(baseUtils: baseutillib.BaseUtilLib, vcpkgDirectory: string): Promise<[string | undefined, boolean | undefined]> {
    baseUtils.baseLib.debug(`getVcpkgCommitId()<<`);
    let id = undefined;
    let isSubmodule = undefined;
    const workspaceDir = process.env.GITHUB_WORKSPACE ?? "";
    if (workspaceDir) {
      let fullVcpkgPath = "";
      baseUtils.baseLib.debug(`inputVcpkgPath=${vcpkgDirectory}`);
      if (path.isAbsolute(vcpkgDirectory))
        fullVcpkgPath = path.normalize(path.resolve(vcpkgDirectory));
      else
        fullVcpkgPath = path.normalize(path.resolve(path.join(workspaceDir, vcpkgDirectory)));
      baseUtils.baseLib.debug(`fullVcpkgPath='${fullVcpkgPath}'`);
      const relPath = fullVcpkgPath.replace(workspaceDir, '');
      baseUtils.baseLib.debug(`relPath='${relPath}'`);
      const submodulePath = path.join(workspaceDir, ".git/modules", relPath, "HEAD")
      baseUtils.baseLib.debug(`submodulePath='${submodulePath}'`);
      // Check whether it is a submodule.
      if (fs.existsSync(submodulePath)) {
        id = fs.readFileSync(submodulePath).toString();
        baseUtils.baseLib.debug(`commitId='${id}'`);
        isSubmodule = true;
      } else if (fs.existsSync(path.join(fullVcpkgPath, ".git"))) {
        id = await runvcpkglib.VcpkgRunner.getCommitId(baseUtils, fullVcpkgPath);
        isSubmodule = false;
      }
      id = id?.trim();
    }
    baseUtils.baseLib.debug(`getVcpkgCommitId()>> -> [id=${id}, isSubmodule=${isSubmodule}]`);
    return [id, isSubmodule];
  }

  public static async computeCacheKeys(
    baseUtilLib: baseutillib.BaseUtilLib,
    vcpkgDirectory: string,
    userProvidedCommitId: string | null): Promise<baseutillib.KeySet> {
    baseUtilLib.baseLib.debug(`computeCacheKeys()<<`);
    const cacheKeySegments: string[] = [];

    // Add to the first segment of the key the values of env vars ImageOS and ImageVersion if available.
    let firstSegment = `runnerOS=${process.env['ImageOS'] ? process.env['ImageOS'] : process.platform}`;
    firstSegment += process.env['ImageVersion'] || "";

    const [commitId, isSubmodule] = await Utils.getVcpkgCommitId(baseUtilLib, vcpkgDirectory);
    if (commitId) {
      firstSegment += `-vcpkgGitCommit=${commitId}`;
      if (isSubmodule) {
        baseUtilLib.baseLib.info(`Adding vcpkg submodule Git commit id '${commitId}' to cache key`);
        if (userProvidedCommitId) {
          baseUtilLib.baseLib.warning(`The provided Git commit id is disregarded: '${userProvidedCommitId}'. Please remove it from the inputs.`);
        }
      } else {
        baseUtilLib.baseLib.info(`vcpkg identified at Git commit id '${commitId}', adding it to the cache's key.`);
      }
    } else if (userProvidedCommitId) {
      firstSegment += `-vcpkgGitCommit=${userProvidedCommitId}`;
      baseUtilLib.baseLib.info(`Adding user provided vcpkg's Git commit id '${userProvidedCommitId}' to cache key.`);
    } else {
      baseUtilLib.baseLib.info(`No vcpkg's commit id was provided, does not contribute to the cache's key.`);
    }

    cacheKeySegments.push(firstSegment);

    const keyset: baseutillib.KeySet = baseutillib.createKeySet(cacheKeySegments);
    baseUtilLib.baseLib.debug(`computeCacheKeys()>>`);
    return keyset;
  }

  public static async saveCache(baseUtilLib: baseutillib.BaseUtilLib, keys: baseutillib.KeySet,
    hitCacheKey: string | null, cachedPaths: string[]): Promise<void> {
    const baseLib = baseUtilLib.baseLib;
    baseLib.debug(`saveCache(keys:${JSON.stringify(keys)},hitCacheKey:${hitCacheKey},cachedPaths:${cachedPaths})<<`)
    try {
      await baseUtilLib.wrapOp('Save vcpkg into the GitHub Action cache (only the tool, not the built packages which are saved by vcpkg`s Binary Caching on GitHub Action`s cache).',
        async () => {

          if (hitCacheKey && Utils.isExactKeyMatch(keys.primary, hitCacheKey)) {
            baseLib.info(`Saving cache is skipped, because cache hit occurred on the cache key '${keys.primary}'.`);
          } else {
            baseLib.info(`Saving a new cache entry, because primary key was missed or a fallback restore key was hit.`);
            const pathsToCache: string[] = cachedPaths;
            baseLib.info(`Caching paths: '${pathsToCache}'`);

            try {
              baseLib.info(`Saving cache with primary key '${keys.primary}' ...`);
              await cache.saveCache(pathsToCache, keys.primary);
            }
            catch (error) {
              if (error instanceof Error) {
                if (error.name === cache.ValidationError.name) {
                  throw error;
                } else if (error.name === cache.ReserveCacheError.name) {
                  baseLib.info(error.message);
                } else {
                  baseLib.warning(error.message);
                }
              }
            }
          }
        });
    } catch (err) {
      baseLib.warning("vcpkg-utils.saveCache() failed!");
      baseutillib.dumpError(baseLib, err);
    }

    baseLib.debug(`saveCache()>>`)
  }

  public static getAllCachedPaths(baseLib: baselib.BaseLib, vcpkgRootDir: string): string[] {
    baseLib.debug(`getAllCachedPaths(${vcpkgRootDir})<<`);
    let pathsToCache: string[] = runvcpkglib.getOrdinaryCachedPaths(vcpkgRootDir);

    // Remove empty entries.
    pathsToCache = pathsToCache.map(s => s.trim()).filter(Boolean);

    // Remove duplicates.
    const ps = [...new Set(pathsToCache)];

    baseLib.debug(`getAllCachedPaths(${vcpkgRootDir})<< -> '${JSON.stringify(ps)}'`);
    return ps;
  }
}

1	// Copyright (c) 2020-2021-2022-2023 Luca Cappa
2	// Released under the term specified in file LICENSE.txt
3	// SPDX short identifier: MIT
4
5	import * as path from 'path'	2✔
6	import * as fs from 'fs'	2✔
7	import * as runvcpkglib from '@lukka/run-vcpkg-lib'	2✔
8	import * as baselib from '@lukka/base-lib'
9	import * as baseutillib from '@lukka/base-util-lib'	2✔
10	import * as cache from '@actions/cache'	2✔
11
12	export class Utils {	2✔
13
14	public static isExactKeyMatch(key: string, cacheKey?: string): boolean {
15	if (cacheKey)	8!
16	return cacheKey.localeCompare(key, undefined, { sensitivity: "accent" }) === 0;	8✔
17	else
18	return false;	×
19	}
20
21	/**
22	* Retrieve the commit id of the Git repository at vcpkgDirectory.
23	* Returns [undefined, undefined] when the provided path is not the root of a Git repository.
24	* @static
25	* @param {baseutillib.BaseUtilLib} baseUtils
26	* @param {string} vcpkgDirectory
27	* @returns {(Promise<[string \| undefined, boolean \| undefined]>)}
28	* @memberof Utils
29	*/
30	public static async getVcpkgCommitId(baseUtils: baseutillib.BaseUtilLib, vcpkgDirectory: string): Promise<[string \| undefined, boolean \| undefined]> {
31	baseUtils.baseLib.debug(`getVcpkgCommitId()<<`);	16✔
32	let id = undefined;	16✔
33	let isSubmodule = undefined;	16✔
34	const workspaceDir = process.env.GITHUB_WORKSPACE ?? "";	16✔
35	if (workspaceDir) {	16✔
36	let fullVcpkgPath = "";	14✔
37	baseUtils.baseLib.debug(`inputVcpkgPath=${vcpkgDirectory}`);	14✔
38	if (path.isAbsolute(vcpkgDirectory))	14!
39	fullVcpkgPath = path.normalize(path.resolve(vcpkgDirectory));	14✔
40	else
41	fullVcpkgPath = path.normalize(path.resolve(path.join(workspaceDir, vcpkgDirectory)));	×
42	baseUtils.baseLib.debug(`fullVcpkgPath='${fullVcpkgPath}'`);	14✔
43	const relPath = fullVcpkgPath.replace(workspaceDir, '');	14✔
44	baseUtils.baseLib.debug(`relPath='${relPath}'`);	14✔
45	const submodulePath = path.join(workspaceDir, ".git/modules", relPath, "HEAD")	14✔
46	baseUtils.baseLib.debug(`submodulePath='${submodulePath}'`);	14✔
47	// Check whether it is a submodule.
48	if (fs.existsSync(submodulePath)) {	14✔
49	id = fs.readFileSync(submodulePath).toString();	2✔
50	baseUtils.baseLib.debug(`commitId='${id}'`);	2✔
51	isSubmodule = true;	2✔
52	} else if (fs.existsSync(path.join(fullVcpkgPath, ".git"))) {	12✔
53	id = await runvcpkglib.VcpkgRunner.getCommitId(baseUtils, fullVcpkgPath);	4✔
54	isSubmodule = false;	4✔
55	}
56	id = id?.trim();	14✔
57	}
58	baseUtils.baseLib.debug(`getVcpkgCommitId()>> -> [id=${id}, isSubmodule=${isSubmodule}]`);	16✔
59	return [id, isSubmodule];	16✔
60	}
61
62	public static async computeCacheKeys(
63	baseUtilLib: baseutillib.BaseUtilLib,
64	vcpkgDirectory: string,
65	userProvidedCommitId: string \| null): Promise<baseutillib.KeySet> {
66	baseUtilLib.baseLib.debug(`computeCacheKeys()<<`);	16✔
67	const cacheKeySegments: string[] = [];	16✔
68
69	// Add to the first segment of the key the values of env vars ImageOS and ImageVersion if available.
70	let firstSegment = `runnerOS=${process.env['ImageOS'] ? process.env['ImageOS'] : process.platform}`;	16!
71	firstSegment += process.env['ImageVersion'] \|\| "";	16!
72
73	const [commitId, isSubmodule] = await Utils.getVcpkgCommitId(baseUtilLib, vcpkgDirectory);	16✔
74	if (commitId) {	16✔
75	firstSegment += `-vcpkgGitCommit=${commitId}`;	8✔
76	if (isSubmodule) {	8✔
77	baseUtilLib.baseLib.info(`Adding vcpkg submodule Git commit id '${commitId}' to cache key`);	4✔
78	if (userProvidedCommitId) {	4✔
79	baseUtilLib.baseLib.warning(`The provided Git commit id is disregarded: '${userProvidedCommitId}'. Please remove it from the inputs.`);	2✔
80	}
81	} else {
82	baseUtilLib.baseLib.info(`vcpkg identified at Git commit id '${commitId}', adding it to the cache's key.`);	4✔
83	}
84	} else if (userProvidedCommitId) {	8✔
85	firstSegment += `-vcpkgGitCommit=${userProvidedCommitId}`;	2✔
86	baseUtilLib.baseLib.info(`Adding user provided vcpkg's Git commit id '${userProvidedCommitId}' to cache key.`);	2✔
87	} else {
88	baseUtilLib.baseLib.info(`No vcpkg's commit id was provided, does not contribute to the cache's key.`);	6✔
89	}
90
91	cacheKeySegments.push(firstSegment);	16✔
92
93	const keyset: baseutillib.KeySet = baseutillib.createKeySet(cacheKeySegments);	16✔
94	baseUtilLib.baseLib.debug(`computeCacheKeys()>>`);	16✔
95	return keyset;	16✔
96	}
97
98	public static async saveCache(baseUtilLib: baseutillib.BaseUtilLib, keys: baseutillib.KeySet,
99	hitCacheKey: string \| null, cachedPaths: string[]): Promise<void> {
100	const baseLib = baseUtilLib.baseLib;	8✔
101	baseLib.debug(`saveCache(keys:${JSON.stringify(keys)},hitCacheKey:${hitCacheKey},cachedPaths:${cachedPaths})<<`)	8✔
102	try {	8✔
103	await baseUtilLib.wrapOp('Save vcpkg into the GitHub Action cache (only the tool, not the built packages which are saved by vcpkg`s Binary Caching on GitHub Action`s cache).',	8✔
104	async () => {	8✔
105
106	if (hitCacheKey && Utils.isExactKeyMatch(keys.primary, hitCacheKey)) {	8✔
107	baseLib.info(`Saving cache is skipped, because cache hit occurred on the cache key '${keys.primary}'.`);	2✔
108	} else {
109	baseLib.info(`Saving a new cache entry, because primary key was missed or a fallback restore key was hit.`);	6✔
110	const pathsToCache: string[] = cachedPaths;	6✔
111	baseLib.info(`Caching paths: '${pathsToCache}'`);	6✔
112
113	try {	6✔
114	baseLib.info(`Saving cache with primary key '${keys.primary}' ...`);	6✔
115	await cache.saveCache(pathsToCache, keys.primary);	6✔
116	}
117	catch (error) {
118	if (error instanceof Error) {	2✔
119	if (error.name === cache.ValidationError.name) {	2!
120	throw error;	×
121	} else if (error.name === cache.ReserveCacheError.name) {	2!
122	baseLib.info(error.message);	×
123	} else {
124	baseLib.warning(error.message);	2✔
125	}
126	}
127	}
128	}
129	});
130	} catch (err) {
131	baseLib.warning("vcpkg-utils.saveCache() failed!");	×
NEW 132	baseutillib.dumpError(baseLib, err);	×
133	}
134
135	baseLib.debug(`saveCache()>>`)	8✔
136	}
137
138	public static getAllCachedPaths(baseLib: baselib.BaseLib, vcpkgRootDir: string): string[] {
139	baseLib.debug(`getAllCachedPaths(${vcpkgRootDir})<<`);	16✔
140	let pathsToCache: string[] = runvcpkglib.getOrdinaryCachedPaths(vcpkgRootDir);	16✔
141
142	// Remove empty entries.
143	pathsToCache = pathsToCache.map(s => s.trim()).filter(Boolean);	16✔
144
145	// Remove duplicates.
146	const ps = [...new Set(pathsToCache)];	16✔
147
148	baseLib.debug(`getAllCachedPaths(${vcpkgRootDir})<< -> '${JSON.stringify(ps)}'`);	16✔
149	return ps;	16✔
150	}
151	}

lukka / run-vcpkg / 7348129007

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous