Add validation of security tag (#5)

Co-authored-by: Matthew Peveler <[email protected]>

Author: bmcutler

dist/index.js

@@ -1,4 +1,5 @@
 const sysadminTag = "[SYSADMIN ACTION]";
+const securityTag = "[SECURITY]";
 const allowedTypes = [
   "Bugfix",
   "Feature",
@@ -30,21 +31,30 @@ const allowedModules = [
 export function checkTitle(fullTitle: string): true {
   let title = fullTitle;
   let hasSysadminTag = false;
+  let hasSecurityTag = false;
 
   if (title.startsWith(sysadminTag)) {
     hasSysadminTag = true;
     title = title.substring(sysadminTag.length);
     if (title.startsWith(" ")) {
-      throw new Error(
-        `There should not be a space between ${sysadminTag} and [<TYPE>:<MODULE>].`
-      );
+      throw new Error(`There should not be a space following ${sysadminTag}.`);
+    }
+  }
+
+  if (title.startsWith(securityTag)) {
+    hasSecurityTag = true;
+    title = title.substring(securityTag.length);
+    if (title.startsWith(" ")) {
+      throw new Error(`There should not be a space following ${securityTag}.`);
     }
   }
 
   if (!/^\[[a-zA-Z0-9\\/]+(?::[a-zA-Z0-9\\/]+)?\] /.test(title)) {
     throw new Error(
       `Invalid title format, must start with ${
         hasSysadminTag ? sysadminTag : ""
+      }${
+        hasSecurityTag ? securityTag : ""
       }[<TYPE>:<MODULE>] and have space before description.`
     );
   }

dist/index.js.map

@@ -12,6 +12,8 @@ describe("validate", () => {
         "[Bugfix:SubminiPolls] xxxx",
         "[Feature:HelpQueue] xxxx",
         "[SYSADMIN ACTION][Refactor:Autograding] xxxx",
+        "[SECURITY][Bugfix:Submission] Some security hole",
+        "[SYSADMIN ACTION][SECURITY][Bugfix:Submission] xxxx",
         "[DevDependency] xxxx",
         "[Dependency] xxxx",
         "[Bugfix:Submission] 0123456789012345678901234567890123456789",
@@ -34,6 +36,30 @@ describe("validate", () => {
             "[SYSADMINACTION][Refactor:Autograding] xxxx",
             "Invalid title format, must start with [<TYPE>:<MODULE>] and have space before description.",
           ],
+          [
+            "[SYSADMIN ACTION] [Refactor:Submission] test",
+            "There should not be a space following [SYSADMIN ACTION].",
+          ],
+          [
+            "[SYSADMIN ACTION][Refactor:Autograding]foo",
+            "Invalid title format, must start with [SYSADMIN ACTION][<TYPE>:<MODULE>] and have space before description.",
+          ],
+          [
+            "[SECURITY] [Refactor:Submission] test",
+            "There should not be a space following [SECURITY].",
+          ],
+          [
+            "[SECURITY][Refactor:Autograding]foo",
+            "Invalid title format, must start with [SECURITY][<TYPE>:<MODULE>] and have space before description.",
+          ],
+          [
+            "[SYSADMIN ACTION][SECURITY][Refactor:Autograding]foo",
+            "Invalid title format, must start with [SYSADMIN ACTION][SECURITY][<TYPE>:<MODULE>] and have space before description.",
+          ],
+          [
+            "[SECURITY][SYSADMIN ACTION][Refactor:Autograding] foo",
+            "Invalid title format, must start with [SECURITY][<TYPE>:<MODULE>] and have space before description.",
+          ],
         ].forEach(([value, expectedException]) => {
           it(`checkTitle should throw: ${value}`, () => {
             expect(() => checkTitle(value)).to.throw(expectedException);