codeql-action/src/start-proxy/reachability.test.ts at 7a818e69771a11e3c5263c3824ac9b3f67f576d3 · 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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
import test from "ava";
import * as sinon from "sinon";

import {
  checkExpectedLogMessages,
  setupTests,
  withRecordingLoggerAsync,
} from "./../testing-utils";
import {
  checkConnections,
  connectionTestConfig,
  ReachabilityBackend,
  ReachabilityError,
} from "./reachability";
import { ProxyInfo, Registry } from "./types";

setupTests(test);

class MockReachabilityBackend implements ReachabilityBackend {
  public async checkConnection(_url: URL): Promise<number> {
    return 200;
  }
}

const mavenRegistry: Registry = {
  type: "maven_registry",
  url: "https://repo.maven.apache.org/maven2/",
};

const nugetFeed: Registry = {
  type: "nuget_feed",
  url: "https://api.nuget.org/v3/index.json",
};

const proxyInfo: ProxyInfo = {
  host: "127.0.0.1",
  port: 1080,
  cert: "",
  registries: [mavenRegistry, nugetFeed],
};

test("checkConnections - basic functionality", async (t) => {
  const backend = new MockReachabilityBackend();
  const messages = await withRecordingLoggerAsync(async (logger) => {
    const reachable = await checkConnections(logger, proxyInfo, backend);
    t.is(reachable.size, proxyInfo.registries.length);
    t.true(reachable.has(mavenRegistry));
    t.true(reachable.has(nugetFeed));
  });
  checkExpectedLogMessages(t, messages, [
    `Testing connection to ${mavenRegistry.url}`,
    `Successfully tested connection to ${mavenRegistry.url}`,
    `Testing connection to ${nugetFeed.url}`,
    `Successfully tested connection to ${nugetFeed.url}`,
    `Finished testing connections`,
  ]);
});

test("checkConnections - excludes failed status codes", async (t) => {
  const backend = new MockReachabilityBackend();
  sinon
    .stub(backend, "checkConnection")
    .onSecondCall()
    .throws(new ReachabilityError(400));
  const messages = await withRecordingLoggerAsync(async (logger) => {
    const reachable = await checkConnections(logger, proxyInfo, backend);
    t.is(reachable.size, 1);
    t.true(reachable.has(mavenRegistry));
  });
  checkExpectedLogMessages(t, messages, [
    `Testing connection to ${mavenRegistry.url}`,
    `Successfully tested connection to ${mavenRegistry.url}`,
    `Testing connection to ${nugetFeed.url}`,
    `Connection test to ${nugetFeed.url} failed. (400)`,
    `Finished testing connections`,
  ]);
});

test("checkConnections - handles other exceptions", async (t) => {
  const backend = new MockReachabilityBackend();
  sinon
    .stub(backend, "checkConnection")
    .onSecondCall()
    .throws(new Error("Some generic error"));
  const messages = await withRecordingLoggerAsync(async (logger) => {
    const reachable = await checkConnections(logger, proxyInfo, backend);
    t.is(reachable.size, 1);
    t.true(reachable.has(mavenRegistry));
  });
  checkExpectedLogMessages(t, messages, [
    `Testing connection to ${mavenRegistry.url}`,
    `Successfully tested connection to ${mavenRegistry.url}`,
    `Testing connection to ${nugetFeed.url}`,
    `Connection test to ${nugetFeed.url} failed: Some generic error`,
    `Finished testing connections`,
  ]);
});

test("checkConnections - handles invalid URLs", async (t) => {
  const backend = new MockReachabilityBackend();
  const messages = await withRecordingLoggerAsync(async (logger) => {
    const reachable = await checkConnections(
      logger,
      {
        ...proxyInfo,
        registries: [
          {
            type: "nuget_feed",
            url: "localhost",
          },
        ],
      },
      backend,
    );
    t.is(reachable.size, 0);
  });
  checkExpectedLogMessages(t, messages, [
    `Skipping check for localhost since it is not a valid URL.`,
    `Finished testing connections`,
  ]);
});

test("checkConnections - appends extra paths", async (t) => {
  const backend = new MockReachabilityBackend();
  const checkConnection = sinon.stub(backend, "checkConnection").resolves(200);

  const messages = await withRecordingLoggerAsync(async (logger) => {
    const reachable = await checkConnections(
      logger,
      {
        ...proxyInfo,
        registries: [{ ...nugetFeed, url: "https://api.nuget.org/" }],
      },
      backend,
    );
  });
  checkExpectedLogMessages(t, messages, [
    `Testing connection to https://api.nuget.org/`,
    `Successfully tested connection to https://api.nuget.org/`,
    `Finished testing connections`,
  ]);

  t.true(
    checkConnection.calledWith(
      sinon.match(
        new URL(
          `https://api.nuget.org/${connectionTestConfig["nuget_feed"]?.path}`,
        ),
      ),
    ),
  );
});