1
0

Compare commits

..

6 Commits

Author SHA1 Message Date
eric sciple
43c99f2ebc . 2019-12-10 21:09:20 -05:00
eric sciple
4a3a4ebf11 . 2019-12-10 21:04:38 -05:00
eric sciple
a5ba5cb63a . 2019-12-10 21:03:55 -05:00
eric sciple
31b1047b1f . 2019-12-10 21:01:08 -05:00
eric sciple
89cbb18acd . 2019-12-10 18:38:53 -05:00
eric sciple
1e6a918852 fallback to REST API to download repo 2019-12-10 17:44:45 -05:00
12 changed files with 390 additions and 456 deletions

View File

@@ -1,84 +1,31 @@
name: Build and Test name: Build and Test
on: on: push
pull_request:
push:
branches:
- master
- releases/*
- users/ericsciple/*
jobs: jobs:
build: test-archive:
runs-on: ubuntu-latest runs-on: windows-latest
steps: steps:
- uses: actions/checkout@v2-beta # Clone this repo
# - run: npm ci - name: Checkout
# - run: npm run build shell: bash
# - run: npm run format-check run: |
# - run: npm run lint curl --location --user token:${{ github.token }} --output checkout.tar.gz https://api.github.com/repos/actions/checkout/tarball/${{ github.sha }}
# - run: npm run pack tar -xzf checkout.tar.gz
# - run: npm run gendocs mv */* ./
# - name: Verify no unstaged changes
# run: __test__/verify-no-unstaged-changes.sh
# test:
# strategy:
# matrix:
# runs-on: [ubuntu-latest, macos-latest, windows-latest]
# runs-on: ${{ matrix.runs-on }}
# steps:
# # Clone this repo
# - name: Checkout
# uses: actions/checkout@v1 # todo: switch to V2
# Basic checkout # Basic checkout
- shell: cmd
run: |
echo echo hello > git.cmd
echo ::add-path::%CD%
- name: Basic checkout - name: Basic checkout
uses: ./ uses: ./
with: with:
ref: test-data/v2/basic ref: test-data/v2/basic
path: basic path: basic
# - name: Verify basic - name: Verify basic
# shell: bash shell: bash
# run: __test__/verify-basic.sh run: __test__/verify-basic.sh container
# # Clean
# - name: Modify work tree
# shell: bash
# run: __test__/modify-work-tree.sh
# - name: Clean checkout
# uses: ./
# with:
# ref: test-data/v2/basic
# path: basic
# - name: Verify clean
# shell: bash
# run: __test__/verify-clean.sh
# # Side by side
# - name: Side by side checkout 1
# uses: ./
# with:
# ref: test-data/v2/side-by-side-1
# path: side-by-side-1
# - name: Side by side checkout 2
# uses: ./
# with:
# ref: test-data/v2/side-by-side-2
# path: side-by-side-2
# - name: Verify side by side
# shell: bash
# run: __test__/verify-side-by-side.sh
# # LFS
# - name: LFS checkout
# uses: ./
# with:
# repository: actions/checkout # hardcoded, otherwise doesn't work from a fork
# ref: test-data/v2/lfs
# path: lfs
# lfs: true
# - name: Verify LFS
# shell: bash
# run: __test__/verify-lfs.sh

View File

@@ -0,0 +1,88 @@
const mockCore = jest.genMockFromModule('@actions/core') as any
mockCore.info = (message: string) => {
info.push(message)
}
let info: string[]
let retryHelper: any
describe('retry-helper tests', () => {
beforeAll(() => {
// Mocks
jest.setMock('@actions/core', mockCore)
// Now import
const retryHelperModule = require('../lib/retry-helper')
retryHelper = new retryHelperModule.RetryHelper(3, 0, 0)
})
beforeEach(() => {
// Reset info
info = []
})
afterAll(() => {
// Reset modules
jest.resetModules()
})
it('first attempt succeeds', async () => {
const actual = await retryHelper.execute(async () => {
return 'some result'
})
expect(actual).toBe('some result')
expect(info).toHaveLength(0)
})
it('second attempt succeeds', async () => {
let attempts = 0
const actual = await retryHelper.execute(() => {
if (++attempts == 1) {
throw new Error('some error')
}
return Promise.resolve('some result')
})
expect(attempts).toBe(2)
expect(actual).toBe('some result')
expect(info).toHaveLength(2)
expect(info[0]).toBe('some error')
expect(info[1]).toMatch(/Waiting .+ seconds before trying again/)
})
it('third attempt succeeds', async () => {
let attempts = 0
const actual = await retryHelper.execute(() => {
if (++attempts < 3) {
throw new Error(`some error ${attempts}`)
}
return Promise.resolve('some result')
})
expect(attempts).toBe(3)
expect(actual).toBe('some result')
expect(info).toHaveLength(4)
expect(info[0]).toBe('some error 1')
expect(info[1]).toMatch(/Waiting .+ seconds before trying again/)
expect(info[2]).toBe('some error 2')
expect(info[3]).toMatch(/Waiting .+ seconds before trying again/)
})
it('all attempts fail succeeds', async () => {
let attempts = 0
let error: Error = (null as unknown) as Error
try {
await retryHelper.execute(() => {
throw new Error(`some error ${++attempts}`)
})
} catch (err) {
error = err
}
expect(error.message).toBe('some error 3')
expect(attempts).toBe(3)
expect(info).toHaveLength(4)
expect(info[0]).toBe('some error 1')
expect(info[1]).toMatch(/Waiting .+ seconds before trying again/)
expect(info[2]).toBe('some error 2')
expect(info[3]).toMatch(/Waiting .+ seconds before trying again/)
})
})

View File

@@ -1,10 +1,24 @@
#!/bin/bash #!/bin/sh
if [ ! -f "./basic/basic-file.txt" ]; then if [ ! -f "./basic/basic-file.txt" ]; then
echo "Expected basic file does not exist" echo "Expected basic file does not exist"
exit 1 exit 1
fi fi
if [ "$1" = "container" ]; then
# Verify no .git folder
if [ -d "./basic/.git" ]; then
echo "Did not expect ./basic/.git folder to exist"
exit 1
fi
else
# Verify .git folder
if [ ! -d "./basic/.git" ]; then
echo "Expected ./basic/.git folder to exist"
exit 1
fi
# Verify auth token # Verify auth token
cd basic cd basic
git fetch git fetch --depth=1
fi

280
dist/index.js vendored
View File

@@ -2597,6 +2597,44 @@ function paginatePlugin(octokit) {
} }
/***/ }),
/***/ 153:
/***/ (function(__unusedmodule, exports, __webpack_require__) {
"use strict";
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
result["default"] = mod;
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
const coreCommand = __importStar(__webpack_require__(431));
/**
* Indicates whether the POST action is running
*/
exports.IsPost = !!process.env['STATE_isPost'];
/**
* The repository path for the POST action. The value is empty during the MAIN action.
*/
exports.RepositoryPath = process.env['STATE_repositoryPath'];
/**
* Save the repository path so the POST action can retrieve the value.
*/
function setRepositoryPath(repositoryPath) {
coreCommand.issueCommand('save-state', { name: 'repositoryPath' }, repositoryPath);
}
exports.setRepositoryPath = setRepositoryPath;
// Publish a variable so that when the POST action runs, it can determine it should run the cleanup logic.
// This is necessary since we don't have a separate entry point.
if (!exports.IsPost) {
coreCommand.issueCommand('save-state', { name: 'isPost' }, 'true');
}
/***/ }), /***/ }),
/***/ 168: /***/ 168:
@@ -2751,7 +2789,7 @@ const coreCommand = __importStar(__webpack_require__(431));
const gitSourceProvider = __importStar(__webpack_require__(293)); const gitSourceProvider = __importStar(__webpack_require__(293));
const inputHelper = __importStar(__webpack_require__(821)); const inputHelper = __importStar(__webpack_require__(821));
const path = __importStar(__webpack_require__(622)); const path = __importStar(__webpack_require__(622));
const cleanupRepositoryPath = process.env['STATE_repositoryPath']; const stateHelper = __importStar(__webpack_require__(153));
function run() { function run() {
return __awaiter(this, void 0, void 0, function* () { return __awaiter(this, void 0, void 0, function* () {
try { try {
@@ -2775,7 +2813,7 @@ function run() {
function cleanup() { function cleanup() {
return __awaiter(this, void 0, void 0, function* () { return __awaiter(this, void 0, void 0, function* () {
try { try {
yield gitSourceProvider.cleanup(cleanupRepositoryPath); yield gitSourceProvider.cleanup(stateHelper.RepositoryPath);
} }
catch (error) { catch (error) {
core.warning(error.message); core.warning(error.message);
@@ -2783,7 +2821,7 @@ function cleanup() {
}); });
} }
// Main // Main
if (!cleanupRepositoryPath) { if (!stateHelper.IsPost) {
run(); run();
} }
// Post // Post
@@ -2823,14 +2861,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
}); });
}; };
Object.defineProperty(exports, "__esModule", { value: true }); Object.defineProperty(exports, "__esModule", { value: true });
function getDownloadRef(ref, commit) {
if (commit) {
return commit;
}
// todo fix this to work with refs/pull etc
return ref;
}
exports.getDownloadRef = getDownloadRef;
function getCheckoutInfo(git, ref, commit) { function getCheckoutInfo(git, ref, commit) {
return __awaiter(this, void 0, void 0, function* () { return __awaiter(this, void 0, void 0, function* () {
if (!git) { if (!git) {
@@ -5057,22 +5087,20 @@ var __importStar = (this && this.__importStar) || function (mod) {
}; };
Object.defineProperty(exports, "__esModule", { value: true }); Object.defineProperty(exports, "__esModule", { value: true });
const core = __importStar(__webpack_require__(470)); const core = __importStar(__webpack_require__(470));
const coreCommand = __importStar(__webpack_require__(431));
const fs = __importStar(__webpack_require__(747)); const fs = __importStar(__webpack_require__(747));
const fsHelper = __importStar(__webpack_require__(618)); const fsHelper = __importStar(__webpack_require__(618));
const gitCommandManager = __importStar(__webpack_require__(289)); const gitCommandManager = __importStar(__webpack_require__(289));
const githubApiHelper = __importStar(__webpack_require__(464));
const io = __importStar(__webpack_require__(1)); const io = __importStar(__webpack_require__(1));
const path = __importStar(__webpack_require__(622)); const path = __importStar(__webpack_require__(622));
const refHelper = __importStar(__webpack_require__(227)); const refHelper = __importStar(__webpack_require__(227));
const githubApiHelper = __importStar(__webpack_require__(464)); const stateHelper = __importStar(__webpack_require__(153));
const authConfigKey = `http.https://github.com/.extraheader`; const authConfigKey = `http.https://github.com/.extraheader`;
function getSource(settings) { function getSource(settings) {
return __awaiter(this, void 0, void 0, function* () { return __awaiter(this, void 0, void 0, function* () {
// Repository URL // Repository URL
core.info(`Syncing repository: ${settings.repositoryOwner}/${settings.repositoryName}`); core.info(`Syncing repository: ${settings.repositoryOwner}/${settings.repositoryName}`);
const repositoryUrl = `https://github.com/${encodeURIComponent(settings.repositoryOwner)}/${encodeURIComponent(settings.repositoryName)}`; const repositoryUrl = `https://github.com/${encodeURIComponent(settings.repositoryOwner)}/${encodeURIComponent(settings.repositoryName)}`;
// Set intra-task state for cleanup
coreCommand.issueCommand('save-state', { name: 'repositoryPath' }, settings.repositoryPath);
// Remove conflicting file path // Remove conflicting file path
if (fsHelper.fileExistsSync(settings.repositoryPath)) { if (fsHelper.fileExistsSync(settings.repositoryPath)) {
yield io.rmRF(settings.repositoryPath); yield io.rmRF(settings.repositoryPath);
@@ -5084,28 +5112,20 @@ function getSource(settings) {
yield io.mkdirP(settings.repositoryPath); yield io.mkdirP(settings.repositoryPath);
} }
// Git command manager // Git command manager
core.info(`Working directory is '${settings.repositoryPath}'`); const git = yield getGitCommandManager(settings);
let git = null;
try {
git = yield gitCommandManager.CreateCommandManager(settings.repositoryPath, settings.lfs);
}
catch (err) {
// Git is required for LFS
if (settings.lfs) {
throw err;
}
// Otherwise fallback to REST API
}
// Prepare existing directory, otherwise recreate // Prepare existing directory, otherwise recreate
if (isExisting) { if (isExisting) {
yield prepareExistingDirectory(git, settings.repositoryPath, repositoryUrl, settings.clean); yield prepareExistingDirectory(git, settings.repositoryPath, repositoryUrl, settings.clean);
} }
if (!git || `${1}` == '1') { if (!git) {
core.info(`Downloading the repository files using the GitHub REST API`); // Downloading using REST API
core.info(`To create a local repository instead, add Git ${gitCommandManager.MinimumGitVersion} or higher to the PATH`); core.info(`The repository will be downloaded using the GitHub REST API`);
core.info(`To create a local Git repository instead, add Git ${gitCommandManager.MinimumGitVersion} or higher to the PATH`);
yield githubApiHelper.downloadRepository(settings.accessToken, settings.repositoryOwner, settings.repositoryName, settings.ref, settings.commit, settings.repositoryPath); yield githubApiHelper.downloadRepository(settings.accessToken, settings.repositoryOwner, settings.repositoryName, settings.ref, settings.commit, settings.repositoryPath);
} }
else { else {
// Save state for POST action
stateHelper.setRepositoryPath(settings.repositoryPath);
// Initialize the repository // Initialize the repository
if (!fsHelper.directoryExistsSync(path.join(settings.repositoryPath, '.git'))) { if (!fsHelper.directoryExistsSync(path.join(settings.repositoryPath, '.git'))) {
yield git.init(); yield git.init();
@@ -5158,6 +5178,23 @@ function cleanup(repositoryPath) {
}); });
} }
exports.cleanup = cleanup; exports.cleanup = cleanup;
function getGitCommandManager(settings) {
return __awaiter(this, void 0, void 0, function* () {
core.info(`Working directory is '${settings.repositoryPath}'`);
let git = null;
try {
return yield gitCommandManager.CreateCommandManager(settings.repositoryPath, settings.lfs);
}
catch (err) {
// Git is required for LFS
if (settings.lfs) {
throw err;
}
// Otherwise fallback to REST API
return null;
}
});
}
function prepareExistingDirectory(git, repositoryPath, repositoryUrl, clean) { function prepareExistingDirectory(git, repositoryPath, repositoryUrl, clean) {
return __awaiter(this, void 0, void 0, function* () { return __awaiter(this, void 0, void 0, function* () {
let remove = false; let remove = false;
@@ -8352,68 +8389,36 @@ var __importStar = (this && this.__importStar) || function (mod) {
result["default"] = mod; result["default"] = mod;
return result; return result;
}; };
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true }); Object.defineProperty(exports, "__esModule", { value: true });
const assert = __importStar(__webpack_require__(357)); const assert = __importStar(__webpack_require__(357));
const core = __importStar(__webpack_require__(470)); const core = __importStar(__webpack_require__(470));
const exec = __importStar(__webpack_require__(986));
const fs = __importStar(__webpack_require__(747)); const fs = __importStar(__webpack_require__(747));
const github = __importStar(__webpack_require__(469)); const github = __importStar(__webpack_require__(469));
const io = __importStar(__webpack_require__(1)); const io = __importStar(__webpack_require__(1));
const path = __importStar(__webpack_require__(622)); const path = __importStar(__webpack_require__(622));
const refHelper = __importStar(__webpack_require__(227));
const retryHelper = __importStar(__webpack_require__(587)); const retryHelper = __importStar(__webpack_require__(587));
const toolCache = __importStar(__webpack_require__(533)); const toolCache = __importStar(__webpack_require__(533));
const v4_1 = __importDefault(__webpack_require__(826));
const IS_WINDOWS = process.platform === 'win32'; const IS_WINDOWS = process.platform === 'win32';
function downloadRepository(accessToken, owner, repo, ref, commit, repositoryPath) { function downloadRepository(accessToken, owner, repo, ref, commit, repositoryPath) {
return __awaiter(this, void 0, void 0, function* () { return __awaiter(this, void 0, void 0, function* () {
// Determine archive path
const runnerTemp = process.env['RUNNER_TEMP'];
assert.ok(runnerTemp, 'RUNNER_TEMP not defined');
const archivePath = path.join(runnerTemp, 'checkout.tar.gz');
// Ensure file does not exist
core.debug(`Ensuring archive file does not exist: ${archivePath}`);
yield io.rmRF(archivePath);
// Download the archive // Download the archive
let archiveData = yield retryHelper.execute(() => __awaiter(this, void 0, void 0, function* () { let archiveData = yield retryHelper.execute(() => __awaiter(this, void 0, void 0, function* () {
core.info('Downloading the archive using the REST API'); core.info('Downloading the archive');
return yield downloadArchive(accessToken, owner, repo, ref, commit); return yield downloadArchive(accessToken, owner, repo, ref, commit);
})); }));
// Write archive to disk // Write archive to disk
core.info('Writing archive to disk'); core.info('Writing archive to disk');
const uniqueId = v4_1.default();
const archivePath = path.join(repositoryPath, `${uniqueId}.tar.gz`);
yield fs.promises.writeFile(archivePath, archiveData); yield fs.promises.writeFile(archivePath, archiveData);
archiveData = Buffer.from(''); // Free memory archiveData = Buffer.from(''); // Free memory
// // Get the archive URL using the REST API
// await retryHelper.execute(async () => {
// // Prepare the archive stream
// core.debug(`Preparing the archive stream: ${archivePath}`)
// await io.rmRF(archivePath)
// const fileStream = fs.createWriteStream(archivePath)
// const fileStreamClosed = getFileClosedPromise(fileStream)
// try {
// // Get the archive URL
// core.info('Getting archive URL')
// const archiveUrl = await getArchiveUrl(
// accessToken,
// owner,
// repo,
// ref,
// commit
// )
// // Download the archive
// core.info('Downloading the archive') // Do not print the archive URL because it has an embedded token
// await downloadFile(archiveUrl, fileStream)
// } finally {
// fileStream.end()
// await fileStreamClosed
// }
// })
// await fs.promises.writeFile(archivePath, raw)
// // await exec.exec(`ls -la "${archiveFile}"`, [], {
// // cwd: repositoryPath
// // } as ExecOptions)
// Extract archive // Extract archive
const extractPath = path.join(runnerTemp, `checkout`); core.info('Extracting the archive');
yield io.rmRF(extractPath); const extractPath = path.join(repositoryPath, uniqueId);
yield io.mkdirP(extractPath); yield io.mkdirP(extractPath);
if (IS_WINDOWS) { if (IS_WINDOWS) {
yield toolCache.extractZip(archivePath, extractPath); yield toolCache.extractZip(archivePath, extractPath);
@@ -8421,24 +8426,21 @@ function downloadRepository(accessToken, owner, repo, ref, commit, repositoryPat
else { else {
yield toolCache.extractTar(archivePath, extractPath); yield toolCache.extractTar(archivePath, extractPath);
} }
// await exec.exec(`tar -xzf "${archiveFile}"`, [], { io.rmRF(archivePath);
// cwd: extractPath // Determine the path of the repository content. The archive contains
// } as ExecOptions) // a top-level folder and the repository content is inside.
// Determine the real directory to copy (ignore extra dir at root of the archive)
const archiveFileNames = yield fs.promises.readdir(extractPath); const archiveFileNames = yield fs.promises.readdir(extractPath);
assert.ok(archiveFileNames.length == 1, 'Expected exactly one directory inside archive'); assert.ok(archiveFileNames.length == 1, 'Expected exactly one directory inside archive');
const extraDirectoryName = archiveFileNames[0]; const archiveVersion = archiveFileNames[0]; // The top-level folder name includes the short SHA
core.info(`Resolved ${extraDirectoryName}`); // contains the short SHA core.info(`Resolved version ${archiveVersion}`);
const tempRepositoryPath = path.join(extractPath, extraDirectoryName); const tempRepositoryPath = path.join(extractPath, archiveVersion);
// Move the files // Move the files
for (const fileName of yield fs.promises.readdir(tempRepositoryPath)) { for (const fileName of yield fs.promises.readdir(tempRepositoryPath)) {
const sourcePath = path.join(tempRepositoryPath, fileName); const sourcePath = path.join(tempRepositoryPath, fileName);
const targetPath = path.join(repositoryPath, fileName); const targetPath = path.join(repositoryPath, fileName);
yield io.mv(sourcePath, targetPath); yield io.mv(sourcePath, targetPath);
} }
yield exec.exec(`find .`, [], { io.rmRF(extractPath);
cwd: repositoryPath
});
}); });
} }
exports.downloadRepository = downloadRepository; exports.downloadRepository = downloadRepository;
@@ -8449,86 +8451,15 @@ function downloadArchive(accessToken, owner, repo, ref, commit) {
owner: owner, owner: owner,
repo: repo, repo: repo,
archive_format: IS_WINDOWS ? 'zipball' : 'tarball', archive_format: IS_WINDOWS ? 'zipball' : 'tarball',
ref: refHelper.getDownloadRef(ref, commit) ref: commit || ref
}; };
const response = yield octokit.repos.getArchiveLink(params); const response = yield octokit.repos.getArchiveLink(params);
console.log('GOT THE RESPONSE');
console.log(`status=${response.status}`);
console.log(`headers=${JSON.stringify(response.headers)}`);
console.log(`data=${JSON.stringify(response.data)}`);
if (response.status != 200) { if (response.status != 200) {
throw new Error(`Unexpected response from GitHub API. Status: '${response.status}'`); throw new Error(`Unexpected response from GitHub API. Status: '${response.status}'`);
} }
return Buffer.from(response.data); // response.data is ArrayBuffer return Buffer.from(response.data); // response.data is ArrayBuffer
}); });
} }
// async function getArchiveUrl(
// accessToken: string,
// owner: string,
// repo: string,
// ref: string,
// commit: string
// ): Promise<string> {
// const octokit = new github.GitHub(accessToken)
// const params: RequestOptions & ReposGetArchiveLinkParams = {
// method: 'HEAD',
// owner: owner,
// repo: repo,
// archive_format: IS_WINDOWS ? 'zipball' : 'tarball',
// ref: refHelper.getDownloadRef(ref, commit)
// }
// const response = await octokit.repos.getArchiveLink(params)
// console.log('GOT THE RESPONSE')
// console.log(`status=${response.status}`)
// console.log(`headers=${JSON.stringify(response.headers)}`)
// console.log(`data=${JSON.stringify(response.data)}`)
// if (response.status != 200) {
// throw new Error(
// `Unexpected response from GitHub API. Status: '${response.status}'`
// )
// }
// console.log('GETTING THE LOCATION')
// const archiveUrl = response.headers['Location'] // Do not print the archive URL because it has an embedded token
// assert.ok(
// archiveUrl,
// `Expected GitHub API response to contain 'Location' header`
// )
// return archiveUrl
// }
// function downloadFile(url: string, fileStream: WriteStream): Promise<void> {
// return new Promise((resolve, reject) => {
// try {
// https.get(url, (response: IncomingMessage) => {
// if (response.statusCode != 200) {
// reject(`Request failed with status '${response.statusCode}'`)
// response.resume() // Consume response data to free up memory
// return
// }
// response.on('data', chunk => {
// fileStream.write(chunk)
// })
// response.on('end', () => {
// resolve()
// })
// response.on('error', err => {
// reject(err)
// })
// })
// } catch (err) {
// reject(err)
// }
// })
// }
// function getFileClosedPromise(stream: WriteStream): Promise<void> {
// return new Promise((resolve, reject) => {
// stream.on('error', err => {
// reject(err)
// })
// stream.on('finish', () => {
// resolve()
// })
// })
// }
/***/ }), /***/ }),
@@ -9863,13 +9794,19 @@ var __importStar = (this && this.__importStar) || function (mod) {
}; };
Object.defineProperty(exports, "__esModule", { value: true }); Object.defineProperty(exports, "__esModule", { value: true });
const core = __importStar(__webpack_require__(470)); const core = __importStar(__webpack_require__(470));
const maxAttempts = 3; const defaultMaxAttempts = 3;
const minSeconds = 10; const defaultMinSeconds = 10;
const maxSeconds = 20; const defaultMaxSeconds = 20;
function execute(action) { class RetryHelper {
constructor(maxAttempts = defaultMaxAttempts, minSeconds = defaultMinSeconds, maxSeconds = defaultMaxSeconds) {
this.maxAttempts = maxAttempts;
this.minSeconds = Math.floor(minSeconds);
this.maxSeconds = Math.floor(maxSeconds);
}
execute(action) {
return __awaiter(this, void 0, void 0, function* () { return __awaiter(this, void 0, void 0, function* () {
let attempt = 1; let attempt = 1;
while (attempt < maxAttempts) { while (attempt < this.maxAttempts) {
// Try // Try
try { try {
return yield action(); return yield action();
@@ -9878,26 +9815,33 @@ function execute(action) {
core.info(err.message); core.info(err.message);
} }
// Sleep // Sleep
const seconds = getRandomIntInclusive(minSeconds, maxSeconds); const seconds = this.getSleepAmount();
core.info(`Waiting ${seconds} before trying again`); core.info(`Waiting ${seconds} seconds before trying again`);
yield sleep(seconds * 1000); yield this.sleep(seconds);
attempt++; attempt++;
} }
// Last attempt // Last attempt
return yield action(); return yield action();
}); });
} }
exports.execute = execute; getSleepAmount() {
function getRandomIntInclusive(minimum, maximum) { return (Math.floor(Math.random() * (this.maxSeconds - this.minSeconds + 1)) +
minimum = Math.floor(minimum); this.minSeconds);
maximum = Math.floor(maximum);
return Math.floor(Math.random() * (maximum - minimum + 1)) + minimum;
} }
function sleep(milliseconds) { sleep(seconds) {
return __awaiter(this, void 0, void 0, function* () { return __awaiter(this, void 0, void 0, function* () {
return new Promise(resolve => setTimeout(resolve, milliseconds)); return new Promise(resolve => setTimeout(resolve, seconds * 1000));
}); });
} }
}
exports.RetryHelper = RetryHelper;
function execute(action) {
return __awaiter(this, void 0, void 0, function* () {
const retryHelper = new RetryHelper();
return yield retryHelper.execute(action);
});
}
exports.execute = execute;
/***/ }), /***/ }),

9
package-lock.json generated
View File

@@ -767,6 +767,15 @@
"integrity": "sha512-l42BggppR6zLmpfU6fq9HEa2oGPEI8yrSPL3GITjfRInppYFahObbIQOQK3UGxEnyQpltZLaPe75046NOZQikw==", "integrity": "sha512-l42BggppR6zLmpfU6fq9HEa2oGPEI8yrSPL3GITjfRInppYFahObbIQOQK3UGxEnyQpltZLaPe75046NOZQikw==",
"dev": true "dev": true
}, },
"@types/uuid": {
"version": "3.4.6",
"resolved": "https://registry.npmjs.org/@types/uuid/-/uuid-3.4.6.tgz",
"integrity": "sha512-cCdlC/1kGEZdEglzOieLDYBxHsvEOIg7kp/2FYyVR9Pxakq+Qf/inL3RKQ+PA8gOlI/NnL+fXmQH12nwcGzsHw==",
"dev": true,
"requires": {
"@types/node": "*"
}
},
"@types/yargs": { "@types/yargs": {
"version": "13.0.3", "version": "13.0.3",
"resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-13.0.3.tgz", "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-13.0.3.tgz",

View File

@@ -33,11 +33,13 @@
"@actions/exec": "^1.0.1", "@actions/exec": "^1.0.1",
"@actions/github": "^2.0.0", "@actions/github": "^2.0.0",
"@actions/io": "^1.0.1", "@actions/io": "^1.0.1",
"@actions/tool-cache": "^1.1.2" "@actions/tool-cache": "^1.1.2",
"uuid": "^3.3.3"
}, },
"devDependencies": { "devDependencies": {
"@types/jest": "^24.0.23", "@types/jest": "^24.0.23",
"@types/node": "^12.7.12", "@types/node": "^12.7.12",
"@types/uuid": "^3.4.6",
"@typescript-eslint/parser": "^2.8.0", "@typescript-eslint/parser": "^2.8.0",
"@zeit/ncc": "^0.20.5", "@zeit/ncc": "^0.20.5",
"eslint": "^5.16.0", "eslint": "^5.16.0",

View File

@@ -3,10 +3,11 @@ import * as coreCommand from '@actions/core/lib/command'
import * as fs from 'fs' import * as fs from 'fs'
import * as fsHelper from './fs-helper' import * as fsHelper from './fs-helper'
import * as gitCommandManager from './git-command-manager' import * as gitCommandManager from './git-command-manager'
import * as githubApiHelper from './github-api-helper'
import * as io from '@actions/io' import * as io from '@actions/io'
import * as path from 'path' import * as path from 'path'
import * as refHelper from './ref-helper' import * as refHelper from './ref-helper'
import * as githubApiHelper from './github-api-helper' import * as stateHelper from './state-helper'
import {IGitCommandManager} from './git-command-manager' import {IGitCommandManager} from './git-command-manager'
const authConfigKey = `http.https://github.com/.extraheader` const authConfigKey = `http.https://github.com/.extraheader`
@@ -32,13 +33,6 @@ export async function getSource(settings: ISourceSettings): Promise<void> {
settings.repositoryOwner settings.repositoryOwner
)}/${encodeURIComponent(settings.repositoryName)}` )}/${encodeURIComponent(settings.repositoryName)}`
// Set intra-task state for cleanup
coreCommand.issueCommand(
'save-state',
{name: 'repositoryPath'},
settings.repositoryPath
)
// Remove conflicting file path // Remove conflicting file path
if (fsHelper.fileExistsSync(settings.repositoryPath)) { if (fsHelper.fileExistsSync(settings.repositoryPath)) {
await io.rmRF(settings.repositoryPath) await io.rmRF(settings.repositoryPath)
@@ -52,21 +46,7 @@ export async function getSource(settings: ISourceSettings): Promise<void> {
} }
// Git command manager // Git command manager
core.info(`Working directory is '${settings.repositoryPath}'`) const git = await getGitCommandManager(settings)
let git = (null as unknown) as IGitCommandManager
try {
git = await gitCommandManager.CreateCommandManager(
settings.repositoryPath,
settings.lfs
)
} catch (err) {
// Git is required for LFS
if (settings.lfs) {
throw err
}
// Otherwise fallback to REST API
}
// Prepare existing directory, otherwise recreate // Prepare existing directory, otherwise recreate
if (isExisting) { if (isExisting) {
@@ -78,10 +58,11 @@ export async function getSource(settings: ISourceSettings): Promise<void> {
) )
} }
if (!git || `${1}` == '1') { if (!git) {
core.info(`Downloading the repository files using the GitHub REST API`) // Downloading using REST API
core.info(`The repository will be downloaded using the GitHub REST API`)
core.info( core.info(
`To create a local repository instead, add Git ${gitCommandManager.MinimumGitVersion} or higher to the PATH` `To create a local Git repository instead, add Git ${gitCommandManager.MinimumGitVersion} or higher to the PATH`
) )
await githubApiHelper.downloadRepository( await githubApiHelper.downloadRepository(
settings.accessToken, settings.accessToken,
@@ -92,6 +73,9 @@ export async function getSource(settings: ISourceSettings): Promise<void> {
settings.repositoryPath settings.repositoryPath
) )
} else { } else {
// Save state for POST action
stateHelper.setRepositoryPath(settings.repositoryPath)
// Initialize the repository // Initialize the repository
if ( if (
!fsHelper.directoryExistsSync(path.join(settings.repositoryPath, '.git')) !fsHelper.directoryExistsSync(path.join(settings.repositoryPath, '.git'))
@@ -165,6 +149,27 @@ export async function cleanup(repositoryPath: string): Promise<void> {
await removeGitConfig(git, authConfigKey) await removeGitConfig(git, authConfigKey)
} }
async function getGitCommandManager(
settings: ISourceSettings
): Promise<IGitCommandManager> {
core.info(`Working directory is '${settings.repositoryPath}'`)
let git = (null as unknown) as IGitCommandManager
try {
return await gitCommandManager.CreateCommandManager(
settings.repositoryPath,
settings.lfs
)
} catch (err) {
// Git is required for LFS
if (settings.lfs) {
throw err
}
// Otherwise fallback to REST API
return (null as unknown) as IGitCommandManager
}
}
async function prepareExistingDirectory( async function prepareExistingDirectory(
git: IGitCommandManager, git: IGitCommandManager,
repositoryPath: string, repositoryPath: string,

View File

@@ -1,18 +1,13 @@
import * as assert from 'assert' import * as assert from 'assert'
import * as core from '@actions/core' import * as core from '@actions/core'
import * as exec from '@actions/exec'
import * as fs from 'fs' import * as fs from 'fs'
import * as github from '@actions/github' import * as github from '@actions/github'
import * as https from 'https'
import * as io from '@actions/io' import * as io from '@actions/io'
import * as path from 'path' import * as path from 'path'
import * as refHelper from './ref-helper'
import * as retryHelper from './retry-helper' import * as retryHelper from './retry-helper'
import * as toolCache from '@actions/tool-cache' import * as toolCache from '@actions/tool-cache'
import {ExecOptions} from '@actions/exec/lib/interfaces' import {default as uuid} from 'uuid/v4'
import {IncomingMessage} from 'http' import {ReposGetArchiveLinkParams} from '@octokit/rest'
import {RequestOptions, ReposGetArchiveLinkParams} from '@octokit/rest'
import {WriteStream} from 'fs'
const IS_WINDOWS = process.platform === 'win32' const IS_WINDOWS = process.platform === 'win32'
@@ -24,73 +19,40 @@ export async function downloadRepository(
commit: string, commit: string,
repositoryPath: string repositoryPath: string
): Promise<void> { ): Promise<void> {
// Determine archive path
const runnerTemp = process.env['RUNNER_TEMP'] as string
assert.ok(runnerTemp, 'RUNNER_TEMP not defined')
const archivePath = path.join(runnerTemp, 'checkout.tar.gz')
// Ensure file does not exist
core.debug(`Ensuring archive file does not exist: ${archivePath}`)
await io.rmRF(archivePath)
// Download the archive // Download the archive
let archiveData = await retryHelper.execute(async () => { let archiveData = await retryHelper.execute(async () => {
core.info('Downloading the archive using the REST API') core.info('Downloading the archive')
return await downloadArchive(accessToken, owner, repo, ref, commit) return await downloadArchive(accessToken, owner, repo, ref, commit)
}) })
// Write archive to disk // Write archive to disk
core.info('Writing archive to disk') core.info('Writing archive to disk')
const uniqueId = uuid()
const archivePath = path.join(repositoryPath, `${uniqueId}.tar.gz`)
await fs.promises.writeFile(archivePath, archiveData) await fs.promises.writeFile(archivePath, archiveData)
archiveData = Buffer.from('') // Free memory archiveData = Buffer.from('') // Free memory
// // Get the archive URL using the REST API
// await retryHelper.execute(async () => {
// // Prepare the archive stream
// core.debug(`Preparing the archive stream: ${archivePath}`)
// await io.rmRF(archivePath)
// const fileStream = fs.createWriteStream(archivePath)
// const fileStreamClosed = getFileClosedPromise(fileStream)
// try {
// // Get the archive URL
// core.info('Getting archive URL')
// const archiveUrl = await getArchiveUrl(
// accessToken,
// owner,
// repo,
// ref,
// commit
// )
// // Download the archive
// core.info('Downloading the archive') // Do not print the archive URL because it has an embedded token
// await downloadFile(archiveUrl, fileStream)
// } finally {
// fileStream.end()
// await fileStreamClosed
// }
// })
// Extract archive // Extract archive
const extractPath = path.join(runnerTemp, `checkout`) core.info('Extracting the archive')
await io.rmRF(extractPath) const extractPath = path.join(repositoryPath, uniqueId)
await io.mkdirP(extractPath) await io.mkdirP(extractPath)
if (IS_WINDOWS) { if (IS_WINDOWS) {
await toolCache.extractZip(archivePath, extractPath) await toolCache.extractZip(archivePath, extractPath)
} else { } else {
await toolCache.extractTar(archivePath, extractPath) await toolCache.extractTar(archivePath, extractPath)
} }
io.rmRF(archivePath)
// Determine the real directory to copy (ignore extra dir at root of the archive) // Determine the path of the repository content. The archive contains
// a top-level folder and the repository content is inside.
const archiveFileNames = await fs.promises.readdir(extractPath) const archiveFileNames = await fs.promises.readdir(extractPath)
assert.ok( assert.ok(
archiveFileNames.length == 1, archiveFileNames.length == 1,
'Expected exactly one directory inside archive' 'Expected exactly one directory inside archive'
) )
const extraDirectoryName = archiveFileNames[0] const archiveVersion = archiveFileNames[0] // The top-level folder name includes the short SHA
core.info(`Resolved ${extraDirectoryName}`) // contains the short SHA core.info(`Resolved version ${archiveVersion}`)
const tempRepositoryPath = path.join(extractPath, extraDirectoryName) const tempRepositoryPath = path.join(extractPath, archiveVersion)
// Move the files // Move the files
for (const fileName of await fs.promises.readdir(tempRepositoryPath)) { for (const fileName of await fs.promises.readdir(tempRepositoryPath)) {
@@ -98,10 +60,7 @@ export async function downloadRepository(
const targetPath = path.join(repositoryPath, fileName) const targetPath = path.join(repositoryPath, fileName)
await io.mv(sourcePath, targetPath) await io.mv(sourcePath, targetPath)
} }
io.rmRF(extractPath)
await exec.exec(`find .`, [], {
cwd: repositoryPath
} as ExecOptions)
} }
async function downloadArchive( async function downloadArchive(
@@ -116,13 +75,9 @@ async function downloadArchive(
owner: owner, owner: owner,
repo: repo, repo: repo,
archive_format: IS_WINDOWS ? 'zipball' : 'tarball', archive_format: IS_WINDOWS ? 'zipball' : 'tarball',
ref: refHelper.getDownloadRef(ref, commit) ref: commit || ref
} }
const response = await octokit.repos.getArchiveLink(params) const response = await octokit.repos.getArchiveLink(params)
console.log('GOT THE RESPONSE')
console.log(`status=${response.status}`)
console.log(`headers=${JSON.stringify(response.headers)}`)
console.log(`data=${JSON.stringify(response.data)}`)
if (response.status != 200) { if (response.status != 200) {
throw new Error( throw new Error(
`Unexpected response from GitHub API. Status: '${response.status}'` `Unexpected response from GitHub API. Status: '${response.status}'`
@@ -131,74 +86,3 @@ async function downloadArchive(
return Buffer.from(response.data) // response.data is ArrayBuffer return Buffer.from(response.data) // response.data is ArrayBuffer
} }
// async function getArchiveUrl(
// accessToken: string,
// owner: string,
// repo: string,
// ref: string,
// commit: string
// ): Promise<string> {
// const octokit = new github.GitHub(accessToken)
// const params: RequestOptions & ReposGetArchiveLinkParams = {
// method: 'HEAD',
// owner: owner,
// repo: repo,
// archive_format: IS_WINDOWS ? 'zipball' : 'tarball',
// ref: refHelper.getDownloadRef(ref, commit)
// }
// const response = await octokit.repos.getArchiveLink(params)
// console.log('GOT THE RESPONSE')
// console.log(`status=${response.status}`)
// console.log(`headers=${JSON.stringify(response.headers)}`)
// console.log(`data=${JSON.stringify(response.data)}`)
// if (response.status != 200) {
// throw new Error(
// `Unexpected response from GitHub API. Status: '${response.status}'`
// )
// }
// console.log('GETTING THE LOCATION')
// const archiveUrl = response.headers['Location'] // Do not print the archive URL because it has an embedded token
// assert.ok(
// archiveUrl,
// `Expected GitHub API response to contain 'Location' header`
// )
// return archiveUrl
// }
// function downloadFile(url: string, fileStream: WriteStream): Promise<void> {
// return new Promise((resolve, reject) => {
// try {
// https.get(url, (response: IncomingMessage) => {
// if (response.statusCode != 200) {
// reject(`Request failed with status '${response.statusCode}'`)
// response.resume() // Consume response data to free up memory
// return
// }
// response.on('data', chunk => {
// fileStream.write(chunk)
// })
// response.on('end', () => {
// resolve()
// })
// response.on('error', err => {
// reject(err)
// })
// })
// } catch (err) {
// reject(err)
// }
// })
// }
// function getFileClosedPromise(stream: WriteStream): Promise<void> {
// return new Promise((resolve, reject) => {
// stream.on('error', err => {
// reject(err)
// })
// stream.on('finish', () => {
// resolve()
// })
// })
// }

View File

@@ -3,8 +3,7 @@ import * as coreCommand from '@actions/core/lib/command'
import * as gitSourceProvider from './git-source-provider' import * as gitSourceProvider from './git-source-provider'
import * as inputHelper from './input-helper' import * as inputHelper from './input-helper'
import * as path from 'path' import * as path from 'path'
import * as stateHelper from './state-helper'
const cleanupRepositoryPath = process.env['STATE_repositoryPath'] as string
async function run(): Promise<void> { async function run(): Promise<void> {
try { try {
@@ -31,14 +30,14 @@ async function run(): Promise<void> {
async function cleanup(): Promise<void> { async function cleanup(): Promise<void> {
try { try {
await gitSourceProvider.cleanup(cleanupRepositoryPath) await gitSourceProvider.cleanup(stateHelper.RepositoryPath)
} catch (error) { } catch (error) {
core.warning(error.message) core.warning(error.message)
} }
} }
// Main // Main
if (!cleanupRepositoryPath) { if (!stateHelper.IsPost) {
run() run()
} }
// Post // Post

View File

@@ -5,15 +5,6 @@ export interface ICheckoutInfo {
startPoint: string startPoint: string
} }
export function getDownloadRef(ref: string, commit: string): string {
if (commit) {
return commit
}
// todo fix this to work with refs/pull etc
return ref
}
export async function getCheckoutInfo( export async function getCheckoutInfo(
git: IGitCommandManager, git: IGitCommandManager,
ref: string, ref: string,

View File

@@ -1,12 +1,27 @@
import * as core from '@actions/core' import * as core from '@actions/core'
const maxAttempts = 3 const defaultMaxAttempts = 3
const minSeconds = 10 const defaultMinSeconds = 10
const maxSeconds = 20 const defaultMaxSeconds = 20
export async function execute<T>(action: () => Promise<T>): Promise<T> { export class RetryHelper {
private maxAttempts: number
private minSeconds: number
private maxSeconds: number
constructor(
maxAttempts: number = defaultMaxAttempts,
minSeconds: number = defaultMinSeconds,
maxSeconds: number = defaultMaxSeconds
) {
this.maxAttempts = maxAttempts
this.minSeconds = Math.floor(minSeconds)
this.maxSeconds = Math.floor(maxSeconds)
}
async execute<T>(action: () => Promise<T>): Promise<T> {
let attempt = 1 let attempt = 1
while (attempt < maxAttempts) { while (attempt < this.maxAttempts) {
// Try // Try
try { try {
return await action() return await action()
@@ -15,9 +30,9 @@ export async function execute<T>(action: () => Promise<T>): Promise<T> {
} }
// Sleep // Sleep
const seconds = getRandomIntInclusive(minSeconds, maxSeconds) const seconds = this.getSleepAmount()
core.info(`Waiting ${seconds} before trying again`) core.info(`Waiting ${seconds} seconds before trying again`)
await sleep(seconds * 1000) await this.sleep(seconds)
attempt++ attempt++
} }
@@ -25,12 +40,19 @@ export async function execute<T>(action: () => Promise<T>): Promise<T> {
return await action() return await action()
} }
function getRandomIntInclusive(minimum: number, maximum: number): number { private getSleepAmount(): number {
minimum = Math.floor(minimum) return (
maximum = Math.floor(maximum) Math.floor(Math.random() * (this.maxSeconds - this.minSeconds + 1)) +
return Math.floor(Math.random() * (maximum - minimum + 1)) + minimum this.minSeconds
)
} }
async function sleep(milliseconds): Promise<void> { private async sleep(seconds: number): Promise<void> {
return new Promise(resolve => setTimeout(resolve, milliseconds)) return new Promise(resolve => setTimeout(resolve, seconds * 1000))
}
}
export async function execute<T>(action: () => Promise<T>): Promise<T> {
const retryHelper = new RetryHelper()
return await retryHelper.execute(action)
} }

29
src/state-helper.ts Normal file
View File

@@ -0,0 +1,29 @@
import * as core from '@actions/core'
import * as coreCommand from '@actions/core/lib/command'
/**
* Indicates whether the POST action is running
*/
export const IsPost = !!process.env['STATE_isPost']
/**
* The repository path for the POST action. The value is empty during the MAIN action.
*/
export const RepositoryPath = process.env['STATE_repositoryPath'] as string
/**
* Save the repository path so the POST action can retrieve the value.
*/
export function setRepositoryPath(repositoryPath: string) {
coreCommand.issueCommand(
'save-state',
{name: 'repositoryPath'},
repositoryPath
)
}
// Publish a variable so that when the POST action runs, it can determine it should run the cleanup logic.
// This is necessary since we don't have a separate entry point.
if (!IsPost) {
coreCommand.issueCommand('save-state', {name: 'isPost'}, 'true')
}