fix: adding acceptance tests

Author: kobenguyent

.github/workflows/test.yml

@@ -21,3 +21,15 @@ jobs:
         run: |
           npm i
           npm test
+      - name: Build
+        run: |
+          npm i
+          npm run build
+      - name: Run acceptance tests
+        working-directory: ./__test__
+        run: |
+          npm i
+          npm run test
+        env:
+          MAILINATOR_TOKEN: ${{secrets.MAILINATOR_TOKEN}}
+          MAILINATOR_DOMAIN: ${{secrets.MAILINATOR_DOMAIN}}

.gitignore

@@ -64,3 +64,6 @@ typings/
 .idea
 dist
 coverage
+__test__/node_modules
+__test__/package-lock.json
+__test__/output

__test__/codecept.conf.ts

@@ -0,0 +1,21 @@
+export const config: CodeceptJS.MainConfig = {
+  tests: './*_test.ts',
+  output: './output',
+  helpers: {
+    Playwright: {
+      url: 'https://codecept.io/',
+      show: false,
+      browser: 'chromium'
+    },
+    "ResembleHelper" : {
+      "require": "../src/index",
+      "baseFolder": "./screenshots/base/",
+      "diffFolder": "./screenshots/diff/",
+      "prepareBaseImage": false
+    }
+  },
+  include: {
+    I: './steps_file'
+  },
+  name: '__test__'
+}

__test__/index.spec.ts

@@ -15,14 +15,8 @@ describe('_getHelper()', () => {
             expect(e.message).toEqual('No matching helper found. Supported helpers: Playwright/Puppeteer/WebDriver/TestCafe/Appium')
         }
     });
-
-    test('should return matching helper', () => {
-        helpers['Playwright'] = { hello: 1 }
-        expect(helper._getHelper()).toEqual({ hello: 1 })
-    });
 })
 
-
 describe('_getPrepareBaseImage()', () => {
     beforeAll(() => {
         helpers['Playwright'] = { hello: 1 }
@@ -73,5 +67,4 @@ describe('resolvePath()', () => {
     test('should return resolvePath', () => {
         expect(helper.resolvePath('hello')).toContain('hello')
     });
-
 })

__test__/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "__test__",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "codeceptjs run --verbose"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "codeceptjs": "^3.4.1",
+    "playwright": "^1.32.3"
+  },
+  "devDependencies": {
+    "@types/node": "^18.15.11",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.0.4"
+  }
+}

__test__/screenshots/base/Playwright_doc.png

@@ -0,0 +1,12 @@
+/// <reference types='codeceptjs' />
+type steps_file = typeof import('./steps_file');
+type ResembleHelper = import('../src/index');
+
+declare namespace CodeceptJS {
+  interface SupportObject { I: I, current: any }
+  interface Methods extends Playwright, ResembleHelper {}
+  interface I extends ReturnType<steps_file>, WithTranslation<ResembleHelper>, WithTranslation<Playwright> {}
+  namespace Translation {
+    interface Actions {}
+  }
+}