Merge pull request #35 from probot/email-format

hiimbex · web-flow · commit c6dd5efd392c · 2017-09-24T11:38:36.000+02:00
add check for valid email format and test
diff --git a/lib/dco.js b/lib/dco.js
@@ -1,3 +1,5 @@
+const validator = require('email-validator')
+
 // Returns the DCO object containing state and description
 // Also returns target_url (in case of failure) in object
 module.exports = function (commits) {
@@ -25,6 +27,10 @@ module.exports = function (commits) {
         signedOff = false
         defaults.failure.description = `The sign-off is missing.`
       } else {
+        if (!validator.validate(commit.author.email)) {
+          signedOff = false
+          defaults.failure.description = `${commit.author.email} is not a valid email address.`
+        }
         match = regex.exec(commit.message)
         if (commit.author.name !== match[1] || commit.author.email !== match[2]) {
           signedOff = false
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -26,6 +26,7 @@
     ]
   },
   "dependencies": {
+    "email-validator": "^1.1.1",
     "probot": "^0.11.0"
   }
 }
diff --git a/test/dco.js b/test/dco.js
@@ -195,4 +195,21 @@ describe('dco', () => {
 
     expect(JSON.stringify(dcoObject)).toBe(success)
   })
+
+  it('returns failure when email is invalid', () => {
+    const commit = {
+      message: 'bad email\n\nsigned-off-by: hiimbex <hiimbex@bexo>',
+      author: {
+        name: 'hiimbex',
+        email: 'hiimbex@bexo'
+      }
+    }
+    const dcoObject = getDCOStatus([{commit, parents: []}])
+
+    expect(JSON.stringify(dcoObject)).toBe(JSON.stringify({
+      state: 'failure',
+      description: 'hiimbex@bexo is not a valid email address.',
+      target_url: 'https://github.com/probot/dco#how-it-works'
+    }))
+  })
 })

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@`
`26`	`26`	`]`
`27`	`27`	`},`
`28`	`28`	`"dependencies": {`
	`29`	`+ "email-validator": "^1.1.1",`
`29`	`30`	`"probot": "^0.11.0"`
`30`	`31`	`}`
`31`	`32`	`}`