Unit tests

.github/workflows/Release.yml

@@ -1,5 +1,5 @@
 # name of your github action
-name: Release
+name: Release CI
 
 # this will help you specify when & which branch to run deployment
 on:

.github/workflows/Test.yml

@@ -0,0 +1,25 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+
+name: Test CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [14.x, 16.x, 18.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "npm"
+      - run: npm install
+      - run: npm test

.gitignore

@@ -6,6 +6,9 @@ yarn-debug.log*
 yarn-error.log*
 lerna-debug.log*
 
+# Test residue
+test-db
+
 # Diagnostic reports (https://nodejs.org/api/report.html)
 report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
 

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm test

README.md

@@ -1,8 +1,8 @@
 # <p align="center"><img src="src/assets/images/scancode-workbench-logo.png" align="center" alt="ScanCode Workbench">
 </p>
 
-[![Travis Build Status](https://travis-ci.org/nexB/scancode-workbench.svg?branch=develop)](https://travis-ci.org/nexB/scancode-workbench) 
-[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/nexB/scancode-workbench)](https://ci.appveyor.com/project/nexB/scancode-workbench)
+[![Test CI](https://github.com/nexB/scancode-workbench/actions/workflows/Test.yml/badge.svg)](https://github.com/nexB/scancode-workbench/actions/workflows/Test.yml)
+[![Release](https://github.com/nexB/scancode-workbench/actions/workflows/Release.yml/badge.svg)](https://github.com/nexB/scancode-workbench/actions/workflows/Release.yml)
 
 ScanCode Workbench provides an advanced visual UI to help you quickly evaluate
 license and other notices identified by 
@@ -22,7 +22,7 @@ works on Windows, OS X and Linux operating systems.
 
 * You can [download the latest release](https://github.com/nexB/scancode-workbench/releases) 
 for your operating system or build it yourself (see below). Once downloaded, you 
-can find `ScanCode-Workbench` under `dist/ScanCode-Workbench-<os>-x64-<version>`.
+can find `ScanCode-Workbench` under `dist/ScanCode-Workbench-<os>-<arch>-<version>`
 * ScanCode Workbench >= v2 is only compatible with scans from 
 [ScanCode v2.0.0](https://github.com/nexB/scancode-toolkit/releases) and 
 above which are run with the ScanCode `-i` option. For a list of available ScanCode 
@@ -40,9 +40,9 @@ information captured by a scan.  The samples are located at
 the [documentation](https://scancode-workbench.readthedocs.io) for more 
 information on how to use ScanCode Workbench.
 
-![Import a JSON file](https://scancode-workbench.readthedocs.io/en/develop/_images/import-json-file.gif)
+[Import a JSON file](https://scancode-workbench.readthedocs.io/en/develop/_images/import-json-file.gif)
 
-## Building
+## Running locally
 
 You'll need [Node.js](https://nodejs.org) (which comes with [npm](http://npmjs.com)) 
 installed on your computer in order to build this app. For a list of platform 
@@ -65,23 +65,21 @@ $ npm start
 
 ## Release Instructions
 
-You can build a `dist` directory containing executables for any one of three 
-target platforms by running:
+You'll need python 3.x to run the build. You can build a `dist` directory containing executables for your platform 
+
+Note: Due to usage of native modules, a build must be done on target platform only.
 
 ```bash
-$ python build.py
+$ npm run publish
 ```
 
 After building is done, you can find `ScanCode-Workbench` under 
 `dist/ScanCode-Workbench-<os>-x64-<version>`. Archives (tar.gz and .zip) are 
 also built.
 
-Note: A build for any of the three target platforms must be executed on the 
-targeted platform.
-
 ## Testing
 
-Test ABCM functionality using:
+Run tests using:
 
 ```bash
 $ npm test

archive_builder.py

@@ -52,7 +52,7 @@
 
 # Prepare file name for archive using platform, architecture & app version
 archive_file_name = '-'.join([APP_NAME, PLATFORM_NAME, ARCH, APP_VERSION])
-print("Composed Archive file name: '" + archive_file_name + "'")
+print(f"Composed Archive file name: '{archive_file_name}'")
 
 # Ensure archive directory dist/ is created, before attempting to store archive inside it
 ensure_archive_directory = f"mkdir -p {ARCHIVE_DIR}"
@@ -64,13 +64,13 @@
   zip_command = f"powershell Compress-Archive {PACKAGE_DIR}/* {ARCHIVE_DIR}/{archive_file_name}.zip"
   print("Executing zip command on powershell:", zip_command)
   os.system(zip_command)
-  print(f"Zip file ready in {ARCHIVE_DIR}/ !!")
+  print(f"Zip file ready: {ARCHIVE_DIR}/{archive_file_name}.zip")
 
 # Prepare .tar.gz file for mac & linux
 else:
   tar_command = f"tar -czf {ARCHIVE_DIR}/{archive_file_name}.tar.gz -C {PACKAGE_DIR} ."
   print("Executing tar command:", tar_command)
   os.system(tar_command)
-  print(f"Tar file ready in {ARCHIVE_DIR}/ !!")
+  print(f"Tar file ready: {ARCHIVE_DIR}/{archive_file_name}.tar.gz")
 
 print("Build succeeded !!!")

docs/.gitignore

@@ -0,0 +1,44 @@
+# Virtual environment
+venv/
+
+# sphinx build folder
+build/
+
+# Compiled source #
+###################
+*.com
+*.class
+*.dll
+*.exe
+*.o
+*.so
+
+# Packages #
+############
+# it's better to unpack these files and commit the raw source
+# git has its own built in compression methods
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+
+# Logs and databases #
+######################
+*.log
+*.sql
+*.sqlite
+
+# OS generated files #
+######################
+.DS_Store?
+ehthumbs.db
+Icon?
+Thumbs.db
+
+# Editor backup files #
+#######################
+*~

jest.config.js

@@ -0,0 +1,7 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  modulePathIgnorePatterns: ["test-old", "dist"],
+  testPathIgnorePatterns: ["node_modules", "dist", "test-old"]
+};