test(flagd): rework e2e tests to new format (#1129)

Signed-off-by: Simon Schrottner <[email protected]>
Signed-off-by: Todd Baert <[email protected]>
Co-authored-by: Todd Baert <[email protected]>

Author: aepfli

.eslintrc.json

@@ -64,7 +64,7 @@
             "checkObsoleteDependencies": true,
             "checkVersionMismatches": true,
             "ignoredDependencies": ["jest-cucumber", "jest"],
-            "ignoredFiles": ["**/test/**", "**/spec/**", "**/*.spec.ts", "**/*.spec.js", "**/*.test.ts", "**/*.test.js"]
+            "ignoredFiles": ["**/test/**", "**/tests/*", "**/spec/**", "**/*.spec.ts", "**/*.spec.js", "**/*.test.ts", "**/*.test.js"]
           }
         ]
       }

libs/providers/flagd-web/schemas

@@ -2,4 +2,7 @@ import { getGherkinTestPath } from '@openfeature/flagd-core';
 
 export const FLAGD_NAME = 'flagd';
 
-export const GHERKIN_EVALUATION_FEATURE = getGherkinTestPath('flagd.feature');
+export const GHERKIN_EVALUATION_FEATURE = getGherkinTestPath(
+  'evaluation.feature',
+  'spec/specification/assets/gherkin/',
+);

libs/providers/flagd-web/src/e2e/constants.ts

@@ -1,5 +1,5 @@
 import type { StepDefinitions } from 'jest-cucumber';
-import type { EvaluationDetails, FlagValue, JsonObject } from '@openfeature/web-sdk';
+import type { EvaluationContext, EvaluationDetails, FlagValue, JsonObject } from '@openfeature/web-sdk';
 import { OpenFeature, ProviderEvents, StandardResolutionReasons } from '@openfeature/web-sdk';
 import { E2E_CLIENT_NAME } from '@openfeature/flagd-core';
 
@@ -8,6 +8,7 @@ export const flagStepDefinitions: StepDefinitions = ({ given, and, when, then })
   let value: FlagValue;
   let details: EvaluationDetails<FlagValue>;
   let fallback: FlagValue;
+  let context: EvaluationContext;
 
   const client = OpenFeature.getClient(E2E_CLIENT_NAME);
 
@@ -17,7 +18,7 @@ export const flagStepDefinitions: StepDefinitions = ({ given, and, when, then })
     });
   });
 
-  given('a provider is registered', () => undefined);
+  given('a stable provider', () => undefined);
   given('a flagd provider is set', () => undefined);
 
   when(
@@ -79,6 +80,32 @@ export const flagStepDefinitions: StepDefinitions = ({ given, and, when, then })
     value = client.getObjectValue(key, defaultValue);
   });
 
+  and(/^a flag with key "(.*)" is evaluated with default value "(.*)"$/, async (key, defaultValue) => {
+    await OpenFeature.setContext(context);
+    flagKey = key;
+    fallback = defaultValue;
+    value = client.getStringValue(flagKey, fallback as string);
+  });
+
+  when(
+    /^context contains keys "(.*)", "(.*)", "(.*)", "(.*)" with values "(.*)", "(.*)", (\d+), "(.*)"$/,
+    (key0, key1, key2, key3, stringVal1, stringVal2, intVal, boolVal) => {
+      context = {
+        [key0]: stringVal1,
+        [key1]: stringVal2,
+        [key2]: Number.parseInt(intVal),
+        [key3]: boolVal === true,
+      };
+    },
+  );
+
+  and(/^the resolved flag value is "(.*)" when the context is empty$/, async (expectedValue) => {
+    context = {};
+    await OpenFeature.setContext(context);
+    value = client.getStringValue(flagKey, fallback as string);
+    expect(value).toEqual(expectedValue);
+  });
+
   then(
     /^the resolved object value should be contain fields "(.*)", "(.*)", and "(.*)", with values "(.*)", "(.*)" and (\d+), respectively$/,
     (field1: string, field2: string, field3: string, boolValue: string, stringValue: string, intValue: string) => {

libs/providers/flagd-web/src/e2e/step-definitions/flag.ts

@@ -4,9 +4,15 @@ export const FLAGD_NAME = 'flagd';
 export const UNSTABLE_CLIENT_NAME = 'unstable';
 export const UNAVAILABLE_CLIENT_NAME = 'unavailable';
 
-export const GHERKIN_FLAGD_FEATURE = getGherkinTestPath('flagd.feature');
-export const GHERKIN_FLAGD_JSON_EVALUATOR_FEATURE = getGherkinTestPath('flagd-json-evaluator.feature');
-export const GHERKIN_FLAGD_RECONNECT_FEATURE = getGherkinTestPath('flagd-reconnect.feature');
+export const GHERKIN_FLAGD = getGherkinTestPath('*.feature');
+export const CONNECTION_FEATURE = getGherkinTestPath('connection.feature');
+export const CONTEXT_ENRICHMENT_FEATURE = getGherkinTestPath('contextEnrichment.feature');
+export const EVALUATION_FEATURE = getGherkinTestPath('evaluation.feature');
+export const EVENTS_FEATURE = getGherkinTestPath('events.feature');
+export const METADATA_FEATURE = getGherkinTestPath('metadata.feature');
+export const RPC_CACHING_FEATURE = getGherkinTestPath('rpc-caching.feature');
+export const SELECTOR_FEATURE = getGherkinTestPath('selector.feature');
+export const TARGETING_FEATURE = getGherkinTestPath('targeting.feature');
 export const GHERKIN_EVALUATION_FEATURE = getGherkinTestPath(
   'evaluation.feature',
   'spec/specification/assets/gherkin/',

libs/providers/flagd/schemas

@@ -1,2 +1 @@
 export * from './constants';
-export * from './step-definitions';

libs/providers/flagd/src/e2e/constants.ts

@@ -0,0 +1,47 @@
+import type { StepsDefinitionCallbackOptions } from 'jest-cucumber/dist/src/feature-definition-creation';
+import type { State, Steps } from './state';
+import { CacheOption, getConfig, ResolverType } from '../../lib/configuration';
+import { mapValueToType } from './utils';
+
+export const configSteps: Steps = (state: State) => {
+  function mapName(name: string): string {
+    switch (name) {
+      case 'resolver':
+        return 'resolverType';
+      default:
+        return name;
+    }
+  }
+
+  return ({ given, when, then }: StepsDefinitionCallbackOptions) => {
+    beforeEach(() => {
+      state.options = {};
+    });
+    given(/^an option "(.*)" of type "(.*)" with value "(.*)"$/, (name: string, type: string, value: string) => {
+      state.options[mapName(name)] = mapValueToType(value, type);
+    });
+    given(/^an environment variable "(.*)" with value "(.*)"$/, (name, value) => {
+      process.env[name] = value;
+    });
+    when('a config was initialized', () => {
+      state.config = getConfig(state.options);
+    });
+
+    then(
+      /^the option "(.*)" of type "(.*)" should have the value "(.*)"$/,
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
+      (_name: string, _type: string, _value: string) => {
+        // TODO: implement with configuration unification, see: https://github.com/open-feature/js-sdk-contrib/issues/1096
+        // const expected = mapValueToType(value, type);
+        // const propertyName = mapName(name);
+        // // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // // @ts-ignore
+        // const configElement = state.config[propertyName];
+        // expect(configElement).toBe(expected);
+      },
+    );
+
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    then('we should have an error', () => {});
+  };
+};

libs/providers/flagd/src/e2e/index.ts

@@ -0,0 +1,33 @@
+import type { JsonObject } from '@openfeature/server-sdk';
+import type { State, Steps } from './state';
+import { mapValueToType } from './utils';
+
+export const contextSteps: Steps =
+  (state: State) =>
+  ({ given, when, then }) => {
+    beforeEach(() => (state.context = undefined));
+    given(
+      /^a context containing a key "(.*)", with type "(.*)" and with value "(.*)"$/,
+      (key: string, type: string, value: string) => {
+        if (state.context == undefined) {
+          state.context = {};
+        }
+        state.context[key] = mapValueToType(value, type);
+      },
+    );
+    given(
+      /^a context containing a nested property with outer key "(.*)" and inner key "(.*)", with value "(.*)"$/,
+      (outer: string, inner: string, value) => {
+        if (state.context == undefined) {
+          state.context = {};
+        }
+        state.context[outer] = { ...(state.context[outer] as JsonObject), [inner]: value };
+      },
+    );
+    given(/^a context containing a targeting key with value "(.*)"$/, (key) => {
+      if (state.context == undefined) {
+        state.context = {};
+      }
+      state.context.targetingKey = key;
+    });
+  };

libs/providers/flagd/src/e2e/step-definitions/configSteps.ts

@@ -0,0 +1,49 @@
+import { ServerProviderEvents } from '@openfeature/server-sdk';
+import type { State, Steps } from './state';
+import { waitFor } from './utils';
+
+export const eventSteps: Steps =
+  (state: State) =>
+  ({ given, when, then }) => {
+    function map(eventType: string): ServerProviderEvents {
+      switch (eventType) {
+        case 'error':
+          return ServerProviderEvents.Error;
+        case 'ready':
+          return ServerProviderEvents.Ready;
+        case 'stale':
+          return ServerProviderEvents.Stale;
+        case 'change':
+          return ServerProviderEvents.ConfigurationChanged;
+
+        default:
+          throw new Error('unknown eventtype');
+      }
+    }
+
+    given(/a (.*) event handler/, async (type: string) => {
+      state.client?.addHandler(map(type), (details) => {
+        state.events.push({ type, details });
+      });
+    });
+
+    then(/^the (.*) event handler should have been executed$/, async (type: string) => {
+      await waitFor(() => expect(state.events.find((value) => value.type == type)).toBeDefined(), { timeout: 20000 });
+      expect(state.events.find((value) => value.type == type)).toBeDefined();
+    });
+
+    then(/^the (.*) event handler should have been executed within (\d+)ms$/, async (type: string, ms: number) => {
+      await waitFor(() => expect(state.events.find((value) => value.type == type)).toBeDefined(), { timeout: ms });
+      const actual = state.events.find((value) => value.type == type);
+      expect(actual).toBeDefined();
+    });
+
+    when(/^a (.*) event was fired$/, async (type: string) => {
+      await waitFor(() => expect(state.events.find((value) => value.type == type)), { timeout: 2000 });
+      expect(state.events.find((value) => value.type == type)).toBeDefined();
+    });
+
+    then('the flag should be part of the event payload', async () => {
+      await waitFor(() => expect(state.events.find((value) => value.type == 'change')), { timeout: 2000 });
+    });
+  };