Add tests (tax, shipping, payment, catalog mode, reverse withdrawal , wholesale customer) (test automation)

.github/workflows/e2e_api_tests.yml

@@ -177,14 +177,14 @@ jobs:
               timeout-minutes: 40
               working-directory: tests/pw
               run: |
-                  npm run test:e2e:lite
+                  npm run test:e2e
 
             # Run e2e coverage
             - name: 🧪 Running e2e coverage
               if: always() && (steps.e2e-test.outcome == 'success' || steps.e2e-test.outcome == 'failure')
               working-directory: tests/pw
               run: |
-                npm run e2e_coverage
+                npm run test:e2e:coverage
 
             # Run API tests
             - name: 🧪 Running the api tests
@@ -193,7 +193,7 @@ jobs:
               timeout-minutes: 5
               working-directory: tests/pw
               run: |
-                  npm run test:api:lite
+                  npm run test:api
 
             # Prepare test summary
             - name: Prepare test summary
@@ -230,8 +230,8 @@ jobs:
             # Backup Database
             - name: Backup Database
               if: always() && steps.db-port.outcome == 'success'
+              working-directory: tests/pw
               run: |
-                  cd tests/pw
                   npm run wp-env run tests-cli wp db export wp-data/db.sql
 
             # Upload artifacts

tests/pw/.env.example

@@ -15,6 +15,7 @@ CI=true                                 [CI/CD environment indicator]
 SLOWMO=10                               [Slow down test execution by provided seconds] [optional]
 NO_SETUP=true                           [Whether not to run setup tests before actual tests] [optional]
 LOCAL=true                              [Local testing indicator] [optional]
+NON_HEADLESS=true                       [browser mode indicator] [optional]
 SITE_PATH=/users/rk/sites/dokan         [Path of the local test site][only for local testing]
 
 # Database Configuration                

tests/pw/.htaccess

@@ -17,6 +17,8 @@ php_value max_input_vars 10000
 php_value memory_limit 1G
 php_value post_max_size 1G
 php_value upload_max_filesize 1G
+php_flag display_errors Off
+php_flag log_errors On
 <IfModule mod_php7.c>
     php_flag opcache.enable Off
 </IfModule>

tests/pw/.wp-env.json

@@ -10,7 +10,7 @@
                 "WP_DEBUG": "true",
                 "SCRIPT_DEBUG": "true",
                 "WP_DEBUG_LOG": "true",
-                "WP_DEBUG_DISPLAY": "false"
+                "WP_DEBUG_DISPLAY": "true"
             },
             "mappings": {
                 ".htaccess": ".htaccess",

tests/pw/README.MD

@@ -137,6 +137,7 @@ CI=true                                 [CI/CD environment indicator]
 SLOWMO=10                               [Slow down test execution by provided seconds] [optional]
 NO_SETUP=true                           [Whether not to run setup tests before actual tests] [optional]
 LOCAL=true                              [Local testing indicator] [optional]
+NON_HEADLESS=true                       [browser mode indicator] [optional]
 SITE_PATH=/users/rk/sites/dokan         [Path of the local test site][only for local testing]
 
 # Database Configuration

tests/pw/api.config.ts

@@ -1,23 +1,27 @@
 import { defineConfig, expect } from '@playwright/test';
 import { customExpect } from '@utils/pwMatchers';
 import 'dotenv/config';
-const { CI, BASE_URL, NO_SETUP, ADMIN, ADMIN_PASSWORD } = process.env;
+const { CI, BASE_URL, NO_SETUP, ADMIN, ADMIN_PASSWORD, DOKAN_PRO } = process.env;
 
 export default defineConfig({
     /* test directory */
     testDir: './tests/api',
+    /* Include tests based on the pattern */
+    grep: [/@lite/, /@pro/],
+    /* Exclude tests based on the pattern */
+    grepInvert: DOKAN_PRO ? [] : [/@pro/],
     /* Folder for test artifacts such as screenshots, videos, traces, etc. */
     outputDir: 'playwright/api/test-artifacts/',
     /* Path to the global setup file. This file will be required and run before all the tests. */
-    globalSetup: './global-setup',
+    // globalSetup: './global-setup',
     /* Path to the global teardown file. This file will be required and run after all the tests. */
     // globalTeardown: './global-teardown',
     /* Maximum time in milliseconds the whole test suite can run */
     globalTimeout: CI ? 20 * (60 * 1000) : 20 * (60 * 1000),
     /* The maximum number of test failures for the whole test suite run. After reaching this number, testing will stop and exit with an error. */
     maxFailures: CI ? 30 : 30,
     /* Maximum time one test can run for. */
-    timeout: CI ? 15 * 1000 : 30 * 1000,
+    timeout: CI ? 15 * 1000 : 20 * 1000,
     /* Configuration for the expect assertion library */
     expect: {
         /* Maximum time expect() should wait for the condition to be met.  For example in `await expect(locator).toHaveText();`*/
@@ -30,7 +34,7 @@ export default defineConfig({
     /* Fail the build on CI if you accidentally left test.only in the source code. */
     // forbidOnly     : !!CI,
     /* The number of times to repeat each test, useful for debugging flaky tests. */
-    repeatEach: CI ? 1 : 0,
+    repeatEach: CI ? 0 : 0,
     /* The maximum number of retry attempts given to failed tests.  */
     retries: CI ? 1 : 0,
     /* Opt out of parallel tests on CI. */
@@ -55,7 +59,7 @@ export default defineConfig({
 
     use: {
         /* Base URL */
-        baseURL: BASE_URL ? BASE_URL : 'http://localhost:9999',
+        baseURL: BASE_URL ?? 'http://localhost:9999',
         /* Whether to ignore HTTPS errors during navigation. */
         ignoreHTTPSErrors: true,
         /* api request headers */
@@ -68,17 +72,28 @@ export default defineConfig({
     projects: [
         // Api project
 
-        // global_setup
-        // {
-        //     name: 'global_setup',
-        //     testMatch: /global\.setup\.ts/,
-        // },
+        // site_setup
+        {
+            name: 'site_setup',
+            testMatch: ['_site.setup.ts'],
+        },
+
+        // auth_setup
+        {
+            name: 'auth_setup',
+            testMatch: ['_auth.setup.ts'],
+            dependencies: NO_SETUP ? [] : ['site_setup'],
+            // fullyParallel: true,
+            retries: 1,
+        },
 
         // api_setup
         {
             name: 'api_setup',
-            testMatch: /.*\.setup\.ts/,
-            // testMatch: /.*\.setup\.spec\.ts/,
+            testMatch: ['_env.setup.ts'],
+            dependencies: NO_SETUP ? [] : ['auth_setup'],
+            fullyParallel: true,
+            retries: 1,
         },
 
         // api_tests
@@ -95,14 +110,14 @@ export default defineConfig({
         // coverage_report
         {
             name: 'coverage_report',
-            testMatch: '_coverage.teardown.ts',
+            testMatch: ['_coverage.teardown.ts'],
         },
 
         // global_teardown
-        // {
-        //     name: 'global_teardown',
-        //     testMatch: /global\.teardown\.ts/,
-        // },
+        {
+            name: 'global_teardown',
+            testMatch: ['global-teardown.ts'],
+        },
     ],
 });
 

tests/pw/e2e.config.ts

@@ -1,11 +1,15 @@
 import { defineConfig, devices, expect } from '@playwright/test';
 import { customExpect } from '@utils/pwMatchers';
 import 'dotenv/config';
-const { CI, LOCAL, BASE_URL, SLOWMO, NO_SETUP } = process.env;
+const { CI, NON_HEADLESS, BASE_URL, SLOWMO, NO_SETUP, DOKAN_PRO } = process.env;
 
 export default defineConfig({
     /* test directory */
     testDir: './tests/e2e',
+    /* Include tests based on the pattern */
+    grep: [/@lite/, /@liteOnly/, /@pro/],
+    /* Exclude tests based on the pattern */
+    grepInvert: DOKAN_PRO ? [/@liteOnly/, /@serial/] : [/@pro/, /@serial/],
     /* Folder for test artifacts such as screenshots, videos, traces, etc. */
     outputDir: 'playwright/e2e/test-artifacts/',
     /* Path to the global setup file. This file will be required and run before all the tests. */
@@ -17,7 +21,7 @@ export default defineConfig({
     /* The maximum number of test failures for the whole test suite run. After reaching this number, testing will stop and exit with an error. */
     maxFailures: CI ? 40 : 40,
     /* Maximum time one test can run for. */
-    timeout: CI ? 45 * 1000 : 45 * 1000,
+    timeout: CI ? 40 * 1000 : 40 * 1000,
     /* Configuration for the expect assertion library */
     expect: {
         /* Maximum time expect() should wait for the condition to be met.  For example in `await expect(locator).toHaveText();`*/
@@ -77,7 +81,7 @@ export default defineConfig({
         /* Emulates 'prefers-colors-scheme' media feature, supported values are 'light', 'dark', 'no-preference' */
         // colorScheme: 'dark' ,
         /* Whether to run tests on headless or non-headless mode */
-        headless: CI ? true : false,
+        headless: !NON_HEADLESS,
         /* Whether to ignore HTTPS errors during navigation. */
         ignoreHTTPSErrors: true,
         /* Record trace only when retrying a test for the first time. */
@@ -103,51 +107,58 @@ export default defineConfig({
     },
 
     projects: [
-        // E2e project
-        // plugin_setup
+        // E2E project
+
+        // local_site_setup
         {
-            name: 'plugin_setup',
-            testMatch: '_plugin.setup.ts',
+            name: 'local_site_setup',
+            testMatch: ['_localSite.setup.ts'],
+        },
+
+        // site_setup
+        {
+            name: 'site_setup',
+            testMatch: ['_site.setup.ts'],
         },
 
         // auth_setup
         {
             name: 'auth_setup',
-            testMatch: '_auth.setup.ts',
-            dependencies: LOCAL ? ['plugin_setup'] : [],
+            testMatch: ['_auth.setup.ts'],
+            dependencies: NO_SETUP ? [] : ['site_setup'],
+            // fullyParallel: true,
+            retries: 1,
         },
 
         // e2e_setup
         {
             name: 'e2e_setup',
-            // testMatch: /.*\.setup\.ts/,
-            testMatch: '_env.setup.ts',
-            /* whether not to run setup tests before running actual tests */
+            testMatch: ['_env.setup.ts'],
             dependencies: NO_SETUP ? [] : ['auth_setup'],
+            fullyParallel: true,
+            retries: 1,
         },
 
         // e2e_tests
         {
             name: 'e2e_tests',
             testMatch: /.*\.spec\.ts/,
-            testIgnore: /.*\.teardown\.spec\.ts/,
             /* whether not to run setup tests before running actual tests */
             dependencies: NO_SETUP ? [] : ['e2e_setup'],
             /* whether not to run teardown tests after running actual tests */
             // teardown: NO_SETUP ? undefined : 'coverage_report',
-            // teardown: 'global_teardown',
         },
 
         // coverage_report
         {
             name: 'coverage_report',
-            testMatch: '_coverage.teardown.ts',
+            testMatch: ['_coverage.teardown.ts'],
         },
 
-        // local site setup project
+        // global_teardown
         {
-            name: 'site_setup',
-            testMatch: /.*\.install\.ts/,
+            name: 'global_teardown',
+            testMatch: ['global-teardown.ts'],
         },
     ],
 });