codeql-action/src/cli/output-cache.test.ts at 40f80a8df09be2b1e7aed995af3abca5f5ffbce1 · github/codeql-action · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
import * as fs from "fs";
import path from "path";

import test from "ava";

import { EnvVar } from "../environment";
import { getTestEnv, setupTests } from "../testing-utils";
import * as util from "../util";

import * as outputCache from "./output-cache";

setupTests(test);

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");
      fs.writeFileSync(
        cacheFile,
        JSON.stringify({
          cmd: "/path/to/codeql",
          entries: { version: { version: "2.20.0" } },
        }),
        "utf8",
      );
      const env = getTestEnv({ [EnvVar.TEMP]: tmpDir });
      t.deepEqual(outputCache.getCachedCodeQlVersion("/path/to/codeql", env), {
        version: "2.20.0",
      });
    });
  },
);

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");
      fs.writeFileSync(
        cacheFile,
        JSON.stringify({
          cmd: "/path/to/other-codeql",
          version: { version: "2.20.0" },
        }),
        "utf8",
      );
      const env = getTestEnv({ [EnvVar.TEMP]: tmpDir });
      t.is(
        outputCache.getCachedCodeQlVersion("/path/to/codeql", env),
        undefined,
      );
    });
  },
);

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 });
      t.is(
        outputCache.getCachedCodeQlVersion("/path/to/codeql", env),
        undefined,
      );
    });
  },
);

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 testValues = [
        { cmd: "/path/to/codeql" },
        { cmd: "/path/to/codeql", version: {} },
        { cmd: "/path/to/codeql", version: { version: 2 } },
        { version: { version: "2.20.0" } },
        {
          cmd: "/path/to/codeql",
          version: { version: "2.20.0", overlayVersion: "1" },
        },
        {
          cmd: "/path/to/codeql",
          version: { version: "2.20.0", features: "nope" },
        },
      ].map((v) => JSON.stringify(v));

      for (const value of testValues) {
        fs.writeFileSync(cacheFile, value, "utf8");
        t.is(
          outputCache.getCachedCodeQlVersion("/path/to/codeql", env),
          undefined,
          value,
        );
      }
    });
  },
);

test.serial("getCachedCodeQlVersion ignores non-existent file", async (t) => {
  await util.withTmpDir(async (tmpDir: string) => {
    const env = getTestEnv({ [EnvVar.TEMP]: tmpDir });
    t.is(outputCache.getCachedCodeQlVersion("/path/to/codeql", env), undefined);
  });
});