codeql-action/src/api-client.test.ts at v4.30.8 · github/codeql-action · GitHub

History

172 lines (151 loc) · 5.5 KB

Raw

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

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

import * as github from "@actions/github";

import * as githubUtils from "@actions/github/lib/utils";

import test from "ava";

import * as sinon from "sinon";

import * as actionsUtil from "./actions-util";

import * as api from "./api-client";

import { setupTests } from "./testing-utils";

import * as util from "./util";

setupTests(test);

test.beforeEach(() => {

util.initializeEnvironment(actionsUtil.getActionVersion());

});

test("getApiClient", async (t) => {

const pluginStub: sinon.SinonStub = sinon.stub(githubUtils.GitHub, "plugin");

const githubStub: sinon.SinonStub = sinon.stub();

pluginStub.returns(githubStub);

sinon.stub(actionsUtil, "getRequiredInput").withArgs("token").returns("xyz");

const requiredEnvParamStub = sinon.stub(util, "getRequiredEnvParam");

requiredEnvParamStub

.withArgs("GITHUB_SERVER_URL")

.returns("http://github.localhost");

requiredEnvParamStub

.withArgs("GITHUB_API_URL")

.returns("http://api.github.localhost");

api.getApiClient();

t.assert(

githubStub.calledOnceWithExactly({

auth: "token xyz",

baseUrl: "http://api.github.localhost",

log: sinon.match.any,

userAgent: `CodeQL-Action/${actionsUtil.getActionVersion()}`,

}),

);

});

function mockGetMetaVersionHeader(

versionHeader: string | undefined,

): sinon.SinonStub<any, any> {

// Passing an auth token is required, so we just use a dummy value

const client = github.getOctokit("123");

const response = {

headers: {

"x-github-enterprise-version": versionHeader,

};

const spyGetContents = sinon

.stub(client.rest.meta, "get")

// eslint-disable-next-line @typescript-eslint/no-unsafe-argument

.resolves(response as any);

sinon.stub(api, "getApiClient").value(() => client);

return spyGetContents;

}

test("getGitHubVersion for Dotcom", async (t) => {

const apiDetails = {

auth: "",

url: "https://github.com",

apiURL: "",

};

sinon.stub(api, "getApiDetails").returns(apiDetails);

const v = await api.getGitHubVersionFromApi(

github.getOctokit("123"),

apiDetails,

);

t.deepEqual(util.GitHubVariant.DOTCOM, v.type);

});

test("getGitHubVersion for GHES", async (t) => {

mockGetMetaVersionHeader("2.0");

const v2 = await api.getGitHubVersionFromApi(api.getApiClient(), {

auth: "",

url: "https://ghe.example.com",

apiURL: undefined,

});

t.deepEqual(

{ type: util.GitHubVariant.GHES, version: "2.0" } as util.GitHubVersion,

v2,

);

});

test("getGitHubVersion for different domain", async (t) => {

mockGetMetaVersionHeader(undefined);

const v3 = await api.getGitHubVersionFromApi(api.getApiClient(), {

auth: "",

url: "https://ghe.example.com",

apiURL: undefined,

});

t.deepEqual({ type: util.GitHubVariant.DOTCOM }, v3);

});

test("getGitHubVersion for GHE_DOTCOM", async (t) => {

mockGetMetaVersionHeader("ghe.com");

const gheDotcom = await api.getGitHubVersionFromApi(api.getApiClient(), {

auth: "",

url: "https://foo.ghe.com",

apiURL: undefined,

});

t.deepEqual({ type: util.GitHubVariant.GHE_DOTCOM }, gheDotcom);

});

test("wrapApiConfigurationError correctly wraps specific configuration errors", (t) => {

// We don't reclassify arbitrary errors

const arbitraryError = new Error("arbitrary error");

let res = api.wrapApiConfigurationError(arbitraryError);

t.is(res, arbitraryError);

// Same goes for arbitrary errors

const configError = new util.ConfigurationError("arbitrary error");

res = api.wrapApiConfigurationError(configError);

t.is(res, configError);

// If an HTTP error doesn't contain a specific error message, we don't

// wrap is an an API error.

const httpError = new util.HTTPError("arbitrary HTTP error", 456);

res = api.wrapApiConfigurationError(httpError);

t.is(res, httpError);

// For other HTTP errors, we wrap them as Configuration errors if they contain

// specific error messages.

const httpNotFoundError = new util.HTTPError("commit not found", 404);

res = api.wrapApiConfigurationError(httpNotFoundError);

t.deepEqual(res, new util.ConfigurationError("commit not found"));

const refNotFoundError = new util.HTTPError(

"ref 'refs/heads/jitsi' not found in this repository - https://docs.github.com/rest",

404,

);

res = api.wrapApiConfigurationError(refNotFoundError);

t.deepEqual(

res,

new util.ConfigurationError(

"ref 'refs/heads/jitsi' not found in this repository - https://docs.github.com/rest",

);

const apiRateLimitError = new util.HTTPError(

"API rate limit exceeded for installation",

403,

);

res = api.wrapApiConfigurationError(apiRateLimitError);

t.deepEqual(

res,

new util.ConfigurationError("API rate limit exceeded for installation"),

);

const tokenSuggestionMessage =

"Please check that your token is valid and has the required permissions: contents: read, security-events: write";

const badCredentialsError = new util.HTTPError("Bad credentials", 401);

res = api.wrapApiConfigurationError(badCredentialsError);

t.deepEqual(res, new util.ConfigurationError(tokenSuggestionMessage));

const notFoundError = new util.HTTPError("Not Found", 404);

res = api.wrapApiConfigurationError(notFoundError);

t.deepEqual(res, new util.ConfigurationError(tokenSuggestionMessage));

const resourceNotAccessibleError = new util.HTTPError(

"Resource not accessible by integration",

403,

);

res = api.wrapApiConfigurationError(resourceNotAccessibleError);

t.deepEqual(

res,

new util.ConfigurationError("Resource not accessible by integration"),

);

});

codeql-action/src/api-client.test.ts at v4.30.8 · github/codeql-action · GitHub

Expand file tree

Breadcrumbs

api-client.test.ts

Latest commit

History

Breadcrumbs

api-client.test.ts

File metadata and controls