mirrors/action-gh-release
1
0
Fork 1
mirror of https://github.com/softprops/action-gh-release.git synced 2025-05-10 18:44:19 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

add tests for finding tag from releases

Browse source 
add tests for updated functionality to break when we find a release.
the logic has been extracted into its own function, to make testing
simpler by avoiding over mocking/stubbing of network calls that would
create or update a release.

the tests that were added use jest's describe/it blocks, but use node's
assert function to align with other tests. there isn't any prior art for
mocking function calls in the codebase, so for now we use simple promises
in "mock" objects that adhere to the Releaser interface
This commit is contained in:
Ryan Waskiewicz 2025-04-11 07:19:10 -05:00
parent f84ee9b913
commit b585fed8fa
No known key found for this signature in database
GPG key ID: 5CD9C00A4F498A18
3 changed files with 290 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

256
__tests__/github.test.ts
View file

@ -1,6 +1,11 @@
import * as assert from "assert";
import { text } from "stream/consumers";
import { mimeOrDefault, asset } from "../src/github";
import {
mimeOrDefault,
asset,
Releaser,
Release,
findTagFromReleases,
} from "../src/github";
describe("github", () => {
describe("mimeOrDefault", () => {
@ -20,4 +25,251 @@ describe("github", () => {
assert.equal(size, 10);
});
});
describe("findTagFromReleases", () => {
const owner = "owner";
const repo = "repo";
const mockRelease: Release = {
id: 1,
upload_url: `https://api.github.com/repos/${owner}/${repo}/releases/1/assets`,
html_url: `https://github.com/${owner}/${repo}/releases/tag/v1.0.0`,
tag_name: "v1.0.0",
name: "Test Release",
body: "Test body",
target_commitish: "main",
draft: false,
prerelease: false,
assets: [],
} as const;
const mockReleaser: Releaser = {
getReleaseByTag: () => Promise.reject("Not implemented"),
createRelease: () => Promise.reject("Not implemented"),
updateRelease: () => Promise.reject("Not implemented"),
allReleases: async function* () {
yield { data: [mockRelease] };
},
} as const;
describe("when the tag_name is not an empty string", () => {
const targetTag = "v1.0.0";
it("finds a matching release in first batch of results", async () => {
const targetRelease = {
...mockRelease,
owner,
repo,
tag_name: targetTag,
};
const otherRelease = {
...mockRelease,
owner,
repo,
tag_name: "v1.0.1",
};
const releaser = {
...mockReleaser,
allReleases: async function* () {
yield { data: [targetRelease] };
yield { data: [otherRelease] };
},
};
const result = await findTagFromReleases(
releaser,
owner,
repo,
targetTag,
);
assert.deepStrictEqual(result, targetRelease);
});
it("finds a matching release in second batch of results", async () => {
const targetRelease = {
...mockRelease,
owner,
repo,
tag_name: targetTag,
};
const otherRelease = {
...mockRelease,
owner,
repo,
tag_name: "v1.0.1",
};
const releaser = {
...mockReleaser,
allReleases: async function* () {
yield { data: [otherRelease] };
yield { data: [targetRelease] };
},
};
const result = await findTagFromReleases(
releaser,
owner,
repo,
targetTag,
);
assert.deepStrictEqual(result, targetRelease);
});
it("returns undefined when a release is not found in any batch", async () => {
const otherRelease = {
...mockRelease,
owner,
repo,
tag_name: "v1.0.1",
};
const releaser = {
...mockReleaser,
allReleases: async function* () {
yield { data: [otherRelease] };
yield { data: [otherRelease] };
},
};
const result = await findTagFromReleases(
releaser,
owner,
repo,
targetTag,
);
assert.strictEqual(result, undefined);
});
it("returns undefined when no releases are returned", async () => {
const releaser = {
...mockReleaser,
allReleases: async function* () {
yield { data: [] };
},
};
const result = await findTagFromReleases(
releaser,
owner,
repo,
targetTag,
);
assert.strictEqual(result, undefined);
});
});
describe("when the tag_name is an empty string", () => {
const emptyTag = "";
it("finds a matching release in first batch of results", async () => {
const targetRelease = {
...mockRelease,
owner,
repo,
tag_name: emptyTag,
};
const otherRelease = {
...mockRelease,
owner,
repo,
tag_name: "v1.0.1",
};
const releaser = {
...mockReleaser,
allReleases: async function* () {
yield { data: [targetRelease] };
yield { data: [otherRelease] };
},
};
const result = await findTagFromReleases(
releaser,
owner,
repo,
emptyTag,
);
assert.deepStrictEqual(result, targetRelease);
});
it("finds a matching release in second batch of results", async () => {
const targetRelease = {
...mockRelease,
owner,
repo,
tag_name: emptyTag,
};
const otherRelease = {
...mockRelease,
owner,
repo,
tag_name: "v1.0.1",
};
const releaser = {
...mockReleaser,
allReleases: async function* () {
yield { data: [otherRelease] };
yield { data: [targetRelease] };
},
};
const result = await findTagFromReleases(
releaser,
owner,
repo,
emptyTag,
);
assert.deepStrictEqual(result, targetRelease);
});
it("returns undefined when a release is not found in any batch", async () => {
const otherRelease = {
...mockRelease,
owner,
repo,
tag_name: "v1.0.1",
};
const releaser = {
...mockReleaser,
allReleases: async function* () {
yield { data: [otherRelease] };
yield { data: [otherRelease] };
},
};
const result = await findTagFromReleases(
releaser,
owner,
repo,
emptyTag,
);
assert.strictEqual(result, undefined);
});
it("returns undefined when no releases are returned", async () => {
const releaser = {
...mockReleaser,
allReleases: async function* () {
yield { data: [] };
},
};
const result = await findTagFromReleases(
releaser,
owner,
repo,
emptyTag,
);
assert.strictEqual(result, undefined);
});
});
});
});