fix(): cache resolve version input (#267)

Update @actions/core to 1.10.0

.github/workflows/versions.yml

@@ -19,7 +19,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [macos-latest, windows-latest, ubuntu-latest]
-        go: [1.12, 1.13, 1.14]
+        go: [1.17, 1.18, 1.19]
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -107,3 +107,20 @@ jobs:
       - name: verify go
         run: __tests__/verify-go.sh ${{ matrix.go }}
         shell: bash
+
+  architecture:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        go-version: [1.16, 1.17]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup Go and check latest
+        uses: ./
+        with:
+          go-version: ${{ matrix.go-version }}
+          architecture: x64
+      - name: Verify Go
+        run: go version

.licensed.yml

@@ -9,6 +9,7 @@ allowed:
   - mit
   - cc0-1.0
   - unlicense
+  - 0bsd
 
 reviewed:
   npm:

README.md

@@ -15,7 +15,8 @@ The V3 edition of the action offers:
 - Adds `GOBIN` to the `PATH`
 - Proxy support
 - Check latest version
-- Bug fixes (including issues around version matching and semver)
+- Caching packages dependencies
+- Bug Fixes (including issues around version matching and semver)
 
 The action will first check the local cache for a version match. If a version is not found locally, it will pull it from the `main` branch of the [go-versions](https://github.com/actions/go-versions/blob/main/versions-manifest.json) repository. On miss or failure, it will fall back to downloading directly from [go dist](https://storage.googleapis.com/golang). To change the default behavior, please use the [check-latest input](#check-latest-version).
 
@@ -94,6 +95,36 @@ steps:
       check-latest: true
   - run: go run hello.go
 ```
+## Caching dependency files and build outputs:
+
+The action has a built-in functionality for caching and restoring go modules and build outputs. It uses [actions/cache](https://github.com/actions/cache) under the hood but requires less configuration settings. The `cache` input is optional, and caching is turned off by default.
+
+The action defaults to search for the dependency file - go.sum in the repository root, and uses its hash as a part of the cache key. Use `cache-dependency-path` input for cases when multiple dependency files are used, or they are located in different subdirectories.
+
+**Caching without specifying dependency file path**
+```yaml
+steps:
+  - uses: actions/checkout@v3
+  - uses: actions/setup-go@v3
+    with:
+      go-version: '1.17'
+      check-latest: true
+      cache: true
+  - run: go run hello.go
+```
+
+**Caching in monorepos**
+```yaml
+steps:
+  - uses: actions/checkout@v3
+  - uses: actions/setup-go@v3
+    with:
+      go-version: '1.17'
+      check-latest: true
+      cache: true
+      cache-dependency-path: subdir/go.sum
+  - run: go run hello.go
+  ```
 ## Getting go version from the go.mod file
 
 The `go-version-file` input accepts a path to a `go.mod` file containing the version of Go to be used by a project. As the `go.mod` file contains only major and minor (e.g. 1.18) tags, the action will search for the latest available patch version sequentially in the runner's directory with the cached tools, in the [version-manifest.json](https://github.com/actions/go-versions/blob/main/versions-manifest.json) file or at the go servers.
@@ -148,4 +179,4 @@ Contributions are welcome! See [Contributor's Guide](docs/contributors.md)
 
 ## Code of Conduct
 
-:wave: Be nice. See [our code of conduct](CONDUCT)
+:wave: Be nice. See [our code of conduct](CODE_OF_CONDUCT.md)

__tests__/cache-restore.test.ts

@@ -0,0 +1,99 @@
+import * as cache from '@actions/cache';
+import * as core from '@actions/core';
+import * as glob from '@actions/glob';
+
+import * as cacheRestore from '../src/cache-restore';
+import * as cacheUtils from '../src/cache-utils';
+import {PackageManagerInfo} from '../src/package-managers';
+
+describe('restoreCache', () => {
+  //Arrange
+  let hashFilesSpy = jest.spyOn(glob, 'hashFiles');
+  let getCacheDirectoryPathSpy = jest.spyOn(
+    cacheUtils,
+    'getCacheDirectoryPath'
+  );
+  let restoreCacheSpy = jest.spyOn(cache, 'restoreCache');
+  let infoSpy = jest.spyOn(core, 'info');
+  let setOutputSpy = jest.spyOn(core, 'setOutput');
+
+  const versionSpec = '1.13.1';
+  const packageManager = 'default';
+  const cacheDependencyPath = 'path';
+
+  beforeEach(() => {
+    getCacheDirectoryPathSpy.mockImplementation(
+      (PackageManager: PackageManagerInfo) => {
+        return new Promise<string[]>(resolve => {
+          resolve(['cache_directory_path', 'cache_directory_path']);
+        });
+      }
+    );
+  });
+
+  it('should throw if dependency file path is not valid', async () => {
+    //Arrange
+    hashFilesSpy.mockImplementation((somePath: string) => {
+      return new Promise<string>(resolve => {
+        resolve('');
+      });
+    });
+
+    //Act + Assert
+    expect(async () => {
+      await cacheRestore.restoreCache(
+        versionSpec,
+        packageManager,
+        cacheDependencyPath
+      );
+    }).rejects.toThrowError(
+      'Some specified paths were not resolved, unable to cache dependencies.'
+    );
+  });
+
+  it('should inform if cache hit is not occured', async () => {
+    //Arrange
+    hashFilesSpy.mockImplementation((somePath: string) => {
+      return new Promise<string>(resolve => {
+        resolve('file_hash');
+      });
+    });
+
+    restoreCacheSpy.mockImplementation(() => {
+      return new Promise<string>(resolve => {
+        resolve('');
+      });
+    });
+
+    //Act + Assert
+    await cacheRestore.restoreCache(
+      versionSpec,
+      packageManager,
+      cacheDependencyPath
+    );
+    expect(infoSpy).toBeCalledWith(`Cache is not found`);
+  });
+
+  it('should set output if cache hit is occured', async () => {
+    //Arrange
+    hashFilesSpy.mockImplementation((somePath: string) => {
+      return new Promise<string>(resolve => {
+        resolve('file_hash');
+      });
+    });
+
+    restoreCacheSpy.mockImplementation(() => {
+      return new Promise<string>(resolve => {
+        resolve('cache_key');
+      });
+    });
+
+    //Act + Assert
+    await cacheRestore.restoreCache(
+      versionSpec,
+      packageManager,
+      cacheDependencyPath
+    );
+    expect(setOutputSpy).toBeCalledWith('cache-hit', true);
+  });
+});

__tests__/cache-utils.test.ts

@@ -0,0 +1,179 @@
+import * as exec from '@actions/exec';
+import * as cache from '@actions/cache';
+import * as core from '@actions/core';
+import * as cacheUtils from '../src/cache-utils';
+import {PackageManagerInfo} from '../src/package-managers';
+
+describe('getCommandOutput', () => {
+  //Arrange
+  let getExecOutputSpy = jest.spyOn(exec, 'getExecOutput');
+
+  it('should return trimmed stdout in case of successful exit code', async () => {
+    //Arrange
+    const stdoutResult = ' stdout ';
+    const trimmedStdout = stdoutResult.trim();
+
+    getExecOutputSpy.mockImplementation((commandLine: string) => {
+      return new Promise<exec.ExecOutput>(resolve => {
+        resolve({exitCode: 0, stdout: stdoutResult, stderr: ''});
+      });
+    });
+
+    //Act + Assert
+    return cacheUtils
+      .getCommandOutput('command')
+      .then(data => expect(data).toBe(trimmedStdout));
+  });
+
+  it('should return error in case of unsuccessful exit code', async () => {
+    //Arrange
+    const stderrResult = 'error message';
+
+    getExecOutputSpy.mockImplementation((commandLine: string) => {
+      return new Promise<exec.ExecOutput>(resolve => {
+        resolve({exitCode: 10, stdout: '', stderr: stderrResult});
+      });
+    });
+
+    //Act + Assert
+    expect(async () => {
+      await cacheUtils.getCommandOutput('command');
+    }).rejects.toThrow();
+  });
+});
+
+describe('getPackageManagerInfo', () => {
+  it('should return package manager info in case of valid package manager name', async () => {
+    //Arrange
+    const packageManagerName = 'default';
+    const expectedResult = {
+      dependencyFilePattern: 'go.sum',
+      cacheFolderCommandList: ['go env GOMODCACHE', 'go env GOCACHE']
+    };
+
+    //Act + Assert
+    return cacheUtils
+      .getPackageManagerInfo(packageManagerName)
+      .then(data => expect(data).toEqual(expectedResult));
+  });
+
+  it('should throw the error in case of invalid package manager name', async () => {
+    //Arrange
+    const packageManagerName = 'invalidName';
+
+    //Act + Assert
+    expect(async () => {
+      await cacheUtils.getPackageManagerInfo(packageManagerName);
+    }).rejects.toThrow();
+  });
+});
+
+describe('getCacheDirectoryPath', () => {
+  //Arrange
+  let getExecOutputSpy = jest.spyOn(exec, 'getExecOutput');
+
+  const validPackageManager: PackageManagerInfo = {
+    dependencyFilePattern: 'go.sum',
+    cacheFolderCommandList: ['go env GOMODCACHE', 'go env GOCACHE']
+  };
+
+  it('should return path to the cache folders which specified package manager uses', async () => {
+    //Arrange
+    getExecOutputSpy.mockImplementation((commandLine: string) => {
+      return new Promise<exec.ExecOutput>(resolve => {
+        resolve({exitCode: 0, stdout: 'path/to/cache/folder', stderr: ''});
+      });
+    });
+
+    const expectedResult = ['path/to/cache/folder', 'path/to/cache/folder'];
+
+    //Act + Assert
+    return cacheUtils
+      .getCacheDirectoryPath(validPackageManager)
+      .then(data => expect(data).toEqual(expectedResult));
+  });
+
+  it('should throw if the specified package name is invalid', async () => {
+    getExecOutputSpy.mockImplementation((commandLine: string) => {
+      return new Promise<exec.ExecOutput>(resolve => {
+        resolve({exitCode: 10, stdout: '', stderr: 'Error message'});
+      });
+    });
+
+    //Act + Assert
+    expect(async () => {
+      await cacheUtils.getCacheDirectoryPath(validPackageManager);
+    }).rejects.toThrow();
+  });
+});
+
+describe('isCacheFeatureAvailable', () => {
+  //Arrange
+  let isFeatureAvailableSpy = jest.spyOn(cache, 'isFeatureAvailable');
+  let warningSpy = jest.spyOn(core, 'warning');
+
+  it('should return true when cache feature is available', () => {
+    //Arrange
+    isFeatureAvailableSpy.mockImplementation(() => {
+      return true;
+    });
+
+    let functionResult;
+
+    //Act
+    functionResult = cacheUtils.isCacheFeatureAvailable();
+
+    //Assert
+    expect(functionResult).toBeTruthy();
+  });
+
+  it('should warn when cache feature is unavailable and GHES is not used ', () => {
+    //Arrange
+    isFeatureAvailableSpy.mockImplementation(() => {
+      return false;
+    });
+
+    process.env['GITHUB_SERVER_URL'] = 'https://github.com';
+
+    let warningMessage =
+      'The runner was not able to contact the cache service. Caching will be skipped';
+
+    //Act
+    cacheUtils.isCacheFeatureAvailable();
+
+    //Assert
+    expect(warningSpy).toHaveBeenCalledWith(warningMessage);
+  });
+
+  it('should return false when cache feature is unavailable', () => {
+    //Arrange
+    isFeatureAvailableSpy.mockImplementation(() => {
+      return false;
+    });
+
+    process.env['GITHUB_SERVER_URL'] = 'https://github.com';
+
+    let functionResult;
+
+    //Act
+    functionResult = cacheUtils.isCacheFeatureAvailable();
+
+    //Assert
+    expect(functionResult).toBeFalsy();
+  });
+
+  it('should throw when cache feature is unavailable and GHES is used', () => {
+    //Arrange
+    isFeatureAvailableSpy.mockImplementation(() => {
+      return false;
+    });
+
+    process.env['GITHUB_SERVER_URL'] = 'https://nongithub.com';
+
+    let errorMessage =
+      'Cache action is only supported on GHES version >= 3.5. If you are on version >=3.5 Please check with GHES admin if Actions cache service is enabled or not.';
+
+    //Act + Assert
+    expect(() => cacheUtils.isCacheFeatureAvailable()).toThrow(errorMessage);
+  });
+});

__tests__/setup-go.test.ts

@@ -13,6 +13,8 @@ let matchers = require('../matchers.json');
 let goTestManifest = require('./data/versions-manifest.json');
 let matcherPattern = matchers.problemMatcher[0].pattern[0];
 let matcherRegExp = new RegExp(matcherPattern.regexp);
+let win32Join = path.win32.join;
+let posixJoin = path.posix.join;
 
 describe('setup-go', () => {
   let inputs = {} as any;
@@ -27,8 +29,10 @@ describe('setup-go', () => {
   let getSpy: jest.SpyInstance;
   let platSpy: jest.SpyInstance;
   let archSpy: jest.SpyInstance;
+  let joinSpy: jest.SpyInstance;
   let dlSpy: jest.SpyInstance;
   let extractTarSpy: jest.SpyInstance;
+  let extractZipSpy: jest.SpyInstance;
   let cacheSpy: jest.SpyInstance;
   let dbgSpy: jest.SpyInstance;
   let whichSpy: jest.SpyInstance;
@@ -61,10 +65,21 @@ describe('setup-go', () => {
     archSpy.mockImplementation(() => os['arch']);
     execSpy = jest.spyOn(cp, 'execSync');
 
+    // switch path join behaviour based on set os.platform
+    joinSpy = jest.spyOn(path, 'join');
+    joinSpy.mockImplementation((...paths: string[]): string => {
+      if (os['platform'] == 'win32') {
+        return win32Join(...paths);
+      }
+
+      return posixJoin(...paths);
+    });
+
     // @actions/tool-cache
     findSpy = jest.spyOn(tc, 'find');
     dlSpy = jest.spyOn(tc, 'downloadTool');
     extractTarSpy = jest.spyOn(tc, 'extractTar');
+    extractZipSpy = jest.spyOn(tc, 'extractZip');
     cacheSpy = jest.spyOn(tc, 'cacheDir');
     getSpy = jest.spyOn(im, 'getVersionsDist');
     getManifestSpy = jest.spyOn(tc, 'getManifestFromRepo');
@@ -89,7 +104,7 @@ describe('setup-go', () => {
     });
     logSpy.mockImplementation(line => {
       // uncomment to debug
-      process.stderr.write('log:' + line + '\n');
+      //process.stderr.write('log:' + line + '\n');
     });
     dbgSpy.mockImplementation(msg => {
       // uncomment to see debug output
@@ -98,7 +113,7 @@ describe('setup-go', () => {
   });
 
   afterEach(() => {
-    jest.resetAllMocks();
+    //jest.resetAllMocks();
     jest.clearAllMocks();
     //jest.restoreAllMocks();
   });
@@ -280,7 +295,6 @@ describe('setup-go', () => {
     findSpy.mockImplementation(() => toolPath);
     await main.run();
 
-    let expPath = path.join(toolPath, 'bin');
     expect(logSpy).toHaveBeenCalledWith(`Found in cache @ ${toolPath}`);
   });
 
@@ -325,6 +339,31 @@ describe('setup-go', () => {
     expect(cnSpy).toHaveBeenCalledWith(`::add-path::${expPath}${osm.EOL}`);
   });
 
+  it('downloads a version not in the cache (windows)', async () => {
+    os.platform = 'win32';
+    os.arch = 'x64';
+
+    inputs['go-version'] = '1.13.1';
+    process.env['RUNNER_TEMP'] = 'C:\\temp\\';
+
+    findSpy.mockImplementation(() => '');
+    dlSpy.mockImplementation(() => 'C:\\temp\\some\\path');
+    extractZipSpy.mockImplementation(() => 'C:\\temp\\some\\other\\path');
+
+    let toolPath = path.normalize('C:\\cache\\go\\1.13.0\\x64');
+    cacheSpy.mockImplementation(() => toolPath);
+
+    await main.run();
+
+    let expPath = path.win32.join(toolPath, 'bin');
+    expect(dlSpy).toHaveBeenCalledWith(
+      'https://storage.googleapis.com/golang/go1.13.1.windows-amd64.zip',
+      'C:\\temp\\go1.13.1.windows-amd64.zip',
+      undefined
+    );
+    expect(cnSpy).toHaveBeenCalledWith(`::add-path::${expPath}${osm.EOL}`);
+  });
+
   it('does not find a version that does not exist', async () => {
     os.platform = 'linux';
     os.arch = 'x64';
@@ -413,7 +452,7 @@ describe('setup-go', () => {
     expect(cnSpy).toHaveBeenCalledWith(`::add-path::${expPath}${osm.EOL}`);
   });
 
-  it('falls back to a version from node dist', async () => {
+  it('falls back to a version from go dist', async () => {
     os.platform = 'linux';
     os.arch = 'x64';
 
@@ -422,9 +461,6 @@ describe('setup-go', () => {
     inputs['go-version'] = versionSpec;
     inputs['token'] = 'faketoken';
 
-    let expectedUrl =
-      'https://github.com/actions/go-versions/releases/download/1.12.14-20200616.18/go-1.12.14-linux-x64.tar.gz';
-
     // ... but not in the local cache
     findSpy.mockImplementation(() => '');
 
@@ -486,7 +522,7 @@ describe('setup-go', () => {
     });
 
     mkdirpSpy.mockImplementation(async () => {});
-    existsSpy.mockImplementation(path => {
+    existsSpy.mockImplementation(() => {
       return false;
     });
 
@@ -667,8 +703,6 @@ describe('setup-go', () => {
       const toolPath = path.normalize('/cache/go/1.17.5/x64');
       extractTarSpy.mockImplementation(async () => '/some/other/temp/path');
       cacheSpy.mockImplementation(async () => toolPath);
-      const expectedUrl =
-        'https://github.com/actions/go-versions/releases/download/1.17.6-1668090892/go-1.17.6-darwin-x64.tar.gz';
 
       await main.run();
 
@@ -794,7 +828,7 @@ exclude example.com/thismodule v1.3.0
 
     it('reads version from go.mod', async () => {
       inputs['go-version-file'] = 'go.mod';
-      existsSpy.mockImplementation(path => true);
+      existsSpy.mockImplementation(() => true);
       readFileSpy.mockImplementation(() => Buffer.from(goModContents));
 
       await main.run();
@@ -806,7 +840,7 @@ exclude example.com/thismodule v1.3.0
 
     it('reads version from .go-version', async () => {
       inputs['go-version-file'] = '.go-version';
-      existsSpy.mockImplementation(path => true);
+      existsSpy.mockImplementation(() => true);
       readFileSpy.mockImplementation(() => Buffer.from(`1.13.0${osm.EOL}`));
 
       await main.run();
@@ -819,7 +853,7 @@ exclude example.com/thismodule v1.3.0
     it('is overwritten by go-version', async () => {
       inputs['go-version'] = '1.13.1';
       inputs['go-version-file'] = 'go.mod';
-      existsSpy.mockImplementation(path => true);
+      existsSpy.mockImplementation(() => true);
       readFileSpy.mockImplementation(() => Buffer.from(goModContents));
 
       await main.run();
@@ -831,7 +865,7 @@ exclude example.com/thismodule v1.3.0
 
     it('reports a read failure', async () => {
       inputs['go-version-file'] = 'go.mod';
-      existsSpy.mockImplementation(path => false);
+      existsSpy.mockImplementation(() => false);
 
       await main.run();
 
@@ -839,5 +873,40 @@ exclude example.com/thismodule v1.3.0
         `::error::The specified go version file at: go.mod does not exist${osm.EOL}`
       );
     });
+
+    it('acquires specified architecture of go', async () => {
+      for (const {arch, version, osSpec} of [
+        {arch: 'amd64', version: '1.13.7', osSpec: 'linux'},
+        {arch: 'armv6l', version: '1.12.2', osSpec: 'linux'}
+      ]) {
+        os.platform = osSpec;
+        os.arch = arch;
+
+        const fileExtension = os.platform === 'win32' ? 'zip' : 'tar.gz';
+
+        const platform = os.platform === 'win32' ? 'win' : os.platform;
+
+        inputs['go-version'] = version;
+        inputs['architecture'] = arch;
+
+        let expectedUrl =
+          platform === 'win32'
+            ? `https://github.com/actions/go-versions/releases/download/${version}/go-${version}-${platform}-${arch}.${fileExtension}`
+            : `https://storage.googleapis.com/golang/go${version}.${osSpec}-${arch}.${fileExtension}`;
+
+        // ... but not in the local cache
+        findSpy.mockImplementation(() => '');
+
+        dlSpy.mockImplementation(async () => '/some/temp/path');
+        let toolPath = path.normalize(`/cache/go/${version}/${arch}`);
+        cacheSpy.mockImplementation(async () => toolPath);
+
+        await main.run();
+
+        expect(logSpy).toHaveBeenCalledWith(
+          `Acquiring go${version} from ${expectedUrl}`
+        );
+      }
+    }, 100000);
   });
 });

action.yml

@@ -12,9 +12,20 @@ inputs:
   token:
     description: Used to pull node distributions from go-versions.  Since there's a default, this is typically not supplied by the user.
     default: ${{ github.token }}
+  cache:
+    description: Used to specify whether caching is needed. Set to true, if you'd like to enable caching.
+    default: false
+  cache-dependency-path:
+    description: 'Used to specify the path to a dependency file - go.sum'
+  architecture:
+    description: 'Target architecture for Go to use. Examples: x86, x64. Will use system architecture by default.'
 outputs:
   go-version:
-    description: 'The installed Go version. Useful when given a version range as input.'
+    description: 'The installed Go version. Useful when given a version range as input.'  
+  cache-hit: 
+    description: 'A boolean value to indicate if a cache was hit'
 runs:
   using: 'node16'
-  main: 'dist/index.js'
+  main: 'dist/setup/index.js'
+  post: 'dist/cache-save/index.js'
+  post-if: success()

docs/contributors.md

@@ -1,17 +1,115 @@
 # Contributors
 
+Thank you for contributing!
 
-# Checkin
+We have prepared a short guide so that the process of making your contribution is as simple and clear as possible. Please check it out before you contribute!
 
-- Do checkin source (src)
-- Do checkin build output (lib)
-- Do checkin runtime node_modules
-- Do not checkin 
+## How can I contribute...
 
-# Adding a dev dependency
+* [Contribute Documentation:green_book:](#contribute-documentation)
 
-Remember to update .gitignore.  
+* [Contribute Code :computer:](#contribute-code)
 
-# Updating toolkit dependency
+* [Provide Support on Issues:pencil:](#provide-support-on-issues)
 
-Until released publically, update tgz packages in toolkit
+* [Review Pull Requests:mag:](#review-pull-requests)
+
+## Contribute documentation
+
+Documentation is a super important, critical part of this project. Docs are how we keep track of what we're doing, how, and why. It's how we stay on the same page about our policies and how we tell others everything they need to be able to use this project or contribute to it. 
+
+Documentation contributions of any size are welcome! Feel free to contribute even if you're just rewording a sentence to be more clear, or fixing a spelling mistake!
+
+**How to contribute:**
+
+Pull requests are the easiest way to contribute changes to git repos at GitHub. They are the preferred contribution method, as they offer a nice way of commenting and amending the proposed changes.
+
+- Please check that no one else has already created a pull request with these changes
+- Use a "feature branch" for your changes. That separates the changes in the pull request from your other changes and makes it easy to edit/amend commits in the pull request 
+- Make sure your changes are formatted correctly and consistently with the rest of the documentation
+- Re-read what you wrote, and run a spellchecker on it to make sure you didn't miss anything
+- If your pull request is connected to an open issue, please, leave a link to this issue in the `Related issue:` section
+- If you later need to add new commits to the pull request, you can simply commit the changes to the local branch and then push them. The pull request gets automatically updated
+
+**Once you've filed the pull request:**
+
+- Maintainers will review your pull request
+- If a maintainer requests changes, first of all, try to think about this request critically and only after that implement and request another review
+- If your PR gets accepted, it will soon be merged into the main branch. But your contribution will take effect only after the release of a new version of the action
+> Sometimes maintainers reject pull requests and that's ok! Usually, along with rejection, we supply the reason for it. Nonetheless, we still really appreciate you taking the time to do it, and we don't take that lightly :heart:
+
+## Contribute code
+
+We like code commits a lot! They're super handy, and they keep the project going and doing the work it needs to do to be useful to others.
+
+Code contributions of just about any size are acceptable!
+
+The main difference between code contributions and documentation contributions is that contributing code requires the inclusion of relevant tests for the code being added or changed. Contributions without accompanying tests will be held off until a test is added unless the maintainers consider the specific tests to be either impossible or way too much of a burden for such a contribution.
+
+**How to contribute:**
+
+Pull requests are the easiest way to contribute changes to git repos at GitHub. They are the preferred contribution method, as they offer a nice way of commenting and amending the proposed changes.
+
+- Please check that no one else has already created a pull request with these changes
+- Use a "feature branch" for your changes. That separates the changes in the pull request from your other changes and makes it easy to edit/amend commits in the pull request
+-  **Run `pre-checkin` script to format, build and test changes**
+- Make sure your changes are well formatted and that all tests are passing
+- If your pull request is connected to an open issue, please, leave a link to this issue in the `Related issue:` section
+- If you later need to add new commits to the pull request, you can simply commit the changes to the local branch and then push them. The pull request gets automatically updated
+
+**Learn more about how to work with the repository:**
+
+- To implement new features or fix bugs, you need to make changes to the `.ts` files, which are located in the `src` folder
+- To comply with the code style, **you need to run the `format` script**
+- To transpile source code to `javascript` we use [NCC](https://github.com/vercel/ncc). **It is very important to run the `build` script after making changes**, otherwise your changes will not get into the final `javascript` build
+- You can also start formatting, building code, and testing with a single `pre-checkin` command
+
+**Learn more about how to implement tests:**
+
+Adding or changing tests is an integral part of making a change to the code. 
+Unit tests are in the `__tests__` folder, and end-to-end tests are in the `workflows` folder (in particular, in the file [versions.yml](https://github.com/actions/setup-go/blob/main/.github/workflows/versions.yml)).
+
+- The contributor can add various types of tests (like unit tests or end-to-end tests), which, in his opinion, will be necessary and sufficient for testing new or changed functionality
+- Tests should cover a successful execution, as well as some edge cases and possible errors
+- As already mentioned, pull requests without tests will be considered more carefully by maintainers. If you are sure that in this situation the tests are not needed or cannot be implemented with a commensurate effort - please add this clarification message to your pull request
+
+**Once you've filed the pull request:**
+
+- CI will start automatically with some checks. Wait until the end of the execution and make sure that all checks passed successfully. If some checks fail, you can open them one by one, try to find the reason for failing and make changes to your code to resolve the problem
+- Maintainers will review your pull request
+- If a maintainer requests changes, first of all, try to think about his request critically and only after that implement and request another review
+- If your PR gets accepted, it will soon be merged into the main branch. But your contribution will take effect only after the release of a new version of the action
+> Sometimes maintainers reject pull requests and that's ok! Usually, along with rejection, we supply the reason for it. Nonetheless, we still really appreciate you taking the time to do it, and we don't take that lightly :heart:
+
+## Provide support on issues
+
+Helping out other users with their questions is an awesome way of contributing to any community. It's not uncommon for most of the issues on open source projects to be support-related questions by users trying to understand something they ran into or find their way around a known bug.
+
+**To help other folks out with their questions:**
+
+- Go to the [issue tracker](https://github.com/actions/setup-go/issues)
+- Read through the list until you find something that you're familiar enough with to answer to
+- Respond to the issue with whatever details are needed to clarify the question, or get more details about what's going on
+- Once the discussion wraps up and things are clarified, ask the original issue filer (or a maintainer) to close it for you
+ 
+*Some notes on picking up support issues:*
+
+- Avoid responding to issues you don't know you can answer accurately
+- Try to refer to past issues with accepted answers as much as possible. Link to them from your replies
+- Be kind and patient with users. Often, folks who have run into confusing things might be upset or impatient. This is natural. If you feel uncomfortable in conversation with them, it's better to stay away or withdraw from the issue.
+
+ > If some user is violating our code of conduct [standards](https://github.com/actions/setup-go/blob/main/CODE_OF_CONDUCT.md#our-standards), refer to the [Enforcement](https://github.com/actions/setup-go/blob/main/CODE_OF_CONDUCT.md#enforcement) section of the Code of Conduct to resolve the conflict
+ 
+
+## Review pull requests
+ 
+
+Another great way to contribute is pull request reviews. Please, be extra kind: people who submit code/doc contributions are putting themselves in a pretty vulnerable position, and have put time and care into what they've done (even if that's not obvious to you!) Please, always respond with respect, and be understanding, but don't feel like you need to sacrifice your standards for their sake, either.
+ 
+**How to review:**
+
+- Go to the [pull requests](https://github.com/actions/setup-go/pulls)
+- Make sure you're familiar with the code or documentation is updated, unless it's a minor change (spellchecking, minor formatting, etc.)
+- Review changes using the GitHub functionality. You can ask a clarifying question, point out an error or suggest an alternative. 
+> Note: You may ask for minor changes - "nitpicks", but consider whether they are real blockers to merging or not
+- Submit your review, which may include comments, an approval, or a changes request

package.json

@@ -1,11 +1,11 @@
 {
   "name": "setup-go",
-  "version": "1.0.0",
+  "version": "3.3.0",
   "private": true,
   "description": "setup go action",
   "main": "lib/setup-go.js",
   "scripts": {
-    "build": "tsc && ncc build",
+    "build": "tsc && ncc build -o dist/setup src/setup-go.ts && ncc build -o dist/cache-save src/cache-save.ts",
     "format": "prettier --write **/*.ts",
     "format-check": "prettier --check **/*.ts",
     "test": "jest --coverage",
@@ -23,8 +23,11 @@
   "author": "GitHub",
   "license": "MIT",
   "dependencies": {
-    "@actions/core": "^1.6.0",
-    "@actions/http-client": "^1.0.6",
+    "@actions/cache": "^3.0.0",
+    "@actions/core": "^1.10.0",
+    "@actions/exec": "^1.1.0",
+    "@actions/glob": "^0.2.0",
+    "@actions/http-client": "^2.0.1",
     "@actions/io": "^1.0.2",
     "@actions/tool-cache": "^1.5.5",
     "semver": "^6.1.1"

src/cache-restore.ts

@@ -0,0 +1,63 @@
+import * as cache from '@actions/cache';
+import * as core from '@actions/core';
+import * as glob from '@actions/glob';
+import path from 'path';
+import fs from 'fs';
+
+import {State, Outputs} from './constants';
+import {PackageManagerInfo} from './package-managers';
+import {getCacheDirectoryPath, getPackageManagerInfo} from './cache-utils';
+
+export const restoreCache = async (
+  versionSpec: string,
+  packageManager: string,
+  cacheDependencyPath?: string
+) => {
+  const packageManagerInfo = await getPackageManagerInfo(packageManager);
+  const platform = process.env.RUNNER_OS;
+
+  const cachePaths = await getCacheDirectoryPath(packageManagerInfo);
+
+  const dependencyFilePath = cacheDependencyPath
+    ? cacheDependencyPath
+    : findDependencyFile(packageManagerInfo);
+  const fileHash = await glob.hashFiles(dependencyFilePath);
+
+  if (!fileHash) {
+    throw new Error(
+      'Some specified paths were not resolved, unable to cache dependencies.'
+    );
+  }
+
+  const primaryKey = `setup-go-${platform}-go-${versionSpec}-${fileHash}`;
+  core.debug(`primary key is ${primaryKey}`);
+
+  core.saveState(State.CachePrimaryKey, primaryKey);
+
+  const cacheKey = await cache.restoreCache(cachePaths, primaryKey);
+  core.setOutput(Outputs.CacheHit, Boolean(cacheKey));
+
+  if (!cacheKey) {
+    core.info(`Cache is not found`);
+    core.setOutput(Outputs.CacheHit, false);
+    return;
+  }
+
+  core.saveState(State.CacheMatchedKey, cacheKey);
+  core.info(`Cache restored from key: ${cacheKey}`);
+};
+
+const findDependencyFile = (packageManager: PackageManagerInfo) => {
+  let dependencyFile = packageManager.dependencyFilePattern;
+  const workspace = process.env.GITHUB_WORKSPACE!;
+  const rootContent = fs.readdirSync(workspace);
+
+  const goSumFileExists = rootContent.includes(dependencyFile);
+  if (!goSumFileExists) {
+    throw new Error(
+      `Dependencies file is not found in ${workspace}. Supported file pattern: ${dependencyFile}`
+    );
+  }
+
+  return path.join(workspace, dependencyFile);
+};

src/cache-save.ts

@@ -0,0 +1,81 @@
+import * as core from '@actions/core';
+import * as cache from '@actions/cache';
+import fs from 'fs';
+import {State} from './constants';
+import {getCacheDirectoryPath, getPackageManagerInfo} from './cache-utils';
+
+// Catch and log any unhandled exceptions.  These exceptions can leak out of the uploadChunk method in
+// @actions/toolkit when a failed upload closes the file descriptor causing any in-process reads to
+// throw an uncaught exception.  Instead of failing this action, just warn.
+process.on('uncaughtException', e => {
+  const warningPrefix = '[warning]';
+  core.info(`${warningPrefix}${e.message}`);
+});
+
+export async function run() {
+  try {
+    await cachePackages();
+  } catch (error) {
+    let message = 'Unknown error!';
+    if (error instanceof Error) {
+      message = error.message;
+    }
+    if (typeof error === 'string') {
+      message = error;
+    }
+    core.setFailed(message);
+  }
+}
+
+const cachePackages = async () => {
+  const cacheInput = core.getBooleanInput('cache');
+  if (!cacheInput) {
+    return;
+  }
+
+  const packageManager = 'default';
+
+  const state = core.getState(State.CacheMatchedKey);
+  const primaryKey = core.getState(State.CachePrimaryKey);
+
+  const packageManagerInfo = await getPackageManagerInfo(packageManager);
+
+  const cachePaths = await getCacheDirectoryPath(packageManagerInfo);
+
+  const nonExistingPaths = cachePaths.filter(
+    cachePath => !fs.existsSync(cachePath)
+  );
+
+  if (nonExistingPaths.length === cachePaths.length) {
+    core.warning('There are no cache folders on the disk');
+    return;
+  }
+
+  if (nonExistingPaths.length) {
+    logWarning(
+      `Cache folder path is retrieved but doesn't exist on disk: ${nonExistingPaths.join(
+        ', '
+      )}`
+    );
+  }
+
+  if (primaryKey === state) {
+    core.info(
+      `Cache hit occurred on the primary key ${primaryKey}, not saving cache.`
+    );
+    return;
+  }
+
+  const cacheId = await cache.saveCache(cachePaths, primaryKey);
+  if (cacheId === -1) {
+    return;
+  }
+  core.info(`Cache saved with the key: ${primaryKey}`);
+};
+
+function logWarning(message: string): void {
+  const warningPrefix = '[warning]';
+  core.info(`${warningPrefix}${message}`);
+}
+
+run();

src/cache-utils.ts

@@ -0,0 +1,75 @@
+import * as cache from '@actions/cache';
+import * as core from '@actions/core';
+import * as exec from '@actions/exec';
+import {supportedPackageManagers, PackageManagerInfo} from './package-managers';
+
+export const getCommandOutput = async (toolCommand: string) => {
+  let {stdout, stderr, exitCode} = await exec.getExecOutput(
+    toolCommand,
+    undefined,
+    {ignoreReturnCode: true}
+  );
+
+  if (exitCode) {
+    stderr = !stderr.trim()
+      ? `The '${toolCommand}' command failed with exit code: ${exitCode}`
+      : stderr;
+    throw new Error(stderr);
+  }
+
+  return stdout.trim();
+};
+
+export const getPackageManagerInfo = async (packageManager: string) => {
+  if (!supportedPackageManagers[packageManager]) {
+    throw new Error(
+      `It's not possible to use ${packageManager}, please, check correctness of the package manager name spelling.`
+    );
+  }
+  const obtainedPackageManager = supportedPackageManagers[packageManager];
+
+  return obtainedPackageManager;
+};
+
+export const getCacheDirectoryPath = async (
+  packageManagerInfo: PackageManagerInfo
+) => {
+  let pathList = await Promise.all(
+    packageManagerInfo.cacheFolderCommandList.map(command =>
+      getCommandOutput(command)
+    )
+  );
+
+  const emptyPaths = pathList.filter(item => !item);
+
+  if (emptyPaths.length) {
+    throw new Error(`Could not get cache folder paths.`);
+  }
+
+  return pathList;
+};
+
+export function isGhes(): boolean {
+  const ghUrl = new URL(
+    process.env['GITHUB_SERVER_URL'] || 'https://github.com'
+  );
+  return ghUrl.hostname.toUpperCase() !== 'GITHUB.COM';
+}
+
+export function isCacheFeatureAvailable(): boolean {
+  if (!cache.isFeatureAvailable()) {
+    if (isGhes()) {
+      throw new Error(
+        'Cache action is only supported on GHES version >= 3.5. If you are on version >=3.5 Please check with GHES admin if Actions cache service is enabled or not.'
+      );
+    } else {
+      core.warning(
+        'The runner was not able to contact the cache service. Caching will be skipped'
+      );
+    }
+
+    return false;
+  }
+
+  return true;
+}

src/constants.ts

@@ -0,0 +1,8 @@
+export enum State {
+  CachePrimaryKey = 'CACHE_KEY',
+  CacheMatchedKey = 'CACHE_RESULT'
+}
+
+export enum Outputs {
+  CacheHit = 'cache-hit'
+}

src/installer.ts

@@ -32,17 +32,18 @@ export interface IGoVersionInfo {
 export async function getGo(
   versionSpec: string,
   checkLatest: boolean,
-  auth: string | undefined
+  auth: string | undefined,
+  arch = os.arch()
 ) {
   let osPlat: string = os.platform();
-  let osArch: string = os.arch();
 
   if (checkLatest) {
     core.info('Attempting to resolve the latest version from the manifest...');
     const resolvedVersion = await resolveVersionFromManifest(
       versionSpec,
       true,
-      auth
+      auth,
+      arch
     );
     if (resolvedVersion) {
       versionSpec = resolvedVersion;
@@ -54,7 +55,7 @@ export async function getGo(
 
   // check cache
   let toolPath: string;
-  toolPath = tc.find('go', versionSpec);
+  toolPath = tc.find('go', versionSpec, arch);
   // If not found in cache, download
   if (toolPath) {
     core.info(`Found in cache @ ${toolPath}`);
@@ -68,9 +69,9 @@ export async function getGo(
   // Try download from internal distribution (popular versions only)
   //
   try {
-    info = await getInfoFromManifest(versionSpec, true, auth);
+    info = await getInfoFromManifest(versionSpec, true, auth, arch);
     if (info) {
-      downloadPath = await installGoVersion(info, auth);
+      downloadPath = await installGoVersion(info, auth, arch);
     } else {
       core.info(
         'Not found in manifest.  Falling back to download directly from Go'
@@ -95,16 +96,16 @@ export async function getGo(
   // Download from storage.googleapis.com
   //
   if (!downloadPath) {
-    info = await getInfoFromDist(versionSpec);
+    info = await getInfoFromDist(versionSpec, arch);
     if (!info) {
       throw new Error(
-        `Unable to find Go version '${versionSpec}' for platform ${osPlat} and architecture ${osArch}.`
+        `Unable to find Go version '${versionSpec}' for platform ${osPlat} and architecture ${arch}.`
       );
     }
 
     try {
       core.info('Install from dist');
-      downloadPath = await installGoVersion(info, undefined);
+      downloadPath = await installGoVersion(info, undefined, arch);
     } catch (err) {
       throw new Error(`Failed to download version ${versionSpec}: ${err}`);
     }
@@ -116,10 +117,11 @@ export async function getGo(
 async function resolveVersionFromManifest(
   versionSpec: string,
   stable: boolean,
-  auth: string | undefined
+  auth: string | undefined,
+  arch: string
 ): Promise<string | undefined> {
   try {
-    const info = await getInfoFromManifest(versionSpec, stable, auth);
+    const info = await getInfoFromManifest(versionSpec, stable, auth, arch);
     return info?.resolvedVersion;
   } catch (err) {
     core.info('Unable to resolve a version from the manifest...');
@@ -129,10 +131,17 @@ async function resolveVersionFromManifest(
 
 async function installGoVersion(
   info: IGoVersionInfo,
-  auth: string | undefined
+  auth: string | undefined,
+  arch: string
 ): Promise<string> {
   core.info(`Acquiring ${info.resolvedVersion} from ${info.downloadUrl}`);
-  const downloadPath = await tc.downloadTool(info.downloadUrl, undefined, auth);
+
+  // Windows requires that we keep the extension (.zip) for extraction
+  const isWindows = os.platform() === 'win32';
+  const tempDir = process.env.RUNNER_TEMP || '.';
+  const fileName = isWindows ? path.join(tempDir, info.fileName) : undefined;
+
+  const downloadPath = await tc.downloadTool(info.downloadUrl, fileName, auth);
 
   core.info('Extracting Go...');
   let extPath = await extractGoArchive(downloadPath);
@@ -145,7 +154,8 @@ async function installGoVersion(
   const cachedDir = await tc.cacheDir(
     extPath,
     'go',
-    makeSemver(info.resolvedVersion)
+    makeSemver(info.resolvedVersion),
+    arch
   );
   core.info(`Successfully cached go to ${cachedDir}`);
   return cachedDir;
@@ -167,7 +177,8 @@ export async function extractGoArchive(archivePath: string): Promise<string> {
 export async function getInfoFromManifest(
   versionSpec: string,
   stable: boolean,
-  auth: string | undefined
+  auth: string | undefined,
+  arch = os.arch()
 ): Promise<IGoVersionInfo | null> {
   let info: IGoVersionInfo | null = null;
   const releases = await tc.getManifestFromRepo(
@@ -177,7 +188,7 @@ export async function getInfoFromManifest(
     'main'
   );
   core.info(`matching ${versionSpec}...`);
-  const rel = await tc.findFromManifest(versionSpec, stable, releases);
+  const rel = await tc.findFromManifest(versionSpec, stable, releases, arch);
 
   if (rel && rel.files.length > 0) {
     info = <IGoVersionInfo>{};
@@ -191,10 +202,11 @@ export async function getInfoFromManifest(
 }
 
 async function getInfoFromDist(
-  versionSpec: string
+  versionSpec: string,
+  arch: string
 ): Promise<IGoVersionInfo | null> {
   let version: IGoVersion | undefined;
-  version = await findMatch(versionSpec);
+  version = await findMatch(versionSpec, arch);
   if (!version) {
     return null;
   }
@@ -210,9 +222,10 @@ async function getInfoFromDist(
 }
 
 export async function findMatch(
-  versionSpec: string
+  versionSpec: string,
+  arch = os.arch()
 ): Promise<IGoVersion | undefined> {
-  let archFilter = sys.getArch();
+  let archFilter = sys.getArch(arch);
   let platFilter = sys.getPlatform();
 
   let result: IGoVersion | undefined;

src/main.ts

@@ -3,9 +3,11 @@ import * as io from '@actions/io';
 import * as installer from './installer';
 import * as semver from 'semver';
 import path from 'path';
+import {restoreCache} from './cache-restore';
+import {isGhes, isCacheFeatureAvailable} from './cache-utils';
 import cp from 'child_process';
 import fs from 'fs';
-import {URL} from 'url';
+import os from 'os';
 
 export async function run() {
   try {
@@ -15,14 +17,26 @@ export async function run() {
     //
     const versionSpec = resolveVersionInput();
 
+    const cache = core.getBooleanInput('cache');
     core.info(`Setup go version spec ${versionSpec}`);
 
+    let arch = core.getInput('architecture');
+
+    if (!arch) {
+      arch = os.arch();
+    }
+
     if (versionSpec) {
       let token = core.getInput('token');
       let auth = !token || isGhes() ? undefined : `token ${token}`;
 
       const checkLatest = core.getBooleanInput('check-latest');
-      const installDir = await installer.getGo(versionSpec, checkLatest, auth);
+      const installDir = await installer.getGo(
+        versionSpec,
+        checkLatest,
+        auth,
+        arch
+      );
 
       core.addPath(path.join(installDir, 'bin'));
       core.info('Added go to the path');
@@ -39,8 +53,14 @@ export async function run() {
       core.info(`Successfully set up Go version ${versionSpec}`);
     }
 
+    if (cache && isCacheFeatureAvailable()) {
+      const packageManager = 'default';
+      const cacheDependencyPath = core.getInput('cache-dependency-path');
+      await restoreCache(versionSpec, packageManager, cacheDependencyPath);
+    }
+
     // add problem matchers
-    const matchersPath = path.join(__dirname, '..', 'matchers.json');
+    const matchersPath = path.join(__dirname, '../..', 'matchers.json');
     core.info(`##[add-matcher]${matchersPath}`);
 
     // output the version actually being used
@@ -90,13 +110,6 @@ export async function addBinToPath(): Promise<boolean> {
   return added;
 }
 
-function isGhes(): boolean {
-  const ghUrl = new URL(
-    process.env['GITHUB_SERVER_URL'] || 'https://github.com'
-  );
-  return ghUrl.hostname.toUpperCase() !== 'GITHUB.COM';
-}
-
 export function parseGoVersion(versionString: string): string {
   // get the installed version as an Action output
   // based on go/src/cmd/go/internal/version/version.go:

src/package-managers.ts

@@ -0,0 +1,15 @@
+type SupportedPackageManagers = {
+  [prop: string]: PackageManagerInfo;
+};
+
+export interface PackageManagerInfo {
+  dependencyFilePattern: string;
+  cacheFolderCommandList: string[];
+}
+
+export const supportedPackageManagers: SupportedPackageManagers = {
+  default: {
+    dependencyFilePattern: 'go.sum',
+    cacheFolderCommandList: ['go env GOMODCACHE', 'go env GOCACHE']
+  }
+};

src/system.ts

@@ -15,9 +15,8 @@ export function getPlatform(): string {
   return plat;
 }
 
-export function getArch(): string {
+export function getArch(arch: string): string {
   // 'arm', 'arm64', 'ia32', 'mips', 'mipsel', 'ppc', 'ppc64', 's390', 's390x', 'x32', and 'x64'.
-  let arch: string = os.arch();
 
   // wants amd64, 386, arm64, armv61, ppc641e, s390x
   // currently not supported by runner but future proofed mapping
@@ -31,6 +30,9 @@ export function getArch(): string {
     case 'x32':
       arch = '386';
       break;
+    case 'arm':
+      arch = 'armv6l';
+      break;
   }
 
   return arch;