6758500310

Committed 04 Nov 2023 07:00AM UTC coverage: 70.71% (-6.0%) from 76.71%

Build # 6758500310

Build Type

push

github

Committed by

lukka

Commit Message

- drop gulp.
- update all deps to latest.
- update node to v20.

Run Details

140 of 226 branches covered (0.0%)

Branch coverage included in aggregate %.

2 of 7 new or added lines in 1 file covered. (28.57%)

33 existing lines in 4 files now uncovered.

338 of 450 relevant lines covered (75.11%)

7.92 hits per line

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

70.24

/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'
import * as fastglob from "fast-glob"

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 getVcpkgJsonPath(baseUtil: baseutillib.BaseUtilLib, vcpkgJsonGlob: string,
    vcpkgJsonIgnores: string[]): Promise<string | null> {
    baseUtil.baseLib.debug(`getVcpkgJsonPath(${vcpkgJsonGlob})<<`);
    let ret: string | null = null;
    try {
      const vcpkgJsonPath = await fastglob(vcpkgJsonGlob, { ignore: vcpkgJsonIgnores });
      if (vcpkgJsonPath?.length === 1) {
        baseUtil.baseLib.info(`Found ${runvcpkglib.VCPKG_JSON} at '${vcpkgJsonPath[0]}'.`);
        ret = vcpkgJsonPath[0];
      } else if (vcpkgJsonPath.length > 1) {
        baseUtil.baseLib.warning(`The file ${runvcpkglib.VCPKG_JSON} was found multiple times with glob expression '${vcpkgJsonGlob}'.`);
      } else {
        baseUtil.baseLib.warning(`The file ${runvcpkglib.VCPKG_JSON} was not found with glob expression '${vcpkgJsonGlob}'.`);
      }
    }
    catch (err) {
      if (err instanceof Error) {
        baseUtil.baseLib.warning(err.message);
      }
    }

    baseUtil.baseLib.debug(`getVcpkgJsonPath()>>`);
    return ret;
  }

  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!");
      if (err instanceof Error) {
        baseLib.warning(err.name);
        baseLib.warning(err.message);
        if (err?.stack) {
          baseLib.warning(err.stack);
        }
      }
    }

    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'	3✔
6	import * as fs from 'fs'	3✔
7	import * as runvcpkglib from '@lukka/run-vcpkg-lib'	3✔
8	import * as baselib from '@lukka/base-lib'
9	import * as baseutillib from '@lukka/base-util-lib'	3✔
10	import * as cache from '@actions/cache'	3✔
11	import * as fastglob from "fast-glob"	3✔
12
13	export class Utils {	3✔
14
15	public static isExactKeyMatch(key: string, cacheKey?: string): boolean {
16	if (cacheKey)	12!
17	return cacheKey.localeCompare(key, undefined, { sensitivity: "accent" }) === 0;	12✔
18	else
19	return false;	×
20	}
21
22	/**
23	* Retrieve the commit id of the Git repository at vcpkgDirectory.
24	* Returns [undefined, undefined] when the provided path is not the root of a Git repository.
25	* @static
26	* @param {baseutillib.BaseUtilLib} baseUtils
27	* @param {string} vcpkgDirectory
28	* @returns {(Promise<[string \| undefined, boolean \| undefined]>)}
29	* @memberof Utils
30	*/
31	public static async getVcpkgCommitId(baseUtils: baseutillib.BaseUtilLib, vcpkgDirectory: string): Promise<[string \| undefined, boolean \| undefined]> {
32	baseUtils.baseLib.debug(`getVcpkgCommitId()<<`);	24✔
33	let id = undefined;	24✔
34	let isSubmodule = undefined;	24✔
35	const workspaceDir = process.env.GITHUB_WORKSPACE ?? "";	24✔
36	if (workspaceDir) {	24✔
37	let fullVcpkgPath = "";	21✔
38	baseUtils.baseLib.debug(`inputVcpkgPath=${vcpkgDirectory}`);	21✔
39	if (path.isAbsolute(vcpkgDirectory))	21!
40	fullVcpkgPath = path.normalize(path.resolve(vcpkgDirectory));	21✔
41	else
42	fullVcpkgPath = path.normalize(path.resolve(path.join(workspaceDir, vcpkgDirectory)));	×
43	baseUtils.baseLib.debug(`fullVcpkgPath='${fullVcpkgPath}'`);	21✔
44	const relPath = fullVcpkgPath.replace(workspaceDir, '');	21✔
45	baseUtils.baseLib.debug(`relPath='${relPath}'`);	21✔
46	const submodulePath = path.join(workspaceDir, ".git/modules", relPath, "HEAD")	21✔
47	baseUtils.baseLib.debug(`submodulePath='${submodulePath}'`);	21✔
48	// Check whether it is a submodule.
49	if (fs.existsSync(submodulePath)) {	21✔
50	id = fs.readFileSync(submodulePath).toString();	3✔
51	baseUtils.baseLib.debug(`commitId='${id}'`);	3✔
52	isSubmodule = true;	3✔
53	} else if (fs.existsSync(path.join(fullVcpkgPath, ".git"))) {	18✔
54	id = await runvcpkglib.VcpkgRunner.getCommitId(baseUtils, fullVcpkgPath);	6✔
55	isSubmodule = false;	6✔
56	}
57	id = id?.trim();	21✔
58	}
59	baseUtils.baseLib.debug(`getVcpkgCommitId()>> -> [id=${id}, isSubmodule=${isSubmodule}]`);	24✔
60	return [id, isSubmodule];	24✔
61	}
62
63	public static async getVcpkgJsonPath(baseUtil: baseutillib.BaseUtilLib, vcpkgJsonGlob: string,
64	vcpkgJsonIgnores: string[]): Promise<string \| null> {
UNCOV 65	baseUtil.baseLib.debug(`getVcpkgJsonPath(${vcpkgJsonGlob})<<`);	×
UNCOV 66	let ret: string \| null = null;	×
UNCOV 67	try {	×
UNCOV 68	const vcpkgJsonPath = await fastglob(vcpkgJsonGlob, { ignore: vcpkgJsonIgnores });	×
UNCOV 69	if (vcpkgJsonPath?.length === 1) {	×
UNCOV 70	baseUtil.baseLib.info(`Found ${runvcpkglib.VCPKG_JSON} at '${vcpkgJsonPath[0]}'.`);	×
UNCOV 71	ret = vcpkgJsonPath[0];	×
72	} else if (vcpkgJsonPath.length > 1) {	×
73	baseUtil.baseLib.warning(`The file ${runvcpkglib.VCPKG_JSON} was found multiple times with glob expression '${vcpkgJsonGlob}'.`);	×
74	} else {
75	baseUtil.baseLib.warning(`The file ${runvcpkglib.VCPKG_JSON} was not found with glob expression '${vcpkgJsonGlob}'.`);	×
76	}
77	}
78	catch (err) {
79	if (err instanceof Error) {	×
80	baseUtil.baseLib.warning(err.message);	×
81	}
82	}
83
UNCOV 84	baseUtil.baseLib.debug(`getVcpkgJsonPath()>>`);	×
UNCOV 85	return ret;	×
86	}
87
88	public static async computeCacheKeys(
89	baseUtilLib: baseutillib.BaseUtilLib,
90	vcpkgDirectory: string,
91	userProvidedCommitId: string \| null): Promise<baseutillib.KeySet> {
92	baseUtilLib.baseLib.debug(`computeCacheKeys()<<`);	24✔
93	const cacheKeySegments: string[] = [];	24✔
94
95	// Add to the first segment of the key the values of env vars ImageOS and ImageVersion if available.
96	let firstSegment = `runnerOS=${process.env['ImageOS'] ? process.env['ImageOS'] : process.platform}`;	24!
97	firstSegment += process.env['ImageVersion'] \|\| "";	24!
98
99	const [commitId, isSubmodule] = await Utils.getVcpkgCommitId(baseUtilLib, vcpkgDirectory);	24✔
100	if (commitId) {	24✔
101	firstSegment += `-vcpkgGitCommit=${commitId}`;	12✔
102	if (isSubmodule) {	12✔
103	baseUtilLib.baseLib.info(`Adding vcpkg submodule Git commit id '${commitId}' to cache key`);	6✔
104	if (userProvidedCommitId) {	6✔
105	baseUtilLib.baseLib.warning(`The provided Git commit id is disregarded: '${userProvidedCommitId}'. Please remove it from the inputs.`);	3✔
106	}
107	} else {
108	baseUtilLib.baseLib.info(`vcpkg identified at Git commit id '${commitId}', adding it to the cache's key.`);	6✔
109	}
110	} else if (userProvidedCommitId) {	12✔
111	firstSegment += `-vcpkgGitCommit=${userProvidedCommitId}`;	3✔
112	baseUtilLib.baseLib.info(`Adding user provided vcpkg's Git commit id '${userProvidedCommitId}' to cache key.`);	3✔
113	} else {
114	baseUtilLib.baseLib.info(`No vcpkg's commit id was provided, does not contribute to the cache's key.`);	9✔
115	}
116
117	cacheKeySegments.push(firstSegment);	24✔
118
119	const keyset: baseutillib.KeySet = baseutillib.createKeySet(cacheKeySegments);	24✔
120	baseUtilLib.baseLib.debug(`computeCacheKeys()>>`);	24✔
121	return keyset;	24✔
122	}
123
124	public static async saveCache(baseUtilLib: baseutillib.BaseUtilLib, keys: baseutillib.KeySet,
125	hitCacheKey: string \| null, cachedPaths: string[]): Promise<void> {
126	const baseLib = baseUtilLib.baseLib;	12✔
127	baseLib.debug(`saveCache(keys:${JSON.stringify(keys)},hitCacheKey:${hitCacheKey},cachedPaths:${cachedPaths})<<`)	12✔
128	try {	12✔
129	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).',	12✔
130	async () => {	12✔
131
132	if (hitCacheKey && Utils.isExactKeyMatch(keys.primary, hitCacheKey)) {	12✔
133	baseLib.info(`Saving cache is skipped, because cache hit occurred on the cache key '${keys.primary}'.`);	3✔
134	} else {
135	baseLib.info(`Saving a new cache entry, because primary key was missed or a fallback restore key was hit.`);	9✔
136	const pathsToCache: string[] = cachedPaths;	9✔
137	baseLib.info(`Caching paths: '${pathsToCache}'`);	9✔
138
139	try {	9✔
140	baseLib.info(`Saving cache with primary key '${keys.primary}' ...`);	9✔
141	await cache.saveCache(pathsToCache, keys.primary);	9✔
142	}
143	catch (error) {
144	if (error instanceof Error) {	3✔
145	if (error.name === cache.ValidationError.name) {	3!
146	throw error;	×
147	} else if (error.name === cache.ReserveCacheError.name) {	3!
148	baseLib.info(error.message);	×
149	} else {
150	baseLib.warning(error.message);	3✔
151	}
152	}
153	}
154	}
155	});
156	} catch (err) {
157	baseLib.warning("vcpkg-utils.saveCache() failed!");	×
158	if (err instanceof Error) {	×
159	baseLib.warning(err.name);	×
160	baseLib.warning(err.message);	×
161	if (err?.stack) {	×
162	baseLib.warning(err.stack);	×
163	}
164	}
165	}
166
167	baseLib.debug(`saveCache()>>`)	12✔
168	}
169
170	public static getAllCachedPaths(baseLib: baselib.BaseLib, vcpkgRootDir: string): string[] {
171	baseLib.debug(`getAllCachedPaths(${vcpkgRootDir})<<`);	24✔
172	let pathsToCache: string[] = runvcpkglib.getOrdinaryCachedPaths(vcpkgRootDir);	24✔
173
174	// Remove empty entries.
175	pathsToCache = pathsToCache.map(s => s.trim()).filter(Boolean);	24✔
176
177	// Remove duplicates.
178	const ps = [...new Set(pathsToCache)];	24✔
179
180	baseLib.debug(`getAllCachedPaths(${vcpkgRootDir})<< -> '${JSON.stringify(ps)}'`);	24✔
181	return ps;	24✔
182	}
183	}

lukka / run-vcpkg / 6758500310

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