Merge pull request #126 from kobenguyent/feat/try-out-ts

feat: move to TS

Author: sharath2106

.github/workflows/npm-publish.yml

@@ -10,6 +10,7 @@ on:
       - master
 
 jobs:
+
   publish-npm:
     runs-on: ubuntu-latest
     steps:
@@ -19,6 +20,7 @@ jobs:
           node-version: 18
           registry-url: https://registry.npmjs.org/
       - run: npm i
+      - run: npm run build
       - run: npx semantic-release
         env:
           NODE_AUTH_TOKEN: ${{secrets.npm_token}}

.github/workflows/test.yml

@@ -0,0 +1,35 @@
+name: Unit tests
+
+on: [push]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.x, 18.x]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: run unit tests
+        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

@@ -62,3 +62,8 @@ typings/
 
 #webstorm
 .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

@@ -0,0 +1,70 @@
+import ResembleHelper from "../src";
+const { container } = require('codeceptjs');
+const helpers = container.helpers();
+
+let helper = new ResembleHelper({	baseFolder: './__test__/screenshots/base/',
+    diffFolder: './__test__/screenshots/diff/',
+    screenshotFolder: './__test__/output',
+    prepareBaseImage: true })
+
+describe('_getHelper()', () => {
+    test('should return error when no matching helper found', () => {
+        try {
+            helper._getHelper()
+        } catch (e: any) {
+            expect(e.message).toEqual('No matching helper found. Supported helpers: Playwright/Puppeteer/WebDriver/TestCafe/Appium')
+        }
+    });
+})
+
+describe('_getPrepareBaseImage()', () => {
+    beforeAll(() => {
+        helpers['Playwright'] = { hello: 1 }
+    })
+    test('should return false when no prepareBaseImage is provided', () => {
+        expect(helper._getPrepareBaseImage({ prepareBaseImage: false, tolerance: 1 })).toBeFalsy()
+    });
+
+    test('should return true when prepareBaseImage matched with config', () => {
+        expect(helper._getPrepareBaseImage({ prepareBaseImage: true })).toBeTruthy()
+    });
+})
+
+describe('_getDiffImagePath()', () => {
+    beforeAll(() => {
+        helpers['Playwright'] = { hello: 1 }
+    })
+    test('should return diffImagePath', () => {
+        expect(helper._getDiffImagePath('hello')).toContain('Diff_hello.png')
+    });
+
+})
+
+describe('_getActualImagePath()', () => {
+    beforeAll(() => {
+        helpers['Playwright'] = { hello: 1 }
+    })
+    test('should return ActualImagePath', () => {
+        expect(helper._getActualImagePath('hello')).toContain('hello')
+    });
+
+})
+
+describe('_getBaseImagePath()', () => {
+    beforeAll(() => {
+        helpers['Playwright'] = { hello: 1 }
+    })
+    test('should return BaseImagePath', () => {
+        expect(helper._getBaseImagePath('hello', {})).toContain('hello')
+    });
+
+})
+
+describe('resolvePath()', () => {
+    beforeAll(() => {
+        helpers['Playwright'] = { hello: 1 }
+    })
+    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"
+  }
+}