Merge pull request #12 from cloud-ecs/spring-cleaning-2

- test: replace mocha with node:test
- refactor: convert scanner stack from callbacks to async/await
- ci: install and start rspamd, spamassassin, and clamd to test against
- ci: install opendkim and opendmarc
- clamdscan: strip file to it as clamd likely doesn't have file perms
- style: prettier

Author: msimerson

.github/workflows/ci.yml

@@ -20,37 +20,85 @@ jobs:
       - uses: actions/setup-node@v6
         with:
           node-version: lts/*
-      - run: npm ci || npm install
+      - run: npm install
       - run: npm run lint
 
   test:
+    needs: [get-lts]
     strategy:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        node-version: [22, 24]
+        node-version: ${{ fromJson(needs.get-lts.outputs.lts) }}
     runs-on: ${{ matrix.os }}
     name: Node ${{ matrix.node-version }} on ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v6
       - uses: actions/setup-node@v6
         with:
           node-version: ${{ matrix.node-version }}
-      - run: npm ci || npm install
+      - run: npm install
       - run: npm test
 
   macos:
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [macos-latest]
-        node-version: [24]
-    runs-on: ${{ matrix.os }}
-    name: Node ${{ matrix.node-version }} on ${{ matrix.os }}
+    runs-on: macos-latest
+    name: Node LTS on macOS
     steps:
       - uses: actions/checkout@v6
       - uses: actions/setup-node@v6
         with:
-          node-version: ${{ matrix.node-version }}
-      - run: npm ci || npm install
+          node-version: lts/*
+      - run: npm install
       - run: npm test
+
+  get-lts:
+    runs-on: ubuntu-latest
+    steps:
+      - id: get
+        uses: msimerson/node-lts-versions@v1
+    outputs:
+      active: ${{ steps.get.outputs.active }}
+      maintenance: ${{ steps.get.outputs.maintenance }}
+      lts: ${{ steps.get.outputs.lts }}
+      current: ${{ steps.get.outputs.current }}
+      min: ${{ steps.get.outputs.min }}
+
+  live:
+    name: live scanners
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    env:
+      ECSD_ENV: ci
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-node@v6
+        with:
+          node-version: lts/*
+      - run: npm install
+      - name: install spamassassin
+        run: sh ./test/helpers/install-spamassassin.sh
+      - name: install rspamd
+        run: sh ./test/helpers/install-rspamd.sh
+      - name: install opendkim
+        run: sh ./test/helpers/install-opendkim.sh
+      - name: wait for scanners to listen
+        run: sh ./test/helpers/wait-for-scanners.sh spamd rspamd
+      - run: npm test
+
+  clamav:
+    name: clamav
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    env:
+      ECSD_ENV: ci
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-node@v6
+        with:
+          node-version: lts/*
+      - run: npm install
+      - name: install clamav
+        run: sh ./test/helpers/install-clamav.sh
+      - name: wait for clamd to listen
+        run: sh ./test/helpers/wait-for-scanners.sh clamd
+      - run: node --test --test-force-exit test/clamav.js

.gitignore

@@ -6,3 +6,4 @@ spool
 ess.sublime-*
 html/vendor
 package-lock.json
+cloud-email-scanner.local.ini

.mocharc.json

@@ -54,7 +54,9 @@ If a package-level instruction file exists, it is authoritative for that package
 - Results: `connection.transaction.results.add(this, { pass|fail|skip|msg|err, emit })`; query with `results.has(plugin, list, search)`. `emit: true` already logs the collated line — don't also `loginfo`/`logerror` the same thing. results.add(this, {err}) always logs.
 - Config loads via `config.get` with a hot-reload callback; declare every boolean or it stays a string and `=== true/false` silently fails:
   ```js
-  this.cfg = this.config.get('name.ini', { booleans: ['+a.b', '-c.d'] }, () => this.load())
+  this.cfg = this.config.get('name.ini', { booleans: ['+a.b', '-c.d'] }, () =>
+    this.load(),
+  )
   ```
 - Keep handlers thin. Push pure decision logic and I/O into `lib/*.js` as pure functions that return a verdict/value; the handler just maps that to `results.add` + `next`. For external I/O (DNS, network), expose an injectable seam — a swappable function whose default is the real implementation — so tests run without mocks.
 - If you add files outside `index.js` (e.g. a `lib/` dir), add them to `package.json` `files` so they publish.

AGENTS.md

@@ -10,15 +10,18 @@ A web service that receives emails via HTTP and scans them with one or many filt
 - [x] rspamd
 - [ ] dcc
 - [ ] virustotal
+- [x] clamav
+- [x] bitdefender
+- [x] opendkim
+- [ ] opendmarc
+
+### Still viable?
+
 - [ ] fprot
 - [ ] f-secure
-- [x] clamav
 - [ ] eset
 - [ ] kaspersky
 - [ ] comodo
-- [x] bitdefender
-- [x] opendkim
-- [ ] opendmarc
 
 ### Legacy / Deprecated Scanners
 
@@ -76,10 +79,9 @@ matt; result=\"Innocent\"; class=\"Whitelisted\"; probability=0.0000; confidence
 
 ![status page image](https://cloud.githubusercontent.com/assets/261635/11162087/56acf54a-8a46-11e5-882c-5d8b5a704d71.png)
 
-
-[ci-img]: https://travis-ci.org/cloud-ecs/ecsd.svg
-[ci-url]: https://travis-ci.org/cloud-ecs/ecsd
+[ci-img]: https://github.com/cloud-ecs/ecsd/actions/workflows/ci.yml/badge.svg
+[ci-url]: https://github.com/cloud-ecs/ecsd/actions/workflows/ci.yml
 [cov-img]: https://codecov.io/github/cloud-ecs/ecsd/coverage.svg
 [cov-url]: https://codecov.io/github/cloud-ecs/ecsd
-[qlty-img]: https://codeclimate.com/github/cloud-ecs/ecsd/badges/gpa.svg
-[qlty-url]: https://codeclimate.com/github/cloud-ecs/ecsd
+[qlty-img]: https://qlty.sh/gh/cloud-ecs/projects/ecsd/maintainability.svg
+[qlty-url]: https://qlty.sh/gh/cloud-ecs/projects/ecsd

README.md

@@ -0,0 +1,14 @@
+; CI overrides (ECSD_ENV=ci). The scanners are installed and started on the
+; GitHub runner, so point the network engines at localhost.
+
+[clamav.net]
+host = 127.0.0.1
+port = 3310
+
+[spamassassin.net]
+host = 127.0.0.1
+port = 783
+
+[rspamd.net]
+host = 127.0.0.1
+port = 11333

cloud-email-scanner.ci.ini

@@ -18,7 +18,7 @@ port = 8000
 
 [clamav.net]
 ; host = 0.0.0.0
-; port = 3306
+; port = 3310
 
 [clamav.cli]
 ; bin = clamdscan
@@ -91,4 +91,4 @@ port = 8000
 
 [dspam.cli]
 ; bin = dspam
-; args = --mode=tum --process --deliver=summary --stdout <
+; args = --mode=tum --process --deliver=summary --stdout <

cloud-email-scanner.ini

@@ -1,22 +1,21 @@
-'use strict';
+'use strict'
 
-const js = require('@eslint/js');
-const globals = require('globals');
+const js = require('@eslint/js')
+const globals = require('globals')
 
 module.exports = [
-    js.configs.recommended,
-    {
-        languageOptions: {
-            ecmaVersion: 'latest',
-            sourceType: 'commonjs',
-            globals: {
-                ...globals.node,
-                ...globals.mocha,
-            },
-        },
-        rules: {
-            'no-console': 'off',
-            'no-unused-vars': 'warn',
-        },
+  js.configs.recommended,
+  {
+    languageOptions: {
+      ecmaVersion: 'latest',
+      sourceType: 'commonjs',
+      globals: {
+        ...globals.node,
+      },
     },
-];
+    rules: {
+      'no-console': 'off',
+      'no-unused-vars': 'warn',
+    },
+  },
+]