add continuous integration

add jest
add puppeteer
add unit test
add functional test
add github actions
add file .env.example don't forget to create .env file locally use the default setting in the .env.example
change tsconfig.json -> strict = false
change tsconfig.json -> moduleResolution = Node
change TableColumn interface, the attribute index is no longer required, because it was not set while creating connection in the example/index.html

Author: Peter Maquiran

.env.example

@@ -0,0 +1,3 @@
+
+PUPPETEER_PORT = 8090
+PUPPETEER_OPEN_CHROME = false

.github/workflows/build-test.yml

@@ -0,0 +1,16 @@
+name: CI
+on: [push]
+jobs:
+  build:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: borales/[email protected]
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v2
+      # with:
+      #   node-version: ${{ matrix.node-version }}
+      #   cache: 'npm'
+    #- run: yarn install --frozen-lockfile
+    - run: cp .env.example .env && yarn test

.gitignore

@@ -3,3 +3,4 @@
 /dist
 .DS_Store
 dist/es2015/tsconfig.tsbuildinfo
+.env

example/index.html

@@ -103,6 +103,9 @@
   });
 
   window.conn = a;
+  window['Connector'] = Connector
+  window['Model'] = Model
+  window['RelationTypes'] = RelationTypes
 
 </script>
 </body>

jest-puppeteer.config.js

@@ -0,0 +1,26 @@
+// jest-puppeteer.config.js
+require('dotenv').config()
+
+const openChrome = process.env.PUPPETEER_OPEN_CHROME
+const port = process.env.PUPPETEER_PORT
+
+module.exports = {
+  server: {
+    command: `http-server -a 127.0.0.1 --port ${port} ./`,
+    port: port,
+    launchTimeout: 5000
+  },
+  launch: {
+    dumpio: true,
+    headless: openChrome != 'true',
+    product: 'chrome',
+    args: [`--window-size=1200,1080`],
+    defaultViewport: {
+      width:1200,
+      height:1080
+    },
+    // executablePath: chromPath
+  },
+  browserContext: 'default',
+  
+}

jest.config.js

@@ -0,0 +1,15 @@
+module.exports = {
+    "roots": [
+      "<rootDir>/test"
+    ],
+    "testMatch": [
+      "**/__tests__/**/*.+(ts|tsx|js)",
+      "**/?(*.)+(spec|test).+(ts|tsx|js)"
+    ],
+    "transform": {
+      "^.+\\.(ts|tsx)$": "ts-jest"
+    },
+    // "globalSetup": "<rootDir>/test/setupJest.ts",
+    preset: 'jest-puppeteer',
+    // setupFilesAfterEnv: "<rootDir>/test/setupJest.ts",
+  }

package.json

@@ -8,18 +8,27 @@
     "format": "prettier --write \"src/**/*.ts\"",
     "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
     "watch": "rimraf dist && tsc -p tsconfig.build.json --watch",
-    "prepublish": "npm run build"
+    "prepublish": "npm run build",
+    "test": "jest --detectOpenHandles"
   },
   "author": "Max Gaurav [email protected]",
   "description": "A promise based ORM wrapper for indexedDB",
   "devDependencies": {
+    "@types/jest-environment-puppeteer": "^5.0.0",
     "@typescript-eslint/eslint-plugin": "^4.31.1",
     "@typescript-eslint/parser": "^4.31.1",
+    "dotenv": "^16.0.0",
     "eslint": "^7.32.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-prettier": "^4.0.0",
+    "http-server": "^14.1.0",
+    "jest": "^27.5.1",
+    "jest-puppeteer": "^6.1.0",
     "prettier": "^2.4.0",
+    "puppeteer": "^13.3.2",
     "rimraf": "^3.0.2",
+    "ts-jest": "^27.1.3",
+    "ts-jest-puppeteer": "^0.0.5",
     "typescript": "^4.4.3"
   },
   "files": [

src/migration/migration.interface.ts

@@ -20,7 +20,7 @@ export interface MigrationInterface {
 
 export interface TableColumn {
   name: string;
-  index: string[] | string;
+  index?: string[] | string;
   attributes?: IDBIndexParameters;
   dbIndex?: IDBIndex | null;
 }

test/functionl/model-no-relationship.test.ts

@@ -0,0 +1,71 @@
+
+import {Model as ModelType} from '../../src/index'
+import {Connector as ConnectorType} from '../../src/index'
+import {RelationTypes as _RelationTypes} from '../../src/index'
+import { ModelKeysInterface } from '../../src/models/model.interface'
+const port = process.env.PUPPETEER_PORT
+
+
+describe('simple model', () => {
+    beforeAll(async () => {
+      await page.goto(`http://127.0.0.1:${port}/example/index.html`)
+    })
+   
+    it('Create model with one attribute that is required', async () => {
+    
+        // wait for variables to be present in the dom
+        await page.waitForFunction(() => 'Connector' in window);
+        await page.waitForFunction(() => 'Model' in window);
+        await page.waitForFunction(() => 'RelationTypes' in window);
+            
+        await page.evaluate(() => {
+            const Connector: typeof ConnectorType = window['Connector']
+            const Model: typeof ModelType = window['Model']
+            const RelationTypes: typeof _RelationTypes = window['RelationTypes'] 
+            
+            const a = new Connector({
+                tables: [{
+                    name: 'admin',
+                    columns: [{
+                        name: 'email',
+                        attributes: {
+                            unique: true
+                        }
+                    }]
+                }],
+                name: 'sample-test',
+                version: 1
+              });
+            
+              a.connect().then(async (models:ModelKeysInterface) => {
+                console.log(a, models);
+
+                // list the tables in th page
+                document.body.innerHTML = 'tables :'+JSON.stringify(Object.keys(models)) 
+              });
+    
+        })
+        
+        // await until the page has a visitable text 'admin'
+        await page.waitForFunction(() => 'admin');
+
+        expect('time not exceeded').toBe('time not exceeded')
+    }, 20000)
+})
+
+
+
+
+
+describe('complex model', () => {
+    beforeAll(async () => {
+      await page.goto(`http://127.0.0.1:${port}/example/index.html`)
+    })
+   
+    it('Check dom variables', async () => {
+  
+      await page.waitForFunction(() => 'conn' in window);
+  
+      expect('time not exceeded').toBe('time not exceeded')
+    }, 20000)
+})

test/page-load.test.ts

@@ -0,0 +1,14 @@
+const port = process.env.PUPPETEER_PORT
+
+describe('page Load', () => {
+  beforeAll(async () => {
+    await page.goto(`http://127.0.0.1:${port}/example/index.html`)
+  })
+ 
+  it('Check dom variables', async () => {
+
+    await page.waitForFunction(() => 'conn' in window);
+
+    expect('time not exceeded').toBe('time not exceeded')
+  }, 10000)
+})