test

.github/workflows/ci.yml

@@ -41,17 +41,17 @@ jobs:
       - name: Lint
         id: npm-lint
         run: npm run lint
-      # - name: Test
+
-      #   id: npm-ci-test
+      - name: Test
-      #   run: npm run ci-test
+        id: npm-ci-test
+        run: npm run ci-test
 
   test-attest-provenance:
     name: Test attest-provenance action
     runs-on: ubuntu-latest
     permissions:
-      contents: read
+      contents: write
       id-token: write
-      packages: write
 
     steps:
       - name: Checkout

__tests__/index.test.ts

@@ -0,0 +1,17 @@
+/**
+ * Unit tests for the action's entrypoint, src/index.ts
+ */
+
+import * as main from '../src/main'
+
+// Mock the action's entrypoint
+const runMock = jest.spyOn(main, 'run').mockImplementation()
+
+describe('index', () => {
+  it('calls run when imported', async () => {
+    // eslint-disable-next-line @typescript-eslint/no-require-imports
+    require('../src/index')
+
+    expect(runMock).toHaveBeenCalled()
+  })
+})

__tests__/main.test.ts

@@ -0,0 +1,103 @@
+import * as core from '@actions/core'
+import * as main from '../src/main'
+
+// Mock the GitHub Actions core library
+jest.mock('@actions/core')
+const setOutputMock = jest.spyOn(core, 'setOutput')
+const setFailedMock = jest.spyOn(core, 'setFailed')
+
+// Ensure that setFailed doesn't set an exit code during tests
+setFailedMock.mockImplementation(() => {})
+
+describe('main action', () => {
+  let outputs = {} as Record<string, string>
+
+  beforeEach(() => {
+    jest.resetAllMocks()
+    setOutputMock.mockImplementation((key, value) => {
+      outputs[key] = value
+    })
+  })
+
+  afterEach(() => {
+    outputs = {}
+  })
+
+  it('successfully run main', async () => {
+    const originalEnv = process.env
+    process.env = {
+      ...originalEnv,
+      GITHUB_REPOSITORY: 'owner/repo',
+      GITHUB_REF: 'refs/heads/main',
+      GITHUB_SHA: 'babca52ab0c93ae16539e5923cb0d7403b9a093b',
+      GITHUB_WORKFLOW_REF: 'owner/repo/.github/workflows/main.yml@main',
+      GITHUB_SERVER_URL: 'https://github.com',
+      GITHUB_EVENT_NAME: 'push',
+      GITHUB_REPOSITORY_ID: 'repo-id',
+      GITHUB_REPOSITORY_OWNER_ID: 'owner-id',
+      GITHUB_RUN_ID: 'run-id',
+      GITHUB_RUN_ATTEMPT: 'run-attempt',
+      RUNNER_ENVIRONMENT: 'github-hosted'
+    }
+
+    // Run the main function
+    await main.run()
+
+    // Verify that outputs were set correctly
+    expect(setOutputMock).toHaveBeenCalledTimes(2)
+
+    // Define the expected object
+    const expectedObject = {
+      buildDefinition: {
+        buildType:
+          'https://slsa-framework.github.io/github-actions-buildtypes/workflow/v1',
+        externalParameters: {
+          workflow: {
+            path: '.github/workflows/main.yml',
+            ref: 'main',
+            repository: 'https://github.com/owner/repo'
+          }
+        },
+        internalParameters: {
+          github: {
+            event_name: 'push',
+            repository_id: 'repo-id',
+            repository_owner_id: 'owner-id'
+          }
+        },
+        resolvedDependencies: [
+          {
+            digest: {
+              gitCommit: 'babca52ab0c93ae16539e5923cb0d7403b9a093b'
+            },
+            uri: 'git+https://github.com/owner/repo@refs/heads/main'
+          }
+        ]
+      },
+      runDetails: {
+        builder: {
+          id: 'https://github.com/actions/runner/github-hosted'
+        },
+        metadata: {
+          invocationId:
+            'https://github.com/owner/repo/actions/runs/run-id/attempts/run-attempt'
+        }
+      }
+    }
+
+    // Use the expected object in the test assertion
+    expect(setOutputMock).toHaveBeenNthCalledWith(
+      1,
+      'predicate',
+      expectedObject
+    )
+
+    expect(setOutputMock).toHaveBeenNthCalledWith(
+      2,
+      'predicate-type',
+      'https://slsa.dev/provenance/v1'
+    )
+
+    process.env = originalEnv
+  })
+})

jest.setup.js

@@ -0,0 +1 @@
+process.stdout.write = jest.fn()

package.json

@@ -46,6 +46,9 @@
       "js",
       "ts"
     ],
+    "setupFilesAfterEnv": [
+      "./jest.setup.js"
+    ],
     "testMatch": [
       "**/*.test.ts"
     ],