mirror of
https://github.com/ToolJet/ToolJet
synced 2026-05-24 09:28:31 +00:00
d10ca6f647
* Add Cypress test cases for gitsync functionality * update the UI cases * update custom commands * Update the test cases * Add version tagging test cases * update the test cases * fix commit function * update the failing test cases * update failing test cases * update the selectors * update the test cases
447 lines
14 KiB
JavaScript
447 lines
14 KiB
JavaScript
import { gitSyncSelectors as GS } from "Selectors/platform/gitsync";
|
|
|
|
Cypress.Commands.add("gitSyncCheckAndConfigure", () => {
|
|
return cy.getAuthHeaders().then((headers) => {
|
|
const orgId = Cypress.env("workspaceId");
|
|
|
|
return cy
|
|
.request({
|
|
method: "GET",
|
|
url: `${Cypress.env("server_host")}/api/git-sync/${orgId}/status`,
|
|
headers,
|
|
failOnStatusCode: false,
|
|
})
|
|
.then((res) => {
|
|
const isConfigured =
|
|
res.status === 200 && res.body?.is_finalized && res.body?.is_enabled;
|
|
|
|
if (isConfigured) {
|
|
Cypress.log({
|
|
message:
|
|
"[gitSync] Already configured and enabled — skipping setup",
|
|
});
|
|
return;
|
|
}
|
|
|
|
Cypress.log({
|
|
message:
|
|
"[gitSync] Not configured — setting up GitHub HTTPS git sync via API",
|
|
});
|
|
|
|
const privateKey = Cypress.env("GITHUB_PRIVATE_KEY");
|
|
|
|
return cy
|
|
.request({
|
|
method: "POST",
|
|
url: `${Cypress.env("server_host")}/api/git-sync/configs`,
|
|
headers,
|
|
body: {
|
|
gitUrl: Cypress.env("GITHUB_REPO_URL"),
|
|
branchName: "master",
|
|
githubEnterpriseUrl: "",
|
|
githubEnterpriseApiUrl: "",
|
|
githubAppId: Cypress.env("GITHUB_APP_ID"),
|
|
githubAppInstallationId: Cypress.env(
|
|
"GITHUB_APP_INSTALLATION_ID",
|
|
),
|
|
githubAppPrivateKey: privateKey,
|
|
useEnvConfig: false,
|
|
gitType: "github_https",
|
|
},
|
|
})
|
|
.then((configRes) => {
|
|
expect(configRes.status, "Git sync config").to.equal(201);
|
|
Cypress.log({
|
|
message: "[gitSync] GitHub HTTPS configured and enabled",
|
|
});
|
|
});
|
|
});
|
|
});
|
|
});
|
|
|
|
Cypress.Commands.add("gitSyncGetBranchId", (branchName) => {
|
|
return cy.getAuthHeaders().then((headers) => {
|
|
return cy
|
|
.request({
|
|
method: "GET",
|
|
url: `${Cypress.env("server_host")}/api/workspace-branches`,
|
|
headers,
|
|
})
|
|
.then((res) => {
|
|
const branches = Array.isArray(res.body)
|
|
? res.body
|
|
: res.body?.branches || [];
|
|
const branch = branches.find((b) => b?.name === branchName);
|
|
return branch?.id || "";
|
|
});
|
|
});
|
|
});
|
|
|
|
Cypress.Commands.add("gitSyncCreateBranchViaApi", (branchName) => {
|
|
return cy.getAuthHeaders().then((headers) => {
|
|
return cy
|
|
.request({
|
|
method: "GET",
|
|
url: `${Cypress.env("server_host")}/api/workspace-branches`,
|
|
headers,
|
|
})
|
|
.then((res) => {
|
|
const branches = Array.isArray(res.body)
|
|
? res.body
|
|
: res.body?.branches || [];
|
|
const exists = branches.some((b) => b?.name === branchName);
|
|
|
|
if (exists) {
|
|
Cypress.log({
|
|
message: `[gitSync] Branch '${branchName}' already exists`,
|
|
});
|
|
return;
|
|
}
|
|
|
|
return cy
|
|
.request({
|
|
method: "POST",
|
|
url: `${Cypress.env("server_host")}/api/workspace-branches`,
|
|
headers,
|
|
body: { name: branchName },
|
|
})
|
|
.then((branchRes) => {
|
|
expect(branchRes.status, `Create branch '${branchName}'`).to.equal(
|
|
201,
|
|
);
|
|
Cypress.log({
|
|
message: `[gitSync] Branch '${branchName}' created`,
|
|
});
|
|
});
|
|
});
|
|
});
|
|
});
|
|
|
|
Cypress.Commands.add(
|
|
"gitSyncImportAppFromFixture",
|
|
(fixturePath, appName, branchName) => {
|
|
return cy.getAuthHeaders().then((headers) => {
|
|
const orgId = Cypress.env("workspaceId");
|
|
|
|
return cy
|
|
.request({
|
|
method: "GET",
|
|
url: `${Cypress.env("server_host")}/api/workspace-branches`,
|
|
headers,
|
|
})
|
|
.then((branchRes) => {
|
|
const branches = Array.isArray(branchRes.body)
|
|
? branchRes.body
|
|
: branchRes.body?.branches || [];
|
|
const branch = branches.find((b) => b?.name === branchName);
|
|
const branchId = branch?.id || "";
|
|
|
|
return cy.fixture(fixturePath).then((fixtureData) => {
|
|
fixtureData.organization_id = orgId;
|
|
|
|
// Override app name in fixture
|
|
fixtureData.app = (fixtureData.app || []).map((app) => ({
|
|
...app,
|
|
appName,
|
|
definition: app.definition?.appV2
|
|
? {
|
|
...app.definition,
|
|
appV2: { ...app.definition.appV2, name: appName },
|
|
}
|
|
: app.definition,
|
|
}));
|
|
|
|
if (branchId) fixtureData.branchId = branchId;
|
|
|
|
return cy
|
|
.request({
|
|
method: "POST",
|
|
url: `${Cypress.env("server_host")}/api/v2/resources/import`,
|
|
headers: {
|
|
tj_auth_token: headers.Cookie.replace("tj_auth_token=", ""),
|
|
"tj-workspace-id": orgId,
|
|
},
|
|
body: fixtureData,
|
|
})
|
|
.then((importRes) => {
|
|
expect(importRes.status, `Import app '${appName}'`).to.equal(
|
|
201,
|
|
);
|
|
const appId = importRes.body?.imports?.app?.[0]?.id;
|
|
Cypress.env("appId", appId);
|
|
Cypress.log({
|
|
message: `[gitSync] App '${appName}' imported to branch '${branchName}' (id: ${appId})`,
|
|
});
|
|
return appId;
|
|
});
|
|
});
|
|
});
|
|
});
|
|
},
|
|
);
|
|
|
|
Cypress.Commands.add("gitSyncCreateBranchViaUI", (branchName) => {
|
|
cy.get("body").then(($body) => {
|
|
if ($body.find(GS.wsBranchPopover).length === 0) {
|
|
cy.get(GS.wsBranchHeader).click();
|
|
}
|
|
});
|
|
cy.get(GS.wsBranchPopover).should("be.visible");
|
|
cy.get(GS.wsCreateBranchBtn).click();
|
|
|
|
cy.get(GS.branchNameInput).should("be.visible").clear().type(branchName);
|
|
cy.contains("button", "Create branch").click();
|
|
|
|
cy.get(GS.branchNameInput).should("not.exist");
|
|
cy.get(GS.wsCurrentBranch).should("contain.text", branchName);
|
|
cy.log(`[gitSync] Branch '${branchName}' created via UI`);
|
|
});
|
|
|
|
Cypress.Commands.add("gitSyncSwitchBranch", (branchName) => {
|
|
cy.get(GS.wsBranchHeader).click();
|
|
cy.get(GS.wsBranchPopover).should("be.visible");
|
|
cy.get(GS.wsSwitchBranchBtn).click();
|
|
|
|
cy.get(GS.wsBranchSearchInput).should("be.visible").clear().type(branchName);
|
|
cy.get(GS.wsBranchListItem(branchName)).should("be.visible").click();
|
|
|
|
cy.wait(1000);
|
|
cy.get(GS.wsCurrentBranch).should("contain.text", branchName);
|
|
cy.log(`[gitSync] Switched to branch '${branchName}'`);
|
|
});
|
|
|
|
Cypress.Commands.add("gitSyncDashboardPush", (message) => {
|
|
// The "Commit" CTA button is only rendered when the URL includes "data-sources".
|
|
// Navigate there so the button is visible, then open the push modal.
|
|
const workspace = Cypress.env("workspaceSlug") || "";
|
|
const dsUrl = workspace ? `/${workspace}/data-sources` : "/data-sources";
|
|
cy.visit(dsUrl, { redirectionLimit: 20 });
|
|
cy.wait(3000);
|
|
|
|
cy.get(GS.wsGitCommitBtn, { timeout: 15000 }).should("be.visible").click();
|
|
|
|
cy.get(GS.modalTitle).should("be.visible");
|
|
cy.get(GS.commitMessageInput).should("be.visible").and("have.value", "");
|
|
cy.get(GS.modalCommitBtn).should("be.disabled");
|
|
|
|
cy.get(GS.commitMessageInput).type(message);
|
|
|
|
cy.wait(2000);
|
|
cy.get(GS.modalCommitBtn).should("be.enabled").click();
|
|
|
|
// Wait for modal to close = success
|
|
cy.get(GS.commitMessageInput, { timeout: 45000 }).should("not.exist");
|
|
cy.wait(2000);
|
|
cy.log(`[gitSync] Dashboard commit pushed: "${message}"`);
|
|
});
|
|
|
|
|
|
Cypress.Commands.add(
|
|
"gitHubWaitForCommitsAhead",
|
|
(headBranch, baseBranch = "master", retries = 10) => {
|
|
const owner = Cypress.env("GITHUB_REPO_OWNER");
|
|
const repo = Cypress.env("GITHUB_REPO_NAME");
|
|
|
|
const check = (remaining) => {
|
|
return cy
|
|
.request({
|
|
method: "GET",
|
|
url: `https://api.github.com/repos/${owner}/${repo}/compare/${baseBranch}...${headBranch}`,
|
|
headers: {
|
|
Authorization: `Bearer ${Cypress.env("GITHUB_TOKEN")}`,
|
|
Accept: "application/vnd.github+json",
|
|
},
|
|
})
|
|
.then((res) => {
|
|
const aheadBy = res.body.ahead_by;
|
|
if (aheadBy > 0) {
|
|
Cypress.log({
|
|
message: `[gitSync] Branch '${headBranch}' is ${aheadBy} commit(s) ahead of '${baseBranch}'`,
|
|
});
|
|
return;
|
|
}
|
|
if (remaining <= 0) {
|
|
throw new Error(
|
|
`Branch '${headBranch}' has no commits ahead of '${baseBranch}' after waiting`,
|
|
);
|
|
}
|
|
Cypress.log({
|
|
message: `[gitSync] Branch not ahead yet, retrying... (${remaining} left)`,
|
|
});
|
|
return cy.wait(3000).then(() => check(remaining - 1));
|
|
});
|
|
};
|
|
|
|
return check(retries);
|
|
},
|
|
);
|
|
|
|
Cypress.Commands.add(
|
|
"gitHubCreatePR",
|
|
(headBranch, title, baseBranch = "master") => {
|
|
const owner = Cypress.env("GITHUB_REPO_OWNER");
|
|
const repo = Cypress.env("GITHUB_REPO_NAME");
|
|
|
|
return cy
|
|
.request({
|
|
method: "POST",
|
|
url: `https://api.github.com/repos/${owner}/${repo}/pulls`,
|
|
headers: {
|
|
Authorization: `Bearer ${Cypress.env("GITHUB_TOKEN")}`,
|
|
Accept: "application/vnd.github+json",
|
|
},
|
|
body: { title, head: headBranch, base: baseBranch },
|
|
})
|
|
.then((res) => {
|
|
expect(res.status, "GitHub create PR").to.equal(201);
|
|
Cypress.env("prNumber", res.body.number);
|
|
Cypress.log({
|
|
message: `[gitSync] PR #${res.body.number} created: ${headBranch} → ${baseBranch}`,
|
|
});
|
|
return res.body.number;
|
|
});
|
|
},
|
|
);
|
|
|
|
Cypress.Commands.add("gitHubMergePR", (prNumber = Cypress.env("prNumber")) => {
|
|
const owner = Cypress.env("GITHUB_REPO_OWNER");
|
|
const repo = Cypress.env("GITHUB_REPO_NAME");
|
|
|
|
return cy
|
|
.request({
|
|
method: "PUT",
|
|
url: `https://api.github.com/repos/${owner}/${repo}/pulls/${prNumber}/merge`,
|
|
headers: {
|
|
Authorization: `Bearer ${Cypress.env("GITHUB_TOKEN")}`,
|
|
Accept: "application/vnd.github+json",
|
|
},
|
|
body: { merge_method: "squash" },
|
|
})
|
|
.then((res) => {
|
|
expect(res.status, `GitHub merge PR #${prNumber}`).to.equal(200);
|
|
Cypress.log({ message: `[gitSync] PR #${prNumber} merged to main` });
|
|
});
|
|
});
|
|
|
|
Cypress.Commands.add("gitHubDeleteBranch", (branchName) => {
|
|
const owner = Cypress.env("GITHUB_REPO_OWNER");
|
|
const repo = Cypress.env("GITHUB_REPO_NAME");
|
|
|
|
return cy
|
|
.request({
|
|
method: "DELETE",
|
|
url: `https://api.github.com/repos/${owner}/${repo}/git/refs/heads/${branchName}`,
|
|
headers: {
|
|
Authorization: `Bearer ${Cypress.env("GITHUB_TOKEN")}`,
|
|
Accept: "application/vnd.github+json",
|
|
},
|
|
failOnStatusCode: false,
|
|
})
|
|
.then((res) => {
|
|
Cypress.log({
|
|
message: `[gitSync] GitHub branch '${branchName}' deleted (${res.status})`,
|
|
});
|
|
});
|
|
});
|
|
|
|
|
|
Cypress.Commands.add("gitSyncGoToDashboard", () => {
|
|
const workspace = Cypress.env("workspaceSlug") || "";
|
|
const url = workspace ? `/${workspace}` : "/";
|
|
cy.visit(url, { redirectionLimit: 20 });
|
|
cy.wait(3000);
|
|
cy.get('[data-cy="dashboard-section-header"]', { timeout: 30000 }).should(
|
|
"be.visible",
|
|
);
|
|
});
|
|
|
|
|
|
Cypress.Commands.add("apiCreateModule", (moduleName, branchId) => {
|
|
return cy.getAuthHeaders().then((headers) =>
|
|
cy
|
|
.request({
|
|
method: "POST",
|
|
url: `${Cypress.env("server_host")}/api/modules`,
|
|
headers,
|
|
body: { name: moduleName, icon: "floppydisk", type: "module", branchId },
|
|
})
|
|
.then((res) => {
|
|
expect(res.status, `Create module '${moduleName}'`).to.equal(201);
|
|
const module = res.body;
|
|
Cypress.log({ message: `[gitSync] Module '${moduleName}' created (id: ${module.id})` });
|
|
return module;
|
|
}),
|
|
);
|
|
});
|
|
|
|
Cypress.Commands.add("apiGetModuleCorrelationId", (moduleId) => {
|
|
return cy.getAuthHeaders().then((headers) =>
|
|
cy
|
|
.request({
|
|
method: "GET",
|
|
url: `${Cypress.env("server_host")}/api/apps/${moduleId}`,
|
|
headers,
|
|
})
|
|
.then((res) => {
|
|
expect(res.status).to.equal(200);
|
|
const correlationId =
|
|
res.body?.co_relation_id ||
|
|
res.body?.app?.co_relation_id ||
|
|
res.body?.data?.co_relation_id;
|
|
expect(correlationId, "co_relation_id on module").to.be.a("string");
|
|
return correlationId;
|
|
}),
|
|
);
|
|
});
|
|
|
|
Cypress.Commands.add("apiRenameModule", (moduleId, newName) => {
|
|
return cy.getAuthHeaders().then((headers) =>
|
|
cy
|
|
.request({
|
|
method: "PUT",
|
|
url: `${Cypress.env("server_host")}/api/modules/${moduleId}`,
|
|
headers,
|
|
body: { app: { name: newName } },
|
|
})
|
|
.then((res) => {
|
|
expect(res.status, `Rename module to '${newName}'`).to.be.oneOf([200, 201, 204]);
|
|
Cypress.log({ message: `[gitSync] Module ${moduleId} renamed to '${newName}'` });
|
|
}),
|
|
);
|
|
});
|
|
|
|
|
|
Cypress.Commands.add("apiCreateAppOnBranch", (appName, branchId) => {
|
|
return cy.getAuthHeaders().then((headers) =>
|
|
cy
|
|
.request({
|
|
method: "POST",
|
|
url: `${Cypress.env("server_host")}/api/apps`,
|
|
headers,
|
|
body: { name: appName, icon: "floppydisk", type: "front-end", branchId },
|
|
})
|
|
.then((res) => {
|
|
expect(res.status, `Create app '${appName}'`).to.equal(201);
|
|
const app = res.body;
|
|
Cypress.log({ message: `[gitSync] App '${appName}' created (id: ${app.id})` });
|
|
return app;
|
|
}),
|
|
);
|
|
});
|
|
|
|
Cypress.Commands.add("apiGetAppIdByNameOnBranch", (appName, branchId) => {
|
|
return cy.getAuthHeaders().then((headers) =>
|
|
cy
|
|
.request({
|
|
method: "GET",
|
|
url: `${Cypress.env("server_host")}/api/apps?page=1&folder=&searchKey=${encodeURIComponent(appName)}&type=front-end&branch_id=${branchId}`,
|
|
headers,
|
|
})
|
|
.then((res) => {
|
|
expect(res.status).to.equal(200);
|
|
const apps = res.body?.apps || res.body?.meta?.apps || res.body || [];
|
|
const match = (Array.isArray(apps) ? apps : []).find((a) => a?.name === appName);
|
|
return match?.id || null;
|
|
}),
|
|
);
|
|
});
|