Merge pull request #44 from shopware/fix-test-data-cleanup

fix: Improved data cleanup of TestDataService

src/fixtures/ApiContexts.ts

@@ -1,13 +1,11 @@
 import { test as base } from '@playwright/test';
 import { AdminApiContext } from '../services/AdminApiContext';
 import { StoreApiContext } from '../services/StoreApiContext';
-import { TestDataService } from '../services/TestDataService';
 import type { FixtureTypes } from '../types/FixtureTypes';
 
 export interface ApiContextTypes {
     AdminApiContext: AdminApiContext;
     StoreApiContext: StoreApiContext;
-    TestDataService: TestDataService;
 }
 
 export const test = base.extend<NonNullable<unknown>, FixtureTypes>({
@@ -32,23 +30,4 @@ export const test = base.extend<NonNullable<unknown>, FixtureTypes>({
         },
         { scope: 'worker' },
     ],
-
-    TestDataService: [
-        async ({ AdminApiContext, IdProvider, DefaultSalesChannel, SalesChannelBaseConfig }, use) => {
-            const DataService = new TestDataService(AdminApiContext, IdProvider, {
-                defaultSalesChannel: DefaultSalesChannel.salesChannel,
-                defaultTaxId: SalesChannelBaseConfig.taxId,
-                defaultCurrencyId: SalesChannelBaseConfig.defaultCurrencyId,
-                defaultCategoryId: DefaultSalesChannel.salesChannel.navigationCategoryId,
-                defaultLanguageId: DefaultSalesChannel.salesChannel.languageId,
-                defaultCountryId: DefaultSalesChannel.salesChannel.countryId,
-                defaultCustomerGroupId: DefaultSalesChannel.salesChannel.customerGroupId,
-            })
-
-            await use(DataService);
-
-            await DataService.cleanUp();
-        },
-        { scope: 'worker' },
-    ],
 });

src/fixtures/TestData.ts

@@ -0,0 +1,26 @@
+import { test as base } from '@playwright/test';
+import { TestDataService } from '../services/TestDataService';
+import type { FixtureTypes } from '../types/FixtureTypes';
+
+export interface TestDataFixtureTypes {
+    TestDataService: TestDataService;
+}
+
+export const test = base.extend<FixtureTypes>({
+
+    TestDataService: async ({ AdminApiContext, IdProvider, DefaultSalesChannel, SalesChannelBaseConfig }, use) => {
+        const DataService = new TestDataService(AdminApiContext, IdProvider, {
+            defaultSalesChannel: DefaultSalesChannel.salesChannel,
+            defaultTaxId: SalesChannelBaseConfig.taxId,
+            defaultCurrencyId: SalesChannelBaseConfig.defaultCurrencyId,
+            defaultCategoryId: DefaultSalesChannel.salesChannel.navigationCategoryId,
+            defaultLanguageId: DefaultSalesChannel.salesChannel.languageId,
+            defaultCountryId: DefaultSalesChannel.salesChannel.countryId,
+            defaultCustomerGroupId: DefaultSalesChannel.salesChannel.customerGroupId,
+        })
+
+        await use(DataService);
+
+        await DataService.cleanUp();
+    },
+});

src/index.ts

@@ -3,6 +3,7 @@ import { test as DefaultSalesChannel } from './fixtures/DefaultSalesChannel';
 import { test as ApiContexts } from './fixtures/ApiContexts';
 import { test as PageContexts } from './fixtures/PageContexts';
 import { test as Actors } from './fixtures/Actors';
+import { test as TestData } from './fixtures/TestData';
 import { test as HelperFixtures } from './fixtures/HelperFixtures';
 import { test as StorefrontPages } from './page-objects/StorefrontPages';
 import { test as AdministrationPages } from './page-objects/AdministrationPages';
@@ -30,6 +31,7 @@ export const test = mergeTests(
     ApiContexts,
     PageContexts,
     Actors,
+    TestData,
     StorefrontPages,
     AdministrationPages,
     DataFixtures,

src/services/TestDataService.ts

@@ -22,7 +22,7 @@ import type {
 
 export interface CreatedRecord {
     resource: string;
-    id: string;
+    payload: Record<string, string>;
 }
 
 export interface SimpleLineItem {
@@ -65,10 +65,30 @@ export class TestDataService {
     public readonly defaultCountryId: string;
     public readonly defaultCustomerGroupId: string;
 
+    /**
+     * Configures if an automated cleanup of the data should be executed.
+     *
+     * @private
+     */
     private shouldCleanUp = true;
 
+    /**
+     * Configuration of higher priority entities for the cleanup operation.
+     * These entities will be deleted before others.
+     * This will prevent restricted delete operations of associated entities.
+     *
+     * @private
+     */
+    private highPriorityEntities = ['order', 'product'];
+
+    /**
+     * A registry of all created records.
+     *
+     * @private
+     */
     private createdRecords: CreatedRecord[] = [];
 
+
     constructor(AdminApiClient: AdminApiContext, IdProvider: IdProvider, options: DataServiceOptions) {
         this.AdminApiClient = AdminApiClient;
         this.IdProvider = IdProvider;
@@ -166,9 +186,7 @@ export class TestDataService {
         const product = await this.createBasicProduct(overrides, taxId, currencyId);
         const media = await this.createMediaTXT(content);
 
-        const productDownload = await this.assignProductDownload(product.id, media.id);
-
-        this.addCreatedRecord('product-download', productDownload.id);
+        await this.assignProductDownload(product.id, media.id);
 
         return product;
     }
@@ -323,7 +341,7 @@ export class TestDataService {
 
         const { data: propertyGroup } = (await propertyGroupResponse.json()) as { data: PropertyGroup };
 
-        this.addCreatedRecord('property-group', propertyGroup.id);
+        this.addCreatedRecord('property_group', propertyGroup.id);
 
         return propertyGroup;
     }
@@ -358,7 +376,7 @@ export class TestDataService {
 
         const { data: propertyGroup } = (await propertyGroupResponse.json()) as { data: PropertyGroup };
 
-        this.addCreatedRecord('property-group', propertyGroup.id);
+        this.addCreatedRecord('property_group', propertyGroup.id);
 
         return propertyGroup;
     }
@@ -785,10 +803,19 @@ export class TestDataService {
      * All entities added to the registry will be deleted by the cleanup call.
      *
      * @param resource - The resource name of the entity.
-     * @param id - The uuid of the entity.
+     * @param payload - You can pass a payload object for the delete operation or simply pass the uuid of the entity.
      */
-    addCreatedRecord(resource: string, id: string) {
-        this.createdRecords.push({ resource, id });
+    addCreatedRecord(resource: string, payload: string | Record<string, string>) {
+        const res = resource.replace('-', '_');
+
+        if (typeof payload === 'string') {
+            this.createdRecords.push({
+                resource: res,
+                payload: { id: payload },
+            });
+        } else {
+            this.createdRecords.push({ resource: res, payload });
+        }
     }
 
     /**
@@ -809,23 +836,41 @@ export class TestDataService {
             return Promise.reject();
         }
 
+        const priorityDeleteOperations: Record<string, SyncApiOperation> = {};
         const deleteOperations: Record<string, SyncApiOperation> = {};
 
         this.createdRecords.forEach((record) => {
-            if (!deleteOperations[`delete-${record.resource}`]) {
-                deleteOperations[`delete-${record.resource}`] = {
-                    entity: record.resource,
-                    action: 'delete',
-                    payload: [],
-                };
+            if (this.highPriorityEntities.includes(record.resource)) {
+                if (!priorityDeleteOperations[`delete-${record.resource}`]) {
+                    priorityDeleteOperations[`delete-${record.resource}`] = {
+                        entity: record.resource,
+                        action: 'delete',
+                        payload: [],
+                    };
+                }
+
+                priorityDeleteOperations[`delete-${record.resource}`].payload.push(record.payload);
+
+            } else {
+                if (!deleteOperations[`delete-${record.resource}`]) {
+                    deleteOperations[`delete-${record.resource}`] = {
+                        entity: record.resource,
+                        action: 'delete',
+                        payload: [],
+                    };
+                }
+
+                deleteOperations[`delete-${record.resource}`].payload.push(record.payload);
             }
+        });
 
-            deleteOperations[`delete-${record.resource}`].payload.push({ id: record.id });
+        await this.AdminApiClient.post('_action/sync', {
+            data: priorityDeleteOperations,
         });
 
         return await this.AdminApiClient.post('_action/sync', {
             data: deleteOperations,
-        })
+        });
     }
 
     /**

src/types/FixtureTypes.ts

@@ -1,6 +1,7 @@
 import { ApiContextTypes } from '../fixtures/ApiContexts';
 import { PageContextTypes } from '../fixtures/PageContexts';
 import { ActorFixtureTypes } from '../fixtures/Actors';
+import { TestDataFixtureTypes } from '../fixtures/TestData';
 import { HelperFixtureTypes } from '../fixtures/HelperFixtures';
 import { DefaultSalesChannelTypes } from '../fixtures/DefaultSalesChannel';
 import { StorefrontPageTypes } from '../page-objects/StorefrontPages';
@@ -11,6 +12,7 @@ export interface FixtureTypes extends
     ApiContextTypes,
     PageContextTypes,
     ActorFixtureTypes,
+    TestDataFixtureTypes,
     HelperFixtureTypes,
     DefaultSalesChannelTypes,
     StorefrontPageTypes,

tests/TestDataService.spec.ts

@@ -11,6 +11,12 @@ test('Data Service', async ({
     expect(product.description).toEqual('Test Description');
     expect(product.coverId).toBeDefined();
 
+    const digitalProduct = await TestDataService.createDigitalProduct('Test Test', { description: 'You can download me.' });
+    expect(digitalProduct.description).toEqual('You can download me.');
+
+    const propertyGroup = await TestDataService.createColorPropertyGroup();
+    expect(propertyGroup.description).toEqual('Color');
+
     const customer = await TestDataService.createCustomer({ firstName: 'Luke', lastName: 'Skywalker' })
     expect(customer.firstName).toEqual('Luke');
     expect(customer.lastName).toEqual('Skywalker');
@@ -22,4 +28,15 @@ test('Data Service', async ({
     expect(order.orderNumber).toEqual('123456789');
     expect(order.orderCustomer.firstName).toEqual('Luke');
     expect(order.price.totalPrice).toEqual(58.99);
+
+    // Data Clean-Up
+    const cleanUpResponse = await TestDataService.cleanUp();
+    expect(cleanUpResponse.ok()).toBeTruthy();
+
+    const cleanUp = await cleanUpResponse.json();
+    expect(cleanUp['notFound'].length).toBe(0);
+    expect(cleanUp['deleted']['category']).toBeDefined();
+    expect(cleanUp['deleted']['media']).toBeDefined();
+    expect(cleanUp['deleted']['property_group']).toBeDefined();
+    expect(cleanUp['deleted']['customer']).toBeDefined();
 });