ci: introducing tests with jest for the actions-scripts. Added a workflow to run them

Author: TheRustifyer

.github/workflows/actions-scripts-tests.yml

@@ -0,0 +1,32 @@
+name: Test Action Scripts
+
+on:
+  push:
+    paths:
+      - 'actions_scripts/**' # Trigger only when files in this folder are modified
+  pull_request:
+    paths:
+      - 'actions_scripts/**' # Run on PRs affecting the actions_scripts folder
+
+jobs:
+  test-and-coverage:
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checkout the repository
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      # Set up Node.js environment
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '23'
+
+      # Install dependencies
+      - name: Install dependencies
+        run: npm ci
+
+      # Run tests and collect coverage
+      - name: Run tests and generate coverage
+        run: npm test

actions_scripts/__tests__/notify_user.test.js

@@ -0,0 +1,68 @@
+import { jest } from '@jest/globals';
+
+const notifyUser = (await import('../notify_user.js')).default
+
+describe('notifyUser', () => {
+  it('should create a PR comment when running in a non-local environment', async () => {
+    // Mock dependencies
+    const mockGithub = {
+      rest: {
+        issues: {
+          createComment: jest.fn().mockResolvedValue({ data: { id: 12345 } }),
+        },
+      },
+    };
+
+    const mockContextCloud = {
+      repo: { owner: 'test-owner', repo: 'test-repo' },
+      payload: { issue: { number: 42 } },
+      actor: 'test-user',
+    };
+
+    const environment = 'test-env';
+    const project = 'test-project';
+    const infra = 'test-infra';
+
+    // Call the function
+    const result = await notifyUser({
+      github: mockGithub,
+      context: mockContextCloud,
+      environment,
+      project,
+      infra,
+    });
+
+    // Assertions
+    expect(mockGithub.rest.issues.createComment).toHaveBeenCalledWith({
+      owner: 'test-owner',
+      repo: 'test-repo',
+      issue_number: 42,
+      body: expect.stringContaining('🚀 Deployment action request received from user: test-user'),
+    });
+    expect(result).toEqual({ id: 12345, message: expect.any(String) });
+  });
+
+  it('should log a message when running in a local environment', async () => {
+    const mockContext = {
+      payload: { act: true, issue: { number: 42 } }, // Simulates a local run
+      actor: 'test-user',
+    };
+
+    const consoleSpy = jest.spyOn(console, 'log').mockImplementation(() => {});
+
+    const result = await notifyUser({
+      github: {},
+      context: mockContext,
+      environment: 'local-env',
+      project: 'local-project',
+      infra: 'local-infra',
+    });
+
+    expect(consoleSpy).toHaveBeenCalledWith(
+      expect.stringContaining('Action is being runned locally by \'ACT\'')
+    );
+    expect(result).toEqual({ id: 1010101010, message: expect.any(String) });
+
+    consoleSpy.mockRestore();
+  });
+});

jest.config.js

@@ -0,0 +1,8 @@
+// Base configuration for using 'JEST' as our test suite for this repo 'JS' custom scripts
+// that typically we use in our actions
+
+export default {
+    transform: {}, // Disable default Babel transform
+    testEnvironment: 'node', // Default to Node.js environment
+};
+