mirror of
https://github.com/actions/deploy-pages.git
synced 2026-02-09 11:51:24 +00:00
282 lines
10 KiB
JavaScript
282 lines
10 KiB
JavaScript
const core = require('@actions/core')
|
|
const process = require('process')
|
|
const cp = require('child_process')
|
|
const path = require('path')
|
|
const nock = require('nock')
|
|
const axios = require('axios')
|
|
|
|
const { Deployment } = require('./deployment')
|
|
|
|
describe('with all environment variables set', () => {
|
|
beforeEach(() => {
|
|
process.env.ACTIONS_RUNTIME_URL = 'my-url'
|
|
process.env.GITHUB_RUN_ID = '123'
|
|
process.env.ACTIONS_RUNTIME_TOKEN = 'a-token'
|
|
process.env.GITHUB_REPOSITORY = 'actions/is-awesome'
|
|
process.env.GITHUB_TOKEN = 'gha-token'
|
|
process.env.GITHUB_SHA = '123abc'
|
|
process.env.GITHUB_ACTOR = 'monalisa'
|
|
process.env.GITHUB_ACTION = '__monalisa/octocat'
|
|
process.env.GITHUB_ACTION_PATH = 'something'
|
|
})
|
|
|
|
afterEach(() => {
|
|
// Remove mock for `core.getInput('preview')`
|
|
delete process.env.INPUT_PREVIEW
|
|
})
|
|
|
|
it('Executes cleanly', done => {
|
|
const ip = path.join(__dirname, './index.js')
|
|
cp.exec(`node ${ip}`, { env: process.env }, (err, stdout) => {
|
|
expect(stdout).toMatch(/::debug::all variables are set/)
|
|
done()
|
|
})
|
|
})
|
|
})
|
|
|
|
describe('with variables missing', () => {
|
|
it('execution fails if there are missing variables', done => {
|
|
delete process.env.ACTIONS_RUNTIME_URL
|
|
const ip = path.join(__dirname, './index.js')
|
|
cp.exec(`node ${ip}`, { env: process.env }, (err, stdout) => {
|
|
expect(stdout).toBe('')
|
|
expect(err).toBeTruthy()
|
|
expect(err.code).toBe(1)
|
|
done()
|
|
})
|
|
})
|
|
})
|
|
|
|
describe('create', () => {
|
|
beforeAll(() => {
|
|
process.env.ACTIONS_RUNTIME_URL = 'http://my-url/'
|
|
process.env.GITHUB_RUN_ID = '123'
|
|
process.env.ACTIONS_RUNTIME_TOKEN = 'a-token'
|
|
process.env.GITHUB_REPOSITORY = 'actions/is-awesome'
|
|
process.env.GITHUB_TOKEN = 'gha-token'
|
|
process.env.GITHUB_SHA = '123abc'
|
|
process.env.GITHUB_ACTOR = 'monalisa'
|
|
process.env.GITHUB_ACTION = '__monalisa/octocat'
|
|
process.env.GITHUB_ACTION_PATH = 'something'
|
|
jest.spyOn(core, 'getInput').mockImplementation(param => {
|
|
switch (param) {
|
|
case 'artifact_name':
|
|
return 'github-pages'
|
|
case 'token':
|
|
return process.env.GITHUB_TOKEN
|
|
default:
|
|
return process.env[`INPUT_${param.toUpperCase()}`] || ''
|
|
}
|
|
})
|
|
|
|
jest.spyOn(core, 'setOutput').mockImplementation(param => {
|
|
return param
|
|
})
|
|
|
|
jest.spyOn(core, 'setFailed').mockImplementation(param => {
|
|
return param
|
|
})
|
|
// Mock error/warning/info/debug
|
|
jest.spyOn(core, 'error').mockImplementation(jest.fn())
|
|
jest.spyOn(core, 'warning').mockImplementation(jest.fn())
|
|
jest.spyOn(core, 'info').mockImplementation(jest.fn())
|
|
jest.spyOn(core, 'debug').mockImplementation(jest.fn())
|
|
})
|
|
|
|
it('can successfully create a deployment', async () => {
|
|
process.env.GITHUB_SHA = 'valid-build-version'
|
|
const fakeJwt =
|
|
'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJiNjllMWIxOC1jOGFiLTRhZGQtOGYxOC03MzVlMzVjZGJhZjAiLCJzdWIiOiJyZXBvOnBhcGVyLXNwYS9taW55aTplbnZpcm9ubWVudDpQcm9kdWN0aW9uIiwiYXVkIjoiaHR0cHM6Ly9naXRodWIuY29tL3BhcGVyLXNwYSIsInJlZiI6InJlZnMvaGVhZHMvbWFpbiIsInNoYSI6ImEyODU1MWJmODdiZDk3NTFiMzdiMmM0YjM3M2MxZjU3NjFmYWM2MjYiLCJyZXBvc2l0b3J5IjoicGFwZXItc3BhL21pbnlpIiwicmVwb3NpdG9yeV9vd25lciI6InBhcGVyLXNwYSIsInJ1bl9pZCI6IjE1NDY0NTkzNjQiLCJydW5fbnVtYmVyIjoiMzQiLCJydW5fYXR0ZW1wdCI6IjIiLCJhY3RvciI6IllpTXlzdHkiLCJ3b3JrZmxvdyI6IkNJIiwiaGVhZF9yZWYiOiIiLCJiYXNlX3JlZiI6IiIsImV2ZW50X25hbWUiOiJwdXNoIiwicmVmX3R5cGUiOiJicmFuY2giLCJlbnZpcm9ubWVudCI6IlByb2R1Y3Rpb24iLCJqb2Jfd29ya2Zsb3dfcmVmIjoicGFwZXItc3BhL21pbnlpLy5naXRodWIvd29ya2Zsb3dzL2JsYW5rLnltbEByZWZzL2hlYWRzL21haW4iLCJpc3MiOiJodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tIiwibmJmIjoxNjM4ODI4MDI4LCJleHAiOjE2Mzg4Mjg5MjgsImlhdCI6MTYzODgyODYyOH0.1wyupfxu1HGoTyIqatYg0hIxy2-0bMO-yVlmLSMuu2w'
|
|
const scope = nock(`http://my-url`)
|
|
.get('/_apis/pipelines/workflows/123/artifacts?api-version=6.0-preview')
|
|
.reply(200, {
|
|
value: [
|
|
{ url: 'https://another-artifact.com', name: 'another-artifact' },
|
|
{ url: 'https://fake-artifact.com', name: 'github-pages' }
|
|
]
|
|
})
|
|
|
|
core.getIDToken = jest.fn().mockResolvedValue(fakeJwt)
|
|
axios.post = jest.fn().mockResolvedValue('test')
|
|
|
|
// Create the deployment
|
|
const deployment = new Deployment()
|
|
await deployment.create(fakeJwt)
|
|
|
|
expect(axios.post).toBeCalledWith(
|
|
'https://api.github.com/repos/actions/is-awesome/pages/deployment',
|
|
{
|
|
artifact_url: 'https://fake-artifact.com&%24expand=SignedContent',
|
|
pages_build_version: 'valid-build-version',
|
|
oidc_token: fakeJwt
|
|
},
|
|
{
|
|
headers: {
|
|
Accept: 'application/vnd.github.v3+json',
|
|
Authorization: `Bearer gha-token`,
|
|
'Content-type': 'application/json'
|
|
}
|
|
}
|
|
)
|
|
|
|
expect(core.setFailed).not.toHaveBeenCalled()
|
|
expect(core.info).toHaveBeenCalledWith('Created deployment for valid-build-version')
|
|
|
|
scope.done()
|
|
})
|
|
|
|
it('can successfully create a preview deployment', async () => {
|
|
process.env.GITHUB_SHA = 'valid-build-version'
|
|
const fakeJwt =
|
|
'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJiNjllMWIxOC1jOGFiLTRhZGQtOGYxOC03MzVlMzVjZGJhZjAiLCJzdWIiOiJyZXBvOnBhcGVyLXNwYS9taW55aTplbnZpcm9ubWVudDpQcm9kdWN0aW9uIiwiYXVkIjoiaHR0cHM6Ly9naXRodWIuY29tL3BhcGVyLXNwYSIsInJlZiI6InJlZnMvaGVhZHMvbWFpbiIsInNoYSI6ImEyODU1MWJmODdiZDk3NTFiMzdiMmM0YjM3M2MxZjU3NjFmYWM2MjYiLCJyZXBvc2l0b3J5IjoicGFwZXItc3BhL21pbnlpIiwicmVwb3NpdG9yeV9vd25lciI6InBhcGVyLXNwYSIsInJ1bl9pZCI6IjE1NDY0NTkzNjQiLCJydW5fbnVtYmVyIjoiMzQiLCJydW5fYXR0ZW1wdCI6IjIiLCJhY3RvciI6IllpTXlzdHkiLCJ3b3JrZmxvdyI6IkNJIiwiaGVhZF9yZWYiOiIiLCJiYXNlX3JlZiI6IiIsImV2ZW50X25hbWUiOiJwdXNoIiwicmVmX3R5cGUiOiJicmFuY2giLCJlbnZpcm9ubWVudCI6IlByb2R1Y3Rpb24iLCJqb2Jfd29ya2Zsb3dfcmVmIjoicGFwZXItc3BhL21pbnlpLy5naXRodWIvd29ya2Zsb3dzL2JsYW5rLnltbEByZWZzL2hlYWRzL21haW4iLCJpc3MiOiJodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tIiwibmJmIjoxNjM4ODI4MDI4LCJleHAiOjE2Mzg4Mjg5MjgsImlhdCI6MTYzODgyODYyOH0.1wyupfxu1HGoTyIqatYg0hIxy2-0bMO-yVlmLSMuu2w'
|
|
const scope = nock(`http://my-url`)
|
|
.get('/_apis/pipelines/workflows/123/artifacts?api-version=6.0-preview')
|
|
.reply(200, {
|
|
value: [
|
|
{ url: 'https://another-artifact.com', name: 'another-artifact' },
|
|
{ url: 'https://fake-artifact.com', name: 'github-pages' }
|
|
]
|
|
})
|
|
|
|
core.getIDToken = jest.fn().mockResolvedValue(fakeJwt)
|
|
axios.post = jest.fn().mockResolvedValue('test')
|
|
|
|
// Return `"true"` for `core.getInput("preview")`
|
|
process.env.INPUT_PREVIEW = 'true'
|
|
|
|
// Create the deployment
|
|
const deployment = new Deployment()
|
|
await deployment.create(fakeJwt)
|
|
|
|
expect(axios.post).toBeCalledWith(
|
|
'https://api.github.com/repos/actions/is-awesome/pages/deployment',
|
|
{
|
|
artifact_url: 'https://fake-artifact.com&%24expand=SignedContent',
|
|
pages_build_version: 'valid-build-version',
|
|
oidc_token: fakeJwt,
|
|
preview: true
|
|
},
|
|
{
|
|
headers: {
|
|
Accept: 'application/vnd.github.v3+json',
|
|
Authorization: `Bearer gha-token`,
|
|
'Content-type': 'application/json'
|
|
}
|
|
}
|
|
)
|
|
|
|
expect(core.setFailed).not.toHaveBeenCalled()
|
|
expect(core.info).toHaveBeenCalledWith('Created deployment for valid-build-version')
|
|
|
|
scope.done()
|
|
})
|
|
|
|
it('Reports errors with failed deployments', async () => {
|
|
process.env.GITHUB_SHA = 'invalid-build-version'
|
|
const scope = nock(`http://my-url`)
|
|
.get('/_apis/pipelines/workflows/123/artifacts?api-version=6.0-preview')
|
|
.reply(200, { value: [{ url: 'https://invalid-artifact.com', name: 'github-pages' }] })
|
|
|
|
axios.post = jest.fn().mockRejectedValue({
|
|
status: 400
|
|
})
|
|
|
|
// Create the deployment
|
|
const deployment = new Deployment()
|
|
try {
|
|
deployment.create()
|
|
} catch (err) {
|
|
expect(axios.post).toBeCalledWith(
|
|
'https://api.github.com/repos/actions/is-awesome/pages/deployment',
|
|
{
|
|
artifact_url: 'https://invalid-artifact.com&%24expand=SignedContent',
|
|
pages_build_version: 'invalid-build-version'
|
|
},
|
|
{
|
|
headers: {
|
|
Accept: 'application/vnd.github.v3+json',
|
|
Authorization: 'Bearer ',
|
|
'Content-type': 'application/json'
|
|
}
|
|
}
|
|
)
|
|
|
|
expect(core.info).toHaveBeenLastCalledWith('Failed to create deployment for invalid-build-version.')
|
|
expect(core.setFailed).toHaveBeenCalledWith({ status: 400 })
|
|
|
|
scope.done()
|
|
}
|
|
})
|
|
})
|
|
|
|
describe('check', () => {
|
|
beforeAll(() => {
|
|
process.env.ACTIONS_RUNTIME_URL = 'http://my-url/'
|
|
process.env.GITHUB_RUN_ID = '123'
|
|
process.env.ACTIONS_RUNTIME_TOKEN = 'a-token'
|
|
process.env.GITHUB_REPOSITORY = 'actions/is-awesome'
|
|
process.env.GITHUB_TOKEN = 'gha-token'
|
|
process.env.GITHUB_SHA = '123abc'
|
|
process.env.GITHUB_ACTOR = 'monalisa'
|
|
process.env.GITHUB_ACTION = '__monalisa/octocat'
|
|
process.env.GITHUB_ACTION_PATH = 'something'
|
|
process.env.ARTIFACT_NAME = 'github-pages'
|
|
|
|
jest.spyOn(core, 'setOutput').mockImplementation(param => {
|
|
return param
|
|
})
|
|
|
|
jest.spyOn(core, 'setFailed').mockImplementation(param => {
|
|
return param
|
|
})
|
|
// Mock error/warning/info/debug
|
|
jest.spyOn(core, 'error').mockImplementation(jest.fn())
|
|
jest.spyOn(core, 'warning').mockImplementation(jest.fn())
|
|
jest.spyOn(core, 'info').mockImplementation(jest.fn())
|
|
jest.spyOn(core, 'debug').mockImplementation(jest.fn())
|
|
})
|
|
|
|
it('sets output to success when deployment is successful', async () => {
|
|
process.env.GITHUB_SHA = 'valid-build-version'
|
|
let repositoryNwo = process.env.GITHUB_REPOSITORY
|
|
let buildVersion = process.env.GITHUB_SHA
|
|
|
|
// mock a successful call to create a deployment
|
|
axios.post = jest.fn().mockResolvedValue({ status: 200 })
|
|
|
|
// mock a completed deployment with status = 'succeed'
|
|
axios.get = jest.fn().mockResolvedValue({
|
|
status: 200,
|
|
data: {
|
|
status: 'succeed'
|
|
}
|
|
})
|
|
|
|
// Create the deployment
|
|
const deployment = new Deployment()
|
|
core.GetInput = jest.fn(input => {
|
|
switch (input) {
|
|
case 'timeout':
|
|
return 10 * 1000
|
|
case 'reporting_interval':
|
|
return 0
|
|
}
|
|
})
|
|
jest.spyOn(core, 'getInput')
|
|
await deployment.check()
|
|
|
|
expect(axios.get).toBeCalledWith(
|
|
`https://api.github.com/repos/${repositoryNwo}/pages/deployment/status/${buildVersion}`,
|
|
{
|
|
headers: {
|
|
Authorization: 'token gha-token'
|
|
}
|
|
}
|
|
)
|
|
|
|
expect(core.setOutput).toBeCalledWith('status', 'succeed')
|
|
|
|
expect(core.info).toHaveBeenCalledWith('Reported success!')
|
|
})
|
|
})
|