mirror of
https://github.com/hanzoai/frappe.git
synced 2026-11-09 14:28:40 +00:00
514 lines
16 KiB
JavaScript
514 lines
16 KiB
JavaScript
// Cypress tests for the Print Format Builder.
|
|
//
|
|
// Each test generates its own unique PF_NAME and tears it down in
|
|
// afterEach, so Cypress retries and parallel runs never collide.
|
|
|
|
// ─── shared helpers ───────────────────────────────────────────────────────────
|
|
|
|
function pf_name() {
|
|
return `Cypress PF ${Date.now()}-${Math.random().toString(36).slice(2, 7)}`;
|
|
}
|
|
|
|
function cleanup(win, name) {
|
|
const csrf_token = win.frappe?.csrf_token;
|
|
if (!csrf_token) return;
|
|
cy.request({
|
|
method: "DELETE",
|
|
url: `/api/resource/Print Format/${encodeURIComponent(name)}`,
|
|
headers: { "X-Frappe-CSRF-Token": csrf_token },
|
|
failOnStatusCode: false,
|
|
});
|
|
}
|
|
|
|
function one_section_layout() {
|
|
return JSON.stringify({
|
|
sections: [{ label: "Alpha", columns: [{ label: "", fields: [] }] }],
|
|
header: { columns: [{ label: "", fields: [] }] },
|
|
footer: { columns: [{ label: "", fields: [] }] },
|
|
});
|
|
}
|
|
|
|
// ─── Create flow ──────────────────────────────────────────────────────────────
|
|
|
|
context("Print Format Builder — create flow", () => {
|
|
let PF_NAME;
|
|
|
|
before(() => {
|
|
cy.login();
|
|
cy.visit("/app");
|
|
});
|
|
|
|
beforeEach(() => {
|
|
PF_NAME = pf_name();
|
|
});
|
|
|
|
afterEach(() => {
|
|
cy.window().then((win) => cleanup(win, PF_NAME));
|
|
});
|
|
|
|
// 1. Page loads with the Create-or-Edit dialog
|
|
it("shows the Create or Edit Print Format dialog", () => {
|
|
cy.visit("/app/print-format-builder");
|
|
cy.get_open_dialog().should("contain", "Create or Edit Print Format");
|
|
cy.get_open_dialog().find(".btn-primary").should("contain", "Create");
|
|
});
|
|
|
|
// 2. Filling the dialog and clicking Create inserts a builder format
|
|
it("creates a new Print Format with print_format_builder_beta=1", () => {
|
|
cy.intercept("POST", "api/method/frappe.client.insert").as("insert");
|
|
|
|
cy.visit("/app/print-format-builder");
|
|
cy.get_open_dialog().should("be.visible");
|
|
|
|
// The print_format_name field has depends_on: action === 'Create' and
|
|
// the dialog runs set_value('action', 'Create') *after* show(), so
|
|
// the depends_on reveal races with the first keystroke and
|
|
// cy.fill_field drops the leading 'C'. Set the value via .invoke('val')
|
|
// and trigger input/change so Frappe's Control picks it up without
|
|
// going through the keyboard simulator at all.
|
|
cy.fill_field("doctype", "ToDo", "Link");
|
|
cy.get_open_dialog()
|
|
.find('[data-fieldname="print_format_name"] input:visible')
|
|
.should("be.enabled")
|
|
.invoke("val", PF_NAME)
|
|
.trigger("input")
|
|
.trigger("change");
|
|
|
|
cy.get_open_dialog().find(".btn-primary").contains("Create").click();
|
|
|
|
cy.wait("@insert").then((interception) => {
|
|
expect(interception.response.statusCode).to.equal(200);
|
|
const doc = interception.response.body.message;
|
|
expect(doc.name).to.equal(PF_NAME);
|
|
expect(doc.doc_type).to.equal("ToDo");
|
|
expect(Number(doc.print_format_builder_beta)).to.equal(1);
|
|
});
|
|
});
|
|
|
|
// 3. Loading the builder for an existing format and saving a change
|
|
it("loads the builder and Save persists a margin change", () => {
|
|
cy.visit("/app");
|
|
|
|
cy.insert_doc(
|
|
"Print Format",
|
|
{
|
|
name: PF_NAME,
|
|
doc_type: "ToDo",
|
|
print_format_builder_beta: 1,
|
|
format_data: JSON.stringify({ header: "", sections: [] }),
|
|
},
|
|
true
|
|
);
|
|
|
|
cy.intercept("POST", "api/method/frappe.client.save").as("save");
|
|
cy.visit(`/app/print-format-builder/${encodeURIComponent(PF_NAME)}`);
|
|
|
|
cy.get(".pfb-tab[title='Format']", { timeout: 30000 }).click();
|
|
cy.get(".pfb-margin-grid").should("be.visible");
|
|
|
|
cy.get(".freeze").should("not.exist");
|
|
cy.get('[data-testid="page-status"]').should("not.be.visible");
|
|
|
|
cy.contains(".pfb-margin-cell label", "Top")
|
|
.closest(".pfb-margin-cell")
|
|
.find('input[type="number"]')
|
|
.clear()
|
|
.type("9")
|
|
.trigger("change")
|
|
.blur();
|
|
|
|
cy.get('[data-testid="page-status"]', { timeout: 5000 })
|
|
.should("be.visible")
|
|
.and("contain", "Not Saved");
|
|
|
|
cy.contains(".page-actions .primary-action", "Save").click({ force: true });
|
|
cy.wait("@save").then((interception) => {
|
|
expect(interception.response.statusCode).to.equal(200);
|
|
expect(Number(interception.response.body.message.margin_top)).to.equal(9);
|
|
});
|
|
cy.get('[data-testid="page-status"]').should("not.be.visible");
|
|
});
|
|
|
|
// 4. Outline tab: clicking a section scrolls to it and selects it
|
|
it("outline tab selects a section on click", () => {
|
|
cy.visit("/app");
|
|
|
|
cy.insert_doc(
|
|
"Print Format",
|
|
{
|
|
name: PF_NAME,
|
|
doc_type: "ToDo",
|
|
print_format_builder_beta: 1,
|
|
format_data: JSON.stringify({
|
|
sections: [
|
|
{ label: "Alpha", columns: [{ label: "", fields: [] }] },
|
|
{ label: "Beta", columns: [{ label: "", fields: [] }] },
|
|
],
|
|
header: { columns: [{ label: "", fields: [] }] },
|
|
footer: { columns: [{ label: "", fields: [] }] },
|
|
}),
|
|
},
|
|
true
|
|
);
|
|
|
|
cy.visit(`/app/print-format-builder/${encodeURIComponent(PF_NAME)}`);
|
|
|
|
cy.get(".pfb-tab[title='Outline']", { timeout: 30000 }).click();
|
|
cy.contains(".pfb-outline-item", "Beta").click();
|
|
|
|
cy.get(".pfb-inspector").should("contain", "Section");
|
|
cy.get(".pfb-inspector").should("contain", "Beta");
|
|
cy.contains(".pfb-outline-item", "Beta").should("have.class", "active");
|
|
});
|
|
|
|
// 5. Field inspector breadcrumb navigates back to parent section
|
|
it("field breadcrumb navigates to parent section", () => {
|
|
cy.visit("/app");
|
|
|
|
cy.insert_doc(
|
|
"Print Format",
|
|
{
|
|
name: PF_NAME,
|
|
doc_type: "ToDo",
|
|
print_format_builder_beta: 1,
|
|
format_data: JSON.stringify({
|
|
sections: [
|
|
{
|
|
label: "Details",
|
|
columns: [
|
|
{
|
|
label: "",
|
|
fields: [
|
|
{
|
|
fieldtype: "Data",
|
|
fieldname: "description",
|
|
label: "Description",
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
],
|
|
header: { columns: [{ label: "", fields: [] }] },
|
|
footer: { columns: [{ label: "", fields: [] }] },
|
|
}),
|
|
},
|
|
true
|
|
);
|
|
|
|
cy.visit(`/app/print-format-builder/${encodeURIComponent(PF_NAME)}`);
|
|
|
|
cy.get(".pfb-tab[title='Outline']", { timeout: 30000 }).click();
|
|
cy.contains(".pfb-outline-item", "Details").click();
|
|
|
|
cy.get(".print-format-container").click();
|
|
cy.contains("[data-pfb-section]", "Details").find(".field").first().click({ force: true });
|
|
|
|
cy.get(".pfb-breadcrumb").should("be.visible");
|
|
cy.get(".pfb-breadcrumb-name").should("contain", "Details");
|
|
|
|
cy.get(".pfb-breadcrumb-btn").click();
|
|
cy.get(".pfb-inspector").should("contain", "Section");
|
|
cy.get(".pfb-inspector").should("contain", "Details");
|
|
cy.get(".pfb-breadcrumb").should("not.exist");
|
|
});
|
|
|
|
// 6. Format tab: font size change is reflected in canvas
|
|
it("font size change applies to canvas preview", () => {
|
|
cy.visit("/app");
|
|
|
|
cy.insert_doc(
|
|
"Print Format",
|
|
{
|
|
name: PF_NAME,
|
|
doc_type: "ToDo",
|
|
print_format_builder_beta: 1,
|
|
format_data: JSON.stringify({
|
|
sections: [],
|
|
header: { columns: [{ label: "", fields: [] }] },
|
|
footer: { columns: [{ label: "", fields: [] }] },
|
|
}),
|
|
},
|
|
true
|
|
);
|
|
|
|
cy.intercept("POST", "api/method/frappe.client.save").as("save");
|
|
cy.visit(`/app/print-format-builder/${encodeURIComponent(PF_NAME)}`);
|
|
|
|
cy.get(".pfb-tab[title='Format']", { timeout: 30000 }).click();
|
|
cy.get(".pfb-margin-grid").should("be.visible");
|
|
|
|
cy.contains("label", "Font Size")
|
|
.closest(".form-group")
|
|
.find("input")
|
|
.clear()
|
|
.type("18")
|
|
.trigger("change")
|
|
.blur();
|
|
|
|
cy.get(".pfb-body").should(($el) => {
|
|
const fs = parseInt($el.css("font-size"), 10);
|
|
expect(fs).to.equal(18);
|
|
});
|
|
});
|
|
});
|
|
|
|
// ─── Setup flow ───────────────────────────────────────────────────────────────
|
|
|
|
context("Print Format Builder — setup flow", () => {
|
|
let PF_NAME;
|
|
|
|
before(() => {
|
|
cy.login();
|
|
cy.visit("/app");
|
|
});
|
|
|
|
beforeEach(() => {
|
|
PF_NAME = pf_name();
|
|
});
|
|
|
|
afterEach(() => {
|
|
cy.window().then((win) => cleanup(win, PF_NAME));
|
|
});
|
|
|
|
// 7. New format with no format_data shows the "How do you want to start?" screen
|
|
it("shows setup screen when no layout is saved", () => {
|
|
cy.insert_doc(
|
|
"Print Format",
|
|
{ name: PF_NAME, doc_type: "ToDo", print_format_builder_beta: 1 },
|
|
true
|
|
);
|
|
|
|
cy.visit(`/app/print-format-builder/${encodeURIComponent(PF_NAME)}`);
|
|
|
|
cy.get(".pfb-setup", { timeout: 20000 }).should("be.visible");
|
|
cy.get(".pfb-setup-title").should("contain", "How do you want to start?");
|
|
cy.get(".pfb-setup-option").should("have.length", 2);
|
|
cy.contains(".pfb-setup-option-label", "Start from default").should("be.visible");
|
|
cy.contains(".pfb-setup-option-label", "Start blank").should("be.visible");
|
|
});
|
|
|
|
// 8. Format with saved format_data skips the setup screen entirely
|
|
it("skips setup screen when a layout is already saved", () => {
|
|
cy.insert_doc(
|
|
"Print Format",
|
|
{
|
|
name: PF_NAME,
|
|
doc_type: "ToDo",
|
|
print_format_builder_beta: 1,
|
|
format_data: one_section_layout(),
|
|
},
|
|
true
|
|
);
|
|
|
|
cy.visit(`/app/print-format-builder/${encodeURIComponent(PF_NAME)}`);
|
|
|
|
cy.get(".sections-container", { timeout: 20000 }).should("be.visible");
|
|
cy.get(".pfb-setup").should("not.exist");
|
|
});
|
|
|
|
// 9. "Start blank" dismisses the setup screen and creates an empty canvas
|
|
it("Start blank dismisses setup and shows empty canvas", () => {
|
|
cy.insert_doc(
|
|
"Print Format",
|
|
{ name: PF_NAME, doc_type: "ToDo", print_format_builder_beta: 1 },
|
|
true
|
|
);
|
|
|
|
cy.visit(`/app/print-format-builder/${encodeURIComponent(PF_NAME)}`);
|
|
|
|
cy.get(".pfb-setup", { timeout: 20000 }).should("be.visible");
|
|
cy.contains(".pfb-setup-option-label", "Start blank").click();
|
|
|
|
cy.get(".pfb-setup").should("not.exist");
|
|
cy.get(".sections-container").should("be.visible");
|
|
// blank canvas — no body sections
|
|
cy.get(".sections-container [data-pfb-section]").should("have.length", 0);
|
|
|
|
// explicitly save and verify the saved layout has no sections
|
|
cy.intercept("POST", "api/method/frappe.client.save").as("save");
|
|
cy.contains(".page-actions .primary-action", "Save").click({ force: true });
|
|
cy.wait("@save").then((interception) => {
|
|
expect(interception.response.statusCode).to.equal(200);
|
|
const layout = JSON.parse(interception.response.body.message.format_data);
|
|
expect(layout.sections).to.deep.equal([]);
|
|
});
|
|
});
|
|
|
|
// 10. "Start from default" dismisses the setup screen and populates sections
|
|
it("Start from default dismisses setup and fills canvas with document fields", () => {
|
|
cy.insert_doc(
|
|
"Print Format",
|
|
{ name: PF_NAME, doc_type: "ToDo", print_format_builder_beta: 1 },
|
|
true
|
|
);
|
|
|
|
cy.visit(`/app/print-format-builder/${encodeURIComponent(PF_NAME)}`);
|
|
|
|
cy.get(".pfb-setup", { timeout: 20000 }).should("be.visible");
|
|
cy.contains(".pfb-setup-option-label", "Start from default").click();
|
|
|
|
cy.get(".pfb-setup").should("not.exist");
|
|
// body sections are populated from ToDo's default fields
|
|
cy.get(".sections-container [data-pfb-section]", { timeout: 10000 }).should(
|
|
"have.length.greaterThan",
|
|
0
|
|
);
|
|
|
|
// explicitly save and verify the saved layout has sections
|
|
cy.intercept("POST", "api/method/frappe.client.save").as("save");
|
|
cy.contains(".page-actions .primary-action", "Save").click({ force: true });
|
|
cy.wait("@save").then((interception) => {
|
|
expect(interception.response.statusCode).to.equal(200);
|
|
const layout = JSON.parse(interception.response.body.message.format_data);
|
|
expect(layout.sections.length).to.be.greaterThan(0);
|
|
});
|
|
});
|
|
});
|
|
|
|
// ─── Section insert (+ Add Section) ──────────────────────────────────────────
|
|
|
|
context("Print Format Builder — section insert", () => {
|
|
let PF_NAME;
|
|
|
|
before(() => {
|
|
cy.login();
|
|
cy.visit("/app");
|
|
});
|
|
|
|
beforeEach(() => {
|
|
PF_NAME = pf_name();
|
|
});
|
|
|
|
afterEach(() => {
|
|
cy.window().then((win) => cleanup(win, PF_NAME));
|
|
});
|
|
|
|
// 11. Section insert element exists in DOM (opacity:0, not display:none)
|
|
it("section insert element is present in DOM between sections", () => {
|
|
cy.insert_doc(
|
|
"Print Format",
|
|
{
|
|
name: PF_NAME,
|
|
doc_type: "ToDo",
|
|
print_format_builder_beta: 1,
|
|
format_data: one_section_layout(),
|
|
},
|
|
true
|
|
);
|
|
|
|
cy.visit(`/app/print-format-builder/${encodeURIComponent(PF_NAME)}`);
|
|
cy.get(".sections-container", { timeout: 20000 }).should("be.visible");
|
|
|
|
cy.get(".section-insert").should("exist");
|
|
cy.get(".section-insert").first().should("not.have.css", "display", "none");
|
|
cy.get(".section-insert-btn").first().should("contain", "Add Section");
|
|
});
|
|
|
|
// 12. Clicking the insert strip before a section adds a new section above it
|
|
it("clicking section insert before a section inserts a new section", () => {
|
|
cy.insert_doc(
|
|
"Print Format",
|
|
{
|
|
name: PF_NAME,
|
|
doc_type: "ToDo",
|
|
print_format_builder_beta: 1,
|
|
format_data: one_section_layout(),
|
|
},
|
|
true
|
|
);
|
|
|
|
cy.visit(`/app/print-format-builder/${encodeURIComponent(PF_NAME)}`);
|
|
cy.get(".sections-container [data-pfb-section]", { timeout: 20000 }).should(
|
|
"have.length",
|
|
1
|
|
);
|
|
|
|
cy.get(".section-with-insert .section-insert-btn").first().click({ force: true });
|
|
|
|
cy.get(".sections-container [data-pfb-section]").should("have.length", 2);
|
|
});
|
|
|
|
// 13. The footer insert strip appends a section after all existing sections
|
|
it("footer section insert appends a section at the end", () => {
|
|
cy.insert_doc(
|
|
"Print Format",
|
|
{
|
|
name: PF_NAME,
|
|
doc_type: "ToDo",
|
|
print_format_builder_beta: 1,
|
|
format_data: one_section_layout(),
|
|
},
|
|
true
|
|
);
|
|
|
|
cy.visit(`/app/print-format-builder/${encodeURIComponent(PF_NAME)}`);
|
|
cy.get(".sections-container [data-pfb-section]", { timeout: 20000 }).should(
|
|
"have.length",
|
|
1
|
|
);
|
|
|
|
cy.get(".sections-container > .section-insert .section-insert-btn").click({ force: true });
|
|
|
|
cy.get(".sections-container [data-pfb-section]").should("have.length", 2);
|
|
});
|
|
|
|
// 14. Multiple inserts accumulate correctly
|
|
it("inserting sections three times yields three sections on a blank canvas", () => {
|
|
cy.insert_doc(
|
|
"Print Format",
|
|
{
|
|
name: PF_NAME,
|
|
doc_type: "ToDo",
|
|
print_format_builder_beta: 1,
|
|
format_data: JSON.stringify({
|
|
sections: [],
|
|
header: { columns: [{ label: "", fields: [] }] },
|
|
footer: { columns: [{ label: "", fields: [] }] },
|
|
}),
|
|
},
|
|
true
|
|
);
|
|
|
|
cy.visit(`/app/print-format-builder/${encodeURIComponent(PF_NAME)}`);
|
|
cy.get(".sections-container", { timeout: 20000 }).should("be.visible");
|
|
cy.get(".sections-container [data-pfb-section]").should("have.length", 0);
|
|
|
|
cy.get(".sections-container > .section-insert .section-insert-btn").click({ force: true });
|
|
cy.get(".sections-container [data-pfb-section]").should("have.length", 1);
|
|
|
|
cy.get(".sections-container > .section-insert .section-insert-btn").click({ force: true });
|
|
cy.get(".sections-container [data-pfb-section]").should("have.length", 2);
|
|
|
|
cy.get(".sections-container > .section-insert .section-insert-btn").click({ force: true });
|
|
cy.get(".sections-container [data-pfb-section]").should("have.length", 3);
|
|
});
|
|
|
|
// 15. Section insert is NOT hidden in clean-preview mode (regression guard)
|
|
//
|
|
// The old code had:
|
|
// .pfb-clean-preview :deep(.section-insert) { display: none !important }
|
|
// which hid the button when a live record was loaded. The fix removed that rule.
|
|
it("section insert is not hidden when preview class is present on the canvas", () => {
|
|
cy.insert_doc(
|
|
"Print Format",
|
|
{
|
|
name: PF_NAME,
|
|
doc_type: "ToDo",
|
|
print_format_builder_beta: 1,
|
|
format_data: one_section_layout(),
|
|
},
|
|
true
|
|
);
|
|
|
|
cy.visit(`/app/print-format-builder/${encodeURIComponent(PF_NAME)}`);
|
|
cy.get(".sections-container", { timeout: 20000 }).should("be.visible");
|
|
|
|
cy.get(".print-format-main").then(($el) => {
|
|
$el[0].classList.add("pfb-clean-preview");
|
|
});
|
|
|
|
cy.get(".section-insert").first().should("not.have.css", "display", "none");
|
|
});
|
|
});
|