SOME-123: Add unit tests run in CI

.github/workflows/main.yml → .github/workflows/pr_comment.yml

@@ -6,12 +6,11 @@ jobs:
     name: Auto jira link commenter
     steps:
       - name: Checkout
-        uses: actions/checkout@v1
+        uses: actions/checkout@v4
 
       - name: Comment PR
-        uses: sbimochan/jira-link-commenter@v2.4
-
+        uses: sbimochan/jira-link-commenter@v3.0
         with:
           jira-project-url: https://jira.atlassian.net/browse
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          custom-comment: 'Thank you for your contribution!!! :confetti_ball:'
+          custom-comment: "Thank you for your contribution!!! :confetti_ball:"

.github/workflows/run_tests.yml

@@ -0,0 +1,20 @@
+on: pull_request
+
+jobs:
+  run_tests:
+    runs-on: ubuntu-latest
+    name: Run tests
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Run tests
+        run: npm test

package.json

@@ -1,6 +1,6 @@
 {
   "name": "jira-link-commenter",
-  "version": "3.0",
+  "version": "3.1",
   "description": "This action auto comments in pull request with Jira link to it.",
   "main": "src/main.js",
   "scripts": {

src/__tests__/ticket.test.js

@@ -1,5 +1,5 @@
-const grabTicket = require('../main').grabTicket;
-const ticketRegex = require('../main').DEFAULT_TICKET_REGEX
+const grabTicket = require('../ticket').grabTicket;
+const ticketRegex = require('../ticket').DEFAULT_TICKET_REGEX
 
 describe('grabTicket', () => {
   it('should return ticket id without colon', () => {
@@ -23,6 +23,13 @@ describe('grabTicket', () => {
     expect(result).toBe('ABCDEFGH-12345678');
   });
 
+  it('should return not return ticket without colon', () => {
+    const title = 'ABCDEFGH-12345678 New Feature';
+    const result = grabTicket(title, ticketRegex);
+
+    expect(result).toBeNull();
+  });
+
   it('should return null if no ticket id is found', () => {
     const title = 'No ticket id here';
     const result = grabTicket(title, ticketRegex);

src/main.js

@@ -1,7 +1,6 @@
 const core = require('@actions/core');
 const github = require('@actions/github');
-
-const DEFAULT_TICKET_REGEX = /^[A-Z,a-z]{2,}-\d{1,}:/g;
+const { grabTicket, DEFAULT_TICKET_REGEX } = require('./ticket');
 
 async function runMain() {
   try {
@@ -53,20 +52,4 @@ async function checkIfOldCommentExists(octokit, context, pullRequestNumber) {
   return isPrevComment;
 }
 
-/**
- * Searches with first Ticket like structure with colon and later removes it.
- *
- * @param {string} title
- */
-function grabTicket(title, ticketRegex) {
-  const ticketIdWithColon = title.match(ticketRegex)?.[0];
-  if (!ticketIdWithColon) {
-    return null;
-  }
-
-  return ticketIdWithColon.slice(0, -1);
-}
-
-module.exports = { grabTicket, DEFAULT_TICKET_REGEX }
-
 runMain();

src/ticket.js

@@ -0,0 +1,17 @@
+const DEFAULT_TICKET_REGEX = /^[A-Z,a-z]{2,}-\d{1,}:/g;
+
+/**
+ * Searches with first Ticket like structure with colon and later removes it.
+ *
+ * @param {string} title
+ */
+function grabTicket(title, ticketRegex) {
+  const ticketIdWithColon = title.match(ticketRegex)?.[0];
+  if (!ticketIdWithColon) {
+    return null;
+  }
+
+  return ticketIdWithColon.slice(0, -1);
+}
+
+module.exports = { grabTicket, DEFAULT_TICKET_REGEX }