feat: add ngtx.scenario.testGeneratorFn

JulianLang · JulianLang · commit ed3611424efc · 2025-02-02T11:20:27.000+01:00
diff --git a/library/ngtx.ts b/library/ngtx.ts
@@ -7,6 +7,7 @@ import {
 } from './scenario-testing/symbols';
 import {
   ComponentFixtureRef,
+  NgtxScenarioTestAssertionFn,
   ScenarioSetupFn,
   ScenarioViewSetupFn,
 } from './scenario-testing/types';
@@ -69,10 +70,17 @@ export const ngtx = Object.assign(_ngtx, {
   scenario: {
     envSetupFn,
     viewSetupFn,
+    testGeneratorFn,
   },
   is,
 });
 
+function testGeneratorFn<Html extends HTMLElement, Component>(
+  fn: NgtxScenarioTestAssertionFn<Html, Component>,
+) {
+  return fn;
+}
+
 function envSetupFn(fn: () => unknown) {
   return Object.assign(fn, { [NgtxScenarioSetupFnMarker]: true });
 }
diff --git a/library/specs/scenario/scenario-testing.spec.ts b/library/specs/scenario/scenario-testing.spec.ts
@@ -4,7 +4,6 @@ import { ActivatedRoute, RouterModule } from '@angular/router';
 import { ngtx } from '../../ngtx';
 import { ScenarioTestingHarness } from '../../scenario-testing/scenario-harnesses';
 import { useScenarioTesting } from '../../scenario-testing/scenario-testing';
-import { NgtxScenarioTestAssertionFn } from '../../scenario-testing/types';
 
 @Injectable()
 class MyService {
@@ -121,15 +120,25 @@ expectThat(
   the.Text.toHaveState({ text: 'Hello, World!' }),
 );
 
-const beComponentType =
-  (type: any): NgtxScenarioTestAssertionFn<HTMLElement, any> =>
+const beComponentType = (type: any) =>
   // TODO: docs: document that debugElement must only be accessed within it case:
-  (addTests, harness) =>
+  ngtx.scenario.testGeneratorFn((addTests, harness) =>
     addTests(() => {
-      it(`should be the component "${type.name}"`, () => {
-        expect(harness.debugElement.componentInstance).toBeInstanceOf(type);
+      const description = harness.isAssertionNegated
+        ? `should not be the component "${type.name}"`
+        : `should be the component "${type.name}"`;
+
+      it(description, () => {
+        if (harness.isAssertionNegated) {
+          expect(harness.debugElement.componentInstance).not.toBeInstanceOf(
+            type,
+          );
+        } else {
+          expect(harness.debugElement.componentInstance).toBeInstanceOf(type);
+        }
       });
-    });
+    }),
+  );
 
 expectThat(
   the.Div.toBeFound(),
@@ -140,6 +149,7 @@ expectThat(
     beComponentType(TextComponent),
     beComponentType(TextComponent),
   ),
+  the.Text.not.to(beComponentType(ScenarioTestComponent)),
 );
 
 tests.run();
