qunitx-cli 0.1.0 → 0.1.1

package/flake.lock

@@ -0,0 +1,64 @@
+{
+  "nodes": {
+    "flake-utils": {
+      "locked": {
+        "lastModified": 1659877975,
+        "narHash": "sha256-zllb8aq3YO3h8B/U0/J1WBgAL8EX5yWf5pMj3G0NAmc=",
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "rev": "c0e246b9b83f637f4681389ecabcb2681b4f3af0",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "type": "github"
+      }
+    },
+    "napalm": {
+      "inputs": {
+        "flake-utils": "flake-utils",
+        "nixpkgs": [
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1672245824,
+        "narHash": "sha256-i596lbPiA/Rfx3DiJiCluxdgxWY7oGSgYMT7OmM+zik=",
+        "owner": "nix-community",
+        "repo": "napalm",
+        "rev": "7c25a05cef52dc405f4688422ce0046ca94aadcf",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-community",
+        "repo": "napalm",
+        "type": "github"
+      }
+    },
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1690860117,
+        "narHash": "sha256-srkCfjMlg777HxDVMfhkIFgRhhtuZjIOIyR2ejLYK+Y=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "96d403ee2479f2070050353b94808209f1352edb",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixpkgs-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "napalm": "napalm",
+        "nixpkgs": "nixpkgs"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

package/flake.nix

@@ -0,0 +1,26 @@
+{
+  description = "A flake for napalm";
+
+  inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
+  inputs.napalm.url = "github:nix-community/napalm";
+
+  # NOTE: This is optional, but is how to configure napalm's env
+  inputs.napalm.inputs.nixpkgs.follows = "nixpkgs";
+
+  outputs = { self, nixpkgs, napalm }:
+  let
+    system = "x86_64-linux";
+    pkgs = nixpkgs.legacyPackages."${system}";
+  in {
+    packages."${system}".default = napalm.legacyPackages."${system}".buildPackage ./. {
+      nodejs = pkgs.nodejs-slim_20;
+      PUPPETEER_SKIP_DOWNLOAD=1;
+    };
+
+    devShells."${system}".default = pkgs.mkShell {
+      nativeBuildInputs = with pkgs; [
+        nodejs-slim_20
+      ];
+    };
+  };
+}

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "qunitx-cli",
   "type": "module",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Browser runner for QUnitx: run your qunitx tests in google-chrome",
-  "main": "index.js",
+  "main": "cli.js",
   "author": "Izel Nakri",
   "license": "MIT",
   "keywords": [
@@ -46,7 +46,7 @@
     "jsdom": "^22.0.0",
     "kleur": "^4.1.5",
     "picomatch": "^2.3.1",
-    "puppeteer": "20.8.3",
+    "puppeteer": "20.9.0",
     "recursive-lookup": "1.1.0",
     "ws": "^8.13.0"
   },
@@ -56,7 +56,7 @@
     "express": "^4.17.3",
     "prettier": "^3.0.0",
     "qunit": "^2.19.4",
-    "qunitx": "^0.6.0",
+    "qunitx": "^0.9.1",
     "release-it": "^16.1.2"
   },
   "volta": {

package/.github/dependabot.yml

@@ -1,7 +0,0 @@
-version: 2
-updates:
-  # Maintain dependencies for GitHub Actions
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "daily"

package/.github/workflows/push.yml

@@ -1,36 +0,0 @@
-name: docker-based-ci
-on: push
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Set ENV variables
-        run: |
-          echo "REGISTRY=ghcr.io" >> $GITHUB_ENV
-          echo "REPO_OWNER=$(echo ${GITHUB_REPOSITORY%/*})" >> $GITHUB_ENV
-          echo "REPO_NAME=$(echo ${GITHUB_REPOSITORY#*/})" >> $GITHUB_ENV
-          echo "BRANCH_NAME=$(echo ${GITHUB_REF#refs/heads/} | tr / -)" >> $GITHUB_ENV
-          echo "DOCKER_TAG=$(echo ${GITHUB_REPOSITORY#*/}):$(echo ${GITHUB_REF#refs/heads/} | tr / -)" >> $GITHUB_ENV
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2.9.0
-        with:
-          install: true
-      - name: Login to GitHub Container Registry
-        uses: docker/login-action@v2.2.0
-        with:
-          registry: ${{env.REGISTRY}}
-          username: ${{env.REPO_OWNER}}
-          password: ${{secrets.CR_PAT}}
-      - name: Build and push
-        uses: docker/build-push-action@v4.1.1
-        with:
-          context: .
-          file: ./Dockerfile
-          push: true
-          tags: ${{env.REGISTRY}}/${{env.REPO_OWNER}}/${{env.DOCKER_TAG}}
-          cache-from: type=gha
-          cache-to: type=gha,mode=max
-      - name: Execute tests
-        run: docker run -t --entrypoint="npm" ${REGISTRY}/${REPO_OWNER}/${DOCKER_TAG} run test

package/CHANGELOG.md

@@ -1,25 +0,0 @@
-### Changelog
-
-All notable changes to this project will be documented in this file. Dates are displayed in UTC.
-
-Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
-
-#### [0.1.0](https://github.com/izelnakri/qunitx-cli/compare/0.0.3...0.1.0)
-
-- pkg upgrades & github CI [`7a33c07`](https://github.com/izelnakri/qunitx-cli/commit/7a33c07ef9c7b404458ac8b46f97c11009fe32fa)
-- remove --browser flag from help [`011c5ae`](https://github.com/izelnakri/qunitx-cli/commit/011c5aecb1e293bb57aa396d7ceac0fca349298f)
-- add TODO [`35a5121`](https://github.com/izelnakri/qunitx-cli/commit/35a512135d9b5abab740bfde9ae6ecb1781ab26b)
-
-#### [0.0.3](https://github.com/izelnakri/qunitx-cli/compare/0.0.2...0.0.3)
-
-> 13 July 2023
-
-- Release 0.0.3 [`0379477`](https://github.com/izelnakri/qunitx-cli/commit/037947750cc372bdd5c45389d78131bd0b8fa51e)
-- built the foundation for development [`569d860`](https://github.com/izelnakri/qunitx-cli/commit/569d8606b75287aceeaaf0b711139650182cd6c4)
-
-#### 0.0.2
-
-> 13 July 2023
-
-- Release 0.0.2 [`73f444d`](https://github.com/izelnakri/qunitx-cli/commit/73f444d385dd8c08188f5a992f172bd5ff898d89)
-- init [`4d2ac8f`](https://github.com/izelnakri/qunitx-cli/commit/4d2ac8fd98ce7a4c988f9036064a6ef592b55f8f)

package/Dockerfile

@@ -1,24 +0,0 @@
-FROM node:20.4.0-slim
-
-ENV PUPPETEER_SKIP_DOWNLOAD=true CHROME_BIN=/usr/bin/google-chrome-stable
-
-RUN apt-get update \
-    && apt-get install -y wget gnupg \
-    && wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key add - \
-    && sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list' \
-    && apt-get update \
-    && apt-get install -y git libxshmfence-dev google-chrome-stable --no-install-recommends \
-    && rm -rf /var/lib/apt/lists/*
-
-WORKDIR /code/
-
-ADD package.json package-lock.json /code/
-
-RUN npm install
-
-ADD lib /code/lib
-ADD vendor /code/vendor
-ADD test /code/test
-ADD . /code/
-
-ENTRYPOINT "/bin/bash"

package/TODO

@@ -1,90 +0,0 @@
-- "$ qunitx sanity-test.ts" made redundant due to (node --test mode) this should impact dependencies and internal modules
-- Implement other test cases in deno
-
-Shim dir structure should be: shims/nodejs/ shims/deno shims/browser
-Make package.json point to them correctly
-Make the package so esbuild build so esbuild builds when qunitx is vendored(if it needs to)
-
-Turn import { module, test } from '../../shims/nodejs.js' to import { module, test } from 'qunitx'; For this to happen browser bundler should pick up actual qunit
-
-Combine nix with Docker for faster container builds
-
-- also watch subdependencies on browser mode (-- how? investigate esbuild watch)
-- maybe make browser tests per file loading <script>, also could add asset maps maybe if puppeteer supports, this could fix initial "qf" bug
-
-implement and test require and timeout flags
-implement concurrency
-
-fix watcher for file removals make the logic smarter
-
-allow passing absolutePaths(maybe)
-
-- globs: test dynamically added file is watched on global input configuration | also check added files on watch gets put to config.fileOrFolderInputs
-currently parse-fs-inputs might be less performant on big folders(?) dependending on how watch is implemented
-- coverage
-watch parsed files from html(?)
-
-
-$ qunitx some-test --browser | default html doesnt match with $ qunitx init and also no html mode should be there
-
-try this: $ npx ava --tap | npx tap-difflet
-or this: $ npx ava --tap | npx faucet
-
-research mocha reporter(TAP > reporters | json stream metada then it consumes this metadata(how?))
-example good reporters: spec(reporter), dot, tap, landing strip(interesting instead put percentage), jest
-
-esbuild ./tmp/test/passing-tests.js  --bundle > test.js
-parse qunitx in the package.json for config
-
-failFast and babelOptions?
-files(and to ignore), require, timeout
-concurrencyStrategies
-
-add node and browser options
-add functionality to execute only one test
-add reporters
-
-pass timezone: https://stackoverflow.com/questions/16448754/how-to-use-a-custom-time-in-browser-to-test-for-client-vs-server-time-difference/39533934#39533934
-= qunitx --timezone="US/Pacific"
-
-QUnit regex filters
-
-Jest Notes
-==========
-TestSequencer
-- this failed in the past? run first
-- when file changed latest
-- this test run in the past and was long? long tests run first
-- file size
-
-TestScheduler
-- schedule across threads
-- reporters
-- dont spawn many threads if total test count is small
-jest-runner/jest-puppeteer(check this)
-
-read jest-worker/worker_thread implementation
-
-
-check if jest-qunit exists
-
-jest-runtime(creates VM context)
-allows module mocking, custom require implementation, also does transforms
-runs the tests
-transform is sync in jest(dep tracking problem)
-
-TestResult / Repoter
-- all data has to be json serializable for threads
-- stack trace of errors
-- how many assertions
-
-AggregatedRestResult[]
-- finished test case, how long, each assertion
-- check jest runners
-
-qunitx init
-
-
-write test metadata(each test) if flag is provided
-
-markdown reporter(interesting: https://mochajs.org/#markdown)

package/build.js

@@ -1,54 +0,0 @@
-import fs from 'fs/promises';
-
-let [qunitJS, qunitCSS, _] = await Promise.all([
-  fs.readFile('./node_modules/qunit/qunit/qunit.js'),
-  fs.readFile('./node_modules/qunit/qunit/qunit.css'),
-  fs.mkdir('./vendor', { recursive: true })
-]);
-
-let newQUnit = qunitJS.toString().replace(
-  'start: function start(count) {',
-  `reset: function() {
-		ProcessingQueue.finished = false;
-		globalStartCalled = false;
-		runStarted = false;
-
-		config.queue.length = 0;
-		config.modules.length = 0;
-		config.autostart = false;
-
-    Object.assign(config.stats, { total: 0, passed: 0, failed: 0, skipped: 0, todo: 0 });
-
-		[
-			"started", "updateRate", "filter", "depth", "current",
-			"pageLoaded", "timeoutHandler", "timeout", "pollution"
-		].forEach( ( key ) => delete config[ key ] );
-
-		const suiteReport = config.currentModule.suiteReport;
-
-		suiteReport.childSuites.length = 0;
-		delete suiteReport._startTime;
-		delete suiteReport._endTime;
-
-		config.modules.push( config.currentModule );
-  },
-  start: function start(count) {`);
-
-await Promise.all([
-  fs.writeFile('./vendor/qunit.js', newQUnit),
-  fs.writeFile('./vendor/qunit.css', qunitCSS),
-  createPackageJSONIfNotExists()
-]);
-
-async function createPackageJSONIfNotExists() {
-  try {
-    await fs.stat('./vendor/package.json');
-
-    return true;
-  } catch (error) {
-    await fs.writeFile('./vendor/package.json', JSON.stringify({
-      name: 'qunitx-vendor',
-      version: '0.0.1'
-    }));
-  }
-}

package/test/commands/help-test.js

@@ -1,72 +0,0 @@
-import { module, test } from 'qunitx';
-import process from "node:process";
-import fs from 'node:fs';
-import { promisify } from 'node:util';
-import { exec } from 'node:child_process';
-
-const CWD = process.cwd();
-const VERSION = JSON.parse(fs.readFileSync(`${CWD}/package.json`)).version;
-const shell = promisify(exec);
-const cli = async function(arg = '') {
-  if (process.argv[0].includes('deno')) {
-    return await shell(`deno run --allow-read --allow-env ${CWD}/deno/cli.js ${arg}`);
-  }
-
-  return await shell(`node ${CWD}/cli.js ${arg}`);
-}
-
-const printedHelpOutput = `[qunitx v${VERSION}] Usage: qunitx [targets] --$flags
-
-Input options:
-- File: $ qunitx test/foo.js
-- Folder: $ qunitx test/login
-- Globs: $ qunitx test/**/*-test.js
-- Combination: $ qunitx test/foo.js test/bar.js test/*-test.js test/logout
-
-Optional flags:
---debug : print console output when tests run in browser
---watch : run the target file or folders, watch them for continuous run and expose http server under localhost
---timeout : change default timeout per test case
---output : folder to distribute built qunitx html and js that a webservers can run[default: tmp]
---failFast : run the target file or folders with immediate abort if a single test fails
---before : run a script before the tests(i.e start a new web server before tests)
---after : run a script after the tests(i.e save test results to a file)
-
-Example: $ qunitx test/foo.ts app/e2e --debug --watch --before=scripts/start-new-webserver.js --after=scripts/write-test-results.js
-
-Commands:
-$ qunitx init               # Bootstraps qunitx base html and add qunitx config to package.json if needed
-$ qunitx new $testFileName  # Creates a qunitx test file`;
-
-module('Commands | Help tests', () => {
-  test('$ qunitx -> prints help text', async (assert) => {
-    const { stdout } = await cli();
-
-    console.log(stdout);
-    assert.ok(stdout.includes(printedHelpOutput));
-  });
-
-  test('$ qunitx print -> prints help text', async (assert) => {
-    const { stdout } = await cli('print');
-
-    assert.ok(stdout.includes(printedHelpOutput));
-  });
-
-  test('$ qunitx p -> prints help text', async (assert) => {
-    const { stdout } = await cli('p');
-
-    assert.ok(stdout.includes(printedHelpOutput));
-  });
-
-  test('$ qunitx help -> prints help text', async (assert) => {
-    const { stdout } = await cli('help');
-
-    assert.ok(stdout.includes(printedHelpOutput));
-  });
-
-  test('$ qunitx h -> prints help text', async (assert) => {
-    const { stdout } = await cli('h');
-
-    assert.ok(stdout.includes(printedHelpOutput));
-  });
-});

package/test/commands/index.js

@@ -1,2 +0,0 @@
-import "./help-test.js";
-// import "./init-test.js";

package/test/commands/init-test.js

@@ -1,44 +0,0 @@
-import { module, test } from 'qunitx';
-import assert from 'node:assert';
-import { promisify } from 'node:util';
-import { exec } from 'node:child_process';
-
-const shell = promisify(exec);
-const cli = async function(arg = '') {
-  if (process.argv[0].includes('deno')) {
-    return await shell(`deno run --allow-read ${CWD}/deno/cli.js ${arg}`);
-  }
-
-  return await shell(`deno run --allow-read ${CWD}/cli.js ${arg}`);
-}
-
-module('Commands | init tests', () => {
-  test('$ qunitx init -> creates the test.html and correctly', async () => {
-    // assert missing
-    const { stdout } = await cli('init');
-    // assert added
-  });
-
-  // it('$ qunitx init warns existing files and assigns attributes to package.json', async function() {
-
-  // });
-
-  // it('$ qunitx init -> recreates missing files from package.json if it exists', async function() {
-
-  // });
-});
-
-async function stripQUnitXFromPackageJSON() {
-
-}
-
-// it('$ qunitx unknown -> raises error', async function() {
-//   t.plan(2);
-
-//   try {
-//     await shell(`node ${process.cwd()}/cli.js dasd`);
-//   } catch ({ stdout }) {
-//     assert.ok(stdout.includes('qunitx unknown command. Available options are:'));
-//     assert.ok(stdout.includes(printedHelpOutput));
-//   }
-// });

package/test/flags/after-test.js

@@ -1,23 +0,0 @@
-import { module, test } from 'qunitx';
-import { assertPassingTestCase, assertFailingTestCase, assertTAPResult } from '../helpers/assert-stdout.js';
-import shell from '../helpers/shell.js';
-
-module('--after script tests for browser mode', { concurrency: false }, (_hooks, moduleMetadata) => {
-  test('--after works when it doesnt need to be awaited', async (assert, testMetadata) => {
-    const { stdout } = await shell('node cli.js test/helpers/passing-tests.js --after=test/helpers/after-script-basic.js', { ...moduleMetadata, ...testMetadata });
-
-    assert.ok(stdout.includes('This is running from after script!!'));
-    assertPassingTestCase(assert, stdout, { debug: false, testNo: 1, moduleName: '{{moduleName}}' });
-    assertTAPResult(assert, stdout, { testCount: 3 });
-  });
-
-  test('--after works when it needs to be awaited', async (assert, testMetadata) => {
-    const { stdout } = await shell('node cli.js test/helpers/passing-tests.js --after=test/helpers/after-script-async.js', { ...moduleMetadata, ...testMetadata });
-
-    assert.ok(stdout.includes('This is running from after script!!'));
-    assert.ok(stdout.includes('After script result is written:'));
-    assert.ok(stdout.includes(JSON.stringify({ testCount: 3, failCount: 0, skipCount: 0, passCount: 3 }, null, 2)));
-    assertPassingTestCase(assert, stdout, { testNo: 1, moduleName: '{{moduleName}}' });
-    assertTAPResult(assert, stdout, { testCount: 3 });
-  });
-});

package/test/flags/before-test.js

@@ -1,23 +0,0 @@
-import { module, test } from 'qunitx';
-import { assertPassingTestCase, assertFailingTestCase, assertTAPResult } from '../helpers/assert-stdout.js';
-import shell from '../helpers/shell.js';
-
-module('--before script tests for browser mode', { concurrency: false }, (_hooks, moduleMetadata) => {
-  test('--before works when it doesnt need to be awaited', async (assert, testMetadata) => {
-    const { stdout } = await shell('node cli.js test/helpers/passing-tests.js --before=test/helpers/before-script-basic.js', { ...moduleMetadata, ...testMetadata });
-
-    assert.ok(stdout.includes('This is running from before script!!'));
-    assertPassingTestCase(assert, stdout, { testNo: 1, moduleName: '{{moduleName}}' });
-    assertTAPResult(assert, stdout, { testCount: 3 });
-  });
-
-  test('--before works it needs to be awaited', { concurrency: false }, async (assert, testMetadata) => {
-    const { stdout } = await shell('node cli.js test/helpers/passing-tests.js test/helpers/before-script-web-server-tests.js --before=test/helpers/before-script-async.js', { ...moduleMetadata, ...testMetadata });
-
-    assert.ok(stdout.includes('This is running from before script!!'));
-    assert.ok(stdout.includes('Starting before script with:'));
-    assertPassingTestCase(assert, stdout, { testNo: 1, moduleName: '{{moduleName}}' });
-    assertPassingTestCase(assert, stdout, { testNo: 4, moduleName: '{{moduleName}} Before script web server tests' });
-    assertTAPResult(assert, stdout, { testCount: 4 });
-  });
-});

package/test/flags/coverage-test.js

@@ -1,6 +0,0 @@
-import { module, test } from 'qunitx';
-
-// test('todo', async (t) => {
-//   t.true(true);
-// });
-

package/test/flags/failfast-test.js

@@ -1,5 +0,0 @@
-import { module, test } from 'qunitx';
-
-// test('todo', async (t) => {
-//   t.true(true);
-// });

package/test/flags/index.js

@@ -1,2 +0,0 @@
-import "./after-test.js";
-import "./before-test.js";

package/test/flags/output-test.js

@@ -1,6 +0,0 @@
-import { module, test } from 'qunitx';
-
-// test('todo', async (t) => {
-//   t.true(true);
-// });
-

package/test/flags/reporter-test.js

@@ -1,6 +0,0 @@
-import { module, test } from 'qunitx';
-
-// test('todo', async (t) => {
-//   t.true(true);
-// });
-

package/test/flags/timeout-test.js

@@ -1,6 +0,0 @@
-import { module, test } from 'qunitx';
-
-// test('todo', async (t) => {
-//   t.true(true);
-// });
-

package/test/flags/watch-test.js

@@ -1,6 +0,0 @@
-import { module, test } from 'qunitx';
-
-// test('todo', async (t) => {
-//   t.true(true);
-// });
-

package/test/helpers/after-script-async.js

@@ -1,13 +0,0 @@
-import fs from 'fs/promises';
-import './after-script-basic.js';
-
-export default async function(results) {
-  let resultsInString = JSON.stringify(results, null, 2);
-
-  await fs.rm(`${process.cwd()}/tmp/results.json`, { force: true, recursive: true });
-  await fs.writeFile(`${process.cwd()}/tmp/results.json`, resultsInString);
-
-  console.log('After script result is written:');
-  console.log(resultsInString);
-}
-

package/test/helpers/after-script-basic.js

@@ -1 +0,0 @@
-console.log('This is running from after script!!');