feat: add only feature to use fdescribe

Author: JulianLang

library/global-config.ts

@@ -8,6 +8,7 @@ const NO_FRAMEWORK_ADAPTER_ERROR = () => {
 
 const DEFAULT_TESTING_FRAMEWORK_ADAPTER = {
   describe: NO_FRAMEWORK_ADAPTER_ERROR,
+  fdescribe: NO_FRAMEWORK_ADAPTER_ERROR,
   beforeEach: NO_FRAMEWORK_ADAPTER_ERROR,
 };
 

library/scenario-testing/scenario-testing.ts

@@ -56,10 +56,12 @@ export class NgtxScenarioTestEnvironment<T> {
 
   public run() {
     const { _framework, _moduleConfig, _componentType, scenarios } = this;
-    const { describe, beforeEach } = _framework;
+    const { describe, fdescribe, beforeEach } = _framework;
 
     for (const scenario of scenarios) {
-      describe(scenario['_description'], () => {
+      const descriptor = scenario['_runFocused'] ? fdescribe : describe;
+
+      descriptor(scenario['_description'], () => {
         beforeEach(async () => {
           await TestBed.configureTestingModule(
             _moduleConfig,
@@ -84,6 +86,7 @@ export class NgtxTestScenario<T = any> {
   ): NgtxTestScenario<T> {
     return new NgtxTestScenario(
       props.description,
+      props.runFocused,
       environment,
       props.moduleConfig,
       props.componentType,
@@ -95,6 +98,7 @@ export class NgtxTestScenario<T = any> {
 
   private constructor(
     private readonly _description: string,
+    private readonly _runFocused: boolean,
     private readonly _testEnvironment: NgtxScenarioTestEnvironment<T>,
     private readonly _moduleConfig: TestModuleMetadata,
     private readonly _componentType: Type<T>,
@@ -113,6 +117,7 @@ export class NgtxTestScenario<T = any> {
       {
         componentType: this._componentType,
         description: this._description,
+        runFocused: this._runFocused,
         moduleConfig: this._moduleConfig,
         modificationsBeforeComponentCreation: [
           ...this._modificationsBeforeComponentCreation,
@@ -137,6 +142,7 @@ export class NgtxTestScenario<T = any> {
       {
         componentType: this._componentType,
         description: this._description,
+        runFocused: this._runFocused,
         moduleConfig: this._moduleConfig,
         modificationsBeforeComponentCreation:
           this._modificationsBeforeComponentCreation,
@@ -174,16 +180,27 @@ export function useScenarioTesting<T>(
     props.componentType,
   );
 
-  const controlLevelScenario = NgtxTestScenario.from(
-    { ...props, description: 'Control' },
-    environment,
-  );
-  const controlLevelExpect: NgtxTestScenario<T>['expect'] =
-    controlLevelScenario.expect.bind(controlLevelScenario);
+  let runScenarioFocused = false;
+  const only = (userScenarios: () => unknown) => {
+    runScenarioFocused = true;
+    userScenarios();
+    runScenarioFocused = false;
+  };
+
+  const controlLevelExpect: NgtxTestScenario<T>['expect'] = (...scenarios) => {
+    return NgtxTestScenario.from(
+      { ...props, runFocused: runScenarioFocused, description: 'Control' },
+      environment,
+    ).expect(...scenarios);
+  };
 
   return {
+    only,
     scenario: (description: string) =>
-      NgtxTestScenario.from({ ...props, description }, environment),
+      NgtxTestScenario.from(
+        { ...props, runFocused: runScenarioFocused, description },
+        environment,
+      ),
     expect: controlLevelExpect,
     tests: environment,
   };

library/scenario-testing/types.ts

@@ -11,6 +11,7 @@ export type ScenarioTestDefinition<T> = (
   fixtureRef: ComponentFixtureRef<T>,
 ) => void;
 export type NgtxTestingFrameworkAdapter = {
+  fdescribe: (title: string, suite: () => void) => void;
   describe: (title: string, suite: () => void) => void;
   beforeEach: (fn: () => void) => void;
 };
@@ -21,6 +22,7 @@ export type NgtxScenarioInitProps<T> = {
 };
 
 export type NgtxScenarioProps<T> = NgtxScenarioInitProps<T> & {
+  runFocused: boolean;
   description: string;
   tests?: ScenarioTestDefinition<T>[];
   modificationsBeforeComponentCreation?: ScenarioSetupFn[];

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@centigrade/ngtx",
-  "version": "2.6.0-alpha.9",
+  "version": "2.6.0-alpha.10",
   "description": "The Angular Testing Extensions is a small set of functions, aiming to make your life easier, when testing Angular components.",
   "scripts": {
     "clean": "shx rm -rf dist",

setupAngularTestEnv.ts

@@ -6,6 +6,7 @@ setupZoneTestEnv();
 
 const jestFramework: NgtxTestingFrameworkAdapter = {
   describe,
+  fdescribe,
   beforeEach,
 };