pompelmi 1.14.0 → 1.16.0

package/packages/testing/index.js

@@ -0,0 +1,82 @@
+'use strict';
+
+const { Verdict } = require('pompelmi');
+
+/**
+ * Creates a mock pompelmi scanner where all scan methods resolve to
+ * the given verdict.
+ *
+ * @param {symbol} defaultVerdict - One of Verdict.Clean, Verdict.Malicious, or Verdict.ScanError.
+ * @returns {{ scan, scanBuffer, scanStream, Verdict }}
+ */
+function createMockScanner(defaultVerdict) {
+  if (defaultVerdict !== Verdict.Clean &&
+      defaultVerdict !== Verdict.Malicious &&
+      defaultVerdict !== Verdict.ScanError) {
+    throw new TypeError('defaultVerdict must be one of Verdict.Clean, Verdict.Malicious, or Verdict.ScanError');
+  }
+
+  return {
+    Verdict,
+    scan:        () => Promise.resolve(defaultVerdict),
+    scanBuffer:  () => Promise.resolve(defaultVerdict),
+    scanStream:  () => Promise.resolve(defaultVerdict),
+    scanS3:      () => Promise.resolve(defaultVerdict),
+    _verdict: defaultVerdict,
+  };
+}
+
+/**
+ * Shorthand: returns a mock scanner that always resolves to Verdict.Clean.
+ */
+function mockClean() {
+  return createMockScanner(Verdict.Clean);
+}
+
+/**
+ * Shorthand: returns a mock scanner that always resolves to Verdict.Malicious.
+ * The virusName parameter is stored on the scanner for inspection in tests.
+ *
+ * @param {string} [virusName='Win.Malware.Test'] - Virus name label (stored as scanner.virusName).
+ */
+function mockInfected(virusName) {
+  const scanner = createMockScanner(Verdict.Malicious);
+  scanner.virusName = virusName || 'Win.Malware.Test';
+  return scanner;
+}
+
+/**
+ * Shorthand: returns a mock scanner that always resolves to Verdict.ScanError.
+ */
+function mockScanError() {
+  return createMockScanner(Verdict.ScanError);
+}
+
+/**
+ * Wraps a test function with a mocked pompelmi scanner.
+ * The scanner is passed as the first argument to fn.
+ *
+ * This is a lightweight helper — for full module-level mocking in Jest/Vitest,
+ * use jest.mock() / vi.mock() directly.
+ *
+ * @param {symbol}   verdict - Verdict to mock.
+ * @param {Function} fn      - Test function that receives the mock scanner.
+ * @returns {Promise}
+ */
+function withMockedPompelmi(verdict, fn) {
+  const scanner = createMockScanner(verdict);
+  try {
+    return Promise.resolve(fn(scanner));
+  } catch (err) {
+    return Promise.reject(err);
+  }
+}
+
+module.exports = {
+  createMockScanner,
+  mockClean,
+  mockInfected,
+  mockScanError,
+  withMockedPompelmi,
+  Verdict,
+};

package/packages/testing/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@pompelmi/testing",
+  "version": "1.0.0",
+  "description": "Mock utilities for unit-testing applications that use pompelmi — Jest, Vitest, and Node test runner",
+  "license": "ISC",
+  "author": "pompelmi contributors",
+  "homepage": "https://pompelmi.app",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pompelmi/pompelmi.git",
+    "directory": "packages/testing"
+  },
+  "keywords": [
+    "pompelmi",
+    "testing",
+    "mock",
+    "jest",
+    "vitest",
+    "clamav",
+    "antivirus",
+    "unit-test"
+  ],
+  "main": "./index.js",
+  "types": "./index.d.ts",
+  "scripts": {
+    "test": "node --test test/index.test.js"
+  },
+  "peerDependencies": {
+    "pompelmi": ">=1.14.0"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  }
+}

package/src/BufferScanner.js

@@ -3,6 +3,9 @@
 const net         = require('net');
 const { Verdict } = require('./verdicts.js');
 
+// net.createConnection is polyfilled by Bun — no code changes needed
+const isBun = typeof Bun !== 'undefined'; // eslint-disable-line no-unused-vars
+
 const CLAMD_INSTREAM = Buffer.from('zINSTREAM\0');
 const CHUNK_SIZE     = 64 * 1024;
 

package/src/ClamdScanner.js

@@ -4,6 +4,8 @@ const net            = require('net');
 const fs             = require('fs');
 const { Verdict }    = require('./verdicts.js');
 
+const isBun = typeof Bun !== 'undefined';
+
 // ClamAV INSTREAM protocol:
 //   1. Send "zINSTREAM\0"
 //   2. Send N chunks, each prefixed with a 4-byte big-endian length
@@ -63,24 +65,46 @@ function scanViaClamd(filePath, options = {}) {
             conn.on('data',  (chunk) => chunks.push(chunk));
             conn.on('end',   () => settle(resolve, parseClamdResponse(Buffer.concat(chunks))));
 
-            conn.on('connect', () => {
+            conn.on('connect', async () => {
                 conn.write(CLAMD_INSTREAM);
 
-                const fileStream = fs.createReadStream(filePath, { highWaterMark: CHUNK_SIZE });
-
-                fileStream.on('error', (err) => settle(reject, err));
-
-                fileStream.on('data', (chunk) => {
-                    const header = Buffer.allocUnsafe(4);
-                    header.writeUInt32BE(chunk.length, 0);
-                    conn.write(header);
-                    conn.write(chunk);
-                });
-
-                fileStream.on('end', () => {
+                if (isBun) {
+                    // Bun.file() is faster than fs.createReadStream on Bun
+                    let fileData;
+                    try {
+                        fileData = await Bun.file(filePath).bytes();
+                    } catch (err) {
+                        return settle(reject, err);
+                    }
+                    const buf = Buffer.from(fileData);
+                    let offset = 0;
+                    while (offset < buf.length) {
+                        const chunk  = buf.slice(offset, offset + CHUNK_SIZE);
+                        const header = Buffer.allocUnsafe(4);
+                        header.writeUInt32BE(chunk.length, 0);
+                        conn.write(header);
+                        conn.write(chunk);
+                        offset += chunk.length;
+                    }
                     conn.write(Buffer.alloc(4)); // terminating zero-length chunk
                     conn.end();
-                });
+                } else {
+                    const fileStream = fs.createReadStream(filePath, { highWaterMark: CHUNK_SIZE });
+
+                    fileStream.on('error', (err) => settle(reject, err));
+
+                    fileStream.on('data', (chunk) => {
+                        const header = Buffer.allocUnsafe(4);
+                        header.writeUInt32BE(chunk.length, 0);
+                        conn.write(header);
+                        conn.write(chunk);
+                    });
+
+                    fileStream.on('end', () => {
+                        conn.write(Buffer.alloc(4)); // terminating zero-length chunk
+                        conn.end();
+                    });
+                }
             });
         });
     }

package/src/StreamScanner.js

@@ -3,6 +3,9 @@
 const net         = require('net');
 const { Verdict } = require('./verdicts.js');
 
+// net.createConnection is polyfilled by Bun — no code changes needed
+const isBun = typeof Bun !== 'undefined'; // eslint-disable-line no-unused-vars
+
 const CLAMD_INSTREAM = Buffer.from('zINSTREAM\0');
 
 function parseClamdResponse(raw) {