Added support for BuildPulse Cache

Author: siddhantdange

.github/workflows/build_cache.yaml

@@ -0,0 +1,24 @@
+name: Build Cache
+
+on:
+  push:
+    branches: [ "cache" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Install Dependencies
+        run: npm install
+        working-directory: ./src/cache
+
+      - name: Build Cache Binaries
+        run: npm run build
+        working-directory: ./src/cache
+

src/@orb.yml

@@ -7,6 +7,54 @@ display:
   home_url: https://github.com/Workshop64/buildpulse-circleci-orb
 
 commands:
+  save_cache:
+    description: Save a file or directory to BuildPulse Cache
+    parameters:
+      key:
+        description: |
+          The key to use when saving the cache. This key should be unique to the
+          files or directories being saved.
+        type: string
+      paths:
+        description: |
+          Paths to files or directories to save to the cache.
+        type: array
+      upload_chunk_size:
+        description: |
+          The maximum size of each chunk of the file to upload to the cache.
+        type: integer
+        default: 33554432 # 32 MB = 32 * 1024 * 1024
+    steps:
+    - run:
+        name: Save a file or directory to BuildPulse Cache
+        environment:
+          INPUT_KEY: << parameters.key >>
+          INPUT_PATHS: << parameters.paths >>
+          INPUT_UPLOAD_CHUNK_SIZE: << parameters.upload_chunk_size >>
+        command: << include(save_cache.sh) >>
+
+  restore_cache:
+    description: Restore a file or directory from BuildPulse Cache
+    parameters:
+      key:
+        description: |
+          The key to use when restoring the cache. This key should be unique to the
+          files or directories being restored.
+        type: string
+      fail_on_cache_miss:
+        description: |
+          The key to use when restoring the cache. This key should be unique to the
+          files or directories being restored.
+        type: boolean
+        default: false
+    steps:
+      - run:
+          name: Restore a file or directory from BuildPulse Cache
+          environment:
+            INPUT_KEY: << parameters.key >>
+            INPUT_FAIL_ON_CACHE_MISS: << parameters.fail_on_cache_miss >>
+          command: << include(restore_cache.sh) >>
+
   upload:
     description: Send test results to BuildPulse.
 

src/cache/.gitignore

@@ -0,0 +1,4 @@
+dist/
+node_modules/
+
+.DS_STORE

src/cache/index.js

@@ -0,0 +1,64 @@
+#!/usr/bin/env node
+
+const cache = require('@buildpulse/cache');
+const { Command } = require('commander');
+
+async function save() {
+  const primaryKey = process.env.INPUT_KEY;
+  const cachePaths = process.env.INPUT_PATHS.split(",");
+  const uploadChunkSize = parseInt(process.env.INPUT_UPLOAD_CHUNK_SIZE);
+  const enableCrossOsArchive = true;
+
+  const cacheId = await cache.saveCache(
+    cachePaths,
+    primaryKey,
+    { uploadChunkSize: uploadChunkSize },
+    enableCrossOsArchive
+  );
+
+  if (cacheId != -1) {
+    console.log(`Cache saved with key: ${primaryKey}`);
+  }
+}
+
+async function restore() {
+  const primaryKey = process.env.INPUT_KEY;
+  const failOnCacheMiss = process.env.INPUT_FAIL_ON_CACHE_MISS === "true";
+  const enableCrossOsArchive = true;
+  const cachePaths = [];
+  const restoreKeys = [];
+
+  const cacheKey = await cache.restoreCache(
+    cachePaths,
+    primaryKey,
+    restoreKeys,
+    { lookupOnly: false },
+    enableCrossOsArchive
+  );
+
+
+  if (!cacheKey) {
+    if (failOnCacheMiss) {
+      throw new Error(
+        `Failed to restore cache entry. Exiting as fail-on-cache-miss is set. Input key: ${primaryKey}`
+      );
+    }
+    console.log(`Cache not found for input keys: ${primaryKey}`);
+
+    return;
+  }
+}
+
+const program = new Command();
+
+program
+  .command('save')
+  .description('Save a file or directory to BuildPulse Cache')
+  .action(save);
+
+program
+  .command('restore')
+  .description('Restore a file or directory from BuildPulse Cache')
+  .action(restore);
+
+program.parse(process.argv);