docs/tests/unit/actions-workflows.js

59 строки
2.1 KiB
JavaScript

import { fileURLToPath } from 'url'
import path from 'path'
import fs from 'fs'
import yaml from 'js-yaml'
import flat from 'flat'
import { chain, difference, get } from 'lodash-es'
import allowedActions from '../../.github/allowed-actions.js'
const __dirname = path.dirname(fileURLToPath(import.meta.url))
const workflowsDir = path.join(__dirname, '../../.github/workflows')
const workflows = fs
.readdirSync(workflowsDir)
.filter((filename) => filename.endsWith('.yml') || filename.endsWith('.yaml'))
.map((filename) => {
const fullpath = path.join(workflowsDir, filename)
const data = yaml.load(fs.readFileSync(fullpath, 'utf8'), { fullpath })
return { filename, fullpath, data }
})
function actionsUsedInWorkflow(workflow) {
return Object.keys(flat(workflow))
.filter((key) => key.endsWith('.uses'))
.map((key) => get(workflow, key))
}
const scheduledWorkflows = workflows
.map((workflow) => workflow.data.on.schedule)
.filter(Boolean)
.flat()
.map((schedule) => schedule.cron)
const allUsedActions = chain(workflows).map(actionsUsedInWorkflow).flatten().uniq().sort().value()
describe('GitHub Actions workflows', () => {
test('all used actions are allowed in .github/allowed-actions.js', () => {
expect(allUsedActions.length).toBeGreaterThan(0)
const unusedActions = difference(allowedActions, allUsedActions)
expect(unusedActions).toEqual([])
})
test('all allowed actions by .github/allowed-actions.js are used by at least one workflow', () => {
expect(allowedActions.length).toBeGreaterThan(0)
const disallowedActions = difference(allUsedActions, allowedActions)
expect(disallowedActions).toEqual([])
})
test('no scheduled workflows run on the hour', () => {
const hourlySchedules = scheduledWorkflows.filter((schedule) => {
const hour = schedule.split(' ')[0]
// return any minute cron segments that equal 0, 00, 000, etc.
return !/[^0]/.test(hour)
})
expect(hourlySchedules).toEqual([])
})
test('all scheduled workflows run at unique times', () => {
expect(scheduledWorkflows.length).toEqual(new Set(scheduledWorkflows).size)
})
})