Tests

.github/workflows/ci.yml

@@ -38,25 +38,16 @@ jobs:
         id: npm-lint
         run: npm run lint
 
+      - name: Run test server
+        run: |
+          docker compose build
+          docker compose up &
+
+      - name: Add SSH identity of test server to known hosts
+        run: |
+          mkdir -p ~/.ssh
+          ssh-keyscan -t rsa -p 2222 127.0.0.1 >> ~/.ssh/known_hosts
+
       - name: Test
         id: npm-ci-test
         run: npm run ci-test
-
-  test-action:
-    name: GitHub Actions Test
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout
-        id: checkout
-        uses: actions/checkout@v4
-
-      - name: Test Local Action
-        id: test-action
-        uses: ./
-        with:
-          milliseconds: 2000
-
-      - name: Print Output
-        id: output
-        run: echo "${{ steps.test-action.outputs.time }}"

__tests__/main.test.ts

@@ -8,21 +8,74 @@
 
 import * as core from '@actions/core'
 import * as main from '../src/main'
+import axios from 'axios'
 
 // Mock the action's main function
 const runMock = jest.spyOn(main, 'run')
 
 // Mock the GitHub Actions core library
+let infoMock: jest.SpyInstance
 let getInputMock: jest.SpyInstance
+let setFailedMock: jest.SpyInstance
 
 describe('action', () => {
   beforeEach(() => {
     jest.clearAllMocks()
 
+    infoMock = jest.spyOn(core, 'info').mockImplementation()
     getInputMock = jest.spyOn(core, 'getInput').mockImplementation()
+    setFailedMock = jest.spyOn(core, 'setFailed').mockImplementation()
   })
 
-  it('deploys Hashicorp', async () => {
+  afterEach(() => {
+    main.cleanup()
+  })
+
+  it('fails if compose file does not exist', async () => {
+    getInputMock.mockImplementation((name: string): string => {
+      switch (name) {
+        case 'compose-file':
+          return 'nada.yml'
+        case 'stack-name':
+          return 'david'
+        case 'ssh-user-at-host':
+          return 'david@notexisting'
+        case 'ssh-port':
+          return '22'
+        default:
+          return ''
+      }
+    })
+
+    await main.run()
+    expect(runMock).toHaveReturned()
+    expect(setFailedMock).toHaveBeenCalledWith(
+      'Compose file nada.yml does not exist'
+    )
+  })
+
+  it('fails if SSH is not reachable', async () => {
+    getInputMock.mockImplementation((name: string): string => {
+      switch (name) {
+        case 'compose-file':
+          return 'docker-compose.test.yml'
+        case 'stack-name':
+          return 'david'
+        case 'ssh-user-at-host':
+          return 'david@notexisting'
+        case 'ssh-port':
+          return '22'
+        default:
+          return ''
+      }
+    })
+
+    await main.run()
+    expect(runMock).toHaveReturned()
+    expect(setFailedMock).toHaveBeenCalled()
+  })
+
+  it('deploys Hashicorp Echo HTTP server', async () => {
     // Set the action's inputs as return values from core.getInput()
     getInputMock.mockImplementation((name: string): string => {
       switch (name) {
@@ -41,5 +94,10 @@ describe('action', () => {
 
     await main.run()
     expect(runMock).toHaveReturned()
-  })
+    expect(setFailedMock).not.toHaveBeenCalled()
+    expect(infoMock).toHaveBeenCalledWith('Cleaning up ...')
+
+    const response = await axios.get('http://127.0.0.1:8888')
+    expect(response.data).toMatch(/Hello World/)
+  }, 30000)
 })

action.yml

@@ -29,3 +29,4 @@ inputs:
 runs:
   using: node20
   main: dist/index.js
+  post: dist/index.js

docker-compose.test.yml

@@ -3,6 +3,6 @@ version: "3.9"
 services:
   web:
     image: "hashicorp/http-echo"
-    command: ["-text", "Hello World"]
+    command: ["-listen", ":8080", "-text", "Hello World"]
     ports:
       - 8080:8080

docker-compose.yml

@@ -9,5 +9,6 @@ services:
     cgroup: host
     ports:
       - 127.0.0.1:2222:22
+      - 127.0.0.1:8888:8080
     volumes:
       - /sys/fs/cgroup:/sys/fs/cgroup:rw