4b004ec331
Some checks failed
Check Transpiled JavaScript / Check dist/ (push) Failing after 43s
Continuous Integration / JavaScript Tests (push) Failing after 5s
Continuous Integration / GitHub Actions Test (push) Failing after 5s
CodeQL / Analyze (javascript) (push) Failing after 5s
Lint Codebase / Lint Codebase (push) Failing after 5s
91 lines
2.7 KiB
Markdown
91 lines
2.7 KiB
Markdown
---
|
|
mode: agent
|
|
tools: ['codebase', 'github']
|
|
description: Generate unit tests for one or more files in the repository.
|
|
---
|
|
|
|
# Create Unit Test(s)
|
|
|
|
You are an expert software engineer tasked with creating unit tests for the
|
|
repository. Your specific task is to generate unit tests that are clear,
|
|
concise, and useful for developers working on the project.
|
|
|
|
## Guidelines
|
|
|
|
Ensure you adhere to the following guidelines when creating unit tests:
|
|
|
|
- Use a clear and consistent format for the unit tests
|
|
- Include a summary of the functionality being tested
|
|
- Use descriptive test names that clearly convey their purpose
|
|
- Ensure tests cover both the main path of success and edge cases
|
|
- Use proper assertions to validate the expected outcomes
|
|
- Use `jest` for writing and running tests
|
|
- Place unit tests in the `__tests__` directory
|
|
- Use fixtures for any necessary test data, placed in the `__fixtures__`
|
|
directory
|
|
|
|
## Example
|
|
|
|
Use the following as an example of how to structure your unit tests:
|
|
|
|
```javascript
|
|
/**
|
|
* Unit tests for the action's main functionality, src/main.js
|
|
*/
|
|
import { jest } from '@jest/globals'
|
|
import * as core from '../__fixtures__/core.js'
|
|
import { wait } from '../__fixtures__/wait.js'
|
|
|
|
// Mocks should be declared before the module being tested is imported.
|
|
jest.unstable_mockModule('@actions/core', () => core)
|
|
jest.unstable_mockModule('../src/wait.js', () => ({ wait }))
|
|
|
|
// The module being tested should be imported dynamically. This ensures that the
|
|
// mocks are used in place of any actual dependencies.
|
|
const { run } = await import('../src/main.js')
|
|
|
|
describe('main.js', () => {
|
|
beforeEach(() => {
|
|
// Set the action's inputs as return values from core.getInput().
|
|
core.getInput.mockImplementation(() => '500')
|
|
|
|
// Mock the wait function so that it does not actually wait.
|
|
wait.mockImplementation(() => Promise.resolve('done!'))
|
|
})
|
|
|
|
afterEach(() => {
|
|
jest.resetAllMocks()
|
|
})
|
|
|
|
it('Sets the time output', async () => {
|
|
await run()
|
|
|
|
// Verify the time output was set.
|
|
expect(core.setOutput).toHaveBeenNthCalledWith(
|
|
1,
|
|
'time',
|
|
// Simple regex to match a time string in the format HH:MM:SS.
|
|
expect.stringMatching(/^\d{2}:\d{2}:\d{2}/)
|
|
)
|
|
})
|
|
|
|
it('Sets a failed status', async () => {
|
|
// Clear the getInput mock and return an invalid value.
|
|
core.getInput.mockClear().mockReturnValueOnce('this is not a number')
|
|
|
|
// Clear the wait mock and return a rejected promise.
|
|
wait
|
|
.mockClear()
|
|
.mockRejectedValueOnce(new Error('milliseconds is not a number'))
|
|
|
|
await run()
|
|
|
|
// Verify that the action was marked as failed.
|
|
expect(core.setFailed).toHaveBeenNthCalledWith(
|
|
1,
|
|
'milliseconds is not a number'
|
|
)
|
|
})
|
|
})
|
|
```
|