migrate tests to github actions

Author: koskimas

.github/workflows/test.yml

@@ -0,0 +1,35 @@
+name: Run tests
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  run-tests:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [12.x, 14.x, 16.x]
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run docker compose
+        run: docker-compose -f docker-compose.yml -f docker-compose-ci.yml up -d
+
+      - name: Wait until docker compose is up
+        run: sleep 30
+
+      - name: Run tests
+        run: npm run test:ci

.prettierrc.json

@@ -0,0 +1,6 @@
+{
+  "printWidth": 100,
+  "singleQuote": true,
+  "bracketSpacing": true,
+  "semi": true
+}

.travis.yml

@@ -1,5 +1,3 @@
-[![Build Status](https://travis-ci.org/Vincit/db-errors.svg?branch=master)](https://travis-ci.org/Vincit/db-errors)
-
 # Unified error API for node.js SQL DB drivers
 
 This project is an attempt to create a unified API for node.js SQL DB driver errors. Each driver
@@ -8,7 +6,7 @@ pass these errors through. It's usually very difficult to reason with these erro
 library wraps those errors to error classes that are the same for all drivers. The wrapped
 error classes also expose useful information about the errors.
 
-__NOTE__: Only MySQL, Sqlite3, MSSQL and PostgreSQL are officially supported (tested).
+**NOTE**: Only MySQL, Sqlite3, MSSQL and PostgreSQL are officially supported (tested).
 
 # Contributions and suggestions are most welcome
 
@@ -20,12 +18,7 @@ If you have an idea for an error we should handle, please open an issue and we'l
 ## Usage
 
 ```js
-const {
-  wrapError,
-  DBError,
-  UniqueViolationError,
-  NotNullViolationError
-} = require('db-errors');
+const { wrapError, DBError, UniqueViolationError, NotNullViolationError } = require('db-errors');
 
 function errorHandler(err) {
   // wrapError function takes any error and returns a DBError subclass instance if
@@ -34,7 +27,9 @@ function errorHandler(err) {
   err = wrapError(err);
 
   if (err instanceof UniqueViolationError) {
-    console.log(`Unique constraint ${err.constraint} failed for table ${err.table} and columns ${err.columns}`);
+    console.log(
+      `Unique constraint ${err.constraint} failed for table ${err.table} and columns ${err.columns}`
+    );
   } else if (err instanceof NotNullViolationError) {
     console.log(`Not null constraint failed for table ${err.table} and column ${err.column}`);
   } else if (err instanceof DBError) {
@@ -56,7 +51,7 @@ function errorHandler(err) {
 ```ts
 class DBError extends Error {
   // The error thrown by the database client.
-  nativeError: Error
+  nativeError: Error;
 }
 ```
 
@@ -85,17 +80,17 @@ class UniqueViolationError extends ConstraintViolationError {
   // The columns that failed.
   //
   // Available for: postgres, sqlite
-  columns: string[]
+  columns: string[];
 
   // The table that has the columns.
   //
   // Available for: postgres, sqlite
-  table: string
+  table: string;
 
   // The constraint that was violated.
   //
   // Available for: postgres, mysql
-  constraint: string
+  constraint: string;
 }
 ```
 
@@ -109,12 +104,12 @@ class NotNullViolationError extends ConstraintViolationError {
   // The column that failed.
   //
   // Available for: postgres, sqlite, mysql
-  column: string
+  column: string;
 
   // The table that has the columns.
   //
   // Available for: postgres, sqlite
-  table: string
+  table: string;
 }
 ```
 
@@ -128,12 +123,12 @@ class ForeignKeyViolationError extends ConstraintViolationError {
   // The table that has the foreign key.
   //
   // Available for: postgres, mysql
-  table: string
+  table: string;
 
   // The constraint that was violated.
   //
   // Available for: postgres, mysql
-  constraint: string
+  constraint: string;
 }
 ```
 
@@ -148,12 +143,12 @@ class CheckViolationError extends ConstraintViolationError {
   // The table that has the check constraint.
   //
   // Available for: postgres
-  table: string
+  table: string;
 
   // The constraint that was violated.
   //
   // Available for: postgres
-  constraint: string
+  constraint: string;
 }
 ```
 
@@ -175,7 +170,6 @@ class DataError extends DBError {
 <br>
 <br>
 
-
 ## Development setup
 
 Run the following commands in the repo root:

README.md

@@ -0,0 +1,8 @@
+services:
+  mssql:
+    image: 'mcr.microsoft.com/mssql/server'
+    environment:
+      ACCEPT_EULA: 'Y'
+      SA_PASSWORD: eioC9vvCZzQSy4S9g37i
+    ports:
+      - '1433:1433'

docker-compose-ci.yml

@@ -1,25 +1,20 @@
-version: "3"
+version: '3'
 services:
-  mssql:
-    image: "microsoft/mssql-server-linux:2017-CU12"
-    environment:
-      - ACCEPT_EULA=Y
-      - SA_PASSWORD=eioC9vvCZzQSy4S9g37i
-    ports:
-      - "1433:1433"
   mysql:
-    image: "mysql:5"
+    image: 'mysql/mysql-server'
     environment:
-      - MYSQL_DATABASE=db_errors_test
-      - MYSQL_USER=db_errors
-      - MYSQL_ROOT_PASSWORD=root
-      - MYSQL_ALLOW_EMPTY_PASSWORD=yes
+      MYSQL_ROOT_PASSWORD: root
+      MYSQL_DATABASE: db_errors_test
     ports:
-      - "3306:3306"
+      - '3307:3306'
+    volumes:
+      - ./testUtils/sql/mysqlInit.sql:/data/application/init.sql
+    command: --init-file /data/application/init.sql
   postgres:
-    image: "postgres:10"
+    image: 'postgres'
     environment:
-      - POSTGRES_DB=db_errors_test
-      - POSTGRES_USER=db_errors
+      POSTGRES_DB: db_errors_test
+      POSTGRES_USER: db_errors
+      POSTGRES_HOST_AUTH_METHOD: trust
     ports:
-      - "5432:5432"
+      - '5433:5432'

docker-compose.yml

@@ -1,11 +1,27 @@
 declare namespace DbTypes {
+  type DBErrorClient = 'postgres' | 'mysql' | 'mssql' | 'sqlite';
+
+  interface DBErrorArgs {
+    nativeError: Error;
+    client: DBErrorClient;
+  }
 
   class DBError extends Error {
+    constructor(args: DBErrorArgs);
+
     name: string;
     nativeError: Error;
+    client: DBErrorClient;
+  }
+
+  interface CheckViolationErrorArgs extends DBErrorArgs {
+    table: string;
+    constraint: string;
   }
 
   class CheckViolationError extends DBError {
+    constructor(args: CheckViolationErrorArgs);
+
     table: string;
     constraint: string;
   }
@@ -14,27 +30,53 @@ declare namespace DbTypes {
 
   class DataError extends DBError {}
 
+  interface ForeignKeyViolationErrorArgs extends DBErrorArgs {
+    table: string;
+    constraint: string;
+    schema?: string;
+  }
+
   class ForeignKeyViolationError extends ConstraintViolationError {
+    constructor(args: ForeignKeyViolationErrorArgs);
+
     table: string;
     constraint: string;
     schema?: string;
   }
 
+  interface NotNullViolationErrorArgs extends DBErrorArgs {
+    table: string;
+    column: string;
+    database?: string;
+    schema?: string;
+  }
+
   class NotNullViolationError extends ConstraintViolationError {
+    constructor(args: NotNullViolationErrorArgs);
+
     table: string;
     column: string;
     database?: string;
     schema?: string;
   }
 
+  interface UniqueViolationErrorArgs extends DBErrorArgs {
+    table: string;
+    columns: string[];
+    constraint: string;
+    schema?: string;
+  }
+
   class UniqueViolationError extends ConstraintViolationError {
+    constructor(args: UniqueViolationErrorArgs);
+
     table: string;
     columns: string[];
     constraint: string;
     schema?: string;
   }
 
-  function wrapError(err: Error): DBError
+  function wrapError(err: Error): DBError;
 
   export {
     wrapError,
@@ -45,7 +87,7 @@ declare namespace DbTypes {
     ForeignKeyViolationError,
     NotNullViolationError,
     UniqueViolationError,
-  }
+  };
 }
 
-export = DbTypes
+export = DbTypes;

index.d.ts

@@ -32,7 +32,7 @@ function parse(node, err, parentResult) {
 
   const result = {
     node,
-    args: Object.assign({}, parentResult && parentResult.args, args)
+    args: Object.assign({}, parentResult && parentResult.args, args),
   };
 
   for (let i = 0; i < node.subclassParsers.length; ++i) {
@@ -55,5 +55,5 @@ module.exports = {
   ForeignKeyViolationError,
   ConstraintViolationError,
   CheckViolationError,
-  DataError
-};
+  DataError,
+};

lib/dbErrors.js

@@ -8,4 +8,4 @@ module.exports = {
   postgres,
   mysql,
   mssql,
-};
+};