Merge pull request #5 from stackql/feat/change-shell-to-js

Feat/change shell to js

Author: yunchengyang515

.github/workflows/test.yml

@@ -0,0 +1,17 @@
+name: 'Build and Test'
+on:
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+      
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js 16
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+      - run: npm ci
+      - run: npm test
+        

.gitignore

@@ -102,3 +102,5 @@ dist
 
 # TernJS port file
 .tern-port
+
+node_modules

action.yml

@@ -27,21 +27,29 @@ runs:
       with:
         use_wrapper: true
 
-    - name: Setup auth
-      id: setup-auth
+    - name: Validate Stackql Version
       shell: bash
       run: |
-        chmod +x ./action_scripts/set_auth_env.sh
-        ./action_scripts/set_auth_env.sh
+        stackql --version
+
+    - name: Setup auth
+      id: setup-auth
+      uses: actions/github-script@v6
+      with:
+        script: |
+          const {setupAuth} = require('./lib/utils.js')
+          setupAuth(core)
       env:
-        AUTH_FILE: ${{inputs.auth_obj_path}}
+        AUTH_FILE_PATH: ${{ inputs.auth_obj_path }}
         AUTH_STR: ${{inputs.auth_str}}
 
     - name: Execute query
-      shell: bash
-      run: |
-        chmod +x ./action_scripts/execute.sh
-        ./action_scripts/execute.sh
+      id: exec-query
+      uses: actions/github-script@v6
+      with:
+        script: |
+          const {executeStackql} = require('./lib/utils.js')
+          await executeStackql(core)
       env:
         QUERY_FILE_PATH: ${{ inputs.query_file_path }}
         QUERY: ${{inputs.query}}

action_scripts/execute.sh

@@ -0,0 +1 @@
+[{"name":"stackql-demo-001","status":"RUNNING"}]

action_scripts/set_auth_env.sh

@@ -0,0 +1 @@
+[{"name":"stackql-demo-001","status":"TERMINATED"}]

lib/tests/failed-result.json

@@ -0,0 +1 @@
+{ "google": { "type": "service_account",  "credentialsfilepath": "sa-key.json" }}

lib/tests/success-result.json

@@ -0,0 +1,143 @@
+const { setupAuth, executeStackql } = require("../utils");
+const childProcess = require("child_process");
+
+jest.mock("child_process", () => ({
+  exec: jest.fn(),
+}));
+
+describe("util", () => {
+  let core;
+  let exec;
+  const expectedAuth =
+    '{ "google": { "type": "service_account",  "credentialsfilepath": "sa-key.json" }}';
+
+  beforeEach(() => {
+    core = {
+      setFailed: jest.fn().mockImplementation((message) => {
+        console.error(message);
+      }),
+      info: jest.fn().mockImplementation((message) => {
+        console.log(message);
+      }),
+      exportVariable: jest.fn(),
+      error: jest.fn().mockImplementation((message) => {
+        console.error(message);
+      }),
+    };
+  });
+
+  describe("setupAuth", () => {
+    let AUTH_ENV = {
+      AUTH_STR: expectedAuth,
+      AUTH_FILE_PATH: "./lib/tests/test-auth.json",
+    };
+
+    beforeEach(() => {
+      jest.resetModules();
+      process.env = { ...AUTH_ENV };
+    });
+
+    afterEach(() => {
+      process.env = AUTH_ENV;
+    });
+
+    it("should throw error when neither AUTH_STR or AUTH_FILE_PATH is set", () => {
+      process.env.AUTH_STR = undefined;
+      process.env.AUTH_FILE_PATH = undefined;
+
+      setupAuth(core);
+      expect(core.setFailed).toBeCalledWith(
+        "Either AUTH_FILE_PATH or AUTH_STR must be set."
+      );
+    });
+
+    it("should set AUTH environment variable when AUTH_STR is set", () => {
+      process.env.AUTH_FILE_PATH = undefined;
+
+      setupAuth(core);
+
+      expect(core.exportVariable).toBeCalledWith("AUTH", expectedAuth);
+    });
+
+    it("should set AUTH environment variable when AUTH_FILE_PATH is set", () => {
+      process.env.AUTH_STR = undefined;
+
+      setupAuth(core);
+
+      expect(core.exportVariable).toBeCalledWith("AUTH", expectedAuth);
+    });
+
+    it("should throw error when AUTH_FILE_PATH is set but file does not exist", () => {
+      process.env.AUTH_STR = undefined;
+      process.env.AUTH_FILE_PATH = "./failed-test-auth.json";
+
+      setupAuth(core);
+      expect(core.setFailed).toBeCalledWith(
+        `Cannot find auth file ${process.env.AUTH_FILE_PATH}`
+      );
+    });
+  });
+
+  describe("executeStackql", () => {
+    const EXECUTE_ENV = {
+      QUERY: "test",
+      QUERY_FILE_PATH: "test-query.json",
+      AUTH: "test-auth",
+    };
+
+    beforeEach(() => {
+      jest.resetModules();
+      process.env = { ...EXECUTE_ENV };
+    });
+
+    afterEach(() => {
+      process.env = EXECUTE_ENV;
+      jest.clearAllMocks();
+    });
+
+    it("should return error when there is neither query or query file path", async () => {
+      process.env = { ...EXECUTE_ENV };
+      process.env.QUERY = undefined;
+      process.env.QUERY_FILE_PATH = undefined;
+
+      await executeStackql(core);
+
+      expect(core.setFailed).toBeCalledWith(
+        "Either query or query_file_path need to be set"
+      );
+    });
+
+    it("should return error when there is no AUTH", async () => {
+      process.env = { ...EXECUTE_ENV };
+      process.env.AUTH = undefined;
+
+      await executeStackql(core);
+
+      expect(core.setFailed).toHaveBeenCalledWith(
+        "Cannot find AUTH environment variable when executing stackql"
+      );
+    });
+
+    it("should execute stackql with query file path", async () => {
+      process.env = { ...EXECUTE_ENV };
+      process.env.QUERY = undefined;
+
+      await executeStackql(core);
+
+      expect(childProcess.exec).toHaveBeenCalledWith(
+        "stackql exec -i test-query.json --auth=test-auth --output=json"
+      );
+    });
+
+    it("should execute stackql with query", async () => {
+      process.env = { ...EXECUTE_ENV };
+      process.env.QUERY_FILE_PATH = undefined;
+
+      await executeStackql(core);
+
+      expect(childProcess.exec).toHaveBeenCalledWith(
+        "stackql exec test --auth=test-auth --output=json"
+      );
+    });
+  });
+});

lib/tests/test-auth.json

@@ -0,0 +1,87 @@
+const { exec } = require("child_process");
+
+function setupAuth(core) {
+  const fs = require("fs");
+  let auth;
+  const fileName = process.env.AUTH_FILE_PATH;
+  const authStr = process.env.AUTH_STR;
+
+  if (!checkEnvVarValid(fileName) && !checkEnvVarValid(authStr)) {
+    core.setFailed("Either AUTH_FILE_PATH or AUTH_STR must be set.");
+    return;
+  }
+
+  if (checkEnvVarValid(fileName)) {
+    try {
+      // Read the contents of the JSON file into a string
+      auth = fs.readFileSync(fileName, "utf-8");
+    } catch (error) {
+      core.error(error);
+      core.setFailed(`Cannot find auth file ${fileName}`);
+      return;
+    }
+  }
+  if (checkEnvVarValid(authStr)) {
+    auth = authStr
+  }
+
+  core.info("Setting AUTH environment variable...");
+  core.exportVariable("AUTH", auth);
+}
+
+async function executeStackql(core) {
+  
+  if (!checkEnvVarValid(process.env.AUTH)) {
+    core.setFailed("Cannot find AUTH environment variable when executing stackql");
+    return;
+  }
+  let [query, queryFilePath, auth, output = "json"] = [
+    process.env.QUERY,
+    process.env.QUERY_FILE_PATH,
+    process.env.AUTH,
+    process.env.OUTPUT,
+  ];
+
+
+
+  if (!checkEnvVarValid(query) && !checkEnvVarValid(queryFilePath)) {
+    core.setFailed("Either query or query_file_path need to be set");
+    return;
+  }
+
+  let args = [];
+  if (queryFilePath) {
+    args = [
+      "exec",
+      "-i",
+      queryFilePath,
+      "--auth=" + auth,
+      "--output=" + output,
+    ];
+  }
+  if (query) {
+    args = ["exec", query, `--auth=${auth}`, `--output=${output}`];
+  }
+  try {
+    await exec(`stackql ${args.join(" ")}`);
+  } catch (error) {
+    core.error(error);
+    core.setFailed("Error when executing stackql");
+  }
+}
+
+/**
+ * Checking if environment variable is not empty or undefined
+ * @param {*} variable
+ */
+const checkEnvVarValid = (variable) => {
+  if (!variable || variable === "" || variable === "undefined") {
+    return false;
+  }
+  return true;
+};
+
+module.exports = {
+  setupAuth,
+  executeStackql,
+};