Skip to content

Use json module for JSON validation in output-cache #4096

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mario-campos merged 9 commits into from
Sep 1, 2026
Merged

Use json module for JSON validation in output-cache #4096

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
93d793c
Use `json` module for JSON validation in `output-cache`
mario-campos Aug 14, 2026
cb9d39f
Export `getCommandCacheFilePath` function for use in tests
mario-campos Aug 14, 2026
d7d901a
Refactor tests to use `getCommandCacheFilePath`
mario-campos Aug 14, 2026
c8ba2d2
Refactor `isVersionInfo` with `json` module
mario-campos Aug 14, 2026
f3deecb
Refactor `OutputCache` with `json` module
mario-campos Aug 14, 2026
b60777a
Delete unnecessary statement from JSDoc comments
mario-campos Aug 14, 2026
1f46830
Fix `VersionInfo` derived type to pass linter
mario-campos Aug 14, 2026
b5d3438
Refactor tests in `output-cache.test.ts` to use named imports from `o…
mario-campos Aug 14, 2026
fcd8d74
Refactor output-caching functions to accept file path dependency
mario-campos Aug 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Refactor tests to use getCommandCacheFilePath 
As well as fixup a few other problems.
  • Loading branch information
@mario-campos
mario-campos committed Aug 14, 2026
commit d7d901a925f541b44083ef27ad5d63ce47bef846
18 changes: 8 additions & 10 deletions src/cli/output-cache.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import * as fs from "fs";
import path from "path";

import test from "ava";

Expand All @@ -18,7 +17,8 @@ test.serial(
"getCachedCodeQlVersion reuses a version persisted by an earlier step",
async (t) => {
await util.withTmpDir(async (tmpDir: string) => {
const cacheFile = path.join(tmpDir, "codeql-action-command-cache.json");
const env = getTestEnv({ [EnvVar.TEMP]: tmpDir });
const cacheFile = outputCache.getCommandCacheFilePath(env);
Comment thread
mario-campos marked this conversation as resolved.
Outdated
fs.writeFileSync(
cacheFile,
JSON.stringify({
Expand All @@ -27,7 +27,6 @@ test.serial(
}),
"utf8",
);
const env = getTestEnv({ [EnvVar.TEMP]: tmpDir });
t.deepEqual(
outputCache.getCachedCodeQlVersion(logger, env, "/path/to/codeql"),
{
Expand All @@ -42,16 +41,16 @@ test.serial(
"getCachedCodeQlVersion ignores a persisted version from a different CLI",
async (t) => {
await util.withTmpDir(async (tmpDir: string) => {
const cacheFile = path.join(tmpDir, "version.json");
const env = getTestEnv({ [EnvVar.TEMP]: tmpDir });
const cacheFile = outputCache.getCommandCacheFilePath(env);
fs.writeFileSync(
cacheFile,
JSON.stringify({
cmd: "/path/to/other-codeql",
version: { version: "2.20.0" },
entries: { version: { version: "2.20.0" } },
}),
"utf8",
);
const env = getTestEnv({ [EnvVar.TEMP]: tmpDir });
t.is(
outputCache.getCachedCodeQlVersion(logger, env, "/path/to/codeql"),
undefined,
Expand All @@ -64,9 +63,9 @@ test.serial(
"getCachedCodeQlVersion ignores a malformed persisted value",
async (t) => {
await util.withTmpDir(async (tmpDir: string) => {
const cacheFile = path.join(tmpDir, "version.json");
fs.writeFileSync(cacheFile, "not valid json", "utf8");
const env = getTestEnv({ [EnvVar.TEMP]: tmpDir });
const cacheFile = outputCache.getCommandCacheFilePath(env);
fs.writeFileSync(cacheFile, "not valid json", "utf8");
t.is(
outputCache.getCachedCodeQlVersion(logger, env, "/path/to/codeql"),
undefined,
Expand All @@ -79,9 +78,8 @@ test.serial(
"getCachedCodeQlVersion ignores a persisted value with the wrong structure",
async (t) => {
await util.withTmpDir(async (tmpDir: string) => {
const cacheFile = path.join(tmpDir, "version.json");
const env = getTestEnv({ [EnvVar.TEMP]: tmpDir });

const cacheFile = outputCache.getCommandCacheFilePath(env);
const testValues = [
{ cmd: "/path/to/codeql" },
{ entries: { version: { version: "2.20.0" } } },
Expand Down