Skip to content

Test the resulting git trees to ensure correct changes have persisted #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 23, 2024
Merged

Test the resulting git trees to ensure correct changes have persisted #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ab9a234
Test the resulting git tree hashes after mutation
s0 Aug 23, 2024
4c8d912
Test the file hashes in tests
s0 Aug 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/core.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,7 @@ export const commitFilesFromBase64 = async ({
input: {
refId: info.targetBranch.id,
oid: baseOid,
force: true,
},
});

Expand Down
32 changes: 32 additions & 0 deletions src/github/graphql/queries.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ import type {
CreateRefMutationVariables,
DeleteRefMutation,
DeleteRefMutationVariables,
GetRefTreeQuery,
GetRefTreeQueryVariables,
GetRepositoryMetadataQuery,
GetRepositoryMetadataQueryVariables,
UpdateRefMutation,
Expand Down Expand Up @@ -83,6 +85,31 @@ const CREATE_COMMIT_ON_BRANCH = /* GraphQL */ `
}
`;

/** For tests only */
const GET_REF_TREE = /* GraphQL */ `
query getRefTree(
$owner: String!
$name: String!
$ref: String!
$path: String!
) {
repository(owner: $owner, name: $name) {
ref(qualifiedName: $ref) {
target {
... on Commit {
tree {
oid
}
file(path: $path) {
oid
}
}
}
}
}
}
`;

export const getRepositoryMetadata = async (
o: GitHubClient,
v: GetRepositoryMetadataQueryVariables,
Expand Down Expand Up @@ -117,3 +144,8 @@ export const createCommitOnBranchQuery = async (
v: CreateCommitOnBranchMutationVariables,
): Promise<CreateCommitOnBranchMutation> =>
o.graphql<CreateCommitOnBranchMutation>(CREATE_COMMIT_ON_BRANCH, v);

export const getRefTreeQuery = async (
o: GitHubClient,
v: GetRefTreeQueryVariables,
): Promise<GetRefTreeQuery> => o.graphql<GetRefTreeQuery>(GET_REF_TREE, v);
207 changes: 177 additions & 30 deletions src/test/integration/node.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,38 +5,88 @@ import { commitFilesFromBuffers } from "../../node.js";
import { deleteBranches } from "./util.js";
import {
createRefMutation,
getRefTreeQuery,
getRepositoryMetadata,
} from "../../github/graphql/queries.js";

const octokit = getOctokit(ENV.GITHUB_TOKEN);

const TEST_BRANCH_PREFIX = `${ROOT_TEST_BRANCH_PREFIX}-node`;

const TEST_TARGET_COMMIT = "fce2760017eab6d85388ed5cfdfac171559d80b3";
/**
* For tests, important that this commit is not an ancestor of TEST_TARGET_COMMIT,
* to ensure that non-fast-forward pushes are tested
*/
const TEST_TARGET_COMMIT_2 = "7ba8473f02849de3b5449b25fc83c5245d338d94";
const TEST_TARGET_TREE_2 = "95c9ea756f3686614dcdc1c42f7f654b684cdac2";

const BASIC_FILE_CHANGES_PATH = "foo.txt";
const BASIC_FILE_CHANGES_OID = "0e23339619d605319ec4b49a0ac9dd94598eff8e";
const BASIC_FILE_CONTENTS = {
message: {
headline: "Test commit",
body: "This is a test commit",
},
fileChanges: {
additions: [
{
path: BASIC_FILE_CHANGES_PATH,
contents: Buffer.alloc(1024, "Hello, world!"),
},
],
},
log,
};

const TEST_TARGET_TREE_WITH_BASIC_CHANGES =
"a3431c9b42b71115c52bc6fbf9da3682cf0ed5e8";

describe("node", () => {
const branches: string[] = [];

// Set timeout to 1 minute
jest.setTimeout(60 * 1000);

const contents = Buffer.alloc(1024, "Hello, world!");
const BASIC_FILE_CONTENTS = {
message: {
headline: "Test commit",
body: "This is a test commit",
},
fileChanges: {
additions: [
{
path: `foo.txt`,
contents,
},
],
},
log,
};

let repositoryId: string;

const expectBranchHasTree = async ({
branch,
treeOid,
file,
}: {
branch: string;
treeOid?: string;
file?: {
path: string;
oid: string;
};
}) => {
const ref = (
await getRefTreeQuery(octokit, {
owner: REPO.owner,
name: REPO.repository,
ref: `refs/heads/${branch}`,
path: file?.path ?? "package.json",
})
).repository?.ref?.target;

if (!ref) {
throw new Error("Unexpected missing ref");
}

if ("tree" in ref) {
if (treeOid) {
expect(ref.tree.oid).toEqual(treeOid);
}
if (file) {
expect(ref.file?.oid).toEqual(file.oid);
}
} else {
throw new Error("Expected ref to have a tree");
}
};

beforeAll(async () => {
const response = await getRepositoryMetadata(octokit, {
owner: REPO.owner,
Expand All @@ -53,12 +103,26 @@ describe("node", () => {
describe("commitFilesFromBuffers", () => {
describe("can commit single file of various sizes", () => {
const SIZES_BYTES = {
"1KiB": 1024,
"1MiB": 1024 * 1024,
"10MiB": 1024 * 1024 * 10,
"1KiB": {
sizeBytes: 1024,
treeOid: "547dfe4079b53c3b45a6717ac1ed6d98512f0a1c",
fileOid: "0e23339619d605319ec4b49a0ac9dd94598eff8e",
},
"1MiB": {
sizeBytes: 1024 * 1024,
treeOid: "a6dca57388cf08de146bcc01a2113b218d6c2858",
fileOid: "a1d7fed1b4a8de1b665dc4f604015b2d87ef978f",
},
"10MiB": {
sizeBytes: 1024 * 1024 * 10,
treeOid: "c4788256a2c1e3ea4267cff0502a656d992248ec",
fileOid: "e36e74edbb6d3fc181ef584a50f8ee55585d27cc",
},
};

for (const [sizeName, sizeBytes] of Object.entries(SIZES_BYTES)) {
for (const [sizeName, { sizeBytes, treeOid, fileOid }] of Object.entries(
SIZES_BYTES,
)) {
it(`Can commit a ${sizeName}`, async () => {
const branch = `${TEST_BRANCH_PREFIX}-${sizeName}`;
branches.push(branch);
Expand All @@ -69,7 +133,7 @@ describe("node", () => {
...REPO,
branch,
base: {
branch: "main",
commit: TEST_TARGET_COMMIT,
},
message: {
headline: "Test commit",
Expand All @@ -85,10 +149,43 @@ describe("node", () => {
},
log,
});

await expectBranchHasTree({
branch,
treeOid,
file: {
path: `${sizeName}.txt`,
oid: fileOid,
},
});
});
}
});

it("can commit using branch as a base", async () => {
const branch = `${TEST_BRANCH_PREFIX}-branch-base`;
branches.push(branch);

await commitFilesFromBuffers({
octokit,
...REPO,
branch,
base: {
branch: "main",
},
...BASIC_FILE_CONTENTS,
});

// Don't test tree for this one as it will change over time / be unstable
await expectBranchHasTree({
branch,
file: {
path: BASIC_FILE_CHANGES_PATH,
oid: BASIC_FILE_CHANGES_OID,
},
});
});

it("can commit using tag as a base", async () => {
const branch = `${TEST_BRANCH_PREFIX}-tag-base`;
branches.push(branch);
Expand All @@ -102,6 +199,15 @@ describe("node", () => {
},
...BASIC_FILE_CONTENTS,
});

// Don't test tree for this one as it will change over time / be unstable
await expectBranchHasTree({
branch,
file: {
path: BASIC_FILE_CHANGES_PATH,
oid: BASIC_FILE_CHANGES_OID,
},
});
});

it("can commit using commit as a base", async () => {
Expand All @@ -113,10 +219,19 @@ describe("node", () => {
...REPO,
branch,
base: {
commit: "fce2760017eab6d85388ed5cfdfac171559d80b3",
commit: TEST_TARGET_COMMIT,
},
...BASIC_FILE_CONTENTS,
});

await expectBranchHasTree({
branch,
treeOid: TEST_TARGET_TREE_WITH_BASIC_CHANGES,
file: {
path: BASIC_FILE_CHANGES_PATH,
oid: BASIC_FILE_CHANGES_OID,
},
});
});

describe("existing branches", () => {
Expand All @@ -129,7 +244,7 @@ describe("node", () => {
input: {
repositoryId,
name: `refs/heads/${branch}`,
oid: "31ded45f25a07726e02fd111d4c230718b49fa2a",
oid: TEST_TARGET_COMMIT_2,
},
});

Expand All @@ -138,11 +253,20 @@ describe("node", () => {
...REPO,
branch,
base: {
commit: "fce2760017eab6d85388ed5cfdfac171559d80b3",
commit: TEST_TARGET_COMMIT,
},
...BASIC_FILE_CONTENTS,
force: true,
});

await expectBranchHasTree({
branch,
treeOid: TEST_TARGET_TREE_WITH_BASIC_CHANGES,
file: {
path: BASIC_FILE_CHANGES_PATH,
oid: BASIC_FILE_CHANGES_OID,
},
});
});

it("cannot commit to existing branch when force is false", async () => {
Expand All @@ -154,7 +278,7 @@ describe("node", () => {
input: {
repositoryId,
name: `refs/heads/${branch}`,
oid: "31ded45f25a07726e02fd111d4c230718b49fa2a",
oid: TEST_TARGET_COMMIT_2,
},
});

Expand All @@ -164,13 +288,18 @@ describe("node", () => {
...REPO,
branch,
base: {
commit: "fce2760017eab6d85388ed5cfdfac171559d80b3",
commit: TEST_TARGET_COMMIT,
},
...BASIC_FILE_CONTENTS,
}),
).rejects.toThrow(
`Branch ${branch} exists already and does not match base`,
);

await expectBranchHasTree({
branch,
treeOid: TEST_TARGET_TREE_2,
});
});

it("can commit to existing branch when force is false and target matches base", async () => {
Expand All @@ -182,7 +311,7 @@ describe("node", () => {
input: {
repositoryId,
name: `refs/heads/${branch}`,
oid: "31ded45f25a07726e02fd111d4c230718b49fa2a",
oid: TEST_TARGET_COMMIT,
},
});

Expand All @@ -191,10 +320,19 @@ describe("node", () => {
...REPO,
branch,
base: {
commit: "31ded45f25a07726e02fd111d4c230718b49fa2a",
commit: TEST_TARGET_COMMIT,
},
...BASIC_FILE_CONTENTS,
});

await expectBranchHasTree({
branch,
treeOid: TEST_TARGET_TREE_WITH_BASIC_CHANGES,
file: {
path: BASIC_FILE_CHANGES_PATH,
oid: BASIC_FILE_CHANGES_OID,
},
});
});

it("can commit to same branch as base", async () => {
Expand All @@ -206,7 +344,7 @@ describe("node", () => {
input: {
repositoryId,
name: `refs/heads/${branch}`,
oid: "31ded45f25a07726e02fd111d4c230718b49fa2a",
oid: TEST_TARGET_COMMIT,
},
});

Expand All @@ -219,6 +357,15 @@ describe("node", () => {
},
...BASIC_FILE_CONTENTS,
});

await expectBranchHasTree({
branch,
treeOid: TEST_TARGET_TREE_WITH_BASIC_CHANGES,
file: {
path: BASIC_FILE_CHANGES_PATH,
oid: BASIC_FILE_CHANGES_OID,
},
});
});
});
});
Expand Down