FilesExpand file tree

main

/

github.test.ts

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

227 lines (192 loc) · 7.18 KB

main

/

github.test.ts

Copy path

Top

File metadata and controls

• Code
• Blame

227 lines (192 loc) · 7.18 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

import { Buffer } from "node:buffer";

import fs from "node:fs/promises";

import path from "node:path";

import { exec } from "tinyexec";

import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";

import { GitHub } from "./github.ts";

import { createGitHttpRemote, shallowClone, testdir } from "./test-utils.ts";

const githubContext = vi.hoisted(() => ({

repo: {

owner: "changesets",

repo: "action",

},

sha: "base-sha",

}));

vi.mock("@actions/github", () => ({

context: githubContext,

getOctokit: () => ({}),

}));

async function git(cwd: string, args: string[]) {

const result = await exec("git", args, {

nodeOptions: { cwd },

throwOnError: true,

});

return result.stdout.trim();

}

function getAuthorization(token: string) {

return `basic ${Buffer.from(`x-access-token:${token}`).toString("base64")}`;

}

function createRemote() {

return createGitHttpRemote({ "file.txt": "initial\n" });

}

async function isolateGitConfig() {

const fixture = await testdir({ "global.gitconfig": "" });

vi.stubEnv("GIT_CONFIG_GLOBAL", path.join(fixture.path, "global.gitconfig"));

return fixture;

}

type GitHttpRemote = Awaited<ReturnType<typeof createGitHttpRemote>>;

async function pushChangedFile(

repository: string,

serverUrl: string,

token: string,

) {

await fs.writeFile(path.join(repository, "file.txt"), "changed\n");

const github = new GitHub({

cwd: repository,

githubToken: token,

pushWithGitCli: true,

serverUrl,

});

await github.pushChanges({

branch: "changeset-release/main",

message: "Version Packages",

});

return github;

}

async function expectReleaseBranch(remote: GitHttpRemote, repository: string) {

expect(

await git(remote.path, ["rev-parse", "refs/heads/changeset-release/main"]),

).toBe(await git(repository, ["rev-parse", "HEAD"]));

}

function expectRequestsToUseToken(remote: GitHttpRemote, token: string) {

expect(remote.requests.length).toBeGreaterThan(0);

for (const request of remote.requests) {

expect(request.headers.authorization).toEqual([getAuthorization(token)]);

}

}

beforeEach(() => {

vi.stubEnv("GIT_AUTHOR_DATE", "2000-01-01T00:00:00Z");

vi.stubEnv("GIT_COMMITTER_DATE", "2000-01-01T00:00:00Z");

vi.stubEnv("GIT_CONFIG_COUNT", "0");

vi.stubEnv("GIT_CONFIG_NOSYSTEM", "1");

vi.stubEnv("GIT_TERMINAL_PROMPT", "0");

});

afterEach(() => {

vi.unstubAllEnvs();

});

describe("GitHub", () => {

it("defaults to GitHub API mode", () => {

const github = new GitHub({

cwd: "/repo",

githubToken: "token",

});

expect(github.pushWithGitCli).toBe(false);

});

it("uses github-token instead of checkout's persisted header for branch and tag pushes", async () => {

await using _gitConfig = await isolateGitConfig();

const actionToken = "action-token";

const checkoutToken = "checkout-token";

await using remote = await createRemote();

await using repositoryFixture = await shallowClone(remote.path);

const repository = repositoryFixture.path;

const serverUrl = new URL(remote.url).origin;

await git(repository, ["remote", "set-url", "origin", remote.url]);

await git(repository, [

"config",

`http.${serverUrl}/.extraheader`,

`AUTHORIZATION: ${getAuthorization(checkoutToken)}`,

]);

const github = await pushChangedFile(repository, serverUrl, actionToken);

await git(repository, ["tag", "v1.0.0"]);

await github.pushTag("v1.0.0");

await expectReleaseBranch(remote, repository);

expect(await git(remote.path, ["rev-parse", "refs/tags/v1.0.0"])).toBe(

await git(repository, ["rev-parse", "v1.0.0"]),

);

expectRequestsToUseToken(remote, actionToken);

}, 15_000);

it("uses github-token instead of credentials embedded in the push URL", async () => {

await using _gitConfig = await isolateGitConfig();

const actionToken = "action-token";

await using remote = await createRemote();

await using repositoryFixture = await shallowClone(remote.path);

const repository = repositoryFixture.path;

const remoteUrl = new URL(remote.url);

remoteUrl.username = "x-access-token";

remoteUrl.password = "checkout-token";

await git(repository, ["remote", "set-url", "origin", remoteUrl.href]);

const persistedCredentialUrl = new URL(remoteUrl);

persistedCredentialUrl.password = "";

await git(repository, [

"config",

`http.${persistedCredentialUrl.href}.extraheader`,

`AUTHORIZATION: ${getAuthorization("checkout-token")}`,

]);

await pushChangedFile(repository, remoteUrl.origin, actionToken);

await expectReleaseBranch(remote, repository);

expectRequestsToUseToken(remote, actionToken);

}, 15_000);

it("uses the push URL when it differs from the fetch URL", async () => {

await using _gitConfig = await isolateGitConfig();

const actionToken = "action-token";

await using fetchRemote = await createRemote();

await using pushRemote = await createRemote();

await using repositoryFixture = await shallowClone(fetchRemote.path);

const repository = repositoryFixture.path;

await git(repository, ["remote", "set-url", "origin", fetchRemote.url]);

await git(repository, ["config", "remote.origin.pushurl", pushRemote.url]);

await pushChangedFile(

repository,

new URL(fetchRemote.url).origin,

actionToken,

);

expect(fetchRemote.requests).toEqual([]);

await expectReleaseBranch(pushRemote, repository);

expectRequestsToUseToken(pushRemote, actionToken);

}, 15_000);

it("uses github-token for every push URL", async () => {

await using _gitConfig = await isolateGitConfig();

const actionToken = "action-token";

await using firstRemote = await createRemote();

await using secondRemote = await createRemote();

await using repositoryFixture = await shallowClone(firstRemote.path);

const repository = repositoryFixture.path;

for (const remote of [firstRemote, secondRemote]) {

await git(repository, [

"config",

"--add",

"remote.origin.pushurl",

remote.url,

]);

}

await pushChangedFile(

repository,

new URL(firstRemote.url).origin,

actionToken,

);

for (const remote of [firstRemote, secondRemote]) {

await expectReleaseBranch(remote, repository);

expectRequestsToUseToken(remote, actionToken);

}

}, 15_000);

it("preserves existing command-scoped Git config entries", async () => {

await using _gitConfig = await isolateGitConfig();

const actionToken = "action-token";

await using fetchRemote = await createRemote();

await using pushRemote = await createRemote();

await using repositoryFixture = await shallowClone(fetchRemote.path);

const repository = repositoryFixture.path;

await git(repository, ["remote", "set-url", "origin", fetchRemote.url]);

vi.stubEnv("GIT_CONFIG_COUNT", "1");

vi.stubEnv("GIT_CONFIG_KEY_0", "remote.origin.pushurl");

vi.stubEnv("GIT_CONFIG_VALUE_0", pushRemote.url);

await pushChangedFile(

repository,

new URL(fetchRemote.url).origin,

actionToken,

);

expect(fetchRemote.requests).toEqual([]);

await expectReleaseBranch(pushRemote, repository);

expectRequestsToUseToken(pushRemote, actionToken);

}, 15_000);

});