mirror of
https://code.forgejo.org/actions/git-backporting.git
synced 2025-02-22 18:45:44 -05:00
6042bcc40b
The auto-no-squash option is added to: * backport all the commits when the pull/merge request has been merged * backport the squashed commit otherwise It is equivalent to dynamically adjust the value of the no-squash option, depending on the context. The no-squash option is kept for backward compatibility for a single use case: backporting the merged commit instead of backporting the commits of the pull/merge request request. Detecting if a pull/merge request was squashed or not depends on the underlying forge: * Forgejo / GitHub: use the API to count the number of parents * GitLab: if the squash_commit_sha is set, the merge request was squashed If the pull/merge request is open, always backport all the commits it contains. Fixes: https://github.com/kiegroup/git-backporting/issues/113 Co-authored-by: Andrea Lamparelli <a.lamparelli95@gmail.com>
353 lines
No EOL
11 KiB
TypeScript
353 lines
No EOL
11 KiB
TypeScript
import { Args } from "@bp/service/args/args.types";
|
|
import { Configs } from "@bp/service/configs/configs.types";
|
|
import PullRequestConfigsParser from "@bp/service/configs/pullrequest/pr-configs-parser";
|
|
import GitClientFactory from "@bp/service/git/git-client-factory";
|
|
import { GitClientType } from "@bp/service/git/git.types";
|
|
import { getAxiosMocked } from "../../../support/mock/git-client-mock-support";
|
|
import { MERGED_SQUASHED_MR } from "../../../support/mock/gitlab-data";
|
|
import GitLabClient from "@bp/service/git/gitlab/gitlab-client";
|
|
import GitLabMapper from "@bp/service/git/gitlab/gitlab-mapper";
|
|
|
|
jest.spyOn(GitLabMapper.prototype, "mapPullRequest");
|
|
jest.spyOn(GitLabClient.prototype, "getPullRequest");
|
|
|
|
jest.mock("axios", () => {
|
|
return {
|
|
create: jest.fn(() => ({
|
|
get: getAxiosMocked,
|
|
})),
|
|
};
|
|
});
|
|
|
|
describe("gitlab merge request config parser", () => {
|
|
|
|
const mergedPRUrl = `https://my.gitlab.host.com/superuser/backporting-example/-/merge_requests/${MERGED_SQUASHED_MR.iid}`;
|
|
|
|
let configParser: PullRequestConfigsParser;
|
|
|
|
beforeAll(() => {
|
|
GitClientFactory.reset();
|
|
GitClientFactory.getOrCreate(GitClientType.GITLAB, "whatever", "my.gitlab.host.com");
|
|
});
|
|
|
|
beforeEach(() => {
|
|
configParser = new PullRequestConfigsParser();
|
|
});
|
|
|
|
test("multiple backports", async () => {
|
|
const args: Args = {
|
|
dryRun: false,
|
|
auth: "",
|
|
pullRequest: mergedPRUrl,
|
|
targetBranch: "v1, v2, v3",
|
|
gitUser: "Me",
|
|
gitEmail: "me@email.com",
|
|
title: "New Title",
|
|
body: "New Body",
|
|
bodyPrefix: "New Body Prefix -",
|
|
reviewers: [],
|
|
assignees: ["user3", "user4"],
|
|
inheritReviewers: false,
|
|
labels: [],
|
|
inheritLabels: false,
|
|
comments: [],
|
|
squash: true,
|
|
};
|
|
|
|
const configs: Configs = await configParser.parseAndValidate(args);
|
|
|
|
expect(GitLabClient.prototype.getPullRequest).toBeCalledTimes(1);
|
|
expect(GitLabClient.prototype.getPullRequest).toBeCalledWith("superuser", "backporting-example", 1, true);
|
|
expect(GitLabMapper.prototype.mapPullRequest).toBeCalledTimes(1);
|
|
expect(GitLabMapper.prototype.mapPullRequest).toBeCalledWith(expect.anything(), []);
|
|
|
|
expect(configs.dryRun).toEqual(false);
|
|
expect(configs.auth).toEqual("");
|
|
expect(configs.folder).toEqual(process.cwd() + "/bp");
|
|
expect(configs.backportPullRequests.length).toEqual(3);
|
|
expect(configs.backportPullRequests).toEqual(
|
|
expect.arrayContaining([
|
|
{
|
|
owner: "superuser",
|
|
repo: "backporting-example",
|
|
head: "bp-v1-ebb1eca",
|
|
base: "v1",
|
|
title: "New Title",
|
|
body: "New Body Prefix -New Body",
|
|
reviewers: [],
|
|
assignees: ["user3", "user4"],
|
|
labels: [],
|
|
comments: [],
|
|
},
|
|
{
|
|
owner: "superuser",
|
|
repo: "backporting-example",
|
|
head: "bp-v2-ebb1eca",
|
|
base: "v2",
|
|
title: "New Title",
|
|
body: "New Body Prefix -New Body",
|
|
reviewers: [],
|
|
assignees: ["user3", "user4"],
|
|
labels: [],
|
|
comments: [],
|
|
},
|
|
{
|
|
owner: "superuser",
|
|
repo: "backporting-example",
|
|
head: "bp-v3-ebb1eca",
|
|
base: "v3",
|
|
title: "New Title",
|
|
body: "New Body Prefix -New Body",
|
|
reviewers: [],
|
|
assignees: ["user3", "user4"],
|
|
labels: [],
|
|
comments: [],
|
|
}
|
|
])
|
|
);
|
|
});
|
|
|
|
test("multiple backports ignore duplicates", async () => {
|
|
const args: Args = {
|
|
dryRun: false,
|
|
auth: "",
|
|
pullRequest: mergedPRUrl,
|
|
targetBranch: "v1, v2, v3, v1",
|
|
gitUser: "Me",
|
|
gitEmail: "me@email.com",
|
|
title: "New Title",
|
|
body: "New Body",
|
|
bodyPrefix: "New Body Prefix -",
|
|
reviewers: [],
|
|
assignees: ["user3", "user4"],
|
|
inheritReviewers: false,
|
|
labels: [],
|
|
inheritLabels: false,
|
|
comments: [],
|
|
squash: true,
|
|
};
|
|
|
|
const configs: Configs = await configParser.parseAndValidate(args);
|
|
|
|
expect(GitLabClient.prototype.getPullRequest).toBeCalledTimes(1);
|
|
expect(GitLabClient.prototype.getPullRequest).toBeCalledWith("superuser", "backporting-example", 1, true);
|
|
expect(GitLabMapper.prototype.mapPullRequest).toBeCalledTimes(1);
|
|
expect(GitLabMapper.prototype.mapPullRequest).toBeCalledWith(expect.anything(), []);
|
|
|
|
expect(configs.dryRun).toEqual(false);
|
|
expect(configs.auth).toEqual("");
|
|
expect(configs.folder).toEqual(process.cwd() + "/bp");
|
|
expect(configs.backportPullRequests.length).toEqual(3);
|
|
expect(configs.backportPullRequests).toEqual(
|
|
expect.arrayContaining([
|
|
{
|
|
owner: "superuser",
|
|
repo: "backporting-example",
|
|
head: "bp-v1-ebb1eca",
|
|
base: "v1",
|
|
title: "New Title",
|
|
body: "New Body Prefix -New Body",
|
|
reviewers: [],
|
|
assignees: ["user3", "user4"],
|
|
labels: [],
|
|
comments: [],
|
|
},
|
|
{
|
|
owner: "superuser",
|
|
repo: "backporting-example",
|
|
head: "bp-v2-ebb1eca",
|
|
base: "v2",
|
|
title: "New Title",
|
|
body: "New Body Prefix -New Body",
|
|
reviewers: [],
|
|
assignees: ["user3", "user4"],
|
|
labels: [],
|
|
comments: [],
|
|
},
|
|
{
|
|
owner: "superuser",
|
|
repo: "backporting-example",
|
|
head: "bp-v3-ebb1eca",
|
|
base: "v3",
|
|
title: "New Title",
|
|
body: "New Body Prefix -New Body",
|
|
reviewers: [],
|
|
assignees: ["user3", "user4"],
|
|
labels: [],
|
|
comments: [],
|
|
}
|
|
])
|
|
);
|
|
});
|
|
|
|
test("multiple backports with custom branch name", async () => {
|
|
const args: Args = {
|
|
dryRun: false,
|
|
auth: "",
|
|
pullRequest: mergedPRUrl,
|
|
targetBranch: "v1, v2, v3",
|
|
gitUser: "Me",
|
|
gitEmail: "me@email.com",
|
|
title: "New Title",
|
|
body: "New Body",
|
|
bodyPrefix: "New Body Prefix -",
|
|
reviewers: [],
|
|
assignees: ["user3", "user4"],
|
|
inheritReviewers: false,
|
|
labels: [],
|
|
inheritLabels: false,
|
|
comments: [],
|
|
bpBranchName: "custom-branch",
|
|
squash: true,
|
|
};
|
|
|
|
const configs: Configs = await configParser.parseAndValidate(args);
|
|
|
|
expect(GitLabClient.prototype.getPullRequest).toBeCalledTimes(1);
|
|
expect(GitLabClient.prototype.getPullRequest).toBeCalledWith("superuser", "backporting-example", 1, true);
|
|
expect(GitLabMapper.prototype.mapPullRequest).toBeCalledTimes(1);
|
|
expect(GitLabMapper.prototype.mapPullRequest).toBeCalledWith(expect.anything(), []);
|
|
|
|
expect(configs.dryRun).toEqual(false);
|
|
expect(configs.auth).toEqual("");
|
|
expect(configs.folder).toEqual(process.cwd() + "/bp");
|
|
expect(configs.backportPullRequests.length).toEqual(3);
|
|
expect(configs.backportPullRequests).toEqual(
|
|
expect.arrayContaining([
|
|
{
|
|
owner: "superuser",
|
|
repo: "backporting-example",
|
|
head: "custom-branch-v1",
|
|
base: "v1",
|
|
title: "New Title",
|
|
body: "New Body Prefix -New Body",
|
|
reviewers: [],
|
|
assignees: ["user3", "user4"],
|
|
labels: [],
|
|
comments: [],
|
|
},
|
|
{
|
|
owner: "superuser",
|
|
repo: "backporting-example",
|
|
head: "custom-branch-v2",
|
|
base: "v2",
|
|
title: "New Title",
|
|
body: "New Body Prefix -New Body",
|
|
reviewers: [],
|
|
assignees: ["user3", "user4"],
|
|
labels: [],
|
|
comments: [],
|
|
},
|
|
{
|
|
owner: "superuser",
|
|
repo: "backporting-example",
|
|
head: "custom-branch-v3",
|
|
base: "v3",
|
|
title: "New Title",
|
|
body: "New Body Prefix -New Body",
|
|
reviewers: [],
|
|
assignees: ["user3", "user4"],
|
|
labels: [],
|
|
comments: [],
|
|
}
|
|
])
|
|
);
|
|
});
|
|
|
|
test("multiple backports with multiple custom branch names", async () => {
|
|
const args: Args = {
|
|
dryRun: false,
|
|
auth: "",
|
|
pullRequest: mergedPRUrl,
|
|
targetBranch: "v1, v2, v3",
|
|
gitUser: "Me",
|
|
gitEmail: "me@email.com",
|
|
title: "New Title",
|
|
body: "New Body",
|
|
bodyPrefix: "New Body Prefix -",
|
|
reviewers: [],
|
|
assignees: ["user3", "user4"],
|
|
inheritReviewers: false,
|
|
labels: [],
|
|
inheritLabels: false,
|
|
comments: [],
|
|
bpBranchName: "custom1, custom2, custom3",
|
|
squash: true,
|
|
};
|
|
|
|
const configs: Configs = await configParser.parseAndValidate(args);
|
|
|
|
expect(GitLabClient.prototype.getPullRequest).toBeCalledTimes(1);
|
|
expect(GitLabClient.prototype.getPullRequest).toBeCalledWith("superuser", "backporting-example", 1, true);
|
|
expect(GitLabMapper.prototype.mapPullRequest).toBeCalledTimes(1);
|
|
expect(GitLabMapper.prototype.mapPullRequest).toBeCalledWith(expect.anything(), []);
|
|
|
|
expect(configs.dryRun).toEqual(false);
|
|
expect(configs.auth).toEqual("");
|
|
expect(configs.folder).toEqual(process.cwd() + "/bp");
|
|
expect(configs.backportPullRequests.length).toEqual(3);
|
|
expect(configs.backportPullRequests).toEqual(
|
|
expect.arrayContaining([
|
|
{
|
|
owner: "superuser",
|
|
repo: "backporting-example",
|
|
head: "custom1",
|
|
base: "v1",
|
|
title: "New Title",
|
|
body: "New Body Prefix -New Body",
|
|
reviewers: [],
|
|
assignees: ["user3", "user4"],
|
|
labels: [],
|
|
comments: [],
|
|
},
|
|
{
|
|
owner: "superuser",
|
|
repo: "backporting-example",
|
|
head: "custom2",
|
|
base: "v2",
|
|
title: "New Title",
|
|
body: "New Body Prefix -New Body",
|
|
reviewers: [],
|
|
assignees: ["user3", "user4"],
|
|
labels: [],
|
|
comments: [],
|
|
},
|
|
{
|
|
owner: "superuser",
|
|
repo: "backporting-example",
|
|
head: "custom3",
|
|
base: "v3",
|
|
title: "New Title",
|
|
body: "New Body Prefix -New Body",
|
|
reviewers: [],
|
|
assignees: ["user3", "user4"],
|
|
labels: [],
|
|
comments: [],
|
|
}
|
|
])
|
|
);
|
|
});
|
|
|
|
test("multiple backports with incorrect number of bp branch names", async () => {
|
|
const args: Args = {
|
|
dryRun: false,
|
|
auth: "",
|
|
pullRequest: mergedPRUrl,
|
|
targetBranch: "v1, v2, v3",
|
|
gitUser: "Me",
|
|
gitEmail: "me@email.com",
|
|
title: "New Title",
|
|
body: "New Body",
|
|
bodyPrefix: "New Body Prefix -",
|
|
reviewers: [],
|
|
assignees: ["user3", "user4"],
|
|
inheritReviewers: false,
|
|
labels: [],
|
|
inheritLabels: false,
|
|
comments: [],
|
|
bpBranchName: "custom-branch1, custom-branch2, custom-branch2, custom-branch3, custom-branch4",
|
|
};
|
|
|
|
await expect(() => configParser.parseAndValidate(args)).rejects.toThrow("The number of backport branch names, if provided, must match the number of target branches or just one, provided 4 branch names instead");
|
|
});
|
|
}); |