@shopware-ag/acceptance-test-suite 5.0.1 → 5.1.0

package/README.md

@@ -14,6 +14,7 @@ This test suite is an extension to [Playwright](https://playwright.dev/) to easi
 * [Page Objects](#page-objects)
 * [Actor Pattern](#actor-pattern)
 * [Data Fixtures](#data-fixtures)
+* [Test Data Service](#test-data-service)
 * [Code Contribution](#code-contribution)
 * [Best practices](#best-practices)
 
@@ -321,6 +322,12 @@ test('Customer login test scenario', async ({ ShopCustomer, Login }) => {
 You can create your own tasks in the same way to make them available for the actor pattern. Every task is just a simple Playwright fixture containing a function call with the corresponding test logic. Make sure to merge your task fixtures with other fixtures you created in your base test file. You can use the `mergeTests` method of Playwright to combine several fixtures into one test extension.
 
 ## Data Fixtures
+
+---
+**Deprecated:** Use the [Test Data Service](#test-data-service) instead.  
+
+---
+
 We already covered a lot of interesting fixtures you can use to create your test scenario. One topic which is missing is test data. Most test scenarios will need some predefined state within the system under test to validate a certain behaviour. Within this test suite we use Playwright fixtures also to create necessary test data via API. The goal is to have no direct system dependencies like a database connection to the system under test.
 
 **Example**  
@@ -374,6 +381,58 @@ test('Property group test scenario', async ({ PropertiesData }) => {
 
 If you create your own data fixtures make sure to import and merge them in your base test file with other fixtures you created.
 
+## Test Data Service
+This service is a simple way to create test data within your tests. It simplifies the usage of the Shopware API and provides sample structs for various entities, which you also can adjust to your needs. For detailed documentation of the methods you can have a look at the service class or simply use the auto-completion of your IDE. Here is a list of available methods:
+
+### Creating Data
+* `createBasicProduct()`
+* `createProductWithImage()`
+* `createDigitalProduct()`
+* `createProductWithPriceRange()`
+* `createBasicManufacturer()`
+* `createManufacturerWithImage()`
+* `createCategory()`
+* `createMediaPNG()`
+* `createMediaTXT()`
+* `createColorPropertyGroup()`
+* `createTextPropertyGroup()`
+* `createTag()`
+* `createCustomer()`
+* `createOrder()`
+* `createPromotionWithCode()`
+* `createBasicPaymentMethod()`
+* `createPaymentMethodWithImage()`
+* `createBasicShippingMethod()`
+* `createShippingMethodWithImage()`
+* `createBasicRule()`
+* `createBasicPageLayout()`
+
+### Relations
+* `assignProductDownload()`
+* `assignProductMedia()`
+* `assignProductManufacturer()`
+* `assignProductCategory()`
+* `assignProductTag()`
+* `assignManufacturerMedia()`
+* `assignPaymentMethodMedia()`
+* `assignShippingMethodMedia()`
+
+### Retrieving Basic Data
+* `getCurrency()`
+* `getRule()`
+* `getShippingMethod()`
+* `getPaymentMethod()`
+* `getAllDeliveryTimeResources()`
+* `getCustomerAddress()`
+* `getSalutation()`
+* `getOrderStateMachine()`
+* `getDeliveryStateMachine()`
+* `getTransactionStateMachine()`
+* `getTransactionStateMachine()`
+* `getStateMachine()`
+* `getStateMachineState()`
+* `getPropertyGroupOptions()`
+
 ## Code Contribution
 You can contribute to this project via its [official repository](https://github.com/shopware/acceptance-test-suite/) on GitHub.  
 
@@ -406,3 +465,22 @@ The most important part is [test isolation](https://playwright.dev/docs/best-pra
 - do not expect the shop to have the defaults en_GB and EUR
 - do not change global settings (sales channel is ok, because it's created by us)
   - basically everything in Settings that is not specific to a sales channel (tax, search, etc.)
+
+## Running Tests in the Test Suite
+If you want to work on the test suite and try to execute tests from within this repository, you have to run a corresponding docker image for a specific Shopware version.
+
+Shopware 6.6  
+```
+docker compose up -d shopware
+```
+
+Shopware 6.5  
+```
+docker compose up -d shopware-65
+```
+
+When the docker container is running you can execute the normal playwright commands.
+
+```
+npx playwright test
+```

package/dist/index.d.mts

@@ -398,6 +398,14 @@ declare class TestDataService {
      * @param currencyId - The uuid of the currency to use for the product pricing.
      */
     createProductWithPriceRange(overrides?: Partial<Product>, taxId?: string, currencyId?: string): Promise<Product>;
+    /**
+     * Creates basic variant products based on property group.
+     *
+     * @param parentProduct Parent product of the variants
+     * @param propertyGroups Property group collection which contain options
+     * @param overrides - Specific data overrides that will be applied to the variant data struct.
+     */
+    createVariantProducts(parentProduct: Product, propertyGroups: PropertyGroup[], overrides?: Partial<Product>): Promise<Product[]>;
     /**
      * Creates a basic manufacturer without images or other special configuration.
      *
@@ -483,19 +491,6 @@ declare class TestDataService {
      * @param overrides - Specific data overrides that will be applied to the payment method data struct.
      */
     createBasicPaymentMethod(overrides?: Partial<PaymentMethod>): Promise<PaymentMethod>;
-    /**
-     * Creates a new basic rule with the condition cart amount >= 1.
-     *
-     * @param overrides - Specific data overrides that will be applied to the payment method data struct.
-     */
-    createBasicRule(overrides?: Partial<Rule>, conditionType?: string, operator?: string, amount?: number): Promise<Rule>;
-    /**
-     * Creates a new basic page layout.
-     *
-     * @param cmsPageType - The type of the cms page layout (page/landingpage/product_detail/product_list).
-     * @param overrides - Specific data overrides that will be applied to the cms page layout data struct.
-     */
-    createBasicPageLayout(cmsPageType: string, overrides?: Partial<CmsPage>): Promise<CmsPage>;
     /**
      * Creates a payment method with one randomly generated image.
      *
@@ -503,13 +498,11 @@ declare class TestDataService {
      */
     createPaymentMethodWithImage(overrides?: Partial<PaymentMethod>): Promise<PaymentMethod>;
     /**
-     * Creates basic variant products based on property group.
+     * Creates a new basic shipping method with random delivery time.
      *
-     * @param parentProduct Parent product of the variants
-     * @param propertyGroups Property group collection which contain options
-     * @param overrides - Specific data overrides that will be applied to the variant data struct.
+     * @param overrides - Specific data overrides that will be applied to the shipping method data struct.
      */
-    createVariantProducts(parentProduct: Product, propertyGroups: PropertyGroup[], overrides?: Partial<Product>): Promise<Product[]>;
+    createBasicShippingMethod(overrides?: Partial<ShippingMethod>): Promise<ShippingMethod>;
     /**
      * Creates a shipping method with one randomly generated image.
      *
@@ -517,24 +510,18 @@ declare class TestDataService {
      */
     createShippingMethodWithImage(overrides?: Partial<ShippingMethod>): Promise<ShippingMethod>;
     /**
-     * Creates a new basic shipping method with random delivery time.
+     * Creates a new basic rule with the condition cart amount >= 1.
      *
-     * @param overrides - Specific data overrides that will be applied to the shipping method data struct.
-     */
-    createBasicShippingMethod(overrides?: Partial<ShippingMethod>): Promise<ShippingMethod>;
-    /**
-     * Function that generates combinations from n number of arrays
-     * with m number of elements in them.
-     * @param array
+     * @param overrides - Specific data overrides that will be applied to the payment method data struct.
      */
-    combineAll: (array: Record<string, string>[][]) => Record<string, string>[][];
+    createBasicRule(overrides?: Partial<Rule>, conditionType?: string, operator?: string, amount?: number): Promise<Rule>;
     /**
-     * Assigns a media resource to a payment method as a logo.
+     * Creates a new basic page layout.
      *
-     * @param paymentMethodId - The uuid of the payment method.
-     * @param mediaId - The uuid of the media resource.
+     * @param cmsPageType - The type of the cms page layout (page/landingpage/product_detail/product_list).
+     * @param overrides - Specific data overrides that will be applied to the cms page layout data struct.
      */
-    assignPaymentMethodMedia(paymentMethodId: string, mediaId: string): Promise<any>;
+    createBasicPageLayout(cmsPageType: string, overrides?: Partial<CmsPage>): Promise<CmsPage>;
     /**
      * Assigns a media resource as the download of a digital product.
      *
@@ -549,6 +536,27 @@ declare class TestDataService {
      * @param mediaId - The uuid of the media resource.
      */
     assignProductMedia(productId: string, mediaId: string): Promise<any>;
+    /**
+     * Assigns a manufacturer to a product.
+     *
+     * @param productId - The uuid of the product.
+     * @param manufacturerId - The uuid of the manufacturer.
+     */
+    assignProductManufacturer(productId: string, manufacturerId: string): Promise<void>;
+    /**
+     * Assigns a product to a category.
+     *
+     * @param productId - The uuid of the product.
+     * @param categoryId - The uuid of the category.
+     */
+    assignProductCategory(productId: string, categoryId: string): Promise<playwright_core.APIResponse>;
+    /**
+     * Assigns a tag to a product.
+     *
+     * @param productId - The uuid of the product.
+     * @param tagId - The uuid of the tag.
+     */
+    assignProductTag(productId: string, tagId: string): Promise<playwright_core.APIResponse>;
     /**
      * Assigns a media resource to a manufacturer as a logo.
      *
@@ -559,24 +567,26 @@ declare class TestDataService {
     /**
      * Assigns a manufacturer to a product.
      *
+     * @deprecated - Use `assignProductManufacturer` instead.
+     *
      * @param manufacturerId - The uuid of the manufacturer.
      * @param productId - The uuid of the product.
      */
     assignManufacturerProduct(manufacturerId: string, productId: string): Promise<void>;
     /**
-     * Assigns a product to a category.
+     * Assigns a media resource to a payment method as a logo.
      *
-     * @param productId - The uuid of the product.
-     * @param categoryId - The uuid of the category.
+     * @param paymentMethodId - The uuid of the payment method.
+     * @param mediaId - The uuid of the media resource.
      */
-    assignProductCategory(productId: string, categoryId: string): Promise<playwright_core.APIResponse>;
+    assignPaymentMethodMedia(paymentMethodId: string, mediaId: string): Promise<any>;
     /**
-     * Assigns a tag to a product.
+     * Assigns a media resource to a shipping method as a logo.
      *
-     * @param productId - The uuid of the product.
-     * @param tagId - The uuid of the tag.
+     * @param shippingMethodId - The uuid of the shipping method.
+     * @param mediaId - The uuid of the media resource.
      */
-    assignProductTag(productId: string, tagId: string): Promise<playwright_core.APIResponse>;
+    assignShippingMethodMedia(shippingMethodId: string, mediaId: string): Promise<any>;
     /**
      * Retrieves a currency based on its ISO code.
      *
@@ -595,13 +605,6 @@ declare class TestDataService {
      * @param name - The name of the shipping method. Default is "Standard".
      */
     getShippingMethod(name?: string): Promise<ShippingMethod>;
-    /**
-     * Assigns a media resource to a shipping method as a logo.
-     *
-     * @param shippingMethodId - The uuid of the shipping method.
-     * @param mediaId - The uuid of the media resource.
-     */
-    assignShippingMethodMedia(shippingMethodId: string, mediaId: string): Promise<any>;
     /**
      * Retrieves all delivery time resources.
      */
@@ -674,12 +677,20 @@ declare class TestDataService {
      * Will delete all entities created by the data service via sync API.
      */
     cleanUp(): Promise<playwright_core.APIResponse | null>;
+    isProduct(item: Product | Promotion): item is Product;
+    isPromotion(item: Product | Promotion): item is Promotion;
     /**
      * Convert a JS date object into a date-time compatible string.
      *
      * @param date - The JS date object from which the date-time should be retrieved.
      */
     convertDateTime(date: Date): string;
+    /**
+     * Function that generates combinations from n number of arrays
+     * with m number of elements in them.
+     * @param array
+     */
+    combineAll: (array: Record<string, string>[][]) => Record<string, string>[][];
     getBasicProductStruct(taxId?: string, currencyId?: string, overrides?: Partial<Product>): Partial<Product>;
     getBasicRuleStruct(overrides: Partial<Rule> | undefined, conditionType: string, operator: string, amount: number): Partial<Rule>;
     getProductPriceRangeStruct(currencyId: string, ruleId: string): Partial<Product>;
@@ -709,8 +720,6 @@ declare class TestDataService {
         deliveryTimeId: string;
         active: boolean;
     } & Partial<ShippingMethod>;
-    isProduct(item: Product | Promotion): item is Product;
-    isPromotion(item: Product | Promotion): item is Promotion;
     getBasicOrderStruct(lineItems: SimpleLineItem[], languageId: string, currency: Currency$1, paymentMethod: PaymentMethod, shippingMethod: ShippingMethod, orderState: StateMachineState, deliveryState: StateMachineState, transactionState: StateMachineState, customer: Customer, customerAddress: CustomerAddress, salesChannelId?: string, overrides?: Partial<Order>): Partial<Order>;
     getBasicProductLineItemStruct(lineItem: SimpleLineItem): {
         productId: string;
@@ -1102,6 +1111,7 @@ declare class ProductDetail implements PageObject {
      * Tabs
      */
     readonly variantsTabLink: Locator;
+    readonly specificationsTabLink: Locator;
     /**
      * Variants Generation
      */
@@ -1122,7 +1132,12 @@ declare class ProductDetail implements PageObject {
     readonly propertyOptionSizeSmall: Locator;
     readonly propertyOptionSizeMedium: Locator;
     readonly propertyOptionSizeLarge: Locator;
+    /**
+     * Cards
+     */
+    readonly customFieldCard: Locator;
     constructor(page: Page);
+    getCustomFieldSetCardContentByName(customFieldSetName: string): Promise<Record<string, Locator>>;
     url(productId: string): string;
 }
 
@@ -1140,7 +1155,11 @@ declare class CustomerDetail implements PageObject {
     readonly editButton: Locator;
     readonly generalTab: Locator;
     readonly accountCard: Locator;
+    readonly customFieldCard: Locator;
+    readonly customFieldSetTabs: Locator;
+    readonly customFieldSetTabCustomContent: Locator;
     constructor(page: Page);
+    getCustomFieldSetCardContentByName(customFieldSetName: string): Promise<Record<string, Locator>>;
     url(customerId: string): string;
 }
 
@@ -1357,6 +1376,7 @@ declare class Categories implements PageObject {
     readonly filterResultPopoverTreeCheckboxItemList: Locator;
     readonly openInNewTabCheckbox: Locator;
     constructor(page: Page);
+    getLandingPageByName(landingPageName: string): Promise<Locator>;
     url(): string;
 }
 
@@ -1364,10 +1384,84 @@ declare class RuleDetail implements PageObject {
     readonly page: Page;
     readonly nameInput: Locator;
     readonly priorityInput: Locator;
+    readonly conditionTypeSelectionInput: Locator;
+    readonly conditionValueSelectionInput: Locator;
+    readonly filtersResultPopoverSelectionList: Locator;
     constructor(page: Page);
     url(ruleId: string, tabName?: string): string;
 }
 
+declare class CustomFieldListing implements PageObject {
+    readonly page: Page;
+    readonly addNewSetButton: Locator;
+    readonly customFieldRows: Locator;
+    constructor(page: Page);
+    getLineItemByCustomFieldSetName(customFieldSetName: string): Promise<Record<string, Locator>>;
+    url(): string;
+}
+
+declare class CustomFieldCreate implements PageObject {
+    readonly page: Page;
+    readonly saveButton: Locator;
+    readonly cancelButton: Locator;
+    readonly technicalNameInput: Locator;
+    readonly positionInput: Locator;
+    readonly labelEnglishGBInput: Locator;
+    readonly assignToSelectionList: Locator;
+    readonly resultAssignToPopoverItemList: Locator;
+    constructor(page: Page);
+    url(): string;
+}
+
+declare class CustomFieldDetail extends CustomFieldCreate {
+    readonly page: Page;
+    readonly newCustomFieldButton: Locator;
+    readonly customFieldEditDialog: Locator;
+    readonly newCustomFieldDialog: Locator;
+    readonly customFieldTechnicalNameInput: Locator;
+    readonly customFieldPositionInput: Locator;
+    readonly customFieldTypeSelectionList: Locator;
+    readonly customFieldModifyByStoreApiCheckbox: Locator;
+    readonly customFieldCancelButton: Locator;
+    readonly customFieldAddButton: Locator;
+    readonly customFieldEditApplyButton: Locator;
+    readonly customFieldLabelEnglishGBInput: Locator;
+    readonly customFieldPlaceholderEnglishGBInput: Locator;
+    readonly customFieldHelpTextEnglishGBInput: Locator;
+    readonly customFieldDeleteListButton: Locator;
+    readonly customFieldDeleteDialog: Locator;
+    readonly customFieldDeleteCancelButton: Locator;
+    readonly customFieldDeleteButton: Locator;
+    constructor(page: Page);
+    getLineItemByCustomFieldName(customFieldName: string): Promise<Record<string, Locator>>;
+    url(customFieldUuid?: string): string;
+}
+
+declare class CategoryDetail implements PageObject {
+    readonly page: Page;
+    readonly saveButton: Locator;
+    readonly cancelButton: Locator;
+    readonly customFieldCard: Locator;
+    readonly customFieldSetTabs: Locator;
+    readonly customFieldSetTabCustomContent: Locator;
+    constructor(page: Page);
+    getCustomFieldSetCardContentByName(customFieldSetName: string): Promise<Record<string, Locator>>;
+    url(categoryUuid: string): string;
+}
+
+declare class RuleCreate implements PageObject {
+    readonly page: Page;
+    readonly nameInput: Locator;
+    readonly priorityInput: Locator;
+    readonly conditionTypeSelectionInput: Locator;
+    readonly conditionValueSelectionInput: Locator;
+    readonly filtersResultPopoverSelectionList: Locator;
+    readonly saveButton: Locator;
+    readonly cancelButton: Locator;
+    constructor(page: Page);
+    url(): string;
+}
+
 interface AdministrationPageTypes {
     AdminProductDetail: ProductDetail;
     AdminOrderDetail: OrderDetail;
@@ -1380,9 +1474,14 @@ interface AdministrationPageTypes {
     AdminDashboard: Dashboard;
     AdminShippingListing: ShippingListing;
     AdminCategories: Categories;
+    AdminCategoryDetail: CategoryDetail;
     AdminLandingPageCreate: LandingPageCreate;
     AdminLandingPageDetail: LandingPageDetail;
     AdminRuleDetail: RuleDetail;
+    AdminRuleCreate: RuleCreate;
+    AdminCustomFieldListing: CustomFieldListing;
+    AdminCustomFieldCreate: CustomFieldCreate;
+    AdminCustomFieldDetail: CustomFieldDetail;
 }
 declare const AdminPageObjects: {
     ProductDetail: typeof ProductDetail;
@@ -1396,9 +1495,14 @@ declare const AdminPageObjects: {
     DataSharing: typeof DataSharing;
     ShippingListing: typeof ShippingListing;
     Categories: typeof Categories;
+    CategoryDetail: typeof CategoryDetail;
     LandingPageCreate: typeof LandingPageCreate;
     LandingPageDetail: typeof LandingPageDetail;
     RuleDetail: typeof RuleDetail;
+    RuleCreate: typeof RuleCreate;
+    CustomFieldListing: typeof CustomFieldListing;
+    CustomFieldCreate: typeof CustomFieldCreate;
+    CustomFieldDetail: typeof CustomFieldDetail;
 };
 
 interface DataFixtureTypes {