Support to retain cache

Signed-off-by: Balaji Arun <balajia@vt.edu>

Author: ibalajiarun

__tests__/context.test.ts

@@ -35,6 +35,7 @@ describe('getCreateArgs', () => {
       new Map<string, string>([
         ['install', 'false'],
         ['use', 'true'],
+        ['keep-state', 'false']
       ]),
       [
         'create',
@@ -50,6 +51,7 @@ describe('getCreateArgs', () => {
         ['driver', 'docker'],
         ['install', 'false'],
         ['use', 'true'],
+        ['keep-state', 'false']
       ]),
       [
         'create',
@@ -65,6 +67,7 @@ describe('getCreateArgs', () => {
         ['install', 'false'],
         ['use', 'false'],
         ['driver-opts', 'image=moby/buildkit:master\nnetwork=host'],
+        ['keep-state', 'false']
       ]),
       [
         'create',
@@ -82,6 +85,7 @@ describe('getCreateArgs', () => {
         ['endpoint', 'tls://foo:1234'],
         ['install', 'false'],
         ['use', 'true'],
+        ['keep-state', 'false']
       ]),
       [
         'create',
@@ -99,6 +103,7 @@ describe('getCreateArgs', () => {
         ['endpoint', 'tls://foo:1234'],
         ['install', 'false'],
         ['use', 'true'],
+        ['keep-state', 'false']
       ]),
       [
         'create',
@@ -115,6 +120,7 @@ describe('getCreateArgs', () => {
         ['install', 'false'],
         ['use', 'false'],
         ['driver-opts', `"env.no_proxy=localhost,127.0.0.1,.mydomain"`],
+        ['keep-state', 'false']
       ]),
       [
         'create',
@@ -130,6 +136,7 @@ describe('getCreateArgs', () => {
         ['install', 'false'],
         ['use', 'false'],
         ['platforms', 'linux/amd64\n"linux/arm64,linux/arm/v7"'],
+        ['keep-state', 'false']
       ]),
       [
         'create',
@@ -139,6 +146,22 @@ describe('getCreateArgs', () => {
         '--platform', 'linux/amd64,linux/arm64,linux/arm/v7'
       ]
     ],
+    [
+      7,
+      new Map<string, string>([
+        ['install', 'false'],
+        ['use', 'true'],
+        ['keep-state', 'false'],
+        ['custom-name', 'test-builder-name'],
+      ]),
+      [
+        'create',
+        '--name', 'test-builder-name',
+        '--driver', 'docker-container',
+        '--buildkitd-flags', '--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host',
+        '--use'
+      ]
+    ],
   ])(
     '[%d] given %p as inputs, returns %p',
     async (num: number, inputs: Map<string, string>, expected: Array<string>) => {
@@ -169,6 +192,7 @@ describe('getAppendArgs', () => {
       new Map<string, string>([
         ['install', 'false'],
         ['use', 'true'],
+        ['keep-state', 'false']
       ]),
       {
         "name": "aws_graviton2",

action.yml

@@ -44,6 +44,13 @@ inputs:
   append:
     description: 'Append additional nodes to the builder'
     required: false
+  keep-state:
+    description: 'Keep state on cleanup'
+    default: 'false'
+    required: false
+  custom-name:
+    description: 'Custom builder name'
+    required: false
 
 outputs:
   name:

dist/index.js

@@ -36,12 +36,13 @@ export interface Inputs {
   config: string;
   configInline: string;
   append: string;
+  keepState: boolean;
 }
 
 export async function getInputs(): Promise<Inputs> {
   return {
     version: core.getInput('version'),
-    name: getBuilderName(core.getInput('driver') || 'docker-container'),
+    name: getBuilderName(core.getInput('custom-name'), core.getInput('driver') || 'docker-container'),
     driver: core.getInput('driver') || 'docker-container',
     driverOpts: await getInputList('driver-opts', true),
     buildkitdFlags: core.getInput('buildkitd-flags') || '--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host',
@@ -51,11 +52,15 @@ export async function getInputs(): Promise<Inputs> {
     endpoint: core.getInput('endpoint'),
     config: core.getInput('config'),
     configInline: core.getInput('config-inline'),
-    append: core.getInput('append')
+    append: core.getInput('append'),
+    keepState: core.getBooleanInput('keep-state')
   };
 }
 
-export function getBuilderName(driver: string): string {
+export function getBuilderName(customName: string, driver: string): string {
+  if (customName && customName.length > 0) {
+    return customName;
+  }
   return driver == 'docker' ? 'default' : `builder-${uuid.v4()}`;
 }
 

dist/index.js.map

@@ -61,6 +61,8 @@ async function run(): Promise<void> {
     fs.mkdirSync(credsdir, {recursive: true});
     stateHelper.setCredsDir(credsdir);
 
+    stateHelper.setKeepState(inputs.keepState);
+
     if (inputs.driver !== 'docker') {
       core.startGroup(`Creating a new builder instance`);
       const authOpts = auth.setCredentials(credsdir, 0, inputs.driver, inputs.endpoint);
@@ -156,7 +158,7 @@ async function cleanup(): Promise<void> {
 
   if (stateHelper.builderName.length > 0) {
     core.startGroup(`Removing builder`);
-    const rmCmd = buildx.getCommand(['rm', stateHelper.builderName], /true/i.test(stateHelper.standalone));
+    const rmCmd = buildx.getCommand(['rm', stateHelper.builderName, stateHelper.keepState ? '--keep-state' : ''], /true/i.test(stateHelper.standalone));
     await exec
       .getExecOutput(rmCmd.commandLine, rmCmd.args, {
         ignoreReturnCode: true

src/context.ts

@@ -6,6 +6,7 @@ export const standalone = process.env['STATE_standalone'] || '';
 export const builderName = process.env['STATE_builderName'] || '';
 export const containerName = process.env['STATE_containerName'] || '';
 export const credsDir = process.env['STATE_credsDir'] || '';
+export const keepState = process.env['STATE_keepState'] || false;
 
 export function setDebug(debug: string) {
   core.saveState('isDebug', debug);
@@ -27,6 +28,10 @@ export function setCredsDir(credsDir: string) {
   core.saveState('credsDir', credsDir);
 }
 
+export function setKeepState(retain: boolean) {
+  core.saveState('keepState', retain);
+}
+
 if (!IsPost) {
   core.saveState('isPost', 'true');
 }