vscode-codeql/extensions/ql-vscode/test/unit-tests/common/location.test.ts at fffb692ca8eeb6a238f08740a3c0069fd1afbe0f · github/vscode-codeql · 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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
import {
  tryGetRemoteLocation,
  tryGetResolvableLocation,
} from "../../../src/common/bqrs-utils";

describe("processing string locations", () => {
  it("should detect Windows whole-file locations", () => {
    const loc = "file://C:/path/to/file.ext:0:0:0:0";
    const wholeFileLoc = tryGetResolvableLocation(loc);
    expect(wholeFileLoc).toEqual({ uri: "C:/path/to/file.ext" });
  });
  it("should detect Unix whole-file locations", () => {
    const loc = "file:///path/to/file.ext:0:0:0:0";
    const wholeFileLoc = tryGetResolvableLocation(loc);
    expect(wholeFileLoc).toEqual({ uri: "/path/to/file.ext" });
  });

  it("should detect Unix 5-part locations", () => {
    const loc = "file:///path/to/file.ext:1:2:3:4";
    const wholeFileLoc = tryGetResolvableLocation(loc);
    expect(wholeFileLoc).toEqual({
      uri: "/path/to/file.ext",
      startLine: 1,
      startColumn: 2,
      endLine: 3,
      endColumn: 4,
    });
  });
  it("should ignore other string locations", () => {
    for (const loc of ["file:///path/to/file.ext", "I am not a location"]) {
      const wholeFileLoc = tryGetResolvableLocation(loc);
      expect(wholeFileLoc).toBeUndefined();
    }
  });
});

describe("getting links to remote (GitHub) locations", () => {
  it("should return undefined if resolvableLocation is undefined", () => {
    const loc = "not a location";
    const fileLinkPrefix = "";
    const sourceLocationPrefix = "";

    const link = tryGetRemoteLocation(
      loc,
      fileLinkPrefix,
      sourceLocationPrefix,
    );

    expect(link).toBeUndefined();
  });

  it("should return undefined if resolvableLocation has the wrong format", () => {
    const loc = {
      uri: "file:/path/to/file.ext",
      startLine: 194,
      startColumn: 18,
      endLine: 237,
      endColumn: 1,
    };
    const fileLinkPrefix = "";
    const sourceLocationPrefix = "/home/foo/bar";

    const link = tryGetRemoteLocation(
      loc,
      fileLinkPrefix,
      sourceLocationPrefix,
    );

    expect(link).toBeUndefined();
  });

  it("should return a remote file ref if the sourceLocationPrefix and resolvableLocation match up", () => {
    const loc = {
      uri: "file:/home/foo/bar/path/to/file.ext",
      startLine: 194,
      startColumn: 18,
      endLine: 237,
      endColumn: 1,
    };
    const fileLinkPrefix = "https://github.com/owner/repo/blob/sha1234";
    const sourceLocationPrefix = "/home/foo/bar";

    const link = tryGetRemoteLocation(
      loc,
      fileLinkPrefix,
      sourceLocationPrefix,
    );

    expect(link).toEqual(
      "https://github.com/owner/repo/blob/sha1234/path/to/file.ext#L194C18-L237C1",
    );
  });

  it("should return undefined if the sourceLocationPrefix is missing and resolvableLocation doesn't match the default format", () => {
    const loc = {
      uri: "file:/home/foo/bar/path/to/file.ext",
      startLine: 194,
      startColumn: 18,
      endLine: 237,
      endColumn: 1,
    };
    const fileLinkPrefix = "https://github.com/owner/repo/blob/sha1234";
    const sourceLocationPrefix = "";

    const link = tryGetRemoteLocation(
      loc,
      fileLinkPrefix,
      sourceLocationPrefix,
    );

    expect(link).toBeUndefined();
  });

  it("should return a remote file ref if the sourceLocationPrefix is missing, but the resolvableLocation matches the default format", () => {
    const loc = {
      uri: "file:/home/runner/work/foo/bar/path/to/file.ext",
      startLine: 194,
      startColumn: 18,
      endLine: 237,
      endColumn: 1,
    };
    const fileLinkPrefix = "https://github.com/owner/repo/blob/sha1234";
    const sourceLocationPrefix = "";

    const link = tryGetRemoteLocation(
      loc,
      fileLinkPrefix,
      sourceLocationPrefix,
    );

    expect(link).toEqual(
      "https://github.com/owner/repo/blob/sha1234/path/to/file.ext#L194C18-L237C1",
    );
  });
});