mirror of
				https://gitea.com/actions/cache.git
				synced 2025-10-29 07:47:12 +00:00 
			
		
		
		
	Compare commits
	
		
			8 Commits
		
	
	
		
			joshmgross
			...
			joshmgross
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
|   | 7527073910 | ||
|   | a631fadf14 | ||
|   | e223b0a12d | ||
|   | decbafc350 | ||
|   | 3854a40aee | ||
|   | 0188dffc5a | ||
|   | 002d3a77f4 | ||
|   | 4809f4ada4 | 
							
								
								
									
										27
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										27
									
								
								README.md
									
									
									
									
									
								
							| @@ -35,7 +35,7 @@ on: push | |||||||
| jobs: | jobs: | ||||||
|   build: |   build: | ||||||
|     runs-on: ubuntu-latest |     runs-on: ubuntu-latest | ||||||
|      |  | ||||||
|     steps: |     steps: | ||||||
|     - uses: actions/checkout@v1 |     - uses: actions/checkout@v1 | ||||||
|  |  | ||||||
| @@ -49,14 +49,31 @@ jobs: | |||||||
|     - name: Generate Prime Numbers |     - name: Generate Prime Numbers | ||||||
|       if: steps.cache-primes.outputs.cache-hit != 'true' |       if: steps.cache-primes.outputs.cache-hit != 'true' | ||||||
|       run: /generate-primes.sh -d prime-numbers |       run: /generate-primes.sh -d prime-numbers | ||||||
|      |  | ||||||
|     - name: Use Prime Numbers |     - name: Use Prime Numbers | ||||||
|       run: /primes.sh -d prime-numbers |       run: /primes.sh -d prime-numbers | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## Ecosystem Examples | ## Implementation Examples | ||||||
|  |  | ||||||
|  | Every programming language and framework has its own way of caching. | ||||||
|  |  | ||||||
|  | See [Examples](examples.md) for a list of `actions/cache` implementations for use with: | ||||||
|  |  | ||||||
|  | - [C# - Nuget](./examples.md#c---nuget) | ||||||
|  | - [Elixir - Mix](./examples.md#elixir---mix) | ||||||
|  | - [Go - Modules](./examples.md#go---modules) | ||||||
|  | - [Java - Gradle](./examples.md#java---gradle) | ||||||
|  | - [Java - Maven](./examples.md#java---maven) | ||||||
|  | - [Node - npm](./examples.md#node---npm) | ||||||
|  | - [Node - Yarn](./examples.md#node---yarn) | ||||||
|  | - [PHP - Composer](./examples.md#php---composer) | ||||||
|  | - [Python - pip](./examples.md#python---pip) | ||||||
|  | - [Ruby - Gem](./examples.md#ruby---gem) | ||||||
|  | - [Rust - Cargo](./examples.md#rust---cargo) | ||||||
|  | - [Swift, Objective-C - Carthage](./examples.md#swift-objective-c---carthage) | ||||||
|  | - [Swift, Objective-C - CocoaPods](./examples.md#swift-objective-c---cocoapods) | ||||||
|  |  | ||||||
| See [Examples](examples.md) |  | ||||||
|  |  | ||||||
| ## Cache Limits | ## Cache Limits | ||||||
|  |  | ||||||
| @@ -76,7 +93,7 @@ steps: | |||||||
|     with: |     with: | ||||||
|       path: path/to/dependencies |       path: path/to/dependencies | ||||||
|       key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }} |       key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }} | ||||||
|    |  | ||||||
|   - name: Install Dependencies |   - name: Install Dependencies | ||||||
|     if: steps.cache.outputs.cache-hit != 'true' |     if: steps.cache.outputs.cache-hit != 'true' | ||||||
|     run: /install.sh |     run: /install.sh | ||||||
|   | |||||||
| @@ -1,18 +1,16 @@ | |||||||
| import * as core from "@actions/core"; | import * as core from "@actions/core"; | ||||||
| import * as exec from "@actions/exec"; |  | ||||||
| import * as io from "@actions/io"; |  | ||||||
| import * as path from "path"; | import * as path from "path"; | ||||||
| import * as cacheHttpClient from "../src/cacheHttpClient"; | import * as cacheHttpClient from "../src/cacheHttpClient"; | ||||||
| import { Events, Inputs } from "../src/constants"; | import { Events, Inputs } from "../src/constants"; | ||||||
| import { ArtifactCacheEntry } from "../src/contracts"; | import { ArtifactCacheEntry } from "../src/contracts"; | ||||||
| import run from "../src/restore"; | import run from "../src/restore"; | ||||||
|  | import * as tar from "../src/tar"; | ||||||
| import * as actionUtils from "../src/utils/actionUtils"; | import * as actionUtils from "../src/utils/actionUtils"; | ||||||
| import * as testUtils from "../src/utils/testUtils"; | import * as testUtils from "../src/utils/testUtils"; | ||||||
|  |  | ||||||
| jest.mock("@actions/exec"); |  | ||||||
| jest.mock("@actions/io"); |  | ||||||
| jest.mock("../src/utils/actionUtils"); |  | ||||||
| jest.mock("../src/cacheHttpClient"); | jest.mock("../src/cacheHttpClient"); | ||||||
|  | jest.mock("../src/tar"); | ||||||
|  | jest.mock("../src/utils/actionUtils"); | ||||||
|  |  | ||||||
| beforeAll(() => { | beforeAll(() => { | ||||||
|     jest.spyOn(actionUtils, "resolvePath").mockImplementation(filePath => { |     jest.spyOn(actionUtils, "resolvePath").mockImplementation(filePath => { | ||||||
| @@ -35,10 +33,6 @@ beforeAll(() => { | |||||||
|         const actualUtils = jest.requireActual("../src/utils/actionUtils"); |         const actualUtils = jest.requireActual("../src/utils/actionUtils"); | ||||||
|         return actualUtils.getSupportedEvents(); |         return actualUtils.getSupportedEvents(); | ||||||
|     }); |     }); | ||||||
|  |  | ||||||
|     jest.spyOn(io, "which").mockImplementation(tool => { |  | ||||||
|         return Promise.resolve(tool); |  | ||||||
|     }); |  | ||||||
| }); | }); | ||||||
|  |  | ||||||
| beforeEach(() => { | beforeEach(() => { | ||||||
| @@ -245,8 +239,7 @@ test("restore with cache found", async () => { | |||||||
|         .spyOn(actionUtils, "getArchiveFileSize") |         .spyOn(actionUtils, "getArchiveFileSize") | ||||||
|         .mockReturnValue(fileSize); |         .mockReturnValue(fileSize); | ||||||
|  |  | ||||||
|     const mkdirMock = jest.spyOn(io, "mkdirP"); |     const extractTarMock = jest.spyOn(tar, "extractTar"); | ||||||
|     const execMock = jest.spyOn(exec, "exec"); |  | ||||||
|     const setCacheHitOutputMock = jest.spyOn(actionUtils, "setCacheHitOutput"); |     const setCacheHitOutputMock = jest.spyOn(actionUtils, "setCacheHitOutput"); | ||||||
|  |  | ||||||
|     await run(); |     await run(); | ||||||
| @@ -257,22 +250,9 @@ test("restore with cache found", async () => { | |||||||
|     expect(createTempDirectoryMock).toHaveBeenCalledTimes(1); |     expect(createTempDirectoryMock).toHaveBeenCalledTimes(1); | ||||||
|     expect(downloadCacheMock).toHaveBeenCalledWith(cacheEntry, archivePath); |     expect(downloadCacheMock).toHaveBeenCalledWith(cacheEntry, archivePath); | ||||||
|     expect(getArchiveFileSizeMock).toHaveBeenCalledWith(archivePath); |     expect(getArchiveFileSizeMock).toHaveBeenCalledWith(archivePath); | ||||||
|     expect(mkdirMock).toHaveBeenCalledWith(cachePath); |  | ||||||
|  |  | ||||||
|     const IS_WINDOWS = process.platform === "win32"; |     expect(extractTarMock).toHaveBeenCalledTimes(1); | ||||||
|     const args = IS_WINDOWS |     expect(extractTarMock).toHaveBeenCalledWith(archivePath, cachePath); | ||||||
|         ? [ |  | ||||||
|               "-xz", |  | ||||||
|               "--force-local", |  | ||||||
|               "-f", |  | ||||||
|               archivePath.replace(/\\/g, "/"), |  | ||||||
|               "-C", |  | ||||||
|               cachePath.replace(/\\/g, "/") |  | ||||||
|           ] |  | ||||||
|         : ["-xz", "-f", archivePath, "-C", cachePath]; |  | ||||||
|  |  | ||||||
|     expect(execMock).toHaveBeenCalledTimes(1); |  | ||||||
|     expect(execMock).toHaveBeenCalledWith(`"tar"`, args); |  | ||||||
|  |  | ||||||
|     expect(setCacheHitOutputMock).toHaveBeenCalledTimes(1); |     expect(setCacheHitOutputMock).toHaveBeenCalledTimes(1); | ||||||
|     expect(setCacheHitOutputMock).toHaveBeenCalledWith(true); |     expect(setCacheHitOutputMock).toHaveBeenCalledWith(true); | ||||||
| @@ -323,8 +303,7 @@ test("restore with a pull request event and cache found", async () => { | |||||||
|         .spyOn(actionUtils, "getArchiveFileSize") |         .spyOn(actionUtils, "getArchiveFileSize") | ||||||
|         .mockReturnValue(fileSize); |         .mockReturnValue(fileSize); | ||||||
|  |  | ||||||
|     const mkdirMock = jest.spyOn(io, "mkdirP"); |     const extractTarMock = jest.spyOn(tar, "extractTar"); | ||||||
|     const execMock = jest.spyOn(exec, "exec"); |  | ||||||
|     const setCacheHitOutputMock = jest.spyOn(actionUtils, "setCacheHitOutput"); |     const setCacheHitOutputMock = jest.spyOn(actionUtils, "setCacheHitOutput"); | ||||||
|  |  | ||||||
|     await run(); |     await run(); | ||||||
| @@ -336,22 +315,9 @@ test("restore with a pull request event and cache found", async () => { | |||||||
|     expect(downloadCacheMock).toHaveBeenCalledWith(cacheEntry, archivePath); |     expect(downloadCacheMock).toHaveBeenCalledWith(cacheEntry, archivePath); | ||||||
|     expect(getArchiveFileSizeMock).toHaveBeenCalledWith(archivePath); |     expect(getArchiveFileSizeMock).toHaveBeenCalledWith(archivePath); | ||||||
|     expect(infoMock).toHaveBeenCalledWith(`Cache Size: ~60 MB (62915000 B)`); |     expect(infoMock).toHaveBeenCalledWith(`Cache Size: ~60 MB (62915000 B)`); | ||||||
|     expect(mkdirMock).toHaveBeenCalledWith(cachePath); |  | ||||||
|  |  | ||||||
|     const IS_WINDOWS = process.platform === "win32"; |     expect(extractTarMock).toHaveBeenCalledTimes(1); | ||||||
|     const args = IS_WINDOWS |     expect(extractTarMock).toHaveBeenCalledWith(archivePath, cachePath); | ||||||
|         ? [ |  | ||||||
|               "-xz", |  | ||||||
|               "--force-local", |  | ||||||
|               "-f", |  | ||||||
|               archivePath.replace(/\\/g, "/"), |  | ||||||
|               "-C", |  | ||||||
|               cachePath.replace(/\\/g, "/") |  | ||||||
|           ] |  | ||||||
|         : ["-xz", "-f", archivePath, "-C", cachePath]; |  | ||||||
|  |  | ||||||
|     expect(execMock).toHaveBeenCalledTimes(1); |  | ||||||
|     expect(execMock).toHaveBeenCalledWith(`"tar"`, args); |  | ||||||
|  |  | ||||||
|     expect(setCacheHitOutputMock).toHaveBeenCalledTimes(1); |     expect(setCacheHitOutputMock).toHaveBeenCalledTimes(1); | ||||||
|     expect(setCacheHitOutputMock).toHaveBeenCalledWith(true); |     expect(setCacheHitOutputMock).toHaveBeenCalledWith(true); | ||||||
| @@ -402,8 +368,7 @@ test("restore with cache found for restore key", async () => { | |||||||
|         .spyOn(actionUtils, "getArchiveFileSize") |         .spyOn(actionUtils, "getArchiveFileSize") | ||||||
|         .mockReturnValue(fileSize); |         .mockReturnValue(fileSize); | ||||||
|  |  | ||||||
|     const mkdirMock = jest.spyOn(io, "mkdirP"); |     const extractTarMock = jest.spyOn(tar, "extractTar"); | ||||||
|     const execMock = jest.spyOn(exec, "exec"); |  | ||||||
|     const setCacheHitOutputMock = jest.spyOn(actionUtils, "setCacheHitOutput"); |     const setCacheHitOutputMock = jest.spyOn(actionUtils, "setCacheHitOutput"); | ||||||
|  |  | ||||||
|     await run(); |     await run(); | ||||||
| @@ -415,22 +380,9 @@ test("restore with cache found for restore key", async () => { | |||||||
|     expect(downloadCacheMock).toHaveBeenCalledWith(cacheEntry, archivePath); |     expect(downloadCacheMock).toHaveBeenCalledWith(cacheEntry, archivePath); | ||||||
|     expect(getArchiveFileSizeMock).toHaveBeenCalledWith(archivePath); |     expect(getArchiveFileSizeMock).toHaveBeenCalledWith(archivePath); | ||||||
|     expect(infoMock).toHaveBeenCalledWith(`Cache Size: ~0 MB (142 B)`); |     expect(infoMock).toHaveBeenCalledWith(`Cache Size: ~0 MB (142 B)`); | ||||||
|     expect(mkdirMock).toHaveBeenCalledWith(cachePath); |  | ||||||
|  |  | ||||||
|     const IS_WINDOWS = process.platform === "win32"; |     expect(extractTarMock).toHaveBeenCalledTimes(1); | ||||||
|     const args = IS_WINDOWS |     expect(extractTarMock).toHaveBeenCalledWith(archivePath, cachePath); | ||||||
|         ? [ |  | ||||||
|               "-xz", |  | ||||||
|               "--force-local", |  | ||||||
|               "-f", |  | ||||||
|               archivePath.replace(/\\/g, "/"), |  | ||||||
|               "-C", |  | ||||||
|               cachePath.replace(/\\/g, "/") |  | ||||||
|           ] |  | ||||||
|         : ["-xz", "-f", archivePath, "-C", cachePath]; |  | ||||||
|  |  | ||||||
|     expect(execMock).toHaveBeenCalledTimes(1); |  | ||||||
|     expect(execMock).toHaveBeenCalledWith(`"tar"`, args); |  | ||||||
|  |  | ||||||
|     expect(setCacheHitOutputMock).toHaveBeenCalledTimes(1); |     expect(setCacheHitOutputMock).toHaveBeenCalledTimes(1); | ||||||
|     expect(setCacheHitOutputMock).toHaveBeenCalledWith(false); |     expect(setCacheHitOutputMock).toHaveBeenCalledWith(false); | ||||||
|   | |||||||
| @@ -1,19 +1,17 @@ | |||||||
| import * as core from "@actions/core"; | import * as core from "@actions/core"; | ||||||
| import * as exec from "@actions/exec"; |  | ||||||
| import * as io from "@actions/io"; |  | ||||||
| import * as path from "path"; | import * as path from "path"; | ||||||
| import * as cacheHttpClient from "../src/cacheHttpClient"; | import * as cacheHttpClient from "../src/cacheHttpClient"; | ||||||
| import { Events, Inputs } from "../src/constants"; | import { Events, Inputs } from "../src/constants"; | ||||||
| import { ArtifactCacheEntry } from "../src/contracts"; | import { ArtifactCacheEntry } from "../src/contracts"; | ||||||
| import run from "../src/save"; | import run from "../src/save"; | ||||||
|  | import * as tar from "../src/tar"; | ||||||
| import * as actionUtils from "../src/utils/actionUtils"; | import * as actionUtils from "../src/utils/actionUtils"; | ||||||
| import * as testUtils from "../src/utils/testUtils"; | import * as testUtils from "../src/utils/testUtils"; | ||||||
|  |  | ||||||
| jest.mock("@actions/core"); | jest.mock("@actions/core"); | ||||||
| jest.mock("@actions/exec"); |  | ||||||
| jest.mock("@actions/io"); |  | ||||||
| jest.mock("../src/utils/actionUtils"); |  | ||||||
| jest.mock("../src/cacheHttpClient"); | jest.mock("../src/cacheHttpClient"); | ||||||
|  | jest.mock("../src/tar"); | ||||||
|  | jest.mock("../src/utils/actionUtils"); | ||||||
|  |  | ||||||
| beforeAll(() => { | beforeAll(() => { | ||||||
|     jest.spyOn(core, "getInput").mockImplementation((name, options) => { |     jest.spyOn(core, "getInput").mockImplementation((name, options) => { | ||||||
| @@ -49,10 +47,6 @@ beforeAll(() => { | |||||||
|     jest.spyOn(actionUtils, "createTempDirectory").mockImplementation(() => { |     jest.spyOn(actionUtils, "createTempDirectory").mockImplementation(() => { | ||||||
|         return Promise.resolve("/foo/bar"); |         return Promise.resolve("/foo/bar"); | ||||||
|     }); |     }); | ||||||
|  |  | ||||||
|     jest.spyOn(io, "which").mockImplementation(tool => { |  | ||||||
|         return Promise.resolve(tool); |  | ||||||
|     }); |  | ||||||
| }); | }); | ||||||
|  |  | ||||||
| beforeEach(() => { | beforeEach(() => { | ||||||
| @@ -128,7 +122,7 @@ test("save with exact match returns early", async () => { | |||||||
|             return primaryKey; |             return primaryKey; | ||||||
|         }); |         }); | ||||||
|  |  | ||||||
|     const execMock = jest.spyOn(exec, "exec"); |     const createTarMock = jest.spyOn(tar, "createTar"); | ||||||
|  |  | ||||||
|     await run(); |     await run(); | ||||||
|  |  | ||||||
| @@ -136,7 +130,7 @@ test("save with exact match returns early", async () => { | |||||||
|         `Cache hit occurred on the primary key ${primaryKey}, not saving cache.` |         `Cache hit occurred on the primary key ${primaryKey}, not saving cache.` | ||||||
|     ); |     ); | ||||||
|  |  | ||||||
|     expect(execMock).toHaveBeenCalledTimes(0); |     expect(createTarMock).toHaveBeenCalledTimes(0); | ||||||
|  |  | ||||||
|     expect(failedMock).toHaveBeenCalledTimes(0); |     expect(failedMock).toHaveBeenCalledTimes(0); | ||||||
| }); | }); | ||||||
| @@ -198,7 +192,7 @@ test("save with large cache outputs warning", async () => { | |||||||
|     const cachePath = path.resolve(inputPath); |     const cachePath = path.resolve(inputPath); | ||||||
|     testUtils.setInput(Inputs.Path, inputPath); |     testUtils.setInput(Inputs.Path, inputPath); | ||||||
|  |  | ||||||
|     const execMock = jest.spyOn(exec, "exec"); |     const createTarMock = jest.spyOn(tar, "createTar"); | ||||||
|  |  | ||||||
|     const cacheSize = 1024 * 1024 * 1024; //~1GB, over the 400MB limit |     const cacheSize = 1024 * 1024 * 1024; //~1GB, over the 400MB limit | ||||||
|     jest.spyOn(actionUtils, "getArchiveFileSize").mockImplementationOnce(() => { |     jest.spyOn(actionUtils, "getArchiveFileSize").mockImplementationOnce(() => { | ||||||
| @@ -209,21 +203,8 @@ test("save with large cache outputs warning", async () => { | |||||||
|  |  | ||||||
|     const archivePath = path.join("/foo/bar", "cache.tgz"); |     const archivePath = path.join("/foo/bar", "cache.tgz"); | ||||||
|  |  | ||||||
|     const IS_WINDOWS = process.platform === "win32"; |     expect(createTarMock).toHaveBeenCalledTimes(1); | ||||||
|     const args = IS_WINDOWS |     expect(createTarMock).toHaveBeenCalledWith(archivePath, cachePath); | ||||||
|         ? [ |  | ||||||
|               "-cz", |  | ||||||
|               "--force-local", |  | ||||||
|               "-f", |  | ||||||
|               archivePath.replace(/\\/g, "/"), |  | ||||||
|               "-C", |  | ||||||
|               cachePath.replace(/\\/g, "/"), |  | ||||||
|               "." |  | ||||||
|           ] |  | ||||||
|         : ["-cz", "-f", archivePath, "-C", cachePath, "."]; |  | ||||||
|  |  | ||||||
|     expect(execMock).toHaveBeenCalledTimes(1); |  | ||||||
|     expect(execMock).toHaveBeenCalledWith(`"tar"`, args); |  | ||||||
|  |  | ||||||
|     expect(logWarningMock).toHaveBeenCalledTimes(1); |     expect(logWarningMock).toHaveBeenCalledTimes(1); | ||||||
|     expect(logWarningMock).toHaveBeenCalledWith( |     expect(logWarningMock).toHaveBeenCalledWith( | ||||||
| @@ -259,7 +240,7 @@ test("save with server error outputs warning", async () => { | |||||||
|     const cachePath = path.resolve(inputPath); |     const cachePath = path.resolve(inputPath); | ||||||
|     testUtils.setInput(Inputs.Path, inputPath); |     testUtils.setInput(Inputs.Path, inputPath); | ||||||
|  |  | ||||||
|     const execMock = jest.spyOn(exec, "exec"); |     const createTarMock = jest.spyOn(tar, "createTar"); | ||||||
|  |  | ||||||
|     const saveCacheMock = jest |     const saveCacheMock = jest | ||||||
|         .spyOn(cacheHttpClient, "saveCache") |         .spyOn(cacheHttpClient, "saveCache") | ||||||
| @@ -271,21 +252,8 @@ test("save with server error outputs warning", async () => { | |||||||
|  |  | ||||||
|     const archivePath = path.join("/foo/bar", "cache.tgz"); |     const archivePath = path.join("/foo/bar", "cache.tgz"); | ||||||
|  |  | ||||||
|     const IS_WINDOWS = process.platform === "win32"; |     expect(createTarMock).toHaveBeenCalledTimes(1); | ||||||
|     const args = IS_WINDOWS |     expect(createTarMock).toHaveBeenCalledWith(archivePath, cachePath); | ||||||
|         ? [ |  | ||||||
|               "-cz", |  | ||||||
|               "--force-local", |  | ||||||
|               "-f", |  | ||||||
|               archivePath.replace(/\\/g, "/"), |  | ||||||
|               "-C", |  | ||||||
|               cachePath.replace(/\\/g, "/"), |  | ||||||
|               "." |  | ||||||
|           ] |  | ||||||
|         : ["-cz", "-f", archivePath, "-C", cachePath, "."]; |  | ||||||
|  |  | ||||||
|     expect(execMock).toHaveBeenCalledTimes(1); |  | ||||||
|     expect(execMock).toHaveBeenCalledWith(`"tar"`, args); |  | ||||||
|  |  | ||||||
|     expect(saveCacheMock).toHaveBeenCalledTimes(1); |     expect(saveCacheMock).toHaveBeenCalledTimes(1); | ||||||
|     expect(saveCacheMock).toHaveBeenCalledWith(primaryKey, archivePath); |     expect(saveCacheMock).toHaveBeenCalledWith(primaryKey, archivePath); | ||||||
| @@ -321,29 +289,15 @@ test("save with valid inputs uploads a cache", async () => { | |||||||
|     const cachePath = path.resolve(inputPath); |     const cachePath = path.resolve(inputPath); | ||||||
|     testUtils.setInput(Inputs.Path, inputPath); |     testUtils.setInput(Inputs.Path, inputPath); | ||||||
|  |  | ||||||
|     const execMock = jest.spyOn(exec, "exec"); |     const createTarMock = jest.spyOn(tar, "createTar"); | ||||||
|  |  | ||||||
|     const saveCacheMock = jest.spyOn(cacheHttpClient, "saveCache"); |     const saveCacheMock = jest.spyOn(cacheHttpClient, "saveCache"); | ||||||
|  |  | ||||||
|     await run(); |     await run(); | ||||||
|  |  | ||||||
|     const archivePath = path.join("/foo/bar", "cache.tgz"); |     const archivePath = path.join("/foo/bar", "cache.tgz"); | ||||||
|  |  | ||||||
|     const IS_WINDOWS = process.platform === "win32"; |     expect(createTarMock).toHaveBeenCalledTimes(1); | ||||||
|     const args = IS_WINDOWS |     expect(createTarMock).toHaveBeenCalledWith(archivePath, cachePath); | ||||||
|         ? [ |  | ||||||
|               "-cz", |  | ||||||
|               "--force-local", |  | ||||||
|               "-f", |  | ||||||
|               archivePath.replace(/\\/g, "/"), |  | ||||||
|               "-C", |  | ||||||
|               cachePath.replace(/\\/g, "/"), |  | ||||||
|               "." |  | ||||||
|           ] |  | ||||||
|         : ["-cz", "-f", archivePath, "-C", cachePath, "."]; |  | ||||||
|  |  | ||||||
|     expect(execMock).toHaveBeenCalledTimes(1); |  | ||||||
|     expect(execMock).toHaveBeenCalledWith(`"tar"`, args); |  | ||||||
|  |  | ||||||
|     expect(saveCacheMock).toHaveBeenCalledTimes(1); |     expect(saveCacheMock).toHaveBeenCalledTimes(1); | ||||||
|     expect(saveCacheMock).toHaveBeenCalledWith(primaryKey, archivePath); |     expect(saveCacheMock).toHaveBeenCalledWith(primaryKey, archivePath); | ||||||
|   | |||||||
							
								
								
									
										58
									
								
								__tests__/tar.test.ts
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										58
									
								
								__tests__/tar.test.ts
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,58 @@ | |||||||
|  | import * as exec from "@actions/exec"; | ||||||
|  | import * as io from "@actions/io"; | ||||||
|  | import * as tar from "../src/tar"; | ||||||
|  |  | ||||||
|  | jest.mock("@actions/exec"); | ||||||
|  | jest.mock("@actions/io"); | ||||||
|  |  | ||||||
|  | beforeAll(() => { | ||||||
|  |     jest.spyOn(io, "which").mockImplementation(tool => { | ||||||
|  |         return Promise.resolve(tool); | ||||||
|  |     }); | ||||||
|  | }); | ||||||
|  |  | ||||||
|  | test("extract tar", async () => { | ||||||
|  |     const mkdirMock = jest.spyOn(io, "mkdirP"); | ||||||
|  |     const execMock = jest.spyOn(exec, "exec"); | ||||||
|  |  | ||||||
|  |     const archivePath = "cache.tar"; | ||||||
|  |     const targetDirectory = "~/.npm/cache"; | ||||||
|  |     await tar.extractTar(archivePath, targetDirectory); | ||||||
|  |  | ||||||
|  |     expect(mkdirMock).toHaveBeenCalledWith(targetDirectory); | ||||||
|  |  | ||||||
|  |     const IS_WINDOWS = process.platform === "win32"; | ||||||
|  |     const tarPath = IS_WINDOWS | ||||||
|  |         ? `${process.env["windir"]}\\System32\\tar.exe` | ||||||
|  |         : "tar"; | ||||||
|  |     expect(execMock).toHaveBeenCalledTimes(1); | ||||||
|  |     expect(execMock).toHaveBeenCalledWith(`"${tarPath}"`, [ | ||||||
|  |         "-xz", | ||||||
|  |         "-f", | ||||||
|  |         archivePath, | ||||||
|  |         "-C", | ||||||
|  |         targetDirectory | ||||||
|  |     ]); | ||||||
|  | }); | ||||||
|  |  | ||||||
|  | test("create tar", async () => { | ||||||
|  |     const execMock = jest.spyOn(exec, "exec"); | ||||||
|  |  | ||||||
|  |     const archivePath = "cache.tar"; | ||||||
|  |     const sourceDirectory = "~/.npm/cache"; | ||||||
|  |     await tar.createTar(archivePath, sourceDirectory); | ||||||
|  |  | ||||||
|  |     const IS_WINDOWS = process.platform === "win32"; | ||||||
|  |     const tarPath = IS_WINDOWS | ||||||
|  |         ? `${process.env["windir"]}\\System32\\tar.exe` | ||||||
|  |         : "tar"; | ||||||
|  |     expect(execMock).toHaveBeenCalledTimes(1); | ||||||
|  |     expect(execMock).toHaveBeenCalledWith(`"${tarPath}"`, [ | ||||||
|  |         "-cz", | ||||||
|  |         "-f", | ||||||
|  |         archivePath, | ||||||
|  |         "-C", | ||||||
|  |         sourceDirectory, | ||||||
|  |         "." | ||||||
|  |     ]); | ||||||
|  | }); | ||||||
							
								
								
									
										5266
									
								
								dist/restore/index.js
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										5266
									
								
								dist/restore/index.js
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							
							
								
								
									
										5240
									
								
								dist/save/index.js
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										5240
									
								
								dist/save/index.js
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							
							
								
								
									
										19
									
								
								examples.md
									
									
									
									
									
								
							
							
						
						
									
										19
									
								
								examples.md
									
									
									
									
									
								
							| @@ -1,6 +1,6 @@ | |||||||
| # Examples | # Examples | ||||||
|  |  | ||||||
| - [C# - Nuget](#c---nuget) | - [C# - NuGet](#c---nuget) | ||||||
| - [Elixir - Mix](#elixir---mix) | - [Elixir - Mix](#elixir---mix) | ||||||
| - [Go - Modules](#go---modules) | - [Go - Modules](#go---modules) | ||||||
| - [Java - Gradle](#java---gradle) | - [Java - Gradle](#java---gradle) | ||||||
| @@ -14,7 +14,7 @@ | |||||||
| - [Swift, Objective-C - Carthage](#swift-objective-c---carthage) | - [Swift, Objective-C - Carthage](#swift-objective-c---carthage) | ||||||
| - [Swift, Objective-C - CocoaPods](#swift-objective-c---cocoapods) | - [Swift, Objective-C - CocoaPods](#swift-objective-c---cocoapods) | ||||||
|  |  | ||||||
| ## C# - Nuget | ## C# - NuGet | ||||||
| Using [NuGet lock files](https://docs.microsoft.com/nuget/consume-packages/package-references-in-project-files#locking-dependencies): | Using [NuGet lock files](https://docs.microsoft.com/nuget/consume-packages/package-references-in-project-files#locking-dependencies): | ||||||
|  |  | ||||||
| ```yaml | ```yaml | ||||||
| @@ -26,6 +26,21 @@ Using [NuGet lock files](https://docs.microsoft.com/nuget/consume-packages/packa | |||||||
|       ${{ runner.os }}-nuget- |       ${{ runner.os }}-nuget- | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
|  | Depending on the environment, huge packages might be pre-installed in the global cache folder. | ||||||
|  | If you do not want to include them, consider to move the cache folder like below. | ||||||
|  | >Note: This workflow does not work for projects that require files to be placed in user profile package folder | ||||||
|  | ```yaml | ||||||
|  | env: | ||||||
|  |   NUGET_PACKAGES: ${{ github.workspace }}/.nuget/packages | ||||||
|  | steps: | ||||||
|  |   - uses: actions/cache@v1 | ||||||
|  |     with: | ||||||
|  |       path: ${{ github.workspace }}/.nuget/packages | ||||||
|  |       key: ${{ runner.os }}-nuget-${{ hashFiles('**/packages.lock.json') }} | ||||||
|  |       restore-keys: | | ||||||
|  |         ${{ runner.os }}-nuget- | ||||||
|  | ``` | ||||||
|  |  | ||||||
| ## Elixir - Mix | ## Elixir - Mix | ||||||
| ```yaml | ```yaml | ||||||
| - uses: actions/cache@v1 | - uses: actions/cache@v1 | ||||||
|   | |||||||
							
								
								
									
										12
									
								
								package-lock.json
									
									
									
										generated
									
									
									
								
							
							
						
						
									
										12
									
								
								package-lock.json
									
									
									
										generated
									
									
									
								
							| @@ -4859,9 +4859,9 @@ | |||||||
|       "dev": true |       "dev": true | ||||||
|     }, |     }, | ||||||
|     "prettier": { |     "prettier": { | ||||||
|       "version": "1.18.2", |       "version": "1.19.1", | ||||||
|       "resolved": "https://registry.npmjs.org/prettier/-/prettier-1.18.2.tgz", |       "resolved": "https://registry.npmjs.org/prettier/-/prettier-1.19.1.tgz", | ||||||
|       "integrity": "sha512-OeHeMc0JhFE9idD4ZdtNibzY0+TPHSpSSb9h8FqtP+YnoZZ1sl8Vc9b1sasjfymH3SonAF4QcA2+mzHPhMvIiw==", |       "integrity": "sha512-s7PoyDv/II1ObgQunCbB9PdLmUcBZcnWOcxDh7O0N/UwDEsHyqkW+Qh28jW+mVuCdx7gLB0BotYI1Y6uI9iyew==", | ||||||
|       "dev": true |       "dev": true | ||||||
|     }, |     }, | ||||||
|     "prettier-linter-helpers": { |     "prettier-linter-helpers": { | ||||||
| @@ -5983,9 +5983,9 @@ | |||||||
|       } |       } | ||||||
|     }, |     }, | ||||||
|     "typescript": { |     "typescript": { | ||||||
|       "version": "3.6.4", |       "version": "3.7.3", | ||||||
|       "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.6.4.tgz", |       "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.7.3.tgz", | ||||||
|       "integrity": "sha512-unoCll1+l+YK4i4F8f22TaNVPRHcD9PA3yCuZ8g5e0qGqlVlJ/8FSateOLLSagn+Yg5+ZwuPkL8LFUc0Jcvksg==", |       "integrity": "sha512-Mcr/Qk7hXqFBXMN7p7Lusj1ktCBydylfQM/FZCk5glCNQJrCUKPkMHdo9R0MTFWsC/4kPFvDS0fDPvukfCkFsw==", | ||||||
|       "dev": true |       "dev": true | ||||||
|     }, |     }, | ||||||
|     "uglify-js": { |     "uglify-js": { | ||||||
|   | |||||||
| @@ -46,8 +46,8 @@ | |||||||
|     "jest": "^24.8.0", |     "jest": "^24.8.0", | ||||||
|     "jest-circus": "^24.7.1", |     "jest-circus": "^24.7.1", | ||||||
|     "nock": "^11.7.0", |     "nock": "^11.7.0", | ||||||
|     "prettier": "1.18.2", |     "prettier": "^1.19.1", | ||||||
|     "ts-jest": "^24.0.2", |     "ts-jest": "^24.0.2", | ||||||
|     "typescript": "^3.6.4" |     "typescript": "^3.7.3" | ||||||
|   } |   } | ||||||
| } | } | ||||||
|   | |||||||
| @@ -1,9 +1,8 @@ | |||||||
| import * as core from "@actions/core"; | import * as core from "@actions/core"; | ||||||
| import { exec } from "@actions/exec"; |  | ||||||
| import * as io from "@actions/io"; |  | ||||||
| import * as path from "path"; | import * as path from "path"; | ||||||
| import * as cacheHttpClient from "./cacheHttpClient"; | import * as cacheHttpClient from "./cacheHttpClient"; | ||||||
| import { Events, Inputs, State } from "./constants"; | import { Events, Inputs, State } from "./constants"; | ||||||
|  | import { extractTar } from "./tar"; | ||||||
| import * as utils from "./utils/actionUtils"; | import * as utils from "./utils/actionUtils"; | ||||||
|  |  | ||||||
| async function run(): Promise<void> { | async function run(): Promise<void> { | ||||||
| @@ -87,27 +86,7 @@ async function run(): Promise<void> { | |||||||
|                 )} MB (${archiveFileSize} B)` |                 )} MB (${archiveFileSize} B)` | ||||||
|             ); |             ); | ||||||
|  |  | ||||||
|             // Create directory to extract tar into |             await extractTar(archivePath, cachePath); | ||||||
|             await io.mkdirP(cachePath); |  | ||||||
|  |  | ||||||
|             // http://man7.org/linux/man-pages/man1/tar.1.html |  | ||||||
|             // tar [-options] <name of the tar archive> [files or directories which to add into archive] |  | ||||||
|             const IS_WINDOWS = process.platform === "win32"; |  | ||||||
|             const args = IS_WINDOWS |  | ||||||
|                 ? [ |  | ||||||
|                       "-xz", |  | ||||||
|                       "--force-local", |  | ||||||
|                       "-f", |  | ||||||
|                       archivePath.replace(/\\/g, "/"), |  | ||||||
|                       "-C", |  | ||||||
|                       cachePath.replace(/\\/g, "/") |  | ||||||
|                   ] |  | ||||||
|                 : ["-xz", "-f", archivePath, "-C", cachePath]; |  | ||||||
|  |  | ||||||
|             const tarPath = await io.which("tar", true); |  | ||||||
|             core.debug(`Tar Path: ${tarPath}`); |  | ||||||
|  |  | ||||||
|             await exec(`"${tarPath}"`, args); |  | ||||||
|  |  | ||||||
|             const isExactKeyMatch = utils.isExactKeyMatch( |             const isExactKeyMatch = utils.isExactKeyMatch( | ||||||
|                 primaryKey, |                 primaryKey, | ||||||
|   | |||||||
							
								
								
									
										22
									
								
								src/save.ts
									
									
									
									
									
								
							
							
						
						
									
										22
									
								
								src/save.ts
									
									
									
									
									
								
							| @@ -1,9 +1,8 @@ | |||||||
| import * as core from "@actions/core"; | import * as core from "@actions/core"; | ||||||
| import { exec } from "@actions/exec"; |  | ||||||
| import * as io from "@actions/io"; |  | ||||||
| import * as path from "path"; | import * as path from "path"; | ||||||
| import * as cacheHttpClient from "./cacheHttpClient"; | import * as cacheHttpClient from "./cacheHttpClient"; | ||||||
| import { Events, Inputs, State } from "./constants"; | import { Events, Inputs, State } from "./constants"; | ||||||
|  | import { createTar } from "./tar"; | ||||||
| import * as utils from "./utils/actionUtils"; | import * as utils from "./utils/actionUtils"; | ||||||
|  |  | ||||||
| async function run(): Promise<void> { | async function run(): Promise<void> { | ||||||
| @@ -46,24 +45,7 @@ async function run(): Promise<void> { | |||||||
|         ); |         ); | ||||||
|         core.debug(`Archive Path: ${archivePath}`); |         core.debug(`Archive Path: ${archivePath}`); | ||||||
|  |  | ||||||
|         // http://man7.org/linux/man-pages/man1/tar.1.html |         await createTar(archivePath, cachePath); | ||||||
|         // tar [-options] <name of the tar archive> [files or directories which to add into archive] |  | ||||||
|         const IS_WINDOWS = process.platform === "win32"; |  | ||||||
|         const args = IS_WINDOWS |  | ||||||
|             ? [ |  | ||||||
|                   "-cz", |  | ||||||
|                   "--force-local", |  | ||||||
|                   "-f", |  | ||||||
|                   archivePath.replace(/\\/g, "/"), |  | ||||||
|                   "-C", |  | ||||||
|                   cachePath.replace(/\\/g, "/"), |  | ||||||
|                   "." |  | ||||||
|               ] |  | ||||||
|             : ["-cz", "-f", archivePath, "-C", cachePath, "."]; |  | ||||||
|  |  | ||||||
|         const tarPath = await io.which("tar", true); |  | ||||||
|         core.debug(`Tar Path: ${tarPath}`); |  | ||||||
|         await exec(`"${tarPath}"`, args); |  | ||||||
|  |  | ||||||
|         const fileSizeLimit = 400 * 1024 * 1024; // 400MB |         const fileSizeLimit = 400 * 1024 * 1024; // 400MB | ||||||
|         const archiveFileSize = utils.getArchiveFileSize(archivePath); |         const archiveFileSize = utils.getArchiveFileSize(archivePath); | ||||||
|   | |||||||
							
								
								
									
										49
									
								
								src/tar.ts
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										49
									
								
								src/tar.ts
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,49 @@ | |||||||
|  | import { exec } from "@actions/exec"; | ||||||
|  | import * as io from "@actions/io"; | ||||||
|  | import { existsSync } from "fs"; | ||||||
|  |  | ||||||
|  | async function getTarPath(): Promise<string> { | ||||||
|  |     // Explicitly use BSD Tar on Windows | ||||||
|  |     const IS_WINDOWS = process.platform === "win32"; | ||||||
|  |     if (IS_WINDOWS) { | ||||||
|  |         const systemTar = `${process.env["windir"]}\\System32\\tar.exe`; | ||||||
|  |         if (existsSync(systemTar)) { | ||||||
|  |             return systemTar; | ||||||
|  |         } | ||||||
|  |     } | ||||||
|  |     return await io.which("tar", true); | ||||||
|  | } | ||||||
|  |  | ||||||
|  | async function execTar(args: string[]): Promise<void> { | ||||||
|  |     try { | ||||||
|  |         const tarPath = await getTarPath(); | ||||||
|  |         const tarExec = process.platform !== "win32" ? `sudo ${tarPath}` : tarPath; | ||||||
|  |         await exec(`"${tarExec}"`, args); | ||||||
|  |     } catch (error) { | ||||||
|  |         const IS_WINDOWS = process.platform === "win32"; | ||||||
|  |         if (IS_WINDOWS) { | ||||||
|  |             throw new Error( | ||||||
|  |                 `Tar failed with error: ${error?.message}. Ensure BSD tar is installed and on the PATH.` | ||||||
|  |             ); | ||||||
|  |         } | ||||||
|  |         throw new Error(`Tar failed with error: ${error?.message}`); | ||||||
|  |     } | ||||||
|  | } | ||||||
|  |  | ||||||
|  | export async function extractTar( | ||||||
|  |     archivePath: string, | ||||||
|  |     targetDirectory: string | ||||||
|  | ): Promise<void> { | ||||||
|  |     // Create directory to extract tar into | ||||||
|  |     await io.mkdirP(targetDirectory); | ||||||
|  |     const args = ["-xz", "-f", archivePath, "-C", targetDirectory]; | ||||||
|  |     await execTar(args); | ||||||
|  | } | ||||||
|  |  | ||||||
|  | export async function createTar( | ||||||
|  |     archivePath: string, | ||||||
|  |     sourceDirectory: string | ||||||
|  | ): Promise<void> { | ||||||
|  |     const args = ["-cz", "-f", archivePath, "-C", sourceDirectory, "."]; | ||||||
|  |     await execTar(args); | ||||||
|  | } | ||||||
		Reference in New Issue
	
	Block a user