Oe UI Test
Testing & Qualityoe-ui-testOe UI Test is an Agent Skill for testing & quality published in the OpenEMS/openems repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Use when writing or fixing Angular/Ionic UI tests in the FEMS/OpenEMS UI (Karma/Jasmine), including formly view tests, chart tests, and component unit tests.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/OpenEMS/openems/blob/HEAD/.github/skills/oe-ui-test/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/oe-ui-test, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
FEMS UI Test Skill
Use this skill when writing or fixing Angular/Ionic tests under ui/src/app/.
Framework
- Use Karma + Jasmine.
- Run tests from
ui/. - Use
// @ts-strict-ignoreonly when unavoidable and consistent with nearby specs.
Core Utilities
Testing helpers live in ui/src/app/shared/components/shared/testing/:
utils.spec.ts:TestContext,TestingUtilstester.ts:OeFormlyViewTester,OeChartTestercommon.ts:OeTester.ChartOptionschannels.spec.ts: reusable channel fixtures
Use DummyConfig from src/app/shared/components/edge/edgeconfig.spec.ts for EdgeConfig and Edge test data. Do not manually construct EdgeConfig or Edge.
Setup Patterns
let testContext: TestContext;
beforeEach(async () => {
testContext = await TestingUtils.sharedSetup();
});
For routed components with a componentId route parameter:
let testContext: TestContext & { route: ActivatedRoute };
beforeEach(async () => {
testContext = await TestingUtils.setupWithActivatedRoute("meter0");
});
For extra providers/imports, use TestingUtils.mergeSetup(...) and follow nearby specs.
DummyConfig
import { DummyConfig } from "src/app/shared/components/edge/edgeconfig.spec";
const config = DummyConfig.from(
DummyConfig.Component.SOCOMEC_CONSUMPTION_METER("meter0"),
);
const edge = DummyConfig.dummyEdge({ role: Role.OWNER });
Inspect DummyConfig.Component in edgeconfig.spec.ts for available component factories before adding new ones. For chart tests, convert dummy configs before use:
const realConfig = DummyConfig.convertDummyEdgeConfigToRealEdgeConfig(config);
Formly View Tests
Use OeFormlyViewTester for components exposing generateView():
expect(OeFormlyViewTester.apply(
MyComponent.generateView(testContext.translate, component, edge),
{ "component0/ActivePower": 3000 },
)).toEqual({
title: "My Component",
lines: [
CHANNEL_LINE("Power", "3.000 W"),
],
});
Common line helpers include CHANNEL_LINE, VALUE_FROM_CHANNELS_LINE, LINE_INFO, LINE_HORIZONTAL, PHASE_ADMIN, and PHASE_GUEST. Inspect edgeconfig.spec.ts for the full helper list.
Chart Tests
Use OeChartTester for history chart components exposing getChartData(). Always wrap both sides of chart comparisons in TestingUtils.removeFunctions().
expect(TestingUtils.removeFunctions(
OeChartTester.apply(
MyChartComponent.getChartData(
DummyConfig.convertDummyEdgeConfigToRealEdgeConfig(config),
testContext.route,
testContext.translate,
),
"line",
History.DAY,
testContext,
config,
),
)).toEqual(TestingUtils.removeFunctions(expectedView));
Use DATA and LABELS from chart test constants where nearby specs do. Use OeTester.ChartOptions helpers for chart options; inspect common.ts for the full list.
Conventions
- Set
testContext.translate.use("de")or"en"when asserting translated strings. - Prefer separate
it()blocks per scenario. - Keep channel fixtures such as
History.DAYandHistory.MONTHin a nearbychannels.spec.ts. - Do not declare components in
TestBedunless the component under test requires it.
Validation
Run from ui/:
npm test
npm run lint