Merge pull request #210 from UgnisSoftware/UGN-407

Add browser testing

Author: masiulis

.github/workflows/test.yaml

@@ -7,16 +7,51 @@ on:
     branches: [master]
 
 jobs:
-  build:
+  unit-tests:
     runs-on: ubuntu-latest
-
     steps:
-      - uses: actions/checkout@v2
-      - name: Use Node.js
-        uses: actions/setup-node@v1
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
         with:
-          node-version: "16.x"
-      - run: npm ci
+          node-version: 18
+      - name: Install dependencies
+        run: npm ci
       - run: npm run lint
       - run: npm run ts
-      - run: npm run test
+      - run: npm run test:unit
+
+  e2e-tests:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - name: Install dependencies
+        run: npm ci
+      - name: Install Playwright
+        run: npx playwright install --with-deps
+      - name: Run Playwright tests
+        run: npx playwright test
+      - uses: actions/upload-artifact@v3
+        if: always()
+        with:
+          name: playwright-report
+          path: playwright-report/
+          retention-days: 30
+
+
+  chromatic-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0 # Required to retrieve git history
+      - name: Install dependencies
+        run: npm ci
+      - name: Publish to Chromatic
+        uses: chromaui/action@v1
+        with:
+          # Grab this from the Chromatic manage page
+          projectToken: ${{ secrets.CHROMATIC_PROJECT_TOKEN }}

.gitignore

@@ -7,4 +7,7 @@ web_modules
 dist
 dist-commonjs
 types
-coverage
+coverage
+/test-results/
+/playwright-report/
+/playwright/.cache/

e2e/example.spec.ts

@@ -0,0 +1,7 @@
+import { test } from '@playwright/test';
+
+test('has title', async ({ page }) => {
+  await page.goto('http://localhost:6006/iframe.html?args=&id=select-header-step--basic&viewMode=story');
+
+  await page.getByRole('row', ).filter({ hasText: 'second' }).click();
+});

package-lock.json

@@ -12,7 +12,9 @@
   ],
   "scripts": {
     "start": "storybook dev -p 6006",
-    "test": "jest",
+    "test:unit": "jest",
+    "test:e2e": "npx playwright test",
+    "test:chromatic": "npx chromatic ",
     "ts": "tsc",
     "lint": "eslint \"src/**/*.{ts,tsx}\"",
     "lint:fix": "eslint \"src/**/*.{ts,tsx}\" --fix",
@@ -39,7 +41,9 @@
     "automatic",
     "match"
   ],
-  "author": "Ugnis",
+  "author": {
+    "name": "Ugnis"
+  },
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/UgnisSoftware/react-spreadsheet-import/issues"
@@ -71,6 +75,7 @@
     "@babel/preset-typescript": "7.21.5",
     "@emotion/jest": "11.11.0",
     "@jest/types": "27.5.1",
+    "@playwright/test": "^1.39.0",
     "@storybook/addon-essentials": "7.0.14",
     "@storybook/addon-interactions": "7.0.14",
     "@storybook/addon-links": "7.0.14",
@@ -85,13 +90,15 @@
     "@testing-library/user-event": "14.4.3",
     "@types/jest": "27.4.1",
     "@types/js-levenshtein": "1.1.1",
+    "@types/node": "^20.8.7",
     "@types/react": "18.2.6",
     "@types/react-dom": "18.2.4",
     "@types/styled-system": "5.1.16",
     "@types/uuid": "9.0.1",
     "@typescript-eslint/eslint-plugin": "5.59.7",
     "@typescript-eslint/parser": "5.59.7",
     "babel-loader": "9.1.2",
+    "chromatic": "^7.4.0",
     "eslint": "8.41.0",
     "eslint-config-prettier": "8.8.0",
     "eslint-plugin-prettier": "4.2.1",
@@ -144,6 +151,7 @@
     "moduleNameMapper": {
       "~/(.*)": "<rootDir>/src/$1"
     },
+    "modulePathIgnorePatterns": ["<rootDir>/e2e/"],
     "transformIgnorePatterns": [
       "[/\\\\]node_modules[/\\\\].+\\.(js|jsx|mjs)$"
     ],
@@ -162,5 +170,7 @@
       "jest-watch-typeahead/filename",
       "jest-watch-typeahead/testname"
     ]
-  }
+  },
+  "readme": "ERROR: No README data found!",
+  "_id": "[email protected]"
 }

package.json

@@ -0,0 +1,77 @@
+import { defineConfig, devices } from '@playwright/test';
+
+/**
+ * Read environment variables from file.
+ * https://github.com/motdotla/dotenv
+ */
+// require('dotenv').config();
+
+/**
+ * See https://playwright.dev/docs/test-configuration.
+ */
+export default defineConfig({
+  testDir: './e2e',
+  /* Run tests in files in parallel */
+  fullyParallel: true,
+  /* Fail the build on CI if you accidentally left test.only in the source code. */
+  forbidOnly: !!process.env.CI,
+  /* Retry on CI only */
+  retries: process.env.CI ? 2 : 0,
+  /* Opt out of parallel tests on CI. */
+  workers: process.env.CI ? 1 : undefined,
+  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
+  reporter: 'html',
+  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
+  use: {
+    /* Base URL to use in actions like `await page.goto('/')`. */
+    // baseURL: 'http://127.0.0.1:3000',
+
+    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
+    trace: 'on-first-retry',
+  },
+
+  /* Configure projects for major browsers */
+  projects: [
+    {
+      name: 'chromium',
+      use: { ...devices['Desktop Chrome'] },
+    },
+
+    {
+      name: 'firefox',
+      use: { ...devices['Desktop Firefox'] },
+    },
+
+    {
+      name: 'webkit',
+      use: { ...devices['Desktop Safari'] },
+    },
+
+    /* Test against mobile viewports. */
+    // {
+    //   name: 'Mobile Chrome',
+    //   use: { ...devices['Pixel 5'] },
+    // },
+    // {
+    //   name: 'Mobile Safari',
+    //   use: { ...devices['iPhone 12'] },
+    // },
+
+    /* Test against branded browsers. */
+    // {
+    //   name: 'Microsoft Edge',
+    //   use: { ...devices['Desktop Edge'], channel: 'msedge' },
+    // },
+    // {
+    //   name: 'Google Chrome',
+    //   use: { ...devices['Desktop Chrome'], channel: 'chrome' },
+    // },
+  ],
+
+  /* Run your local dev server before starting the tests */
+  webServer: {
+     command: 'npm run start',
+     url: 'http://localhost:6006',
+     reuseExistingServer: !process.env.CI,
+  },
+});

playwright.config.ts

@@ -32,9 +32,7 @@ export const SelectHeaderStep = ({ data, onContinue }: SelectHeaderProps) => {
     <>
       <ModalBody pb={0}>
         <Heading {...styles.heading}>{translations.selectHeaderStep.title}</Heading>
-        <Box h={0} flexGrow={1}>
-          <SelectHeaderTable data={data} selectedRows={selectedRows} setSelectedRows={setSelectedRows} />
-        </Box>
+        <SelectHeaderTable data={data} selectedRows={selectedRows} setSelectedRows={setSelectedRows} />
       </ModalBody>
       <ContinueButton
         onContinue={handleContinue}