@matter/testing 0.13.0-alpha.0-20250327-8b06e5a79 → 0.13.0-alpha.0-20250328-6dde053de

package/src/chip/python-test.ts

@@ -168,27 +168,13 @@ function spiffy(line: string) {
  * or the test will not run.  So we must extract these arguments to pass into the script.
  *
  * A program defining mandatory arguments to itself seems silly but we work with what we've got amiright?
- *
- * We read the entire configuration but all we currently extract are arguments to the first run that aren't
- * "boilerplate" arguments that we don't need.
- *
- * We also use this opportunity to extract PICS which are returned programmatically.  So we use a regexp which has high
- * "eww" factory, but the alternative would be invoking Python and instantiating, which would not be fast.
  */
 async function createCommand(descriptor: TestFileDescriptor, subject: Subject, extraArgs: string[]) {
-    const { path, config } = descriptor;
-
-    const command = ["python3", path, ...Constants.PythonRunnerArgs];
-
-    if (config) {
-        let args = config["script-args"] as string;
-        if (typeof args === "string") {
-            args = args.replace(
-                /--(?:storage-path|commissioning-method|discriminator|passcode|trace-to|PICS)\s+\S+\s+/g,
-                "",
-            );
-            command.push(...args.trim().split(/\s+/));
-        }
+    const command = ["python3", descriptor.path, ...Constants.PythonRunnerArgs];
+
+    const args = scriptArgsOf(descriptor);
+    if (args !== undefined) {
+        command.push(...args);
     }
 
     command.push(...extraArgs);
@@ -200,3 +186,15 @@ async function createCommand(descriptor: TestFileDescriptor, subject: Subject, e
 
     return command;
 }
+
+function scriptArgsOf(descriptor: TestFileDescriptor) {
+    const scriptArgs = descriptor.config?.["script-args"];
+    if (typeof scriptArgs !== "string") {
+        return;
+    }
+
+    return scriptArgs
+        .replace(/--(?:storage-path|commissioning-method|discriminator|passcode|trace-to|PICS)\s+\S+\s+/g, "")
+        .trim()
+        .split(/\s+/);
+}

package/src/chip/state.ts

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { Package } from "#tools";
+import { ansi, Package } from "#tools";
 import { BackchannelCommand } from "../device/backchannel.js";
 import { Subject } from "../device/subject.js";
 import { Test } from "../device/test.js";
@@ -28,13 +28,14 @@ import { YamlTest } from "./yaml-test.js";
  */
 const Values = {
     isInitialized: false,
-    maybeRunner: undefined as TestRunner | undefined,
-    maybeMocha: undefined as Mocha | undefined,
-    maybeSubject: undefined as Subject.Factory | undefined,
-    maybeTest: undefined as Test | undefined,
-    maybeContainer: undefined as Container | undefined,
-    maybePics: undefined as PicsFile | undefined,
-    maybeTests: undefined as TestDescriptor.Filesystem | undefined,
+    runner: undefined as TestRunner | undefined,
+    mocha: undefined as Mocha | undefined,
+    subject: undefined as Subject.Factory | undefined,
+    test: undefined as Test | undefined,
+    mainContainer: undefined as Container | undefined,
+    mdnsContainer: undefined as Container | undefined,
+    pics: undefined as PicsFile | undefined,
+    tests: undefined as TestDescriptor.Filesystem | undefined,
     initializedSubjects: new WeakSet<Subject>(),
     activeSubject: undefined as Subject | undefined,
     singleUseSubject: false,
@@ -43,7 +44,7 @@ const Values = {
     subjects: new Map<Subject.Factory, Record<string, Subject>>(),
     snapshots: new Map<Subject, {}>(),
     containerLifecycleInstalled: false,
-    tests: new Map<TestDescriptor, Test>(),
+    testMap: new Map<TestDescriptor, Test>(),
 };
 
 /**
@@ -51,7 +52,7 @@ const Values = {
  */
 export const State = {
     get container() {
-        const container = Values.maybeContainer;
+        const container = Values.mainContainer;
 
         if (container === undefined) {
             throw new Error("Docker container is not initialized");
@@ -61,11 +62,11 @@ export const State = {
     },
 
     set runner(runner: TestRunner) {
-        Values.maybeRunner = runner;
+        Values.runner = runner;
     },
 
     get runner() {
-        const runner = Values.maybeRunner;
+        const runner = Values.runner;
 
         if (runner === undefined) {
             throw new Error("No test runner configured");
@@ -75,11 +76,11 @@ export const State = {
     },
 
     set mocha(mocha: Mocha) {
-        Values.maybeMocha = mocha;
+        Values.mocha = mocha;
     },
 
     get mocha() {
-        const mocha = Values.maybeMocha;
+        const mocha = Values.mocha;
 
         if (mocha === undefined) {
             throw new Error("No mocha instance configured");
@@ -89,11 +90,11 @@ export const State = {
     },
 
     set subject(subject: Subject.Factory) {
-        Values.maybeSubject = subject;
+        Values.subject = subject;
     },
 
     get subject() {
-        const subject = Values.maybeSubject;
+        const subject = Values.subject;
 
         if (subject === undefined) {
             throw new Error("no default subject configured");
@@ -103,26 +104,26 @@ export const State = {
     },
 
     get pics() {
-        if (Values.maybePics === undefined) {
+        if (Values.pics === undefined) {
             throw new Error("PICS not initialized");
         }
 
-        return Values.maybePics;
+        return Values.pics;
     },
 
     get tests() {
-        if (Values.maybeTests === undefined) {
+        if (Values.tests === undefined) {
             throw new Error("CHIP test descriptor not loaded");
         }
-        return Values.maybeTests;
+        return Values.tests;
     },
 
     get test() {
-        if (Values.maybeTest === undefined) {
+        if (Values.test === undefined) {
             throw new Error("No active test");
         }
 
-        return Values.maybeTest;
+        return Values.test;
     },
 
     get isInitialized() {
@@ -138,7 +139,23 @@ export const State = {
         }
 
         const { progress } = State.runner;
-        return await progress.run(`Initializing containers`, initialize);
+
+        progress.update("Initializing containers");
+        try {
+            const result = await initialize();
+
+            const imageVersion = formatSha(await State.container.imageId);
+            const chipVersion = formatSha(await State.container.read("/etc/chip-version"));
+
+            progress.success(
+                `Initialized containers from image ${ansi.bold(imageVersion)} for CHIP ${ansi.bold(chipVersion)}`,
+            );
+
+            return result;
+        } catch (e) {
+            progress.failure("Initializing containers");
+            throw e;
+        }
     },
 
     /**
@@ -187,11 +204,11 @@ export const State = {
         const subject = Values.activeSubject!;
 
         try {
-            Values.maybeTest = test;
+            Values.test = test;
             await beforeTest(subject, test);
             await test.invoke(subject, reporter.beginStep.bind(reporter), args);
         } finally {
-            Values.maybeTest = undefined;
+            Values.test = undefined;
         }
     },
 
@@ -238,10 +255,10 @@ export const State = {
             identifier = maybeDescriptor;
         }
 
-        let test = Values.tests.get(identifier);
+        let test = Values.testMap.get(identifier);
         if (!test) {
             test = createTest(identifier);
-            Values.tests.set(identifier, test);
+            Values.testMap.set(identifier, test);
         }
 
         return test;
@@ -347,6 +364,21 @@ export const State = {
             Values.activeSubject = undefined;
         }
     },
+
+    /**
+     * Clear the MDNS cache.
+     */
+    async clearMdns() {
+        if (!Values.mdnsContainer) {
+            throw new Error("Cannot reset MDNS because MDNS container is not initialized");
+        }
+
+        // Active subjects will not be discoverable after we clear DNS
+        await this.deactivateSubject();
+
+        // Clear DNS
+        await Values.mdnsContainer.exec("/bin/mdns-clear");
+    },
 };
 
 /**
@@ -387,12 +419,12 @@ async function configureContainer() {
         command: ["/usr/bin/dbus-daemon", "--nopidfile", "--system", "--nofork"],
     });
 
-    await composition.add({
+    Values.mdnsContainer = await composition.add({
         name: "mdns",
-        command: ["/usr/sbin/avahi-daemon"],
+        command: ["/bin/mdns-run"],
     });
 
-    Values.maybeContainer = await composition.add({
+    Values.mainContainer = await composition.add({
         name: "chip",
         recreate: true,
     });
@@ -404,7 +436,7 @@ async function configureContainer() {
             console.error("Error terminating containers:", e);
         }
 
-        Values.maybeContainer = undefined;
+        Values.mainContainer = undefined;
     });
 }
 
@@ -419,7 +451,7 @@ async function configurePics() {
     const overrides = new PicsFile(testing.resolve(Constants.localPicsOverrideFile));
     pics.patch(overrides);
 
-    Values.maybePics = pics;
+    Values.pics = pics;
 
     await State.container.write(ContainerPaths.matterJsPics, pics.toString());
 }
@@ -435,7 +467,7 @@ async function configureTests() {
     if (!Array.isArray(descriptor.members)) {
         throw new Error(`CHIP test descriptor has no members`);
     }
-    Values.maybeTests = TestDescriptor.Filesystem(descriptor);
+    Values.tests = TestDescriptor.Filesystem(descriptor);
 }
 
 /**
@@ -528,3 +560,10 @@ function createTest(descriptor: TestDescriptor) {
             throw new Error(`Cannot implement CHIP test ${descriptor.name} of kind ${descriptor.kind}`);
     }
 }
+
+function formatSha(sha: string) {
+    if (sha.startsWith("sha256:")) {
+        sha = sha.substring(7);
+    }
+    return ansi.bold(sha.substring(0, 12));
+}

package/src/docker/container.ts

@@ -19,6 +19,9 @@ import { Terminal } from "./terminal.js";
  */
 export interface Container {
     docker: Docker;
+
+    imageId: Promise<string>;
+
     start(): Promise<void>;
     kill(): Promise<void>;
     remove(force?: boolean): Promise<void>;
@@ -226,6 +229,10 @@ function adaptContainer(docker: Docker, ct: Dockerode.Container): Container {
     return {
         docker,
 
+        get imageId() {
+            return ct.inspect().then(info => info.Image);
+        },
+
         async start() {
             await DockerError.adapt(ct.start());
         },

package/src/mocha.ts

@@ -221,7 +221,7 @@ export function adaptReporter(
             });
 
             runner.on(RUNNER.EVENT_TEST_BEGIN, test => {
-                if (updateStats) {
+                if (updateStats && test.descriptor) {
                     test.descriptor.runAt = new Date();
                 }
                 logs = (test as any).logs = [];
@@ -230,13 +230,17 @@ export function adaptReporter(
 
             if (updateStats) {
                 runner.on(RUNNER.EVENT_TEST_PASS, test => {
+                    if (!test.descriptor) {
+                        return;
+                    }
+
                     test.descriptor.durationMs = test.duration;
                     test.descriptor.passed = true;
                 });
             }
 
             runner.on(RUNNER.EVENT_TEST_FAIL, (test, error) => {
-                if (updateStats) {
+                if (updateStats && test.descriptor) {
                     test.descriptor.durationMs = test.duration;
                     test.descriptor.passed = false;
                 }

package/src/test-descriptor.ts

@@ -22,6 +22,7 @@ export interface TestDescriptor {
     description?: string;
     pics?: string;
     config?: Record<string, unknown>;
+    startUncommissioned?: boolean;
     runAt?: Date;
     passed?: boolean;
     durationMs?: number;