feat: Optimized smtp configuration

Author: dploeger

README.md

@@ -25,7 +25,7 @@ _confluence-outdated_ includes a command to create a template document:
 
 Example:
 
-    confluence-outdated createconfigurationdocument --url https://example.com/confluence --user somebody --password secret --space CM --title "My configuration document" --parentId 12345
+    confluence-outdated CreateConfigurationDocument --url https://example.com/confluence --user somebody --password secret --space CM --title "My configuration document" --parentId 12345
 
 The command will output the page ID for the configuration document and a link to it.
 
@@ -59,6 +59,15 @@ subject and the body of the notification mails.
 They will get [this object](https://github.com/dodevops/confluence-outdated/blob/master/lib/api/DocumentInfo.ts#L6) as
 a context for the template.
 
+## Usage
+
+After the configuration document is properly setup, run *confluence-outdated* on a regular basis:
+
+    confluence-outdated Check --url https://example.com/confluence --user somebody --password secret -i 123456 -s "smtp://localhost:25/?ignoreTLS=true"
+
+This will fetch the confluence document with the id 123456 as the configuration and check all required documentation as
+configured. The SMTP url is based on the [nodemailer smtp transport](https://nodemailer.com/smtp/).
+
 ## Development
 
 The tests subdirectory contain unit tests run by mocha for all parts of the api. If you want to help developing, please

lib/api/Configuration.ts

@@ -2,7 +2,6 @@ import got from 'got'
 import { Check } from './Check'
 import { Logger } from 'loglevel'
 import { ConfigurationError } from '../error/ConfigurationError'
-import * as SMTPTransport from 'nodemailer/lib/smtp-transport'
 import * as cheerio from 'cheerio'
 import { Maintainer } from './Maintainer'
 import log = require('loglevel')
@@ -55,11 +54,6 @@ export class Configuration {
    */
   public notificationFrom: string
 
-  /**
-   * Transport options for nodemailer for the notifications
-   */
-  public transportOptions: SMTPTransport.Options
-
   /**
    * A list of checks for outdated documents
    */
@@ -102,15 +96,19 @@ export class Configuration {
   }
 
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  private _getConfigurationFromPanel($: Root, panelName: string): Array<any> {
+  private _getConfigurationFromPanel($: Root, panelName: string, lowerCase = true): Array<any> {
     const keys = $(`ac\\:parameter:contains("${panelName}") + ac\\:rich-text-body table tr th`)
     const values = $(`ac\\:parameter:contains("${panelName}") + ac\\:rich-text-body table tr td`)
     const rows = $(`ac\\:parameter:contains("${panelName}") + ac\\:rich-text-body table tr td`).parent()
     const returnObject = []
     for (let i = 0; i < rows.length; i++) {
       const rowObject = {}
       keys.each((index, key) => {
-        rowObject[$(key).text().toLowerCase()] = $(values[index + i * 2]).text()
+        let configurationKey = $(key).text()
+        if (lowerCase) {
+          configurationKey = configurationKey.toLowerCase()
+        }
+        rowObject[configurationKey] = $(values[index + i * 2]).text()
       })
       returnObject.push(rowObject)
     }
@@ -174,8 +172,6 @@ export class Configuration {
         }
       })
 
-      this.transportOptions = this._getConfigurationFromPanel($, 'SMTP')[0]
-
       this.notificationSubjectTemplate = $(
         'ac\\:parameter:contains("Notification Template") + ac\\:rich-text-body ac\\:parameter:contains("Subject") + ac\\:rich-text-body'
       ).text()

lib/api/Confluence.ts

@@ -75,7 +75,7 @@ export class Confluence {
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
     }).json<any>()
 
-    const author = (document && document.version && document.version.by && document.version.by.username) || null
+    const author = document.version.by.username ?? null
 
     if (!author) {
       this._log.error(`Can't get author from this document:

lib/api/Notification.ts

@@ -16,10 +16,10 @@ export class Notification {
   private _log: Logger
   private readonly _dryRun: boolean
 
-  constructor(configuration: Configuration, confluence: Confluence, transport: Mail = null, dryRun = false) {
+  constructor(configuration: Configuration, smtpTransportUrl: string, confluence: Confluence, transport: Mail = null, dryRun = false) {
     this._configuration = configuration
     this._confluence = confluence
-    this._transport = transport || createTransport(this._configuration.transportOptions)
+    this._transport = transport || createTransport(smtpTransportUrl)
 
     this._log = log.getLogger('Notification')
     this._dryRun = dryRun
@@ -40,9 +40,14 @@ export class Notification {
       }
     }
 
+    let to = documentInfo.author
+    if (this._configuration.domain) {
+      to = `${to}@${this._configuration.domain}`
+    }
+
     const mailOptions = {
       from: this._configuration.notificationFrom,
-      to: `${documentInfo.author}@${this._configuration.domain}`,
+      to: to,
       subject: subjectTemplate(documentInfo),
       html: bodyTemplate(documentInfo),
     }

lib/commands/Check.ts

@@ -20,6 +20,14 @@ export class CheckOptions extends DefaultOptions {
     toggle: true,
   })
   dryRun: boolean
+
+  @option({
+    name: 'smtpurl',
+    flag: 's',
+    description: 'SMTP URL (check out https://nodemailer.com/smtp/ for options)',
+    required: true,
+  })
+  smtpTransportUrl: string
 }
 
 @command({
@@ -42,7 +50,7 @@ export default class extends Command {
 
     const confluence = new Confluence(options.confluenceUrl, options.confluenceUser, options.confluencePassword)
 
-    const notification = new Notification(configuration, confluence, null, options.dryRun)
+    const notification = new Notification(configuration, options.smtpTransportUrl, confluence, null, options.dryRun)
 
     for (const check of configuration.checks) {
       log.debug(`Checking for documents older than ${check.maxAge} day(s) with label(s) ${check.labels.join(',')}`)

lib/commands/CreateConfigurationDocument.ts

@@ -40,7 +40,7 @@ export default class extends Command {
 
     const confluence = new Confluence(options.confluenceUrl, options.confluenceUser, options.confluencePassword)
 
-    const pageId = confluence.createConfigurationDocument(options.space, options.title, options.parentId)
+    const pageId = await confluence.createConfigurationDocument(options.space, options.title, options.parentId)
 
     return `The configuration document was created with the ID
     ${pageId}

package.json

@@ -15,7 +15,8 @@
     "url": ""
   },
   "scripts": {
-    "test": "grunt test"
+    "test": "grunt test",
+    "prepare": "grunt build"
   },
   "files": [
     "index.d.ts",

resources/configurationDocument.html

@@ -23,28 +23,6 @@
         </table>
     </ac:rich-text-body>
 </ac:structured-macro>
-<ac:structured-macro ac:name="panel" ac:schema-version="1" ac:macro-id="ecfe796e-b701-4f30-a74a-b94dbb33daff">
-    <ac:parameter ac:name="title">SMTP</ac:parameter>
-    <ac:rich-text-body>
-        <i>See <a href="https://nodemailer.com/smtp/">the nodemailer SMTP documentation</a> for all available options here.</i>
-        <table class="wrapped">
-            <colgroup>
-                <col/>
-                <col/>
-            </colgroup>
-            <tbody>
-            <tr>
-                <th>Host</th>
-                <td>localhost</td>
-            </tr>
-            <tr>
-                <th>Port</th>
-                <td>25</td>
-            </tr>
-            </tbody>
-        </table>
-    </ac:rich-text-body>
-</ac:structured-macro>
 <ac:structured-macro ac:name="panel" ac:schema-version="1" ac:macro-id="f19cd8b2-57e0-4c68-a823-8a2daee08c12">
     <ac:parameter ac:name="title">Checks</ac:parameter>
     <ac:rich-text-body>

test/ConfigurationTest.ts

@@ -22,9 +22,6 @@ describe('The Configuration API', (): void => {
     chai.expect(configuration.notificationBodyTemplate).to.eq(MockServer.NOTIFICATION_BODY)
     chai.expect(configuration.notificationSubjectTemplate).to.eq(MockServer.NOTIFICATION_SUBJECT)
 
-    chai.expect(configuration.transportOptions.host).to.eq('localhost')
-    chai.expect(configuration.transportOptions.port).to.eq('25')
-
     chai.expect(configuration.notificationFrom).to.eq('Notification <[email protected]>')
   })
 })

test/NotificationTest.ts

@@ -31,7 +31,7 @@ describe('The Notification API', (): void => {
   })
 
   it('should send notifications', async (): Promise<void> => {
-    const notification = new Notification(configuration, confluence, transportStub)
+    const notification = new Notification(configuration, '', confluence, transportStub)
     const documentInfo = new DocumentInfo(0, 'author', moment(), 'message', 'title', 'http://example.com')
     await notification.notify(documentInfo)
     chai.expect((transportStub as unknown as SinonStubbedInstance<Mail>).sendMail.calledOnce).to.be.true
@@ -45,7 +45,7 @@ describe('The Notification API', (): void => {
     ).to.be.true
   })
   it('should use a maintainer when configured', async (): Promise<void> => {
-    const notification = new Notification(configuration, confluence, transportStub)
+    const notification = new Notification(configuration, '', confluence, transportStub)
     const documentInfo = new DocumentInfo(0, 'author2', moment(), 'message', 'Test2', 'http://example.com')
     await notification.notify(documentInfo)
     chai.expect((transportStub as unknown as SinonStubbedInstance<Mail>).sendMail.calledOnce).to.be.true
@@ -59,7 +59,7 @@ describe('The Notification API', (): void => {
     ).to.be.true
   })
   it('should not send notifications on a dry run', async (): Promise<void> => {
-    const notification = new Notification(configuration, confluence, transportStub, true)
+    const notification = new Notification(configuration, '', confluence, transportStub, true)
     const documentInfo = new DocumentInfo(0, 'author', moment(), 'message', 'title', 'http://example.com')
     await notification.notify(documentInfo)
     chai.expect((transportStub as unknown as SinonStubbedInstance<Mail>).sendMail.notCalled).to.be.true