Haraka 3.0.2 → 3.0.4

package/{tests → test}/outbound_bounce_rfc3464.js

@@ -1,18 +1,19 @@
 'use strict';
 
-// Testing bounce email contents related to errors occuring during STMP dialog
+// Testing bounce email contents related to errors occuring during SMTP dialog
 
 // About running the tests:
 // - Making a folder for queuing files
 // - Creating a HMailItem instance using fixtures/util_hmailitem
-// - Talk some STMP in the playbook
+// - Talk some SMTP in the playbook
 // - Test the outcome by replacing trigger functions with our testing code (outbound.send_email, HMailItem.temp_fail, ...)
 //   At one point, the mocked remote SMTP says "5XX" or "4XX" and we test that
 //   * outbound.send_email is called with a RFC3464 bounce message
 //   * or, in case of 4XX: that temp_fail is called and dsn vars are available)
 
-const fs          = require('fs');
-const path        = require('path');
+const assert = require('node:assert')
+const fs          = require('node:fs');
+const path        = require('node:path');
 
 const util_hmailitem = require('./fixtures/util_hmailitem');
 const TODOItem    = require('../outbound/todo');
@@ -30,62 +31,55 @@ const outbound_context = {
 
 const queue_dir = path.resolve(__dirname, 'test-queue');
 
-exports.bounce_3464 = {
-    setUp : done => {
+describe('outbound_bounce_rfc3464', () => {
+    beforeEach((done) => {
         fs.exists(queue_dir, exists => {
-            if (exists) {
-                done();
-            }
-            else {
-                fs.mkdir(queue_dir, err => {
-                    if (err) {
-                        return done(err);
-                    }
-                    done();
-                });
-            }
-        });
-    },
-    tearDown: done => {
-        fs.exists(queue_dir, exists => {
-            if (exists) {
-                const files = fs.readdirSync(queue_dir);
-                files.forEach((file,index) => {
-                    const curPath = path.resolve(queue_dir, file);
-                    if (fs.lstatSync(curPath).isDirectory()) { // recurse
-                        return done(new Error(`did not expect an sub folder here ("${curPath}")! cancel`));
-                    }
-                });
-                files.forEach((file,index) => {
-                    const curPath = path.resolve(queue_dir, file);
-                    fs.unlinkSync(curPath);
-                });
-                done();
-            }
-            else {
+            if (exists) return done();
+
+            fs.mkdir(queue_dir, err => {
+                if (err) return done(err);
                 done();
-            }
-        });
-    },
-    'test MAIL FROM responded with 500 5.0.0 triggers send_email() containing bounce msg with codes and message': test => {
-        test.expect(9);
+            })
+        })
+    })
 
-        util_hmailitem.newMockHMailItem(outbound_context, test, {}, mock_hmail => {
+    afterEach((done) => {
+        fs.exists(queue_dir, exists => {
+            if (!exists) return done()
+
+            const files = fs.readdirSync(queue_dir);
+            files.forEach((file,index) => {
+                const curPath = path.resolve(queue_dir, file);
+                if (fs.lstatSync(curPath).isDirectory()) { // recurse
+                    return done(new Error(`did not expect an sub folder here ("${curPath}")! cancel`));
+                }
+            })
+            files.forEach((file,index) => {
+                const curPath = path.resolve(queue_dir, file);
+                fs.unlinkSync(curPath);
+            })
+            done();
+        })
+    })
+
+    it('test MAIL FROM responded with 500 5.0.0 triggers send_email() containing bounce msg with codes and message', (done) => {
+
+        util_hmailitem.newMockHMailItem(outbound_context, done, {}, (mock_hmail) => {
             const mock_socket = mock_sock.connect('testhost', 'testport');
             mock_socket.writable = true;
 
             const orig_send_email = outbound_context.exports.send_email;
+
             outbound_context.exports.send_email = (from, to, contents, cb, opts) => {
-                test.ok(true, 'outbound.send_email called');
-                test.ok(contents.match(/^Content-type: message\/delivery-status/m), 'its a bounce report');
-                test.ok(contents.match(/^Final-Recipient: rfc822;recipient@domain/m), 'bounce report contains final recipient');
-                test.ok(contents.match(/^Action: failed/m), 'DATA-5XX: bounce report contains action field');
-                test.ok(contents.match(/^Status: 5\.0\.0/m), 'bounce report contains status field with ext. smtp code');
-                test.ok(contents.match(/Absolutely not acceptable\. Basic Test Only\./), 'original upstream message available');
+                assert.ok(true, 'outbound.send_email called');
+                assert.ok(contents.match(/^Content-type: message\/delivery-status/m), 'its a bounce report');
+                assert.ok(contents.match(/^Final-Recipient: rfc822;recipient@domain/m), 'bounce report contains final recipient');
+                assert.ok(contents.match(/^Action: failed/m), 'DATA-5XX: bounce report contains action field');
+                assert.ok(contents.match(/^Status: 5\.0\.0/m), 'bounce report contains status field with ext. smtp code');
+                assert.ok(contents.match(/Absolutely not acceptable\. Basic Test Only\./), 'original upstream message available');
                 outbound_context.exports.send_email = orig_send_email;
-
-                test.done();
-            };
+                done()
+            }
 
             // The playbook
             // from remote: This line is to be sent (from an mocked remote SMTP) to haraka outbound. This is done in this test.
@@ -105,27 +99,27 @@ exports.bounce_3464 = {
                 { 'from': 'haraka', 'test': 'QUIT', end_test: true }, // this will trigger calling the callback
             ];
 
-            util_hmailitem.playTestSmtpConversation(mock_hmail, mock_socket, test, testPlaybook, () => {
+            util_hmailitem.playTestSmtpConversation(mock_hmail, mock_socket, done, testPlaybook, () => {
+            })
+        })
+    })
 
-            });
-        });
-    },
-    'test that early response of 3XX triggers temp_fail': test => {
-        test.expect(7);
+    it('test that early response of 3XX triggers temp_fail', (done) => {
 
-        util_hmailitem.newMockHMailItem(outbound_context, test, {}, mock_hmail => {
+        util_hmailitem.newMockHMailItem(outbound_context, done, {}, mock_hmail => {
             const mock_socket = mock_sock.connect('testhost', 'testport');
             mock_socket.writable = true;
 
             const orig_temp_fail = HMailItem.prototype.temp_fail;
             HMailItem.prototype.temp_fail = function (err, opts) {
-                test.ok(true, 'early-3XX: outbound.temp_fail called');
-                test.equal('3.0.0', this.todo.rcpt_to[0].dsn_status, 'early-3XX: dsn status = 3.0.0');
-                test.equal('delayed', this.todo.rcpt_to[0].dsn_action, 'early-3XX: dsn action = delayed');
-                test.ok(this.todo.rcpt_to[0].dsn_smtp_response.match(/No time for you right now/), 'early-3XX: original upstream message available');
+                assert.ok(true, 'early-3XX: outbound.temp_fail called');
+                assert.equal('3.0.0', this.todo.rcpt_to[0].dsn_status, 'early-3XX: dsn status = 3.0.0');
+                assert.equal('delayed', this.todo.rcpt_to[0].dsn_action, 'early-3XX: dsn action = delayed');
+                assert.ok(this.todo.rcpt_to[0].dsn_smtp_response.match(/No time for you right now/), 'early-3XX: original upstream message available');
                 HMailItem.prototype.temp_fail = orig_temp_fail;
-                test.done();
-            };
+                done()
+            }
+
             const testPlaybook = [
                 { 'from': 'remote', 'line': '220 testing-smtp' },
 
@@ -139,26 +133,26 @@ exports.bounce_3464 = {
                 { 'from': 'haraka', 'test': 'QUIT', end_test: true }, // this will trigger calling the callback
             ];
 
-            util_hmailitem.playTestSmtpConversation(mock_hmail, mock_socket, test, testPlaybook, () => {
+            util_hmailitem.playTestSmtpConversation(mock_hmail, mock_socket, done, testPlaybook, () => {
+
+            })
+        })
+    })
 
-            });
-        });
-    },
-    'test that response of 4XX for RCPT-TO triggers temp_fail': test => {
-        test.expect(8);
+    it('test that response of 4XX for RCPT-TO triggers temp_fail', (done) => {
 
-        util_hmailitem.newMockHMailItem(outbound_context, test, {}, mock_hmail => {
+        util_hmailitem.newMockHMailItem(outbound_context, done, {}, mock_hmail => {
             const mock_socket = mock_sock.connect('testhost', 'testport');
             mock_socket.writable = true;
 
             const orig_temp_fail = HMailItem.prototype.temp_fail;
             HMailItem.prototype.temp_fail = function (err, opts) {
-                test.ok(true, 'RCPT-TO-4XX: outbound.temp_fail called');
-                test.equal('4.0.0', this.todo.rcpt_to[0].dsn_status, 'RCPT-TO-4XX: dsn status = 4.0.0');
-                test.equal('delayed', this.todo.rcpt_to[0].dsn_action, 'RCPT-TO-4XX: dsn action = delayed');
-                test.ok(this.todo.rcpt_to[0].dsn_smtp_response.match(/Currently not available\. Try again later\./), 'RCPT-TO-4XX: original upstream message available');
+                assert.ok(true, 'RCPT-TO-4XX: outbound.temp_fail called');
+                assert.equal('4.0.0', this.todo.rcpt_to[0].dsn_status, 'RCPT-TO-4XX: dsn status = 4.0.0');
+                assert.equal('delayed', this.todo.rcpt_to[0].dsn_action, 'RCPT-TO-4XX: dsn action = delayed');
+                assert.ok(this.todo.rcpt_to[0].dsn_smtp_response.match(/Currently not available\. Try again later\./), 'RCPT-TO-4XX: original upstream message available');
                 HMailItem.prototype.temp_fail = orig_temp_fail;
-                test.done();
+                done()
             };
             const testPlaybook = [
                 { 'from': 'remote', 'line': '220 testing-smtp' },
@@ -176,26 +170,24 @@ exports.bounce_3464 = {
                 { 'from': 'haraka', 'test': 'QUIT', end_test: true }, // this will trigger calling the callback
             ];
 
-            util_hmailitem.playTestSmtpConversation(mock_hmail, mock_socket, test, testPlaybook, () => {
+            util_hmailitem.playTestSmtpConversation(mock_hmail, mock_socket, done, testPlaybook, () => {})
+        })
+    })
 
-            });
-        });
-    },
-    'test that response of 4XX for DATA triggers temp_fail': test => {
-        test.expect(9);
+    it('test that response of 4XX for DATA triggers temp_fail', (done) => {
 
-        util_hmailitem.newMockHMailItem(outbound_context, test, {}, mock_hmail => {
+        util_hmailitem.newMockHMailItem(outbound_context, done, {}, mock_hmail => {
             const mock_socket = mock_sock.connect('testhost', 'testport');
             mock_socket.writable = true;
 
             const orig_temp_fail = HMailItem.prototype.temp_fail;
             HMailItem.prototype.temp_fail = function (err, opts) {
-                test.ok(true, 'DATA-4XX: outbound.temp_fail called');
-                test.equal('4.6.0', this.todo.rcpt_to[0].dsn_status, 'DATA-4XX: dsn status = 4.6.0');
-                test.equal('delayed', this.todo.rcpt_to[0].dsn_action, 'DATA-4XX: dsn action = delayed');
-                test.ok(this.todo.rcpt_to[0].dsn_smtp_response.match(/Currently I do not like ascii art cats\./), 'DATA-4XX: original upstream message available');
+                assert.ok(true, 'DATA-4XX: outbound.temp_fail called');
+                assert.equal('4.6.0', this.todo.rcpt_to[0].dsn_status, 'DATA-4XX: dsn status = 4.6.0');
+                assert.equal('delayed', this.todo.rcpt_to[0].dsn_action, 'DATA-4XX: dsn action = delayed');
+                assert.ok(this.todo.rcpt_to[0].dsn_smtp_response.match(/Currently I do not like ascii art cats\./), 'DATA-4XX: original upstream message available');
                 HMailItem.prototype.temp_fail = orig_temp_fail;
-                test.done();
+                done()
             };
             const testPlaybook = [
                 { 'from': 'remote', 'line': '220 testing-smtp' },
@@ -217,28 +209,28 @@ exports.bounce_3464 = {
                 { 'from': 'haraka', 'test': 'QUIT', end_test: true }, // this will trigger calling the callback
             ];
 
-            util_hmailitem.playTestSmtpConversation(mock_hmail, mock_socket, test, testPlaybook, () => {
+            util_hmailitem.playTestSmtpConversation(mock_hmail, mock_socket, done, testPlaybook, () => {
+
+            })
+        })
+    })
 
-            });
-        });
-    },
-    'test that response of 5XX for RCPT-TO triggers send_email() containing bounce msg with codes and message': test => {
-        test.expect(10);
+    it('test that response of 5XX for RCPT-TO triggers send_email() containing bounce msg with codes and message', (done) => {
 
-        util_hmailitem.newMockHMailItem(outbound_context, test, {}, mock_hmail => {
+        util_hmailitem.newMockHMailItem(outbound_context, done, {}, mock_hmail => {
             const mock_socket = mock_sock.connect('testhost', 'testport');
             mock_socket.writable = true;
 
             const orig_send_email = outbound_context.exports.send_email;
             outbound_context.exports.send_email = (from, to, contents, cb, opts) => {
-                test.ok(true, 'RCPT-TO-5XX: outbound.send_email called');
-                test.ok(contents.match(/^Content-type: message\/delivery-status/m), 'RCPT-TO-5XX: its a bounce report');
-                test.ok(contents.match(/^Final-Recipient: rfc822;recipient@domain/m), 'RCPT-TO-5XX:  bounce report contains final recipient');
-                test.ok(contents.match(/^Action: failed/m), 'DATA-5XX: bounce report contains action field');
-                test.ok(contents.match(/^Status: 5\.1\.1/m), 'RCPT-TO-5XX: bounce report contains status field with our ext. smtp code');
-                test.ok(contents.match(/Not available and will not come back/), 'RCPT-TO-5XX: original upstream message available');
+                assert.ok(true, 'RCPT-TO-5XX: outbound.send_email called');
+                assert.ok(contents.match(/^Content-type: message\/delivery-status/m), 'RCPT-TO-5XX: its a bounce report');
+                assert.ok(contents.match(/^Final-Recipient: rfc822;recipient@domain/m), 'RCPT-TO-5XX:  bounce report contains final recipient');
+                assert.ok(contents.match(/^Action: failed/m), 'DATA-5XX: bounce report contains action field');
+                assert.ok(contents.match(/^Status: 5\.1\.1/m), 'RCPT-TO-5XX: bounce report contains status field with our ext. smtp code');
+                assert.ok(contents.match(/Not available and will not come back/), 'RCPT-TO-5XX: original upstream message available');
                 outbound_context.exports.send_email = orig_send_email;
-                test.done();
+                done()
             };
             const testPlaybook = [
                 { 'from': 'remote', 'line': '220 testing-smtp' },
@@ -256,28 +248,26 @@ exports.bounce_3464 = {
                 { 'from': 'haraka', 'test': 'QUIT', end_test: true }, // this will trigger calling the callback
             ];
 
-            util_hmailitem.playTestSmtpConversation(mock_hmail, mock_socket, test, testPlaybook, () => {
+            util_hmailitem.playTestSmtpConversation(mock_hmail, mock_socket, done, testPlaybook, () => {})
+        })
+    })
 
-            });
-        });
-    },
-    'test that response of 5XX for DATA triggers send_email() containing bounce msg with codes and message': test => {
-        test.expect(11);
+    it('test that response of 5XX for DATA triggers send_email() containing bounce msg with codes and message', (done) => {
 
-        util_hmailitem.newMockHMailItem(outbound_context, test, {}, mock_hmail => {
+        util_hmailitem.newMockHMailItem(outbound_context, done, {}, mock_hmail => {
             const mock_socket = mock_sock.connect('testhost', 'testport');
             mock_socket.writable = true;
 
             const orig_send_email = outbound_context.exports.send_email;
             outbound_context.exports.send_email = (from, to, contents, cb, opts) => {
-                test.ok(true, 'DATA-5XX: outbound.send_email called');
-                test.ok(contents.match(/^Content-type: message\/delivery-status/m), 'DATA-5XX: its a bounce report');
-                test.ok(contents.match(/^Final-Recipient: rfc822;recipient@domain/m), 'DATA-5XX:  bounce report contains final recipient');
-                test.ok(contents.match(/^Action: failed/m), 'DATA-5XX: bounce report contains action field');
-                test.ok(contents.match(/^Status: 5\.6\.0/m), 'DATA-5XX: bounce report contains status field with our ext. smtp code');
-                test.ok(contents.match(/I never did and will like ascii art cats/), 'DATA-5XX: original upstream message available');
+                assert.ok(true, 'DATA-5XX: outbound.send_email called');
+                assert.ok(contents.match(/^Content-type: message\/delivery-status/m), 'DATA-5XX: its a bounce report');
+                assert.ok(contents.match(/^Final-Recipient: rfc822;recipient@domain/m), 'DATA-5XX:  bounce report contains final recipient');
+                assert.ok(contents.match(/^Action: failed/m), 'DATA-5XX: bounce report contains action field');
+                assert.ok(contents.match(/^Status: 5\.6\.0/m), 'DATA-5XX: bounce report contains status field with our ext. smtp code');
+                assert.ok(contents.match(/I never did and will like ascii art cats/), 'DATA-5XX: original upstream message available');
                 outbound_context.exports.send_email = orig_send_email;
-                test.done();
+                done()
             };
             const testPlaybook = [
                 { 'from': 'remote', 'line': '220 testing-smtp' },
@@ -299,10 +289,8 @@ exports.bounce_3464 = {
                 { 'from': 'haraka', 'test': 'QUIT', end_test: true }, // this will trigger calling the callback
             ];
 
-            util_hmailitem.playTestSmtpConversation(mock_hmail, mock_socket, test, testPlaybook, () => {
-
-            });
-        });
-    },
-}
+            util_hmailitem.playTestSmtpConversation(mock_hmail, mock_socket, done, testPlaybook, () => {})
+        })
+    })
+})