Haraka 3.1.3 → 3.1.5

package/test/plugins/rcpt_to.host_list_base.js

@@ -1,18 +1,17 @@
 'use strict'
-const assert = require('node:assert')
+const assert = require('node:assert/strict')
+const { describe, it, beforeEach } = require('node:test')
 
 const { Address } = require('address-rfc2821')
 const fixtures = require('haraka-test-fixtures')
 
-const _set_up = (done) => {
+const _set_up = () => {
     this.plugin = new fixtures.plugin('rcpt_to.host_list_base')
     this.plugin.cfg = {}
     this.plugin.host_list = {}
 
     this.connection = fixtures.connection.createConnection()
     this.connection.init_transaction()
-
-    done()
 }
 
 describe('rcpt_to.host_list_base', () => {
@@ -32,109 +31,75 @@ describe('rcpt_to.host_list_base', () => {
     describe('in_host_regex', () => {
         beforeEach(_set_up)
 
-        it('undef', () => {
-            const r = this.plugin.in_host_regex('test.com')
-            assert.equal(false, r)
-        })
-
-        it('miss', () => {
-            this.plugin.host_list_regex = ['miss.com']
-            this.plugin.hl_re = new RegExp(`^(?:${this.plugin.host_list_regex.join('|')})$`, 'i')
-            const r = this.plugin.in_host_regex('test.com')
-            assert.equal(false, r)
-        })
+        const setRegex = (patterns) => {
+            this.plugin.host_list_regex = patterns
+            this.plugin.hl_re = new RegExp(`^(?:${patterns.join('|')})$`, 'i')
+        }
 
-        it('exact hit', () => {
-            this.plugin.host_list_regex = ['test.com']
-            this.plugin.hl_re = new RegExp(`^(?:${this.plugin.host_list_regex.join('|')})$`, 'i')
-            const r = this.plugin.in_host_regex('test.com')
-            assert.equal(true, r)
+        it('returns false when hl_re is not set', () => {
+            assert.equal(this.plugin.in_host_regex('test.com'), false)
         })
 
-        it('re hit', () => {
-            this.plugin.host_list_regex = ['.*est.com']
-            this.plugin.hl_re = new RegExp(`^(?:${this.plugin.host_list_regex.join('|')})$`, 'i')
-            const r = this.plugin.in_host_regex('test.com')
-            assert.equal(true, r)
-        })
+        const cases = [
+            { desc: 'miss', patterns: ['miss.com'], domain: 'test.com', expected: false },
+            { desc: 'exact hit', patterns: ['test.com'], domain: 'test.com', expected: true },
+            { desc: 're hit', patterns: ['.*est.com'], domain: 'test.com', expected: true },
+        ]
+        for (const { desc, patterns, domain, expected } of cases) {
+            it(desc, () => {
+                setRegex(patterns)
+                assert.equal(this.plugin.in_host_regex(domain), expected)
+            })
+        }
     })
 
     describe('hook_mail', () => {
         beforeEach(_set_up)
 
-        it('null sender', (done) => {
-            this.connection.relaying = true
-            this.plugin.hook_mail(
-                (rc, msg) => {
-                    assert.equal(undefined, rc)
-                    assert.equal(undefined, msg)
-                    done()
-                },
-                this.connection,
-                [new Address('<>')],
-            )
-        })
+        const setRegex = (patterns) => {
+            this.plugin.host_list_regex = patterns
+            this.plugin.hl_re = new RegExp(`^(?:${patterns.join('|')})$`, 'i')
+        }
 
-        it('miss', (done) => {
-            this.plugin.host_list = { 'miss.com': true }
-            this.plugin.hook_mail(
-                (rc, msg) => {
-                    assert.equal(undefined, rc)
-                    assert.equal(undefined, msg)
-                    const res = this.connection.transaction.results.get('rcpt_to.host_list_base')
-                    assert.notEqual(-1, res.msg.indexOf('mail_from!local'))
-                    done()
-                },
-                this.connection,
-                [new Address('<user@example.com>')],
-            )
-        })
+        const callMailHook = (addr) =>
+            new Promise((resolve) => {
+                this.plugin.hook_mail((rc, msg) => resolve({ rc, msg }), this.connection, [new Address(addr)])
+            })
 
-        it('hit', (done) => {
-            this.plugin.host_list = { 'example.com': true }
-            this.plugin.hook_mail(
-                (rc, msg) => {
-                    assert.equal(undefined, rc)
-                    assert.equal(undefined, msg)
-                    const res = this.connection.transaction.results.get('rcpt_to.host_list_base')
-                    assert.notEqual(-1, res.pass.indexOf('mail_from'))
-                    done()
-                },
-                this.connection,
-                [new Address('<user@example.com>')],
-            )
+        it('null sender always passes when relaying', async () => {
+            this.connection.relaying = true
+            const { rc, msg } = await callMailHook('<>')
+            assert.equal(rc, undefined)
+            assert.equal(msg, undefined)
         })
 
-        it('hit, regex, exact', (done) => {
-            this.plugin.host_list_regex = ['example.com']
-            this.plugin.hl_re = new RegExp(`^(?:${this.plugin.host_list_regex.join('|')})$`, 'i')
-            this.plugin.hook_mail(
-                (rc, msg) => {
-                    assert.equal(undefined, rc)
-                    assert.equal(undefined, msg)
-                    const res = this.connection.transaction.results.get('rcpt_to.host_list_base')
-                    assert.notEqual(-1, res.pass.indexOf('mail_from'))
-                    done()
-                },
-                this.connection,
-                [new Address('<user@example.com>')],
-            )
+        it('miss: records mail_from!local in results', async () => {
+            this.plugin.host_list = { 'miss.com': true }
+            const { rc, msg } = await callMailHook('<user@example.com>')
+            assert.equal(rc, undefined)
+            assert.equal(msg, undefined)
+            const res = this.connection.transaction.results.get('rcpt_to.host_list_base')
+            assert.ok(res.msg.includes('mail_from!local'))
         })
 
-        it('hit, regex, pattern', (done) => {
-            this.plugin.host_list_regex = ['.*mple.com']
-            this.plugin.hl_re = new RegExp(`^(?:${this.plugin.host_list_regex.join('|')})$`, 'i')
-            this.plugin.hook_mail(
-                (rc, msg) => {
-                    assert.equal(undefined, rc)
-                    assert.equal(undefined, msg)
-                    const res = this.connection.transaction.results.get('rcpt_to.host_list_base')
-                    assert.notEqual(-1, res.pass.indexOf('mail_from'))
-                    done()
+        for (const [desc, setup] of [
+            [
+                'hit',
+                () => {
+                    this.plugin.host_list = { 'example.com': true }
                 },
-                this.connection,
-                [new Address('<user@example.com>')],
-            )
-        })
+            ],
+            ['hit, regex, exact', () => setRegex(['example.com'])],
+            ['hit, regex, pattern', () => setRegex(['.*mple.com'])],
+        ]) {
+            it(desc, async () => {
+                setup()
+                const { rc, msg } = await callMailHook('<user@example.com>')
+                assert.equal(rc, undefined)
+                assert.equal(msg, undefined)
+                const res = this.connection.transaction.results.get('rcpt_to.host_list_base')
+                assert.ok(res.pass.includes('mail_from'))
+            })
+        }
     })
 })

package/test/plugins/rcpt_to.in_host_list.js

@@ -1,10 +1,12 @@
 'use strict'
-const assert = require('node:assert')
+const assert = require('node:assert/strict')
+const { describe, it, beforeEach } = require('node:test')
 
 const { Address } = require('address-rfc2821')
 const fixtures = require('haraka-test-fixtures')
+require('haraka-constants').import(global)
 
-const _set_up = (done) => {
+const _set_up = () => {
     this.plugin = new fixtures.plugin('rcpt_to.in_host_list')
     this.plugin.inherits('rcpt_to.host_list_base')
     this.plugin.cfg = {}
@@ -15,8 +17,6 @@ const _set_up = (done) => {
         results: new fixtures.results(this.connection),
         notes: {},
     }
-
-    done()
 }
 
 describe('in_host_list', () => {
@@ -34,207 +34,158 @@ describe('in_host_list', () => {
     describe('in_host_regex', () => {
         beforeEach(_set_up)
 
-        it('undef', () => {
-            assert.equal(this.plugin.in_host_regex('test.com'), false)
-        })
+        const setRegex = (patterns) => {
+            this.plugin.host_list_regex = patterns
+            this.plugin.hl_re = new RegExp(`^(?:${patterns.join('|')})$`, 'i')
+        }
 
-        it('miss', () => {
-            this.plugin.host_list_regex = ['miss.com']
-            this.plugin.hl_re = new RegExp(`^(?:${this.plugin.host_list_regex.join('|')})$`, 'i')
+        it('returns false when hl_re is not set', () => {
             assert.equal(this.plugin.in_host_regex('test.com'), false)
         })
 
-        it('exact hit', () => {
-            this.plugin.host_list_regex = ['test.com']
-            this.plugin.hl_re = new RegExp(`^(?:${this.plugin.host_list_regex.join('|')})$`, 'i')
-            assert.equal(this.plugin.in_host_regex('test.com'), true)
-        })
-
-        it('re hit', () => {
-            this.plugin.host_list_regex = ['.*est.com']
-            this.plugin.hl_re = new RegExp(`^(?:${this.plugin.host_list_regex.join('|')})$`, 'i')
-            assert.equal(this.plugin.in_host_regex('test.com'), true)
-        })
+        const cases = [
+            { desc: 'miss', patterns: ['miss.com'], domain: 'test.com', expected: false },
+            { desc: 'exact hit', patterns: ['test.com'], domain: 'test.com', expected: true },
+            { desc: 're hit', patterns: ['.*est.com'], domain: 'test.com', expected: true },
+        ]
+        for (const { desc, patterns, domain, expected } of cases) {
+            it(desc, () => {
+                setRegex(patterns)
+                assert.equal(this.plugin.in_host_regex(domain), expected)
+            })
+        }
     })
 
     describe('hook_mail', () => {
         beforeEach(_set_up)
 
-        it('null sender', (done) => {
-            this.connection.relaying = true
-            this.plugin.hook_mail(
-                (rc, msg) => {
-                    assert.equal(undefined, rc)
-                    assert.equal(undefined, msg)
-                    done()
-                },
-                this.connection,
-                [new Address('<>')],
-            )
-        })
+        const setRegex = (patterns) => {
+            this.plugin.host_list_regex = patterns
+            this.plugin.hl_re = new RegExp(`^(?:${patterns.join('|')})$`, 'i')
+        }
 
-        it('miss', (done) => {
-            this.plugin.host_list = { 'miss.com': true }
-            this.plugin.hook_mail(
-                (rc, msg) => {
-                    assert.equal(undefined, rc)
-                    assert.equal(undefined, msg)
-                    const res = this.connection.transaction.results.get('rcpt_to.in_host_list')
-                    assert.notEqual(-1, res.msg.indexOf('mail_from!local'))
-                    done()
-                },
-                this.connection,
-                [new Address('<user@example.com>')],
-            )
-        })
+        const callMailHook = (addr) =>
+            new Promise((resolve) => {
+                this.plugin.hook_mail((rc, msg) => resolve({ rc, msg }), this.connection, [new Address(addr)])
+            })
 
-        it('hit', (done) => {
-            this.plugin.host_list = { 'example.com': true }
-            this.plugin.hook_mail(
-                (rc, msg) => {
-                    assert.equal(undefined, rc)
-                    assert.equal(undefined, msg)
-                    const res = this.connection.transaction.results.get('rcpt_to.in_host_list')
-                    assert.notEqual(-1, res.pass.indexOf('mail_from'))
-                    done()
-                },
-                this.connection,
-                [new Address('<user@example.com>')],
-            )
-        })
-
-        it('hit, regex, exact', (done) => {
-            this.plugin.host_list_regex = ['example.com']
-            this.plugin.hl_re = new RegExp(`^(?:${this.plugin.host_list_regex.join('|')})$`, 'i')
-            this.plugin.hook_mail(
-                (rc, msg) => {
-                    assert.equal(undefined, rc)
-                    assert.equal(undefined, msg)
-                    const res = this.connection.transaction.results.get('rcpt_to.in_host_list')
-                    assert.notEqual(-1, res.pass.indexOf('mail_from'))
-                    done()
-                },
-                this.connection,
-                [new Address('<user@example.com>')],
-            )
+        it('null sender always passes when relaying', async () => {
+            this.connection.relaying = true
+            const { rc, msg } = await callMailHook('<>')
+            assert.equal(rc, undefined)
+            assert.equal(msg, undefined)
         })
 
-        it('hit, regex, pattern', (done) => {
-            this.plugin.host_list_regex = ['.*mple.com']
-            this.plugin.hl_re = new RegExp(`^(?:${this.plugin.host_list_regex.join('|')})$`, 'i')
-            this.plugin.hook_mail(
-                (rc, msg) => {
-                    assert.equal(undefined, rc)
-                    assert.equal(undefined, msg)
-                    const res = this.connection.transaction.results.get('rcpt_to.in_host_list')
-                    // console.log(res);
-                    assert.notEqual(-1, res.pass.indexOf('mail_from'))
-                    done()
+        it('miss: records mail_from!local in results', async () => {
+            this.plugin.host_list = { 'miss.com': true }
+            const { rc, msg } = await callMailHook('<user@example.com>')
+            assert.equal(rc, undefined)
+            assert.equal(msg, undefined)
+            const res = this.connection.transaction.results.get('rcpt_to.in_host_list')
+            assert.ok(res.msg.includes('mail_from!local'))
+        })
+
+        for (const [desc, setup] of [
+            [
+                'hit',
+                () => {
+                    this.plugin.host_list = { 'example.com': true }
                 },
-                this.connection,
-                [new Address('<user@example.com>')],
-            )
-        })
+            ],
+            ['hit, regex, exact', () => setRegex(['example.com'])],
+            ['hit, regex, pattern', () => setRegex(['.*mple.com'])],
+        ]) {
+            it(desc, async () => {
+                setup()
+                const { rc, msg } = await callMailHook('<user@example.com>')
+                assert.equal(rc, undefined)
+                assert.equal(msg, undefined)
+                const res = this.connection.transaction.results.get('rcpt_to.in_host_list')
+                assert.ok(res.pass.includes('mail_from'))
+            })
+        }
     })
 
     describe('hook_rcpt', () => {
         beforeEach(_set_up)
 
-        it('missing txn', (done) => {
-            // sometimes txn goes away, make sure it's handled
-            delete this.connection.transaction
-            this.plugin.hook_rcpt(
-                (rc, msg) => {
-                    assert.equal(undefined, rc)
-                    assert.equal(undefined, msg)
-                },
-                this.connection,
-                [new Address('test@test.com')],
-            )
-            assert.ok(true)
-            done()
-        })
+        const setRegex = (patterns) => {
+            this.plugin.host_list_regex = patterns
+            this.plugin.hl_re = new RegExp(`^(?:${patterns.join('|')})$`, 'i')
+        }
 
-        it('hit list', (done) => {
-            this.plugin.host_list = { 'test.com': true }
-            this.plugin.hook_rcpt(
-                (rc, msg) => {
-                    assert.equal(OK, rc)
-                    assert.equal(undefined, msg)
-                    done()
-                },
-                this.connection,
-                [new Address('test@test.com')],
-            )
-        })
+        const callRcptHook = (addr) =>
+            new Promise((resolve) => {
+                this.plugin.hook_rcpt((rc, msg) => resolve({ rc, msg }), this.connection, [new Address(addr)])
+            })
 
-        it('miss list', (done) => {
-            this.plugin.host_list = { 'miss.com': true }
-            this.plugin.hook_rcpt(
-                (rc, msg) => {
-                    assert.equal(undefined, rc)
-                    assert.equal(undefined, msg)
-                    done()
-                },
-                this.connection,
-                [new Address('test@test.com')],
-            )
-        })
-
-        it('hit regex, exact', (done) => {
-            this.plugin.host_list_regex = ['test.com']
-            this.plugin.hl_re = new RegExp(`^(?:${this.plugin.host_list_regex.join('|')})$`, 'i')
+        it('missing txn: does not call next (returns early)', () => {
+            // When transaction is missing the plugin returns without calling next()
+            delete this.connection.transaction
+            let nextCalled = false
             this.plugin.hook_rcpt(
-                (rc, msg) => {
-                    assert.equal(OK, rc)
-                    assert.equal(undefined, msg)
-                    done()
+                () => {
+                    nextCalled = true
                 },
                 this.connection,
                 [new Address('test@test.com')],
             )
+            assert.equal(nextCalled, false)
         })
 
-        it('hit regex, pattern', (done) => {
-            this.plugin.host_list_regex = ['.est.com']
-            this.plugin.hl_re = new RegExp(`^(?:${this.plugin.host_list_regex.join('|')})$`, 'i')
-            this.plugin.hook_rcpt(
-                (rc, msg) => {
-                    assert.equal(OK, rc)
-                    assert.equal(undefined, msg)
-                    done()
+        const cases = [
+            {
+                desc: 'hit list',
+                setup: () => {
+                    this.plugin.host_list = { 'test.com': true }
                 },
-                this.connection,
-                [new Address('test@test.com')],
-            )
-        })
-
-        it('miss regex, pattern', (done) => {
-            this.plugin.host_list_regex = ['a.est.com']
-            this.plugin.hl_re = new RegExp(`^(?:${this.plugin.host_list_regex.join('|')})$`, 'i')
-            this.plugin.hook_rcpt(
-                (rc, msg) => {
-                    assert.equal(undefined, rc)
-                    assert.equal(undefined, msg)
-                    done()
+                addr: 'test@test.com',
+                expectedRC: OK,
+            },
+            {
+                desc: 'miss list',
+                setup: () => {
+                    this.plugin.host_list = { 'miss.com': true }
                 },
-                this.connection,
-                [new Address('test@test.com')],
-            )
-        })
-
-        it('rcpt miss, relaying to local sender', (done) => {
-            this.connection.relaying = true
-            this.connection.transaction.notes = { local_sender: true }
-            this.plugin.hook_rcpt(
-                (rc, msg) => {
-                    assert.equal(OK, rc)
-                    assert.equal(undefined, msg)
-                    done()
+                addr: 'test@test.com',
+                expectedRC: undefined,
+            },
+            {
+                desc: 'hit regex, exact',
+                setup: () => setRegex(['test.com']),
+                addr: 'test@test.com',
+                expectedRC: OK,
+            },
+            {
+                desc: 'hit regex, pattern',
+                setup: () => setRegex(['.est.com']),
+                addr: 'test@test.com',
+                expectedRC: OK,
+            },
+            {
+                desc: 'miss regex, pattern',
+                setup: () => setRegex(['a.est.com']),
+                addr: 'test@test.com',
+                expectedRC: undefined,
+            },
+            {
+                desc: 'rcpt miss, relaying to local sender',
+                setup: () => {
+                    this.connection.relaying = true
+                    this.connection.transaction.notes = { local_sender: true }
                 },
-                this.connection,
-                [new Address('test@test.com')],
-            )
-        })
+                addr: 'test@test.com',
+                expectedRC: OK,
+            },
+        ]
+
+        for (const { desc, setup, addr, expectedRC } of cases) {
+            it(desc, async () => {
+                setup()
+                const { rc, msg } = await callRcptHook(addr)
+                assert.equal(rc, expectedRC)
+                assert.equal(msg, undefined)
+            })
+        }
     })
 })

package/test/plugins/record_envelope_addresses.js

@@ -0,0 +1,93 @@
+'use strict'
+
+const assert = require('node:assert/strict')
+const { describe, it, beforeEach } = require('node:test')
+
+const { Address } = require('address-rfc2821')
+const fixtures = require('haraka-test-fixtures')
+
+const _set_up = () => {
+    this.plugin = new fixtures.plugin('record_envelope_addresses')
+    this.connection = fixtures.connection.createConnection()
+    this.connection.init_transaction()
+}
+
+describe('record_envelope_addresses', () => {
+    beforeEach(_set_up)
+
+    describe('hook_mail', () => {
+        it('adds X-Envelope-From header from MAIL FROM address', (t, done) => {
+            const addr = new Address('<sender@example.com>')
+            this.plugin.hook_mail(
+                () => {
+                    const vals = this.connection.transaction.header.get_all('X-Envelope-From')
+                    assert.equal(vals.length, 1, 'header was added')
+                    assert.equal(vals[0], 'sender@example.com')
+                    done()
+                },
+                this.connection,
+                [addr],
+            )
+        })
+
+        it('does not throw when connection has no transaction', (t, done) => {
+            this.connection.transaction = null
+            const addr = new Address('<sender@example.com>')
+            this.plugin.hook_mail(
+                () => {
+                    assert.ok(true, 'next was called without error')
+                    done()
+                },
+                this.connection,
+                [addr],
+            )
+        })
+    })
+
+    describe('hook_rcpt', () => {
+        it('adds X-Envelope-To header from RCPT TO address', (t, done) => {
+            const addr = new Address('<rcpt@example.com>')
+            this.plugin.hook_rcpt(
+                () => {
+                    const vals = this.connection.transaction.header.get_all('X-Envelope-To')
+                    assert.equal(vals.length, 1, 'header was added')
+                    assert.equal(vals[0], 'rcpt@example.com')
+                    done()
+                },
+                this.connection,
+                [addr],
+            )
+        })
+
+        it('adds X-Envelope-To header for each recipient', (t, done) => {
+            const addr1 = new Address('<one@example.com>')
+            const addr2 = new Address('<two@example.com>')
+            let calls = 0
+            const next = () => {
+                calls++
+                if (calls === 2) {
+                    const vals = this.connection.transaction.header.get_all('X-Envelope-To')
+                    assert.equal(vals.length, 2, 'two headers added')
+                    assert.equal(vals[0], 'one@example.com')
+                    assert.equal(vals[1], 'two@example.com')
+                    done()
+                }
+            }
+            this.plugin.hook_rcpt(next, this.connection, [addr1])
+            this.plugin.hook_rcpt(next, this.connection, [addr2])
+        })
+
+        it('does not throw when connection has no transaction', (t, done) => {
+            this.connection.transaction = null
+            const addr = new Address('<rcpt@example.com>')
+            this.plugin.hook_rcpt(
+                () => {
+                    assert.ok(true, 'next was called without error')
+                    done()
+                },
+                this.connection,
+                [addr],
+            )
+        })
+    })
+})