Created downloader and tests

stackql · yunchengyang515 · Dec 9, 2023 · Nov 11, 2023 · Nov 11, 2023 · Nov 11, 2023
commit b05fe45f6386366fcb131fa7e081e47523acba9b
diff --git a/.gitignore b/.gitignore
@@ -33,4 +33,5 @@ yarn-error.log*
 
 # typescript
 *.tsbuildinfo
-next-env.d.ts
+next-env.d.ts
+.stackql*
diff --git a/README.md b/README.md
@@ -18,4 +18,9 @@
     - `upgrade` - if in local mode, upgrade the local stackql binary from the latest release
     - `execute` - execute a query returns an array of rows (objects)
     - `executeStmt` - executes a statement and returns a string (like `REGISTRY PULL` or `INSERT ...`)
-    - `executeQueriesAsync` - executes a list of queries and returns an array of rows (objects) - queries need to return the same columns/schema
+    - `executeQueriesAsync` - executes a list of queries and returns an array of rows (objects) - queries need to return the same columns/schema
+
+## Test
+```
+ deno test --allow-net --allow-read --allow-write --allow-env --allow-run <test file path>
+```
diff --git a/deps.ts b/deps.ts
@@ -0,0 +1 @@
+export { bold } from "https://deno.land/std/fmt/colors.ts"
diff --git a/src/stackql.ts b/src/stackql.ts
@@ -0,0 +1,5 @@
+export class StackQL {
+    private getBinary(){
+
+    }
+}
diff --git a/src/types/platforms.ts b/src/types/platforms.ts
@@ -0,0 +1,5 @@
+export enum SupportedOs {
+    Linux = "linux",
+    Darwin = "darwin",
+    Windows = "windows",
+}
diff --git a/src/utils/downloader.test.ts b/src/utils/downloader.test.ts
@@ -0,0 +1,23 @@
+import { assertExists } from "https://deno.land/std@0.206.0/assert/assert_exists.ts";
+import { Downloader } from "./downloader.ts";
+
+Deno.test("Downloader setupStackQL Integration Test", async () => {
+  // Arrange
+  const downloader = new Downloader();
+
+  // Act
+  try {
+    const binaryPath = await downloader.setupStackQL();
+
+    // Assert
+    assertExists(binaryPath);
+    // Check if the binary exists after setupStackQL is called
+
+    console.log(
+      "Test passed: setupStackQL completed without errors and binary exists.",
+    );
+  } catch (error) {
+    console.error("Test failed:", error);
+    throw error; // This will cause the test to fail
+  }
+});
diff --git a/src/utils/downloader.ts b/src/utils/downloader.ts
@@ -0,0 +1,143 @@
+import { join } from "https://deno.land/std@0.133.0/path/mod.ts";
+import { SupportedOs } from "../types/platforms.ts";
+import { darwinUnpack, unzip } from "./unpacker.ts";
+
+export class Downloader {
+  private os: string;
+  private arch: string;
+  private urlMap: Record<string, string>;
+
+  constructor() {
+    this.os = Deno.build.os; // 'linux', 'darwin', or 'windows'
+    this.arch = Deno.build.arch; // 'x86_64', 'arm64', etc.
+
+    this.urlMap = {
+      "linux-x86_64":
+        "https://releases.stackql.io/stackql/latest/stackql_linux_amd64.zip",
+      "windows-x86_64":
+        "https://releases.stackql.io/stackql/latest/stackql_windows_amd64.zip",
+      "darwin-x86_64":
+        "https://storage.googleapis.com/stackql-public-releases/latest/stackql_darwin_multiarch.pkg",
+      // Additional OS-architecture combinations can be added here
+    };
+  }
+
+  private async downloadFile(url: string, downloadDir: string) {
+    const res = await fetch(url);
+    const file = await Deno.open(downloadDir, { create: true, write: true });
+
+    await res.body?.pipeTo(file.writable);
+    try {
+      file.close();
+    } catch (error) {
+      console.error(`ERROR: [downloadFile] ${error.message}`);
+    }
+
+    console.log("Closed file");
+  }
+
+  private getUrl(): string {
+    const key = `${this.os}-${this.arch}`;
+    const url = this.urlMap[key];
+
+    if (!url) {
+      throw new Error(`Unsupported OS type: ${this.os} ${this.arch}`);
+    }
+
+    return url;
+  }
+
+  /**
+   * Gets binary name
+   * @returns  binrary name
+   */
+  private getBinaryName() {
+    const binaryMap: Record<SupportedOs, string> = {
+      [SupportedOs.Windows]: "stackql.exe",
+      [SupportedOs.Darwin]: "stackql/Payload/stackql",
+      [SupportedOs.Linux]: "stackql", // Default case for Linux and other platforms
+    };
+    const os = Deno.build.os.toLowerCase();
+
+    if (!Object.values(SupportedOs).includes(os as SupportedOs)) {
+      throw new Error(`Unsupported OS type: ${os}`);
+    }
+
+    const binaryOs = os as SupportedOs;
+    return binaryMap[binaryOs];
+  }
+
+  /**
+   * Gets download dir
+   * @returns download dir
+   */
+  private async getDownloadDir(): Promise<string> {
+    const projectDir = Deno.cwd();
+    console.log("Project dir:", projectDir);
+
+    if (!projectDir) {
+      throw new Error("Unable to determine the project directory.");
+    }
+
+    const downloadDir = join(projectDir, ".stackql");
+
+    try {
+      const stat = await Deno.stat(downloadDir);
+      if (!stat.isDirectory) {
+        await Deno.mkdir(downloadDir, { recursive: true });
+      }
+    } catch (error) {
+      if (error instanceof Deno.errors.NotFound) {
+        await Deno.mkdir(downloadDir, { recursive: true });
+      } else {
+        throw error;
+      }
+    }
+
+    return downloadDir;
+  }
+
+  private binaryExists(binaryName: string, downloadDir: string): boolean {
+    const binPath = join(downloadDir, binaryName);
+    try {
+      Deno.statSync(binPath);
+      return true;
+    } catch (error) {
+      if (error instanceof Deno.errors.NotFound) {
+        return false;
+      }
+      throw error;
+    }
+  }
+
+  /**
+   * Setup stackql binary, check if binary exists, if not download it
+   */
+  public async setupStackQL() {
+    console.log("Installing stackql...");
+
+    try {
+      const binaryName = this.getBinaryName();
+      const url = this.getUrl();
+      const downloadDir = await this.getDownloadDir();
+      console.log(
+        `Downloading latest version of stackql from ${url} to ${downloadDir}`,
+      );
+      if (this.binaryExists(binaryName, downloadDir)) {
+        console.log("stackql is already installed");
+        return;
+      }
+      console.log("Downloading stackql binary");
+      const archiveFileName = `${downloadDir}/${url.split("/").pop()}`;
+      await this.downloadFile(url, archiveFileName);
+
+      console.log("Unpacking stackql binary");
+      const unpacker = Deno.build.os === "darwin" ? darwinUnpack : unzip;
+      await unpacker({ downloadDir, archiveFileName });
+      return join(downloadDir, binaryName);
+    } catch (error) {
+      console.error(`ERROR: [setup] ${error.message}`);
+      Deno.exit(1);
+    }
+  }
+}
diff --git a/src/utils/unpacker.ts b/src/utils/unpacker.ts
@@ -0,0 +1,33 @@
+import { decompress } from "https://deno.land/x/zip/mod.ts";
+
+type UnpackParams = {
+  downloadDir: string;
+  archiveFileName: string;
+};
+
+export const darwinUnpack = async (params: UnpackParams) => {
+  const { downloadDir, archiveFileName } = params;
+  const unpackedFileName = `${downloadDir}/stackql`;
+  const command =
+    `pkgutil --expand-full ${archiveFileName} ${unpackedFileName}`;
+  const process = Deno.run({
+    cmd: command.split(" "),
+    stdout: "piped",
+    stderr: "piped",
+  });
+  const { code } = await process.status();
+  if (code !== 0) {
+    const output = new TextDecoder().decode(await process.output());
+    const errorOutput = new TextDecoder().decode(
+      await process.stderrOutput(),
+    );
+    console.error("Error executing pkgutil:", output, errorOutput);
+    process.close();
+    throw new Error("Failed to unpack stackql");
+  }
+  process.close();
+};
+
+export const unzip = async (params: UnpackParams) => {
+  await decompress(params.archiveFileName, params.downloadDir);
+};
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		export { bold } from "https://deno.land/std/fmt/colors.ts"