feat(resolve-check-config): add support for check-store e2e-tests

Author: damienwebdev

.github/workflows/_internal-check-store.yaml

@@ -85,12 +85,19 @@ jobs:
         env:
           COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }}
 
+      - name: Opt in to e2e-test
+        working-directory: ${{ steps.setup-magento.outputs.path }}
+        run: |
+          mkdir -p .github
+          echo '{ "jobs": { "e2e-test": true } }' > .github/check-store.json
+
       - uses: actions/upload-artifact@v7
         with:
           name: store-fixture-${{ matrix.version }}
           path: |
             ${{ steps.setup-magento.outputs.path }}
             !${{ steps.setup-magento.outputs.path }}/vendor
+          include-hidden-files: true
           retention-days: 3
 
   check-store:

.github/workflows/check-store.yaml

@@ -57,11 +57,13 @@ jobs:
           kind: custom
           custom_versions: ${{ steps.get-magento-version.outputs.project }}:${{ fromJSON(steps.get-magento-version.outputs.version) }}
 
-      - uses: graycoreio/github-actions-magento2/resolve-check-config@main
+      ## TODO: restore to graycoreio/github-actions-magento2/resolve-check-config@main before merge
+      - uses: digitalrisedorset/github-actions-magento2/resolve-check-config@feat/check-store-e2e-support
         id: resolve
         with:
           kind: store
           matrix: ${{ steps.supported-version.outputs.matrix }}
+          config_path: ${{ inputs.path }}/.github/check-store.json
 
   unit-test:
     runs-on: ${{ matrix.os }}
@@ -245,9 +247,10 @@ jobs:
   e2e-test:
     runs-on: ${{ matrix.os }}
     needs: compute_matrix
+    if: ${{ fromJSON(needs.compute_matrix.outputs.resolved)['e2e-test'].enabled != false }}
     services: ${{ matrix.services }}
     strategy:
-      matrix: ${{ fromJSON(needs.compute_matrix.outputs.matrix) }}
+      matrix: ${{ fromJSON(needs.compute_matrix.outputs.resolved)['e2e-test'].matrix }}
 
     steps:
       - uses: actions/checkout@v6

resolve-check-config/check-store.schema.json

@@ -11,7 +11,11 @@
       "properties": {
         "unit-test": { "$ref": "#/$defs/jobConfig" },
         "coding-standard": { "$ref": "#/$defs/jobConfig" },
-        "smoke-test": { "$ref": "#/$defs/jobConfig" }
+        "smoke-test": { "$ref": "#/$defs/jobConfig" },
+        "e2e-test": {
+          "$ref": "#/$defs/jobConfig",
+          "description": "Opt-in: e2e-test does not run unless enabled here."
+        }
       },
       "additionalProperties": false
     }

resolve-check-config/dist/index.js

@@ -3,6 +3,7 @@
   "jobs": {
     "unit-test": true,
     "coding-standard": true,
+    "e2e-test": true,
     "integration-test": {
       "services": ["search", "queue", "cache"]
     },

resolve-check-config/examples/check-store.example.json

@@ -17,7 +17,7 @@ const MATRIX: Matrix = {
 
 describe('STORE_JOBS', () => {
   it('declares the check-store jobs', () => {
-    expect(Object.keys(STORE_JOBS).sort()).toEqual(['coding-standard', 'smoke-test', 'unit-test']);
+    expect(Object.keys(STORE_JOBS).sort()).toEqual(['coding-standard', 'e2e-test', 'smoke-test', 'unit-test']);
   });
 
   it('declares smoke-test required tiers (end-user cannot toggle)', () => {
@@ -31,6 +31,16 @@ describe('STORE_JOBS', () => {
     ]);
   });
 
+  it('declares e2e-test required tiers (end-user cannot toggle)', () => {
+    expect(STORE_JOBS['e2e-test'].services).toEqual([]);
+    expect([...STORE_JOBS['e2e-test'].requiredServices!].sort()).toEqual([
+      'cache',
+      'db',
+      'search',
+      'web',
+    ]);
+  });
+
   it('exposes empty service defaults for unit-test and coding-standard', () => {
     expect(STORE_JOBS['unit-test'].services).toEqual([]);
     expect(STORE_JOBS['coding-standard'].services).toEqual([]);
@@ -44,7 +54,7 @@ describe('STORE_JOBS', () => {
 describe('resolveStoreConfig', () => {
   it('emits every known job with default tier expansion, always including mysql for smoke-test', () => {
     const resolved = resolveStoreConfig({}, MATRIX);
-    expect(Object.keys(resolved).sort()).toEqual(['coding-standard', 'smoke-test', 'unit-test']);
+    expect(Object.keys(resolved).sort()).toEqual(['coding-standard', 'e2e-test', 'smoke-test', 'unit-test']);
     expect(resolved['unit-test'].matrix.include[0].services).toEqual({});
     expect(Object.keys(resolved['smoke-test'].matrix.include[0].services!).sort()).toEqual([
       'mysql',
@@ -71,6 +81,21 @@ describe('resolveStoreConfig', () => {
     ]);
   });
 
+  it('disables e2e-test by default (opt-in job)', () => {
+    const resolved = resolveStoreConfig({}, MATRIX);
+    expect(resolved['e2e-test'].enabled).toBe(false);
+    expect(resolved['unit-test'].enabled).toBe(true);
+    expect(resolved['smoke-test'].enabled).toBe(true);
+  });
+
+  it('enables e2e-test when the caller opts in', () => {
+    const resolved = resolveStoreConfig(
+      { jobs: { 'e2e-test': true } },
+      MATRIX,
+    );
+    expect(resolved['e2e-test'].enabled).toBe(true);
+  });
+
   it('honors enabled=false for a job', () => {
     const resolved = resolveStoreConfig(
       { jobs: { 'smoke-test': false } },

resolve-check-config/src/kinds/store.spec.ts

@@ -15,6 +15,11 @@ export const STORE_JOBS: Record<string, JobDefaults> = {
     services: [],
     requiredServices: ['db', 'search', 'queue', 'cache', 'web'],
   },
+  'e2e-test': {
+    services: [],
+    requiredServices: ['db', 'search', 'cache', 'web'],
+    enabledByDefault: false,
+  },
 };
 
 export const KNOWN_JOBS_STORE: readonly string[] = Object.keys(STORE_JOBS);

resolve-check-config/src/kinds/store.ts

@@ -14,7 +14,7 @@ export const normalizeJobEntry = (
   defaults: JobDefaults,
 ): { enabled: boolean; tiers: readonly Tier[] } => {
   if (raw === undefined) {
-    return { enabled: true, tiers: defaults.services };
+    return { enabled: defaults.enabledByDefault ?? true, tiers: defaults.services };
   }
   if (typeof raw === 'boolean') {
     return { enabled: raw, tiers: defaults.services };

resolve-check-config/src/parse.ts

@@ -53,10 +53,15 @@ export interface Matrix {
  * regardless of caller overrides. Use it for tiers a job structurally
  * cannot run without (e.g. mysql for a running store smoke-test) and
  * which therefore should not appear in the user-facing schema enum.
+ *
+ * `enabledByDefault` controls the `enabled` value emitted when the
+ * caller's config omits the job entirely. Defaults to `true`; set
+ * `false` for opt-in jobs.
  */
 export interface JobDefaults {
   services: readonly Tier[];
   requiredServices?: readonly Tier[];
+  enabledByDefault?: boolean;
 }
 
 /**