haraka 0.0.33 → 3.3.0

package/test/outbound/qfile.js

@@ -0,0 +1,124 @@
+'use strict'
+
+const { describe, it } = require('node:test')
+const assert = require('node:assert')
+const os = require('node:os')
+
+const qfile = require('../../outbound/qfile')
+
+describe('outbound/qfile', () => {
+    describe('name', () => {
+        it('name() basic functions', () => {
+            const name = qfile.name()
+            const split = name.split('_')
+            assert.equal(split.length, 7)
+            assert.equal(split[2], 0)
+            assert.equal(split[3], process.pid)
+        })
+
+        it('name() with overrides', () => {
+            const overrides = {
+                arrival: 12345,
+                next_attempt: 12345,
+                attempts: 15,
+                pid: process.pid,
+                uid: 'XXYYZZ',
+                host: os.hostname(),
+            }
+            const name = qfile.name(overrides)
+            const split = name.split('_')
+            assert.equal(split.length, 7)
+            assert.equal(split[0], overrides.arrival)
+            assert.equal(split[1], overrides.next_attempt)
+            assert.equal(split[2], overrides.attempts)
+            assert.equal(split[3], overrides.pid)
+            assert.equal(split[4], overrides.uid)
+            assert.equal(split[6], overrides.host)
+        })
+
+        it('rnd_unique() is unique-ish', () => {
+            const repeats = 1000
+            const u = qfile.rnd_unique()
+            for (let i = 0; i < repeats; i++) {
+                assert.notEqual(u, qfile.rnd_unique())
+            }
+        })
+    })
+
+    describe('parts', () => {
+        it('parts() updates previous queue filenames', () => {
+            // $nextattempt_$attempts_$pid_$uniq.$host
+            const name = '1111_0_2222_3333.foo.example.com'
+            const parts = qfile.parts(name)
+            assert.equal(parts.next_attempt, 1111)
+            assert.equal(parts.attempts, 0)
+            assert.equal(parts.pid, 2222)
+            assert.equal(parts.host, 'foo.example.com')
+        })
+
+        it('parts() handles standard queue filenames', () => {
+            const overrides = {
+                arrival: 12345,
+                next_attempt: 12345,
+                attempts: 15,
+                pid: process.pid,
+                uid: 'XXYYZZ',
+                host: os.hostname(),
+            }
+            const name = qfile.name(overrides)
+            const parts = qfile.parts(name)
+            assert.equal(parts.arrival, overrides.arrival)
+            assert.equal(parts.next_attempt, overrides.next_attempt)
+            assert.equal(parts.attempts, overrides.attempts)
+            assert.equal(parts.pid, overrides.pid)
+            assert.equal(parts.uid, overrides.uid)
+            assert.equal(parts.host, overrides.host)
+        })
+
+        it('handles 4-part legacy filename', () => {
+            const r = qfile.parts('1484878079415_0_12345_8888.mta1.example.com')
+            delete r.arrival
+            delete r.uid
+            delete r.counter
+            assert.deepEqual(r, {
+                next_attempt: 1484878079415,
+                attempts: 0,
+                pid: 12345,
+                host: 'mta1.example.com',
+                age: 0,
+            })
+        })
+
+        it('handles 7-part standard filename', () => {
+            const r = qfile.parts('1516650518128_1516667073032_8_29538_TkPZWz_1_haraka')
+            delete r.age
+            assert.deepEqual(r, {
+                arrival: 1516650518128,
+                next_attempt: 1516667073032,
+                attempts: 8,
+                pid: 29538,
+                uid: 'TkPZWz',
+                counter: 1,
+                host: 'haraka',
+            })
+        })
+
+        it('punts on 5-part filename', () => {
+            assert.deepEqual(qfile.parts('1516650518128_1516667073032_8_29538_TkPZWz'), null)
+        })
+    })
+
+    describe('hostname', () => {
+        it('defaults to os.hostname()', () => {
+            assert.deepEqual(qfile.hostname(), os.hostname())
+        })
+
+        it('replaces backslash char', () => {
+            assert.deepEqual(qfile.hostname('mt\\a1.exam\\ple.com'), 'mt\\057a1.exam\\057ple.com')
+        })
+
+        it('replaces underscore char', () => {
+            assert.deepEqual(qfile.hostname('mt_a1.exam_ple.com'), 'mt\\137a1.exam\\137ple.com')
+        })
+    })
+})

package/test/outbound/queue.js

@@ -0,0 +1,325 @@
+'use strict'
+
+const { describe, it, beforeEach, afterEach } = require('node:test')
+const assert = require('node:assert')
+const fs = require('node:fs')
+const path = require('node:path')
+const os = require('node:os')
+
+const queue = require('../../outbound/queue')
+const qfile = require('../../outbound/qfile')
+
+const sourceQueueDir = path.join('test', 'queue')
+const testQueueDir = path.join('test', 'test-queue')
+const fixtureFiles = [
+    '1508455115683_1508455115683_0_90253_9Q4o4V_1_haraka',
+    '1508269674999_1508269674999_0_34002_socVUF_1_haraka',
+]
+
+const clearTestQueue = () => {
+    fs.mkdirSync(testQueueDir, { recursive: true })
+    for (const file of fs.readdirSync(testQueueDir)) {
+        fs.unlinkSync(path.join(testQueueDir, file))
+    }
+}
+
+const populateTestQueue = () => {
+    clearTestQueue()
+    for (const file of fixtureFiles) {
+        fs.copyFileSync(path.join(sourceQueueDir, file), path.join(testQueueDir, file))
+    }
+}
+
+describe('outbound/queue', () => {
+    describe('read_parts', () => {
+        it('parses valid queue filenames', () => {
+            const filename = '1507509981169_1507509981169_0_61403_e0Y0Ym_1_haraka'
+            const parts = queue.read_parts(filename)
+            assert.ok(parts)
+            assert.equal(parts.arrival, 1507509981169)
+            assert.equal(parts.next_attempt, 1507509981169)
+            assert.equal(parts.attempts, 0)
+            assert.equal(parts.pid, 61403)
+            assert.equal(parts.uid, 'e0Y0Ym')
+        })
+
+        it('rejects dot files', () => {
+            assert.strictEqual(queue.read_parts('__tmp__.filename'), false)
+        })
+
+        it('rejects error files', () => {
+            assert.strictEqual(queue.read_parts('error.something'), false)
+        })
+
+        it('rejects invalid queue files', () => {
+            assert.strictEqual(queue.read_parts('invalid-file'), false)
+        })
+    })
+
+    describe('load_queue_files', () => {
+        beforeEach(() => {
+            populateTestQueue()
+        })
+        afterEach(() => {
+            clearTestQueue()
+        })
+
+        it('processes valid queue files', async () => {
+            const seen = []
+
+            const files = await queue.load_queue_files(
+                null,
+                ['1508455115683_1508455115683_0_90253_9Q4o4V_1_haraka'],
+                (file) => {
+                    seen.push(file)
+                    return file
+                },
+            )
+            assert.equal(seen.length, 1)
+            assert.equal(files[0], '1508455115683_1508455115683_0_90253_9Q4o4V_1_haraka')
+        })
+
+        it('skips invalid files', async () => {
+            const seen = []
+
+            await queue.load_queue_files(
+                null,
+                ['1507509981169_1507509981169_0_61403_e0Y0Ym_1_haraka', 'invalid-file', 'zero-length'],
+                (file) => {
+                    seen.push(file)
+                },
+            )
+            assert.equal(seen.length, 1)
+        })
+
+        it('filters files by pid', async () => {
+            let renameAttempts = 0
+
+            const originalRename = queue.rename_to_actual_pid
+            queue.rename_to_actual_pid = () => {
+                renameAttempts++
+                throw new Error('test skip')
+            }
+
+            await queue.load_queue_files(
+                61403,
+                [
+                    '1507509981169_1507509981169_0_61403_e0Y0Ym_1_haraka',
+                    '1508455115683_1508455115683_0_90253_9Q4o4V_1_haraka',
+                ],
+                () => {},
+            )
+            queue.rename_to_actual_pid = originalRename
+            assert.equal(renameAttempts, 1)
+        })
+    })
+
+    describe('ensure_queue_dir', () => {
+        it('creates queue dir', async () => {
+            const tmpDir = path.join(os.tmpdir(), `haraka-test-queue-${Date.now()}`)
+
+            const originalQueueDir = queue.queue_dir
+            queue.queue_dir = tmpDir
+
+            try {
+                await queue.ensure_queue_dir()
+                assert.ok(fs.existsSync(tmpDir))
+                const stat = await fs.promises.stat(tmpDir)
+                assert.ok(stat.isDirectory())
+            } catch (err) {
+                assert.fail(`ensure_queue_dir threw an error: ${err.message}`)
+            } finally {
+                queue.queue_dir = originalQueueDir
+                if (fs.existsSync(tmpDir)) fs.rmSync(tmpDir, { recursive: true })
+            }
+        })
+
+        it('returns early if queue dir already exists', async () => {
+            const tmpDir = path.join(os.tmpdir(), `haraka-test-queue-exists-${Date.now()}`)
+            fs.mkdirSync(tmpDir)
+
+            const originalQueueDir = queue.queue_dir
+            queue.queue_dir = tmpDir
+
+            try {
+                await queue.ensure_queue_dir()
+                assert.ok(fs.existsSync(tmpDir))
+            } catch (err) {
+                assert.fail(`ensure_queue_dir threw an error: ${err.message}`)
+            } finally {
+                queue.queue_dir = originalQueueDir
+                fs.rmSync(tmpDir, { recursive: true })
+            }
+        })
+    })
+
+    describe('_load_cur_queue', () => {
+        beforeEach(() => {
+            populateTestQueue()
+        })
+        afterEach(() => {
+            clearTestQueue()
+        })
+
+        it('reads queue directory and processes files', async () => {
+            const processedFiles = []
+            await queue._load_cur_queue(null, (file) => {
+                processedFiles.push(file)
+            })
+
+            assert.ok(processedFiles.length >= 0)
+        })
+    })
+
+    describe('list_queue', () => {
+        beforeEach(() => {
+            populateTestQueue()
+        })
+        afterEach(() => {
+            clearTestQueue()
+        })
+
+        it('returns todo objects from real queue files', async () => {
+            const qlist = await queue.list_queue()
+            assert.ok(Array.isArray(qlist))
+            assert.ok(qlist.length > 0)
+            assert.ok(qlist[0].mail_from)
+            assert.ok(Array.isArray(qlist[0].rcpt_to))
+        })
+    })
+
+    describe('stat_queue', () => {
+        beforeEach(() => {
+            populateTestQueue()
+        })
+        afterEach(() => {
+            clearTestQueue()
+        })
+
+        it('returns queue stats', async () => {
+            const stats = await queue.stat_queue()
+            assert.ok(stats)
+            assert.ok('queue_dir' in stats)
+            assert.ok(stats.queue_count >= 1)
+        })
+    })
+
+    describe('load_pid_queue', () => {
+        beforeEach(() => {
+            populateTestQueue()
+        })
+        afterEach(() => {
+            clearTestQueue()
+        })
+
+        it('delegates pid loading to init_queue', async () => {
+            const parts = qfile.parts(fixtureFiles[0])
+            const observed = []
+            const originalLoadQueue = queue.init_queue
+
+            queue.init_queue = (pid) => {
+                observed.push(pid)
+            }
+
+            try {
+                assert.ok(fs.existsSync(path.join(testQueueDir, fixtureFiles[0])))
+                await queue.load_pid_queue(parts.pid)
+                assert.deepEqual(observed, [parts.pid])
+            } finally {
+                queue.init_queue = originalLoadQueue
+            }
+        })
+    })
+
+    describe('queue maintenance', () => {
+        it('delete_dot_files removes leftover dot files only', async () => {
+            const tmpDir = path.join(os.tmpdir(), `haraka-dot-clean-${Date.now()}`)
+            fs.mkdirSync(tmpDir, { recursive: true })
+            const dotName = `${qfile.platformDOT}leftover`
+            const normalName = 'keep-me'
+            fs.writeFileSync(path.join(tmpDir, dotName), 'x')
+            fs.writeFileSync(path.join(tmpDir, normalName), 'x')
+
+            const originalQueueDir = queue.queue_dir
+            queue.queue_dir = tmpDir
+            try {
+                await queue.delete_dot_files()
+                assert.equal(fs.existsSync(path.join(tmpDir, dotName)), false)
+                assert.equal(fs.existsSync(path.join(tmpDir, normalName)), true)
+            } finally {
+                queue.queue_dir = originalQueueDir
+                fs.rmSync(tmpDir, { recursive: true, force: true })
+            }
+        })
+
+        it('_add_hmail pushes immediate items and schedules delayed ones', () => {
+            const originalPush = queue.delivery_queue.push
+            const originalAdd = queue.temp_fail_queue.add
+            const pushed = []
+            const delayed = []
+            let delayedCb
+
+            queue.delivery_queue.push = (item) => pushed.push(item)
+            queue.temp_fail_queue.add = (id, ms, cb) => {
+                delayed.push([id, ms])
+                delayedCb = cb
+            }
+            queue.cur_time = new Date()
+
+            const immediate = { filename: 'a', next_process: queue.cur_time - 1 }
+            const future = { filename: 'b', next_process: queue.cur_time.getTime() + 1000 }
+
+            try {
+                queue._add_hmail(immediate)
+                queue._add_hmail(future)
+                assert.equal(pushed.length, 1)
+                assert.equal(delayed.length, 1)
+                assert.equal(delayed[0][0], 'b')
+                delayedCb()
+                assert.equal(pushed.length, 2)
+            } finally {
+                queue.delivery_queue.push = originalPush
+                queue.temp_fail_queue.add = originalAdd
+            }
+        })
+
+        it('scan_queue_pids returns unique pids from queue files', async () => {
+            populateTestQueue()
+            const originalQueueDir = queue.queue_dir
+            queue.queue_dir = testQueueDir
+
+            try {
+                const pids = await queue.scan_queue_pids()
+                assert.ok(Array.isArray(pids))
+                assert.equal(pids.length >= 1, true)
+            } finally {
+                queue.queue_dir = originalQueueDir
+                clearTestQueue()
+            }
+        })
+
+        it('scan_queue_pids throws when queue dir cannot be read', async () => {
+            const originalQueueDir = queue.queue_dir
+            const badPath = path.join(os.tmpdir(), `queue-not-dir-${Date.now()}`)
+            fs.writeFileSync(badPath, 'x')
+            queue.queue_dir = badPath
+            try {
+                await assert.rejects(() => queue.scan_queue_pids())
+            } finally {
+                queue.queue_dir = originalQueueDir
+                fs.rmSync(badPath, { force: true })
+            }
+        })
+
+        it('delete_dot_files handles readdir errors without throwing', async () => {
+            const originalQueueDir = queue.queue_dir
+            queue.queue_dir = path.join(os.tmpdir(), `missing-dot-${Date.now()}`)
+            try {
+                await queue.delete_dot_files()
+                assert.ok(true)
+            } finally {
+                queue.queue_dir = originalQueueDir
+            }
+        })
+    })
+})