evcc-io/tests/hems.spec.ts

import { test, expect } from "@playwright/test";
import { start, stop, restart, baseUrl } from "./evcc";
import {
  expectModalVisible,
  expectModalHidden,
  editorClear,
  editorPaste,
  enableAppContext,
  expectAppEvent,
  newLoadpoint,
  addDemoCharger,
} from "./utils";
import { startSimulator, stopSimulator, simulatorUrl, simulatorApply } from "./simulator";

test.use({ baseURL: baseUrl() });
test.describe.configure({ mode: "parallel" });

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

const CONFIG = "fast.evcc.yaml";

test.describe("HEMS", () => {
  test("grid sessions", async ({ page }) => {
    await start(CONFIG, "hems.sql");
    await page.goto("/#/config");

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

    await expect(hemsModal.getByTestId("grid-sessions")).toBeVisible();
    await expect(hemsModal).toContainText("Recorded 3 grid limitation events");
    await expect(hemsModal).toContainText("Most recent");

    const csvLink = hemsModal.getByRole("link", { name: "Download CSV" });
    await expect(csvLink).toHaveAttribute("href", /\.\/api\/gridsessions\?format=csv&lang=en/);

    await expect(hemsModal.getByTestId("yaml-editor")).toBeVisible();
    await expect(hemsModal.getByRole("button", { name: "Save" })).toBeVisible();
    await expect(hemsModal).not.toContainText("Configured via evcc.yaml");

    await hemsModal.getByRole("button", { name: "Cancel" }).click();
    await expectModalHidden(hemsModal);
  });

  test("modal yaml-configured", async ({ page }) => {
    await start("hems-yaml.evcc.yaml");
    await page.goto("/#/config");

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

    await expect(hemsModal.getByTestId("grid-sessions")).not.toBeVisible();
    await expect(hemsModal).toContainText("Configured via evcc.yaml");
    await expect(hemsModal.getByTestId("yaml-editor")).not.toBeVisible();
    await expect(hemsModal.getByRole("button", { name: "Save" })).not.toBeVisible();
    await expect(hemsModal.getByRole("button", { name: "Cancel" })).toBeVisible();

    await hemsModal.getByRole("button", { name: "Cancel" }).click();
    await expectModalHidden(hemsModal);
  });

  test("external control without circuits", async ({ page }) => {
    const GRID_CONFIG = "hems-grid.evcc.yaml";
    await startSimulator();
    await start(GRID_CONFIG);

    await page.goto("/#/config");

    // configure hems
    await page.getByTestId("hems").getByRole("button", { name: "edit" }).click();
    const hemsModal = page.getByTestId("hems-modal");
    await expectModalVisible(hemsModal);
    const hemsEditor = hemsModal.getByTestId("yaml-editor");
    await editorClear(hemsEditor);
    await editorPaste(
      hemsEditor,
      page,
      `type: relay
maxPower: 4200
interval: 0.1s
limit:
  source: http
  uri: ${simulatorUrl()}/api/state
  jq: .hems.relay`
    );
    await hemsModal.getByRole("button", { name: "Save" }).click();
    await expectModalHidden(hemsModal);

    await restart(GRID_CONFIG);
    await page.goto("/#/config");

    // verify external control is the only circuit visible
    await expect(page.getByTestId("circuits")).toContainText(
      ["External Limit", "Power", "0.0 kW"].join("")
    );

    // enable hems in simulator
    await page.goto(simulatorUrl());
    const hemsRelayCheckbox = page.getByLabel("Relay Limit");
    await hemsRelayCheckbox.check();
    await simulatorApply(page);

    // verify config ui
    await page.goto("/#/config");
    await expect(page.getByTestId("circuits")).toContainText(
      ["External Limit", "Consumption limited", "yes", "Power", "0.0 kW / 4.2 kW"].join("")
    );

    // disable in simulator
    await page.goto(simulatorUrl());
    await hemsRelayCheckbox.uncheck();
    await simulatorApply(page);

    await stopSimulator();
  });

  test.describe("grid sessions CSV in app context", () => {
    test("dispatches download event", async ({ page }) => {
      await enableAppContext(page);
      await start(CONFIG, "hems.sql");
      await page.goto("/#/config");

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

      const csvLink = hemsModal.getByRole("link", { name: "Download CSV" });
      await csvLink.click();
      expect(await expectAppEvent(page)).toMatchObject({
        type: "download",
        url: expect.stringContaining("/api/gridsessions?format=csv&lang=en"),
      });
    });
  });

  test("external control with circuits", async ({ page }) => {
    const GRID_CONFIG = "hems-grid.evcc.yaml";
    await start(GRID_CONFIG);

    await page.goto("/#/config");

    // configure circuits
    await page.getByTestId("circuits").getByRole("button", { name: "edit" }).click();
    const circuitsModal = page.getByTestId("circuits-modal");
    await expectModalVisible(circuitsModal);
    const circuitsEditor = circuitsModal.getByTestId("yaml-editor");
    await editorClear(circuitsEditor);
    await editorPaste(circuitsEditor, page, `- name: main\n  title: House`);
    await circuitsModal.getByRole("button", { name: "Save" }).click();
    await expectModalHidden(circuitsModal);

    // configure hems
    await page.getByTestId("hems").getByRole("button", { name: "edit" }).click();
    const hemsModal = page.getByTestId("hems-modal");
    await expectModalVisible(hemsModal);
    const hemsEditor = hemsModal.getByTestId("yaml-editor");
    await editorClear(hemsEditor);
    await editorPaste(
      hemsEditor,
      page,
      `type: relay
maxPower: 4200
interval: 0.1s
limit:
  source: const
  value: true`
    );
    await hemsModal.getByRole("button", { name: "Save" }).click();
    await expectModalHidden(hemsModal);

    await restart(GRID_CONFIG);
    await page.goto("/#/config");

    // verify external control is the top-most circuit, with main beneath it
    await expect(page.getByTestId("circuits")).toContainText(
      [
        "External Limit",
        "Consumption limited",
        "yes",
        "Power",
        "0.0 kW / 4.2 kW",
        "House",
        "Consumption limited",
        "yes",
        "Power",
        "0.0 kW",
      ].join("")
    );

    // a new loadpoint can only be assigned to the dedicated circuit, not gridcontrol
    await newLoadpoint(page, "Carport");
    await addDemoCharger(page);
    const lpModal = page.getByTestId("loadpoint-modal");
    await expectModalVisible(lpModal);
    const circuitOptions = lpModal.getByLabel("Circuit").getByRole("option");
    await expect(circuitOptions).toHaveText(["---", "House [main]"]);
  });
});