Skip to content

Commit

Permalink
#203 Add round switch test, and clean up dialog handling
Browse files Browse the repository at this point in the history
  • Loading branch information
@alexhad6
alexhad6 committed Dec 15, 2023
1 parent 963349e commit a482a93
Show file tree
Hide file tree
Showing 3 changed files with 101 additions and 78 deletions.
70 changes: 35 additions & 35 deletions cypress/e2e/parameter-navigation.cy.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,44 +69,44 @@ describe("parameter data for latest commit", () => {
cy.get("@Quantity").should("contain", "1.2345 m");
});

// it("expands and collapses nested items when clicked", () => {
// // Children do not exist (collapsed)
// cy.getByTestId("parameter-list-item-dict")
// .as("dict")
// .should("exist")
// .within(() => {
// cy.getByTestId("parameter-list-item-int").should("not.exist");
// cy.getByTestId("parameter-list-item-str").should("not.exist");
// });

// // Wait briefly to allow for other processes to finish (this test fails
// // intermittently, so this is an attempt to fix it).
// // eslint-disable-next-line cypress/no-unnecessary-waiting
// cy.wait(10);

// // Click dict item
// cy.get("@dict").find('[role="button"]').click();

// // Children are visible (expended)
// cy.get("@dict").within(() => {
// cy.getByTestId("parameter-list-item-int").should("be.visible");
// cy.getByTestId("parameter-list-item-str").should("be.visible");
// });
it("expands and collapses nested items when clicked", () => {
// Children do not exist (collapsed)
cy.getByTestId("parameter-list-item-dict")
.as("dict")
.should("exist")
.within(() => {
cy.getByTestId("parameter-list-item-int").should("not.exist");
cy.getByTestId("parameter-list-item-str").should("not.exist");
});

// Wait briefly to allow for other processes to finish (this test fails
// intermittently, so this is an attempt to fix it).
// eslint-disable-next-line cypress/no-unnecessary-waiting
cy.wait(10);

// Click dict item
cy.get("@dict").find('[role="button"]').click();

// Children are visible (expended)
cy.get("@dict").within(() => {
cy.getByTestId("parameter-list-item-int").should("be.visible");
cy.getByTestId("parameter-list-item-str").should("be.visible");
});

// // Wait briefly to allow for other processes to finish (this test fails
// // intermittently, so this is an attempt to fix it).
// // eslint-disable-next-line cypress/no-unnecessary-waiting
// cy.wait(10);
// Wait briefly to allow for other processes to finish (this test fails
// intermittently, so this is an attempt to fix it).
// eslint-disable-next-line cypress/no-unnecessary-waiting
cy.wait(10);

// // Click dict item
// cy.get("@dict").find('[role="button"]').click();
// Click dict item
cy.get("@dict").find('[role="button"]').click();

// // Children do not exist (collapsed)
// cy.get("@dict").within(() => {
// cy.getByTestId("parameter-list-item-int").should("not.exist");
// cy.getByTestId("parameter-list-item-str").should("not.exist");
// });
// });
// Children do not exist (collapsed)
cy.get("@dict").within(() => {
cy.getByTestId("parameter-list-item-int").should("not.exist");
cy.getByTestId("parameter-list-item-str").should("not.exist");
});
});

// it("collapses all items when the collapse all button is clicked", () => {
// // Children do not exist (collapsed)
Expand Down
91 changes: 48 additions & 43 deletions tests/e2e/test_parameter_editing.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,32 @@
from playwright.sync_api import Page, Dialog, expect
from tests.e2e.helpers import reset_db, get_datetime_input

num_dialogs: int
last_dialog_message: str | None


def capture_dialogs(page: Page, accept: bool = False) -> None:
"""
Capture dialogs for the given page, updating the global variables
``num_confirm_dialogs`` and ``dialog_message`` for each dialog, and accepting or
dismissing the dialog according to ``accept``.
"""
# pylint: disable=global-statement
global num_dialogs, last_dialog_message
num_dialogs = 0
last_dialog_message = None

def handle_dialog(dialog: Dialog) -> None:
global num_dialogs, last_dialog_message
num_dialogs += 1
last_dialog_message = dialog.message
if accept:
dialog.accept()
else:
dialog.dismiss()

page.on("dialog", handle_dialog)


@pytest.fixture(autouse=True)
def setup(page: Page) -> None:
Expand All @@ -23,6 +49,7 @@ def test_input_int(page: Page) -> None:
leaf_input = item.get_by_test_id("leaf-input").get_by_role("textbox")
leaf_type_input = item.get_by_test_id("leaf-type-input").get_by_role("combobox")

# Initial input
expect(leaf_input).to_have_value("123")
expect(leaf_input).to_have_attribute("aria-invalid", "false")
expect(item.get_by_test_id("leaf-unit-input")).not_to_be_attached()
Expand All @@ -47,6 +74,7 @@ def test_input_float(page: Page) -> None:
leaf_input = item.get_by_test_id("leaf-input").get_by_role("textbox")
leaf_type_input = item.get_by_test_id("leaf-type-input").get_by_role("combobox")

# Initial input
expect(leaf_input).to_have_value("1.2345")
expect(leaf_input).to_have_attribute("aria-invalid", "false")
expect(item.get_by_test_id("leaf-unit-input")).not_to_be_attached()
Expand All @@ -70,6 +98,7 @@ def test_input_bool(page: Page) -> None:
leaf_input = item.get_by_test_id("leaf-input").get_by_role("combobox")
leaf_type_input = item.get_by_test_id("leaf-type-input").get_by_role("combobox")

# Initial input
expect(leaf_input).to_have_text("True")
expect(item.get_by_test_id("leaf-unit-input")).not_to_be_attached()
expect(leaf_type_input).to_have_text("bool")
Expand All @@ -92,6 +121,7 @@ def test_input_str(page: Page) -> None:
leaf_input = item.get_by_test_id("leaf-input").get_by_role("textbox")
leaf_type_input = item.get_by_test_id("leaf-type-input").get_by_role("combobox")

# Initial input
expect(leaf_input).to_have_value("test")
expect(item.get_by_test_id("leaf-unit-input")).not_to_be_attached()
expect(leaf_type_input).to_have_text("str")
Expand All @@ -113,6 +143,7 @@ def test_input_none(page: Page) -> None:
leaf_input = item.get_by_test_id("leaf-input").get_by_role("textbox")
leaf_type_input = item.get_by_test_id("leaf-type-input").get_by_role("combobox")

# Initial input
expect(leaf_input).to_have_value("None")
expect(leaf_input).to_be_disabled()
expect(item.get_by_test_id("leaf-unit-input")).not_to_be_attached()
Expand All @@ -135,6 +166,7 @@ def test_input_datetime(page: Page) -> None:
leaf_input = item.get_by_test_id("leaf-input").locator("input[type=datetime-local]")
leaf_type_input = item.get_by_test_id("leaf-type-input").get_by_role("combobox")

# Initial input
expect(leaf_input).to_have_value(datetime_input_value)
expect(item.get_by_test_id("leaf-unit-input")).not_to_be_attached()
expect(leaf_type_input).to_have_text("datetime")
Expand All @@ -158,6 +190,7 @@ def test_input_quantity(page: Page) -> None:
leaf_unit_input = item.get_by_test_id("leaf-unit-input").get_by_role("textbox")
leaf_type_input = item.get_by_test_id("leaf-type-input").get_by_role("combobox")

# Initial input
expect(leaf_input).to_have_value("1.2345")
expect(leaf_input).to_have_attribute("aria-invalid", "false")
expect(leaf_unit_input).to_have_value("m")
Expand Down Expand Up @@ -254,17 +287,10 @@ def test_exit_edit_mode_no_changes(page: Page) -> None:
Can exit edit mode or close the page when there are no changes, and there are no
dialogs.
"""
no_dialogs = True
capture_dialogs(page)
edit_button = page.get_by_test_id("edit-button")
cancel_button = page.get_by_test_id("cancel-edit-button")

def handle_dialog(dialog: Dialog) -> None:
nonlocal no_dialogs
no_dialogs = False
dialog.dismiss()

page.on("dialog", handle_dialog)

# Exit edit mode
expect(edit_button).not_to_be_attached()
expect(cancel_button).to_be_attached()
Expand All @@ -275,15 +301,15 @@ def handle_dialog(dialog: Dialog) -> None:
# Close the page
page.close(run_before_unload=True)

assert no_dialogs
assert num_dialogs == 0


def test_exit_edit_mode_invalid_changes(page: Page) -> None:
"""
Can exit edit mode or close the page when there are invalid changes only, and there
are no dialogs.
"""
no_dialogs = True
capture_dialogs(page)
edit_button = page.get_by_test_id("edit-button")
cancel_button = page.get_by_test_id("cancel-edit-button")
leaf_input = (
Expand All @@ -292,13 +318,6 @@ def test_exit_edit_mode_invalid_changes(page: Page) -> None:
.get_by_role("textbox")
)

def handle_dialog(dialog: Dialog) -> None:
nonlocal no_dialogs
no_dialogs = False
dialog.dismiss()

page.on("dialog", handle_dialog)

# Fill with invalid value, then exit and re-enter edit mode
leaf_input.fill("123a")
cancel_button.click()
Expand All @@ -309,7 +328,7 @@ def handle_dialog(dialog: Dialog) -> None:
leaf_input.fill("123a")
page.close(run_before_unload=True)

assert no_dialogs
assert num_dialogs == 0


def test_exit_edit_mode_valid_changes_dismiss(page: Page) -> None:
Expand All @@ -318,44 +337,36 @@ def test_exit_edit_mode_valid_changes_dismiss(page: Page) -> None:
is given a confirmation dialog. If they dismiss this dialog, exit mode is not
exited.
"""
num_confirm_dialogs = 0
dialog_message = None
capture_dialogs(page, accept=False)
cancel_button = page.get_by_test_id("cancel-edit-button")
leaf_input = (
page.get_by_test_id("parameter-list-item-int")
.get_by_test_id("leaf-input")
.get_by_role("textbox")
)

def handle_dialog(dialog: Dialog) -> None:
nonlocal num_confirm_dialogs, dialog_message
num_confirm_dialogs += 1
dialog_message = dialog.message
dialog.dismiss()

page.on("dialog", handle_dialog)

# Fill with valid value and attempt to exit edit mode
leaf_input.fill("1234")
cancel_button.click()
expect(leaf_input).to_have_value("1234")
assert num_confirm_dialogs == 1
assert dialog_message == "You have unsaved changes. Do you want to discard them?"
assert num_dialogs == 1
assert (
last_dialog_message == "You have unsaved changes. Do you want to discard them?"
)

# Change to invalid value and attempt to close the page
leaf_input.fill("1234")
page.close(run_before_unload=True)
expect(leaf_input).to_have_value("1234")
assert num_confirm_dialogs == 2
assert num_dialogs == 2


def test_exit_edit_mode_valid_changes_accept(page: Page) -> None:
"""
When there are valid changes and exit mode is exited, the user is given a
confirmation dialog. If they accept this dialog, exit mode is exited.
"""
num_confirm_dialogs = 0
dialog_message = None
capture_dialogs(page, accept=True)
edit_button = page.get_by_test_id("edit-button")
cancel_button = page.get_by_test_id("cancel-edit-button")
leaf_input = (
Expand All @@ -364,18 +375,12 @@ def test_exit_edit_mode_valid_changes_accept(page: Page) -> None:
.get_by_role("textbox")
)

def handle_dialog(dialog: Dialog) -> None:
nonlocal num_confirm_dialogs, dialog_message
num_confirm_dialogs += 1
dialog_message = dialog.message
dialog.accept()

page.on("dialog", handle_dialog)

# Fill with valid value and exit edit mode
leaf_input.fill("1234")
cancel_button.click()
edit_button.click()
expect(leaf_input).to_have_value("123")
assert num_confirm_dialogs == 1
assert dialog_message == "You have unsaved changes. Do you want to discard them?"
assert num_dialogs == 1
assert (
last_dialog_message == "You have unsaved changes. Do you want to discard them?"
)
18 changes: 18 additions & 0 deletions tests/e2e/test_parameter_navigation.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,21 @@ def test_displays_params(page: Page) -> None:
),
]:
expect(page.get_by_test_id(test_id)).to_have_text(expected_text)


def test_round_switch(page: Page) -> None:
"""Rounds numerical parameters only when round switch is checked."""
round_switch = page.get_by_test_id("round-switch")
float_item = page.get_by_test_id("parameter-list-item-float")
quantity_item = page.get_by_test_id("parameter-list-item-Quantity")

# Rounded (default)
expect(round_switch).to_be_checked()
expect(float_item).to_have_text("float1.234")
expect(quantity_item).to_have_text("Quantity1.234 m")

# Unrounded
round_switch.uncheck()
expect(round_switch).not_to_be_checked()
expect(float_item).to_have_text("float1.2345")
expect(quantity_item).to_have_text("Quantity1.2345 m")

0 comments on commit a482a93

Please sign in to comment.