Merge pull request #6 from stackql/feature/wrapper

Feature/wrapper

Author: yunchengyang515

.github/workflows/example-workflows.yml

@@ -12,8 +12,8 @@ defaults:
     shell: bash
 
 jobs:
-  stackql-versions:
-    name: 'Stackql Versions'
+  stackql-tests:
+    name: 'Stackql Examples'
     runs-on: ubuntu-latest
 
     steps:
@@ -22,6 +22,8 @@ jobs:
 
     - name: Setup stackql
       uses: ./
+      with:
+        use_wrapper: 'true'
 
 
     - name: Validate Stackql Version
@@ -35,9 +37,15 @@ jobs:
         AUTH: ${{ vars.AUTH }}  ##'{ "github": { "type": "basic", "credentialsenvvar": "STACKQL_GITHUB_CREDS" } }'
         STACKQL_GITHUB_CREDS: ${{  secrets.STACKQL_GITHUB_CREDS }}
 
-    - name: use Google Provider
+    - name: Use Google Provider
       run: | ## use the secret to create json file
         sudo echo ${{ secrets.GOOGLE_CREDS }} | base64 -d > sa-key.json
         stackql exec -i ./examples/google-example.iql --auth="${AUTH}"
       env:
         AUTH: ${{ vars.AUTH }}  ## '{ "google": { "type": "service_account",  "credentialsfilepath": "sa-key.json" }}'
+
+    ##### uncomment the step to see error handling
+    # - name: Handle error
+    #   run: | ## use the secret to create json file
+    #     stackql exec -i ./examples/github-example.iql --auth="${INVALID_AUTH}"
+

.husky/pre-commit

@@ -1,4 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-npm run build && git add dist/
+npm run build && git add dist/ && git add wrapper/

README.md

@@ -1,6 +1,6 @@
 # setup-stackql
 
-The `stackql/setup-stackql` action is a JavaScript action that sets up Terraform CLI in your GitHub Actions workflow by:
+The `stackql/setup-stackql` action is a JavaScript action that sets up StackQL CLI in your GitHub Actions workflow by:
 
 - Downloading a latest Stackql CLI and adding it to the `PATH`.
 - Setup AUTH env var in the Github Action

action.yml

@@ -1,7 +1,11 @@
 name: 'StackQL Studio - Setup StackQL'
 description: 'Sets up StackQL CLI in your GitHub Actions workflow.'
 author: 'Yuncheng Yang, StackQL'
-
+inputs:
+  use_wrapper:
+    description: 'Whether or not to install a wrapper to wrap subsequent calls of the `stackql` binary and expose its STDOUT, STDERR, and exit code as outputs named `stdout`, `stderr`, and `exitcode` respectively. Defaults to `true`.'
+    default: 'true'
+    required: false
 
 runs:
   using: 'node16'

dist/index.js

@@ -6748,12 +6748,51 @@ async function addPermission(){
   }
 }
 
+
+async function installWrapper (pathToCLI) {
+  let source, target;
+
+  // If we're on Windows, then the executable ends with .exe
+  const exeSuffix = os.platform().startsWith('win') ? '.exe' : '';
+
+  // Rename stackql(.exe) to stackql-bin(.exe)
+  try {
+    source = [pathToCLI, `stackql${exeSuffix}`].join(path.sep);
+    target = [pathToCLI, `stackql-bin${exeSuffix}`].join(path.sep);
+    core.debug(`Moving ${source} to ${target}.`);
+    await io.mv(source, target);
+  } catch (e) {
+    core.debug(`Unable to move ${source} to ${target}.`);
+    throw e;
+  }
+
+  // Install our wrapper as stackql by moving the wrapped executable to stackql
+  try {
+    source = path.resolve([__dirname, '..', 'wrapper', 'dist', 'index.js'].join(path.sep));
+    target = [pathToCLI, 'stackql'].join(path.sep);
+    core.debug(`Copying ${source} to ${target}.`);
+    await io.cp(source, target);
+  } catch (e) {
+    core.error(`Unable to copy ${source} to ${target}.`);
+    throw e;
+  }
+
+  // Export a new environment variable, so our wrapper can locate the binary
+  core.exportVariable('STACKQL_CLI_PATH', pathToCLI);
+}
+
+
 async function setup(){
 
   const path = await downloadCLI()
 
   core.addPath(path)
   await addPermission()
+  const wrapper = core.getInput('use_wrapper') === 'true';
+  if(wrapper){
+    console.log('installing wrapper')
+    await installWrapper(path)
+  }
 }
 
 (async () => {

index.js

@@ -46,12 +46,51 @@ async function addPermission(){
   }
 }
 
+
+async function installWrapper (pathToCLI) {
+  let source, target;
+
+  // If we're on Windows, then the executable ends with .exe
+  const exeSuffix = os.platform().startsWith('win') ? '.exe' : '';
+
+  // Rename stackql(.exe) to stackql-bin(.exe)
+  try {
+    source = [pathToCLI, `stackql${exeSuffix}`].join(path.sep);
+    target = [pathToCLI, `stackql-bin${exeSuffix}`].join(path.sep);
+    core.debug(`Moving ${source} to ${target}.`);
+    await io.mv(source, target);
+  } catch (e) {
+    core.debug(`Unable to move ${source} to ${target}.`);
+    throw e;
+  }
+
+  // Install our wrapper as stackql by moving the wrapped executable to stackql
+  try {
+    source = path.resolve([__dirname, '..', 'wrapper', 'dist', 'index.js'].join(path.sep));
+    target = [pathToCLI, 'stackql'].join(path.sep);
+    core.debug(`Copying ${source} to ${target}.`);
+    await io.cp(source, target);
+  } catch (e) {
+    core.error(`Unable to copy ${source} to ${target}.`);
+    throw e;
+  }
+
+  // Export a new environment variable, so our wrapper can locate the binary
+  core.exportVariable('STACKQL_CLI_PATH', pathToCLI);
+}
+
+
 async function setup(){
 
   const path = await downloadCLI()
 
   core.addPath(path)
   await addPermission()
+  const wrapper = core.getInput('use_wrapper') === 'true';
+  if(wrapper){
+    console.log('installing wrapper')
+    await installWrapper(path)
+  }
 }
 
 (async () => {

package.json

@@ -4,7 +4,7 @@
   "description": "",
   "main": "index.js",
   "scripts": {
-    "build": "ncc build index.js --out dist",
+    "build": "cd wrapper && npm run build && cd .. && ncc build index.js --out dist",
     "postinstall": "husky install"
   },
   "repository": {