Deployment agnostic snapshots

elastic · Nov 19, 2024 · 86d2221 · 86d2221
1 parent a5df223
commit 86d2221
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 5 deletions.
diff --git a/packages/kbn-test/src/functional_test_runner/lib/config/schema.ts b/packages/kbn-test/src/functional_test_runner/lib/config/schema.ts
@@ -152,6 +152,7 @@ export const schema = Joi.object()
 
     updateBaselines: Joi.boolean().default(false),
     updateSnapshots: Joi.boolean().default(false),
+    deploymentAgnosticSnapshots: Joi.boolean().default(false),
     browser: Joi.object()
       .keys({
         type: Joi.string().valid('chrome', 'firefox', 'msedge').default('chrome'),

diff --git a/packages/kbn-test/src/functional_test_runner/lib/mocha/load_tests.ts b/packages/kbn-test/src/functional_test_runner/lib/mocha/load_tests.ts
@@ -57,7 +57,12 @@ export const loadTests = ({
     updateBaselines,
   };
 
-  decorateSnapshotUi({ lifecycle, updateSnapshots, isCi: !!process.env.CI });
+  decorateSnapshotUi({
+    lifecycle,
+    updateSnapshots,
+    isCi: !!process.env.CI,
+    deploymentAgnostic: config.get('deploymentAgnosticSnapshots'),
+  });
 
   function loadTestFile(path: string) {
     if (typeof path !== 'string' || !isAbsolute(path)) {

diff --git a/packages/kbn-test/src/functional_test_runner/lib/snapshots/decorate_snapshot_ui.ts b/packages/kbn-test/src/functional_test_runner/lib/snapshots/decorate_snapshot_ui.ts
@@ -33,11 +33,13 @@ const globalState: {
   registered: boolean;
   currentTest: Test | null;
   snapshotStates: Record<string, ISnapshotState>;
+  deploymentAgnostic: boolean;
 } = {
   updateSnapshot: 'none',
   registered: false,
   currentTest: null,
   snapshotStates: {},
+  deploymentAgnostic: false,
 };
 
 const modifyStackTracePrepareOnce = once(() => {
@@ -66,10 +68,12 @@ export function decorateSnapshotUi({
   lifecycle,
   updateSnapshots,
   isCi,
+  deploymentAgnostic = false,
 }: {
   lifecycle: Lifecycle;
   updateSnapshots: boolean;
   isCi: boolean;
+  deploymentAgnostic?: boolean;
 }) {
   let rootSuite: Suite | undefined;
 
@@ -82,6 +86,7 @@ export function decorateSnapshotUi({
     globalState.registered = true;
     globalState.snapshotStates = {};
     globalState.currentTest = null;
+    globalState.deploymentAgnostic = deploymentAgnostic;
 
     if (isCi) {
       // make sure snapshots that have not been committed
@@ -125,7 +130,9 @@ export function decorateSnapshotUi({
       const snapshotState = globalState.snapshotStates[file];
 
       if (snapshotState && !test.isPassed()) {
-        snapshotState.markSnapshotsAsCheckedForTest(test.fullTitle());
+        snapshotState.markSnapshotsAsCheckedForTest(
+          getTestTitle(test, globalState.deploymentAgnostic)
+        );
       }
     });
 
@@ -194,7 +201,7 @@ export function expectSnapshot(received: any) {
 
   const context: SnapshotContext = {
     snapshotState,
-    currentTestName: test.fullTitle(),
+    currentTestName: getTestTitle(test, globalState.deploymentAgnostic),
   };
 
   return {
@@ -204,6 +211,13 @@ export function expectSnapshot(received: any) {
   };
 }
 
+function getTestTitle(test: Test, deploymentAgnostic: boolean = false) {
+  if (deploymentAgnostic) {
+    return ['Deployment-agnostic', ...test.titlePath().splice(1)].join(' ');
+  }
+  return test.fullTitle();
+}
+
 function expectToMatchSnapshot(snapshotContext: SnapshotContext, received: any) {
   const matcher = toMatchSnapshot.bind(snapshotContext as any);
   const result = matcher(received) as SyncExpectationResult;

diff --git a/...tion/deployment_agnostic/apis/observability/apm/traces/__snapshots__/top_traces.spec.snap b/...tion/deployment_agnostic/apis/observability/apm/traces/__snapshots__/top_traces.spec.snap
diff --git a/x-pack/test/api_integration/deployment_agnostic/default_configs/serverless.config.base.ts b/x-pack/test/api_integration/deployment_agnostic/default_configs/serverless.config.base.ts
@@ -85,6 +85,7 @@ export function createServerlessTestConfig<T extends DeploymentAgnosticCommonSer
         // services can be customized, but must extend DeploymentAgnosticCommonServices
         ...(options.services || services),
       },
+      deploymentAgnosticSnapshots: true,
       dockerServers: defineDockerServersConfig({
         registry: {
           enabled: !!dockerRegistryPort,

diff --git a/x-pack/test/api_integration/deployment_agnostic/default_configs/stateful.config.base.ts b/x-pack/test/api_integration/deployment_agnostic/default_configs/stateful.config.base.ts
@@ -124,7 +124,7 @@ export function createStatefulTestConfig<T extends DeploymentAgnosticCommonServi
           path.resolve(REPO_ROOT, STATEFUL_ROLES_ROOT_PATH, 'roles.yml'),
         ],
       },
-
+      deploymentAgnosticSnapshots: true,
       kbnTestServer: {
         ...xPackAPITestsConfig.get('kbnTestServer'),
         serverArgs: [