Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Uses tool cache - skips wrapper create on hit. #94

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 35 additions & 8 deletions dist/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ const tc = __webpack_require__(7784);
const io = __webpack_require__(7436);
const releases = __webpack_require__(9947);

// Constants
const CACHE_KEY = 'terraform';

// arch in [arm, x32, x64...] (https://nodejs.org/api/os.html#os_os_arch)
// return value in [amd64, 386, arm]
function mapArch (arch) {
Expand All @@ -53,7 +56,7 @@ function mapOS (os) {
return mappings[os] || os;
}

async function downloadCLI (url) {
async function downloadCLI (url, version) {
core.debug(`Downloading Terraform CLI from ${url}`);
const pathToCLIZip = await tc.downloadTool(url);

Expand All @@ -65,7 +68,24 @@ async function downloadCLI (url) {
throw new Error(`Unable to download Terraform from ${url}`);
}

return pathToCLI;
// Cache for later
const cachedPath = await tc.cacheDir(pathToCLI, CACHE_KEY, version);
return cachedPath;
}

async function checkWrapper (pathToCLI) {
const exeSuffix = os.platform().startsWith('win') ? '.exe' : '';
const target = [pathToCLI, `terraform-bin${exeSuffix}`].join(path.sep);

core.debug('Checking for existing wrapper');

const hasWrapper = io.which(target);

if (hasWrapper) {
core.debug('Wrapper found, skipping creation.');
}

return hasWrapper;
}

async function installWrapper (pathToCLI) {
Expand Down Expand Up @@ -95,9 +115,6 @@ async function installWrapper (pathToCLI) {
core.error(`Unable to copy ${source} to ${target}.`);
throw e;
}

// Export a new environment variable, so our wrapper can locate the binary
core.exportVariable('TERRAFORM_CLI_PATH', pathToCLI);
}

// Add credentials to CLI Configuration File
Expand Down Expand Up @@ -151,14 +168,24 @@ async function run () {
throw new Error(`Terraform version ${version} not available for ${platform} and ${arch}`);
}

// Download requested version
const pathToCLI = await downloadCLI(build.url);
// Check cache for requested version, then download if not present
let pathToCLI = tc.find(CACHE_KEY, release.version, os.arch());

// Check to see if wrapper has been installed in a previous run
const hasWrapper = pathToCLI && checkWrapper(pathToCLI);

if (!pathToCLI) {
pathToCLI = await downloadCLI(build.url, release.version);
}

// Install our wrapper
if (wrapper) {
if (wrapper && !hasWrapper) {
await installWrapper(pathToCLI);
}

// Export a new environment variable, so our wrapper can locate the binary
core.exportVariable('TERRAFORM_CLI_PATH', pathToCLI);

// Add to path
core.addPath(pathToCLI);

Expand Down
43 changes: 35 additions & 8 deletions lib/setup-terraform.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ const tc = require('@actions/tool-cache');
const io = require('@actions/io');
const releases = require('@hashicorp/js-releases');

// Constants
const CACHE_KEY = 'terraform';

// arch in [arm, x32, x64...] (https://nodejs.org/api/os.html#os_os_arch)
// return value in [amd64, 386, arm]
function mapArch (arch) {
Expand All @@ -28,7 +31,7 @@ function mapOS (os) {
return mappings[os] || os;
}

async function downloadCLI (url) {
async function downloadCLI (url, version) {
core.debug(`Downloading Terraform CLI from ${url}`);
const pathToCLIZip = await tc.downloadTool(url);

Expand All @@ -40,7 +43,24 @@ async function downloadCLI (url) {
throw new Error(`Unable to download Terraform from ${url}`);
}

return pathToCLI;
// Cache for later
const cachedPath = await tc.cacheDir(pathToCLI, CACHE_KEY, version);
return cachedPath;
}

async function checkWrapper (pathToCLI) {
const exeSuffix = os.platform().startsWith('win') ? '.exe' : '';
const target = [pathToCLI, `terraform-bin${exeSuffix}`].join(path.sep);

core.debug('Checking for existing wrapper');

const hasWrapper = io.which(target);

if (hasWrapper) {
core.debug('Wrapper found, skipping creation.');
}

return hasWrapper;
}

async function installWrapper (pathToCLI) {
Expand Down Expand Up @@ -70,9 +90,6 @@ async function installWrapper (pathToCLI) {
core.error(`Unable to copy ${source} to ${target}.`);
throw e;
}

// Export a new environment variable, so our wrapper can locate the binary
core.exportVariable('TERRAFORM_CLI_PATH', pathToCLI);
}

// Add credentials to CLI Configuration File
Expand Down Expand Up @@ -126,14 +143,24 @@ async function run () {
throw new Error(`Terraform version ${version} not available for ${platform} and ${arch}`);
}

// Download requested version
const pathToCLI = await downloadCLI(build.url);
// Check cache for requested version, then download if not present
let pathToCLI = tc.find(CACHE_KEY, release.version, os.arch());

// Check to see if wrapper has been installed in a previous run
const hasWrapper = pathToCLI && checkWrapper(pathToCLI);

if (!pathToCLI) {
pathToCLI = await downloadCLI(build.url, release.version);
}

// Install our wrapper
if (wrapper) {
if (wrapper && !hasWrapper) {
await installWrapper(pathToCLI);
}

// Export a new environment variable, so our wrapper can locate the binary
core.exportVariable('TERRAFORM_CLI_PATH', pathToCLI);

// Add to path
core.addPath(pathToCLI);

Expand Down
14 changes: 14 additions & 0 deletions test/setup-terraform.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -564,6 +564,13 @@ describe('Setup Terraform', () => {
.fn()
.mockReturnValueOnce('file');

tc.cacheDir = jest.fn()
.mockReturnValueOnce('file');

tc.find = jest
.fn()
.mockReturnValueOnce(null);

os.platform = jest
.fn()
.mockReturnValue('linux');
Expand Down Expand Up @@ -608,6 +615,13 @@ describe('Setup Terraform', () => {
.fn()
.mockReturnValueOnce('file');

tc.cacheDir = jest.fn()
.mockReturnValueOnce('file');

tc.find = jest
.fn()
.mockReturnValueOnce(null);

os.platform = jest
.fn()
.mockReturnValue('win32');
Expand Down