evcc-io/tests/config-messaging.spec.ts

import { test, expect } from "@playwright/test";
import { start, stop, restart, baseUrl } from "./evcc";
import { expectModalHidden, expectModalVisible, editorClear, editorPaste } from "./utils";

const CONFIG_WITH_MESSAGING = "config-messaging.evcc.yaml";
const CONFIG_MESSAGING_LEGACY = "messaging-legacy.sql";

test.use({ baseURL: baseUrl() });

test.afterEach(async () => {
  await stop();
});

test.describe("messaging", async () => {
  test("messaging not configured", async ({ page }) => {
    await start();
    await page.goto("/#/config");

    const card = page.getByTestId("messaging");
    await expect(card).toBeVisible();
    await expect(card).toContainText(["Configured", "no"].join(""));
  });

  test("messaging from yaml ui (legacy)", async ({ page }) => {
    await start(undefined, CONFIG_MESSAGING_LEGACY);
    await page.goto("/#/config");

    const card = page.getByTestId("messaging");
    await expect(card).toBeVisible();
    await expect(card).toContainText(["Configured", "yes"].join(""));

    await card.getByRole("button", { name: "edit" }).click();
    const modal = page.getByTestId("messaging-legacy-modal");
    await expectModalVisible(modal);

    // check for new configuration notice
    await expect(modal.getByRole("alert")).toContainText(
      "New notification configuration available"
    );

    const validYaml = `events:
  start:
    title: Charge started
    msg: Started charging`;
    // differs from the stored config so saving is an actual change
    const changedYaml = `events:
  start:
    title: Charge started
    msg: Charging has begun`;

    // default content
    const editor = modal.getByTestId("yaml-editor");
    await expect(editor).toContainText(validYaml);

    // clear and enter invalid yaml
    await editorClear(editor);
    await editorPaste(editor, page, "foo: bar");
    await page.getByRole("button", { name: "Save" }).click();
    await expect(modal.getByTestId("error")).toContainText("invalid keys: foo");

    // clear and enter valid yaml
    await editorClear(editor);
    await editorPaste(editor, page, changedYaml);

    await page.getByRole("button", { name: "Save" }).click();
    await expect(modal.getByTestId("error")).not.toBeVisible();

    // modal closes
    await expectModalHidden(modal);

    await expect(card).toBeVisible();
    await expect(card).toContainText(["Configured", "yes"].join(""));
  });

  test("messaging from evcc.yaml", async ({ page }) => {
    await start(CONFIG_WITH_MESSAGING);
    await page.goto("/#/config");

    const card = page.getByTestId("messaging");
    await expect(card).toBeVisible();
    await expect(card).toContainText(["Configured", "yes"].join(""));
  });
  test("messaging events via ui", async ({ page }) => {
    await start();
    await page.goto("/#/config");

    const card = page.getByTestId("messaging");
    await expect(card).toBeVisible();
    await expect(card).toContainText(["Configured", "no"].join(""));

    await card.getByRole("button", { name: "edit" }).click();
    const modal = page.getByTestId("messaging-modal");
    await expectModalVisible(modal);

    // validate start event
    const eventStart = modal.getByTestId("event-start");
    const switchInput = eventStart.getByRole("switch");
    const titleInput = eventStart.getByLabel("Title");
    const messageInput = eventStart.getByLabel("Message");

    await expect(switchInput).not.toBeChecked();
    await expect(titleInput).toBeDisabled();
    await expect(titleInput).toHaveValue("Charge started");
    await expect(messageInput).toBeDisabled();
    await expect(messageInput).toHaveValue("Started charging in ${mode} mode.");

    await switchInput.check();
    await expect(titleInput).toBeEnabled();
    await expect(messageInput).toBeEnabled();

    await titleInput.fill("event-start-title");
    await messageInput.fill("event-start-message");

    // unsaved changes: ESC keeps modal open
    await page.keyboard.press("Escape");
    await expectModalVisible(modal);

    // validate connection
    await modal.getByRole("button", { name: "Save", exact: true }).click();
    await expectModalHidden(modal);
    // start plus the opt-out suggestion event
    await expect(card).toContainText(["Events", "2", "Services", "0"].join(""));

    // restart button appears
    const restartButton = page
      .getByTestId("bottom-banner")
      .getByRole("button", { name: "Restart" });
    await expect(restartButton).toBeVisible();

    await restart();
    await page.reload();

    await card.getByRole("button", { name: "edit" }).click();

    // validate start event
    await expect(switchInput).toBeChecked();
    await expect(titleInput).toBeEnabled();
    await expect(messageInput).toBeEnabled();
    await expect(titleInput).toHaveValue("event-start-title");
    await expect(messageInput).toHaveValue("event-start-message");
  });
  test("create, verify, delete custom service via ui", async ({ page }) => {
    await start();
    await page.goto("/#/config");

    const card = page.getByTestId("messaging");
    await expect(card).toBeVisible();
    await expect(card).toContainText(["Configured", "no"].join(""));

    await card.getByRole("button", { name: "edit" }).click();
    const modal = page.getByTestId("messaging-modal");
    await expectModalVisible(modal);

    // confirm save unsaved changes
    page.once("dialog", (dialog) => dialog.accept());
    await modal.getByRole("link", { name: "Services (0)" }).click();
    await modal.getByRole("button", { name: "Add service" }).click();

    const messengerModal = page.getByTestId("messenger-modal");
    await expectModalHidden(modal);
    await expectModalVisible(messengerModal);

    await messengerModal.getByLabel("Service").selectOption("User-defined service");
    await messengerModal.getByRole("button", { name: "Validate & save" }).click();

    await expectModalHidden(messengerModal);
    await expectModalVisible(modal);

    const messengerBox = modal.getByTestId("messenger-box-0");
    await expect(messengerBox).toHaveText(["#1", "User-defined service"].join(""));
    await modal.getByRole("button", { name: "Close" }).click();
    await expectModalHidden(modal);
    // suggestion event is enabled by default
    await expect(card).toContainText(["Events", "1", "Services", "1"].join(""));

    await card.getByRole("button", { name: "edit" }).click();
    await expectModalVisible(modal);
    await messengerBox.getByRole("button", { name: "edit" }).click();
    await expectModalHidden(modal);
    await expectModalVisible(messengerModal);
    await messengerModal.getByRole("button", { name: "Delete" }).click();
    await expectModalHidden(messengerModal);
    await expectModalVisible(modal);
    await expect(messengerBox).not.toBeVisible();
    await page.keyboard.press("Escape");
    await expectModalHidden(modal);

    // service gone, saved suggestion event remains
    await expect(card).toContainText(["Events", "1", "Services", "0"].join(""));
  });
});