Merge pull request #9 from NMFS-RADFish/radfish-6-download-zip

Rework CLI to download latest boilerplate release

Author: brockinit

.gitignore

@@ -1,3 +1,6 @@
+# Test fixtures
+__tests__/fixtures/output
+
 # Logs
 logs
 *.log

README.md

@@ -4,16 +4,14 @@
 
 ![radfish_logo](https://github.com/NMFS-RADFish/boilerplate/assets/11274285/f0c1f78d-d2bd-4590-897c-c6ec87522dd1)
 
-# USAGE
+# System Requirements
+- Node.js v18+
+- `tar` v3.3+
 
-The cli supports executing the program via cli with or without arguments.
+# Creating a project
 
-The program also supports only adding certain arguments. In this case, the program will recognize which arguments are missing, and prompt the user to add the rest of them via cli.
+```
+npx @nmfs-radfish/create-radfish-app my-pwa
+``` 
 
-In the project root:
-
-`npx create-radfish-app` and the program will prompt you to add in the required fields (region and type)
-
-Or
-
-`npx create-radfish-app --region=alaska --type=evtr`
+Provide the cli the name of your new project. A new project will be created using the [default boilerplate template](https://github.com/NMFS-RADFish/boilerplate).

__tests__/download.spec.js

@@ -0,0 +1,93 @@
+const path = require("path");
+const https = require("https");
+const fs = require("fs");
+const child_process = require("child_process");
+
+jest.mock("https");
+
+describe("downloadFile", () => {
+  it("should download a file", (done) => {
+    https.get.mockImplementationOnce((url, callback) => {
+      const response = {
+        statusCode: 200,
+        pipe: jest.fn(),
+      };
+      callback(response);
+      return response;
+    });
+    jest.mock("fs");
+    const fs = require("fs");
+    fs.createWriteStream.mockReturnValueOnce({
+      on: jest.fn((event, callback) => {
+        callback(null);
+      }),
+      close: jest.fn((callback) => {
+        callback(null);
+      }),
+    });
+    const download = require("../lib/download");
+
+    download.downloadFile("https://example.com", "download/path", (err, res) => {
+      try {
+        expect(fs.createWriteStream).toHaveBeenCalledWith(expect.stringMatching("download/path"));
+        expect(https.get).toHaveBeenCalledWith("https://example.com", expect.any(Function));
+
+        done();
+      } catch (err) {
+        done(err);
+      }
+    });
+  });
+});
+
+describe("unzip", () => {
+  beforeEach(() => {
+    jest.resetModules();
+    fs.rmSync(path.resolve(__dirname, "fixtures", "output"), { recursive: true, force: true });
+  });
+
+  it("should correctly pass arguments when spawning the tar command process", (done) => {
+    jest.doMock("child_process", () => ({
+      exec: jest.fn((command, options, callback) => {
+        callback(null, "stdout", "stderr");
+      }),
+    }));
+    const child_process = require("child_process");
+    const download = require("../lib/download");
+    download.unzip("filepath", () => {
+      try {
+        expect(child_process.exec).toHaveBeenCalledWith(
+          `tar -xf filepath --exclude .github`,
+          {
+            cwd: process.cwd(),
+          },
+          expect.any(Function),
+        );
+        done();
+      } catch (err) {
+        done(err);
+      }
+    });
+  });
+
+  it("should ignore the .github folder", (done) => {
+    jest.unmock("child_process");
+    jest.unmock("fs");
+    const child_process = require("child_process");
+    const fs = require("fs");
+    const download = require("../lib/download");
+    const zippath = path.resolve(__dirname, "fixtures", "output.tar.gz");
+
+    download.unzip(zippath, (err) => {
+      try {
+        expect(err).toBeNull();
+        fs.readdir(path.resolve(__dirname, "fixtures", "output"), (err, files) => {
+          expect(files).not.toContain(".github");
+          done();
+        });
+      } catch (err) {
+        done(err);
+      }
+    });
+  });
+});

config.js

@@ -1,55 +1,5 @@
 import { Separator } from "@inquirer/select";
 
-const regionConfig = [
-  {
-    value: "Alaska",
-    code: "alaska",
-    description:
-      "Extending to the Arctic, Alaska’s culturally-diverse people, infrastructure, economy, and ecosystems are already experiencing the effects of climate change. Obtaining a better understanding of these early impacts will provide an integration of science and decision-making for adaptation on a global scale.",
-  },
-  {
-    value: "Central",
-    code: "central",
-    description:
-      "NOAA’s Central region includes the “bread basket” of the Nation. A significant portion of the Nation’s agriculture, particularly wheat and corn, comes from this region. In addition to agriculture, an integrated advanced technology corridor stretches along the Front Range of the Rockies, with assets and commercial interests in climate research and space environment.)",
-  },
-  {
-    value: "Great Lakes",
-    code: "greatlakes",
-    description:
-      "While the Great Lakes region has been a leader for innovative science and advances in natural resources management, there are still significant gaps in knowledge about ecological processes and key indicators of ecosystem health. The Great Lakes face new and emerging problems due to the effects of climate change, including potentially changing long-term water levels and the timing and duration of weather events.",
-  },
-  {
-    value: "Gulf of Mexico",
-    code: "gulfofmexico",
-    description:
-      "The Gulf of Mexico provides the Nation with valuable energy resources, tasty seafood, extraordinary beaches and leisure activities, and a rich cultural heritage. It is also home to some of the most devastating weather in the Nation, including the most costly natural disaster in U.S. history.",
-  },
-  {
-    value: "North Atlantic",
-    code: "northatlantic",
-    description:
-      "NOAA's North Atlantic region extends from Maine to Virginia and is rich with history, culture, and economic opportunities. It is home to more than 70 million people, more than 80 percent of which live in the region's 180 coastal counties.",
-  },
-  {
-    value: "Pacific",
-    code: "pacific",
-    description:
-      "NOAA's North Atlantic region extends from Maine to Virginia and is rich with history, culture, and economic opportunities. It is home to more than 70 million people, more than 80 percent of which live in the region's 180 coastal counties.",
-  },
-  {
-    value: "Southeast & Caribbean",
-    code: "southwest",
-    description:
-      "The Southeast and Caribbean region is one of the fastest growing in the US, with a rapidly transforming economic base. Increasing population, particularly along coasts, drives a strong demand for ecosystem services, and puts more people at risk to hazards and changing climate.",
-  },
-  {
-    value: "Western Region",
-    description:
-      "In many regards, the West is still “wild” with over 753 million acres of land held by the Federal government in public trust, much of which is managed as national parks and forests. From the deserts to the coastal temperate rain forests, the West is characterized by numerous distinct and complex terrestrial and marine ecosystems.",
-  },
-];
-
 const applicationTypes = [
   {
     name: "Electronic Vessel Trip Reporting (eVTR)",
@@ -65,4 +15,4 @@ const applicationTypes = [
   },
 ];
 
-export { regionConfig, applicationTypes };
+export { applicationTypes };

index.js

@@ -1,12 +1,11 @@
 #!/usr/bin/env node
-import { execSync } from "child_process";
-import { confirm } from "@inquirer/prompts";
-import select from "@inquirer/select";
-import { Command } from "commander";
-import ora from "ora";
-import { validateRegion } from "./validators.js";
-import { regionConfig } from "./config.js";
-import path from "path";
+const { execSync } = require("child_process");
+const { confirm } = require("@inquirer/prompts");
+const { Command } = require("commander");
+const ora = require("ora");
+const path = require("path");
+const { downloadFile, unzip } = require("./lib/download.js");
+const fs = require("fs");
 
 const program = new Command();
 
@@ -18,54 +17,74 @@ program
 // program options
 program.argument("<projectDirectoryPath>").option("-r --region <string>", "specified region");
 
-program.action((projectDirectoryPath, options) => {
-  const isValidRegion = validateRegion(options.region);
-
-  if (!isValidRegion) {
-    const regionCodes = regionConfig
-      .map((region) => region.code)
-      .join(" , ")
-      .replace(/, $/, ""); // remove comma from last elem
-    console.error("Invalid region code. Here are the valid regions: ", regionCodes);
-  }
-
+program.action((projectDirectoryPath) => {
   scaffoldRadFishApp(projectDirectoryPath);
 });
 
-// check options passed in via cli command
-const options = program.opts();
-
 async function scaffoldRadFishApp(projectDirectoryPath) {
   const targetDirectory = path.resolve(
     process.cwd(),
     `${projectDirectoryPath.trim().replace(/\s+/g, "-")}`, // replace whitespaces in the filepath
   );
 
-  async function defineRegion() {
-    return await select({
-      name: "region",
-      message: "Which NOAA region will you be building your app for?",
-      choices: regionConfig,
-    });
-  }
-
-  async function confirmConfiguration(region) {
+  async function confirmConfiguration() {
     return await confirm({
-      message: `You are about to scaffold an application for the region of ${region} in the following project directory: ${targetDirectory}
+      message: `You are about to scaffold an application in the following project directory: ${targetDirectory}
       Okay to proceed?`,
     });
   }
 
-  // this will clone the radfish app boilerplate and spin it up
-  function bootstrapApp() {
-    const repoUrl = "git@github.com:NMFS-RADFish/boilerplate.git"; // via ssh each user/developer will need to have ssh keypair setup in github org
+  async function bootstrapApp() {
     const spinner = ora("Setting up application").start();
 
-    // Clone the repository
     try {
-      execSync(`git clone ${repoUrl} ${targetDirectory}`);
-      console.log(`Repository cloned successfully.`);
+      await new Promise((resolve, reject) => {
+        downloadFile(
+          "https://github.com/NMFS-RADFish/boilerplate/archive/refs/tags/latest.tar.gz",
+          "boilerplate.tar.gz",
+          (err, res) => {
+            if (err) {
+              return reject(err);
+            }
+            resolve(res);
+          },
+        );
+      });
+
+      await new Promise((resolve, reject) => {
+        unzip("boilerplate.tar.gz", (err, res) => {
+          if (err) {
+            return reject(err);
+          }
+          resolve(res);
+        });
+      });
+
+      await new Promise((resolve, reject) => {
+        fs.rename(
+          path.resolve(process.cwd(), "boilerplate-latest"),
+          path.resolve(process.cwd(), targetDirectory),
+          (err, res) => {
+            if (err) {
+              return reject(err);
+            }
+            resolve(res);
+          },
+        );
+      });
+
+      await new Promise((resolve, reject) => {
+        fs.rm(path.resolve(process.cwd(), "boilerplate.tar.gz"), (err, res) => {
+          if (err) {
+            return reject(err);
+          }
+          resolve(res);
+        });
+      });
+
+      console.log(`Project successfully created.`);
     } catch (error) {
+      console.log(error);
       console.error(`Error cloning repository: ${error.message}`);
       process.exit(1);
     }
@@ -94,9 +113,7 @@ async function scaffoldRadFishApp(projectDirectoryPath) {
     spinner.stop();
   }
 
-  const region = options.region ? options.region : await defineRegion();
-
-  const confirmation = await confirmConfiguration(region);
+  const confirmation = await confirmConfiguration();
 
   if (confirmation) {
     await bootstrapApp();

lib/download.js

@@ -0,0 +1,55 @@
+const child_process = require("child_process");
+const fs = require("fs");
+const https = require("https");
+const path = require("path");
+
+/**
+ *
+ * @param {string} url - the url to download
+ * @param {string} outputFilepath - the name of the output file
+ * @param {Function<Error?, response>} callback - callback function
+ * @returns void
+ */
+module.exports.downloadFile = async function (
+  url,
+  outputFilepath = "download",
+  callback = () => {},
+) {
+  https.get(url, function (response) {
+    if (response.statusCode >= 400) {
+      return callback(new Error("Failed to download file"), null);
+    }
+
+    if (response.statusCode === 302) {
+      return module.exports.downloadFile(response.headers.location, outputFilepath, callback);
+    }
+
+    if (response.statusCode === 200) {
+      const file = fs.createWriteStream(path.resolve(process.cwd(), outputFilepath));
+      response.pipe(file);
+      file.on("finish", function () {
+        file.close(callback);
+      });
+    }
+  });
+};
+
+/**
+ * Expands a zip file into a directory
+ * @param {string} filepath
+ * @param {string} destinationPath
+ * @param {Function<Error?, response>} callback
+ */
+module.exports.unzip = async (filepath, callback = () => {}) => {
+  const filepathDir = path.resolve(path.dirname(filepath));
+  child_process.exec(
+    `tar -xf ${filepath} --exclude .github`,
+    { cwd: filepathDir },
+    (err, stdout, stderr) => {
+      if (err) {
+        return callback(err, stderr);
+      }
+      return callback(null, stdout);
+    },
+  );
+};