deploy.sh 1.0.0 → 2.0.0

package/.eslintignore

@@ -3,3 +3,4 @@ docs
 fixtures
 tmp
 coverage
+website

package/.eslintrc

@@ -1,23 +1,12 @@
 {
-  "extends": "eslint:recommended",
+  "extends": ["eslint:recommended", "plugin:jest/recommended"],
+  "plugins": ["jest"],
   "env": {
     "es6": true,
     "node": true
   },
   "parserOptions": {
-    "ecmaVersion": "2017"
-  },
-  "rules": {
-    "no-inner-declarations": 0,
-    "strict": 0,
-    "semi": [
-      "error",
-      "always"
-    ],
-    "no-octal": 0,
-    "indent": [
-      "error",
-      2
-    ]
+    "ecmaVersion": "latest",
+    "sourceType": "module"
   }
 }

package/.github/workflows/ci.yml

@@ -0,0 +1,48 @@
+name: Node.js CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [16.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "npm"
+      - run: npm i -g npm@7
+      - run: npm ci
+      - run: npm run build --if-present
+      - run: npm test
+
+  gh-release:
+    if: github.event_name != 'pull_request'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: "16.x"
+      - uses: webfactory/ssh-agent@v0.5.3
+        with:
+          ssh-private-key: ${{ secrets.GH_PAGES_DEPLOY }}
+      - name: Release to GitHub Pages
+        env:
+          USE_SSH: true
+          GIT_USER: git
+        run: |
+          git config --global user.email "gabecsapo@gmail.com"
+          git config --global user.name "Gabriel J. Csapo"
+          cd website
+          npm install
+          npm run deploy

package/.husky/pre-commit

@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+./node_modules/.bin/eslint .
+./node_modules/.bin/pretty-quick --staged

package/.release-it.json

@@ -0,0 +1,5 @@
+{
+  "github": {
+    "release": true
+  }
+}

package/README.md

@@ -1,15 +1,14 @@
-# deploy.sh <img align="right" src="docs/logo.png" width="120">
+# deploy.sh <img align="right" src="website/static/img/logo.png" width="120">
 
 > ☁️ open source continuous deployment service
 
 [![Npm Version](https://img.shields.io/npm/v/deploy.sh.svg)](https://www.npmjs.com/package/deploy.sh)
-[![Coverage Status](https://lcov-server.gabrielcsapo.com/badge/github%2Ecom/gabrielcsapo/deploy.sh.svg)](https://lcov-server.gabrielcsapo.com/coverage/github%2Ecom/gabrielcsapo/deploy.sh)
 [![Dependency Status](https://starbuck.gabrielcsapo.com/badge/github/gabrielcsapo/deploy.sh/status.svg)](https://starbuck.gabrielcsapo.com/github/gabrielcsapo/deploy.sh)
 [![devDependency Status](https://starbuck.gabrielcsapo.com/badge/github/gabrielcsapo/deploy.sh/dev-status.svg)](https://starbuck.gabrielcsapo.com/github/gabrielcsapo/deploy.sh#info=devDependencies)
 [![Build Status](https://travis-ci.org/gabrielcsapo/deploy.sh.svg?branch=master)](https://travis-ci.org/gabrielcsapo/deploy.sh)
 ![npm](https://img.shields.io/npm/dt/deploy.sh.svg)
 ![npm](https://img.shields.io/npm/dm/deploy.sh.svg)
 
-![Static Example](./docs/example.gif)
+![Static Example](./website/static/example.gif)
 
-To learn more visit [http://www.gabrielcsapo.com/deploy.sh/](http://www.gabrielcsapo.com/deploy.sh/)
+To learn more visit [https://gabrielcsapo.github.io/deploy.sh](https://gabrielcsapo.github.io/deploy.sh)

package/__tests__/lib/classifier.test.js

@@ -0,0 +1,49 @@
+const path = require("path");
+
+const classifier = require("../../lib/classifier");
+
+describe("@lib/classifier", () => {
+  const baseDirectory = path.resolve(__dirname, "..", "..", "examples");
+
+  test("should be able to classify static site", async () => {
+    const directory = path.resolve(baseDirectory, "static");
+    const output = await classifier(directory);
+
+    expect(output).toEqual({
+      type: "static",
+      build: `\n        FROM mhart/alpine-node:base-8\n        WORKDIR ${directory}\n        ADD . .\n\n        CMD ["node", "index.js"]\n      `,
+    });
+  });
+
+  test("should be able to classify node site", async () => {
+    const directory = path.resolve(baseDirectory, "node");
+    const output = await classifier(directory);
+
+    expect(output).toEqual({
+      type: "node",
+      build: `\n        FROM mhart/alpine-node:8\n        WORKDIR ${directory}\n        ADD . .\n\n        RUN npm install\n\n        CMD ["npm", "start"]\n      `,
+    });
+  });
+
+  test("should be able to classify docker site", async () => {
+    const directory = path.resolve(baseDirectory, "docker");
+    const output = await classifier(directory);
+
+    expect(output).toEqual({
+      type: "docker",
+      build: `FROM mhart/alpine-node:8\nWORKDIR ${directory}\nADD . .\n\nCMD ["node", "index.js"]\n`,
+    });
+  });
+
+  test("should be able to classify unknown deploy target", async () => {
+    const directory = path.resolve(
+      path.resolve(__dirname, "..", "fixtures"),
+      "unknown"
+    );
+    const output = await classifier(directory);
+
+    expect(output).toEqual({
+      type: "unknown",
+    });
+  });
+});

package/__tests__/lib/helpers/util.test.js

@@ -0,0 +1,57 @@
+const os = require("os");
+const fs = require("fs");
+
+const {
+  getPort,
+  hash,
+  contains,
+  mk,
+  rm,
+} = require("../../../lib/helpers/util");
+
+describe("@lib/util", () => {
+  test("@getPort: should be able return a valid port", async () => {
+    let port = await getPort();
+    let port1 = await getPort();
+
+    expect(Number.isInteger(port)).toBeTruthy();
+    expect(Number.isInteger(port1)).toBeTruthy();
+    expect(port !== port1).toBeTruthy();
+  });
+
+  test("@hash: should return a proper lowercase hash", () => {
+    const ret = hash(6);
+    expect(ret.length).toBeTruthy();
+    expect(ret.toLowerCase()).toBeTruthy();
+  });
+
+  test("@contains: should be able to return a proper conditional for truthy and false cases", () => {
+    expect(
+      contains(
+        ["index.html", "main.css"],
+        ["index.html", "!Dockerfile", "!package.json"]
+      )
+    ).toBeTruthy();
+    expect(
+      contains(
+        ["index.html", "main.css", "Dockerfile"],
+        ["index.html", "!Dockerfile", "!package.json"]
+      )
+    ).toBeFalsy();
+    expect(
+      contains([], ["index.html", "!Dockerfile", "!package.json"])
+    ).toBeFalsy();
+  });
+
+  test("@mk / @rm: should be able to make recursive directory", async () => {
+    let directory = `${os.tmpdir()}/hello/world/this/is/a/nested/directory`;
+
+    await mk(directory);
+
+    expect(fs.existsSync(directory)).toBeTruthy();
+
+    await rm(directory);
+
+    expect(!fs.existsSync(directory)).toBeTruthy();
+  });
+});

package/bin/deploy-delete.js

@@ -1,6 +1,9 @@
 #!/usr/bin/env node
+import ora from "ora";
+
+export default async function (cli) {
+  const spinner = ora().start();
 
-module.exports = async function(cli, spinner) {
   spinner.text = `Deleting deployment ${cli.application}`;
 
   const { token, username } = await cli.getCredentials();
@@ -8,4 +11,4 @@ module.exports = async function(cli, spinner) {
   await cli.deleteDeployment({ token, username, name: cli.application });
 
   spinner.succeed(`Deployment deleted, ${cli.application} successfully`);
-};
+}

package/bin/deploy-deploy.js

@@ -1,31 +1,36 @@
 #!/usr/bin/env node
 
-const fs = require('fs');
-const path = require('path');
+import fs from "fs";
+import path from "path";
+import ora from "ora";
 
-module.exports = async function(cli, spinner) {
-  spinner.text = 'Creating application bundle';
+export default async function (cli) {
+  const spinner = ora().start();
+
+  spinner.text = "Creating application bundle";
 
   await cli.createBundle(process.cwd());
 
-  spinner.text = 'Getting deploy keys';
+  spinner.text = "Getting deploy keys";
 
   const { token, username } = await cli.getCredentials();
 
-  spinner.text = 'Uploading application bundle';
+  spinner.text = "Uploading application bundle";
 
-  const bundle = fs.createReadStream(path.resolve(process.cwd(), 'bundle.tgz'));
+  const bundle = fs.readFileSync(path.resolve(process.cwd(), "bundle.tgz"));
 
   const { deployment } = await cli.uploadBundle({
     name: path.basename(process.cwd()),
     bundle,
     token,
-    username
+    username,
   });
 
-  spinner.text = 'Cleaning up local files';
+  spinner.text = "Cleaning up local files";
 
   await cli.removeBundle(process.cwd());
 
-  spinner.succeed(`Upload successfully, http://${deployment.subdomain}.localhost:5000`);
-};
+  spinner.succeed(
+    `Upload successfully, http://${deployment.subdomain}.localhost:5000`
+  );
+}

package/bin/deploy-list.js

@@ -1,18 +1,20 @@
 #!/usr/bin/env node
+import moment from "moment";
+import Url from "url";
+import Table from "turtler";
+import ora from "ora";
 
-const moment = require('moment');
-const Url = require('url');
-const Table = require('turtler');
+export default async function (cli) {
+  const spinner = ora().start();
 
-module.exports = async function(cli, spinner) {
-  spinner.text = 'Getting deployment list';
+  spinner.text = "Getting deployment list";
 
   const { token, username } = await cli.getCredentials();
   const { deployments } = await cli.getDeployments({ token, username });
 
   spinner.stop();
 
-  if(deployments.length > 0) {
+  if (deployments.length > 0) {
     let data = [["name", "url", "age", "requests", "status"]];
 
     deployments.forEach((r, i) => {
@@ -20,13 +22,19 @@ module.exports = async function(cli, spinner) {
       config.host = `${r.subdomain}.${config.host}`;
       const url = Url.format(config);
 
-      data[i + 1] = [r.name, url, moment(r.updated_at).fromNow(), r.requests.toString(), r.status];
+      data[i + 1] = [
+        r.name,
+        url,
+        moment(r.updated_at).fromNow(),
+        r.requests.toString(),
+        r.status,
+      ];
     });
 
     let table = new Table(data);
 
     console.log(table.markdown()); // eslint-disable-line
   } else {
-    console.log('0 deployments found'); // eslint-disable-line
+    console.log("0 deployments found"); // eslint-disable-line
   }
-};
+}

package/bin/deploy-login.js

@@ -1,39 +1,43 @@
 #!/usr/bin/env node
+import inquirer from "inquirer";
+import ora from "ora";
 
-const inquirer = require('inquirer');
-
-module.exports = async function(cli, spinner) {
-  spinner.stop();
+export default async function (cli) {
+  const spinner = ora();
 
   const { username, password } = await inquirer.prompt([
     {
-      name: 'username',
-      type: 'input',
-      message: 'Enter your e-mail address:',
-      validate: function( value ) {
-        if (value.length > 0 && value.indexOf('@') > -1 && value.indexOf('.') > -1) {
+      name: "username",
+      type: "input",
+      message: "Enter your e-mail address:",
+      validate: function (value) {
+        if (
+          value.length > 0 &&
+          value.indexOf("@") > -1 &&
+          value.indexOf(".") > -1
+        ) {
           return true;
         } else {
-          return 'Please enter your e-mail address';
+          return "Please enter your e-mail address";
         }
-      }
+      },
     },
     {
-      name: 'password',
-      type: 'password',
-      message: 'Enter your password:',
+      name: "password",
+      type: "password",
+      message: "Enter your password:",
       mask: true,
-      validate: function(value) {
+      validate: function (value) {
         if (value.length) {
           return true;
         } else {
-          return 'Please enter your password';
+          return "Please enter your password";
         }
-      }
-    }
+      },
+    },
   ]);
-  const credentials = await cli.login({ username, password});
+  const credentials = await cli.login({ username, password });
   await cli.cacheCredentials(credentials);
 
-  console.log(`Successfully logged in as ${credentials.username}`); // eslint-disable-line
-};
+  spinner.succeed(`Logged in as ${credentials.username}`); // eslint-disable-line
+}

package/bin/deploy-logout.js

@@ -1,12 +1,16 @@
 #!/usr/bin/env node
 
-module.exports = async function(cli, spinner) {
+import ora from "ora";
+
+export default async function (cli) {
+  const spinner = ora().start();
+
   const { token, username } = await cli.getCredentials();
 
   spinner.text = `Logging out of current session for ${username}`;
 
   await cli.logout({ token, username });
-  await cli.cacheCredentials({ username: '', token: '' });
+  await cli.cacheCredentials({ username: "", token: "" });
 
-  spinner.succeed(`Logged out of session for ${username} successfully`);
-};
+  spinner.succeed(`Logged out as ${username}`);
+}

package/bin/deploy-logs.js

@@ -1,19 +1,26 @@
 #!/usr/bin/env node
 
-module.exports = async function(cli, spinner) {
-  spinner.text = `Getting logs for ${cli.application}`;
+import ora from "ora";
 
-  const { token, username } = await cli.getCredentials();
-  const { logs } = await cli.getLogs({ token, username, name: cli.application });
+export default async function (cli) {
+  const spinner = ora().start();
+
+  spinner.text = `Getting logs for application: "${cli.application}"`;
 
-  spinner.stop();
+  const { token, username } = await cli.getCredentials();
+  const { logs } = await cli.getLogs({
+    token,
+    username,
+    name: cli.application,
+  });
 
-  if(logs) {
-    console.log('' + // eslint-disable-line
-    `==========
-      ${logs.join('').trim()}
-    ==========`);
+  if (logs) {
+    spinner.info(`
+==========
+${logs.join("").trim()}
+==========
+    `);
   } else {
-    console.log('No logs available 🙈'); // eslint-disable-line
+    spinner.info("No logs available 🙈"); // eslint-disable-line
   }
-};
+}

package/bin/deploy-open.js

@@ -1,13 +1,20 @@
 #!/usr/bin/env node
 
-const Url = require('url');
-const opn = require('opn');
+import Url from "url";
+import opn from "opn";
+import ora from "ora";
 
-module.exports = async function(cli, spinner) {
-  spinner.text = 'Opening up url to deployment instance';
+export default async function (cli) {
+  const spinner = ora().start();
+
+  spinner.text = "Opening up url to deployment instance";
 
   const { token, username } = await cli.getCredentials();
-  const { deployment } = await cli.getDeployments({ token, username, name: cli.application });
+  const { deployment } = await cli.getDeployments({
+    token,
+    username,
+    name: cli.application,
+  });
 
   const config = Url.parse(cli.url);
   config.host = `${deployment.subdomain}.${config.host}`;
@@ -16,4 +23,4 @@ module.exports = async function(cli, spinner) {
   spinner.text = `Opening deployment at ${url}`;
   spinner.stopAndPersist();
   opn(url, { wait: false });
-};
+}

package/bin/deploy-register.js

@@ -1,40 +1,45 @@
 #!/usr/bin/env node
 
-const inquirer = require('inquirer');
+import inquirer from "inquirer";
+import ora from "ora";
+
+export default async function (cli) {
+  const spinner = ora();
 
-module.exports = async function(cli, spinner) {
-  spinner.stop();
-  
   const { username, password } = await inquirer.prompt([
     {
-      name: 'username',
-      type: 'input',
-      message: 'Enter a valid e-mail address:',
-      validate: function( value ) {
-        if (value.length > 0 && value.indexOf('@') > -1 && value.indexOf('.') > -1) {
+      name: "username",
+      type: "input",
+      message: "Enter a valid e-mail address:",
+      validate: function (value) {
+        if (
+          value.length > 0 &&
+          value.indexOf("@") > -1 &&
+          value.indexOf(".") > -1
+        ) {
           return true;
         } else {
-          return 'Please enter a valid e-mail address';
+          return "Please enter a valid e-mail address";
         }
-      }
+      },
     },
     {
-      name: 'password',
-      type: 'password',
-      message: 'Enter a password:',
+      name: "password",
+      type: "password",
+      message: "Enter a password:",
       mask: true,
-      validate: function(value) {
+      validate: function (value) {
         if (value.length) {
           return true;
         } else {
-          return 'Please enter a password';
+          return "Please enter a password";
         }
-      }
-    }
+      },
+    },
   ]);
 
   const credentials = await cli.register({ username, password });
   await cli.cacheCredentials(credentials);
 
-  console.log(`registered as ${credentials.username}`); // eslint-disable-line
-};
+  spinner.succeed(`registered as ${credentials.username}`); // eslint-disable-line
+}

package/bin/deploy-server.js

@@ -1,5 +1,11 @@
 #!/usr/bin/env node
 
-module.exports = async function(cli, spinner) {
-  await require('../index.js')(cli, spinner);
-};
+import ora from "ora";
+
+export default async function (cli) {
+  const spinner = ora().start();
+
+  const { default: importCommand } = await import("../index.js");
+
+  importCommand(cli, spinner);
+}

package/bin/deploy-whoami.js

@@ -1,12 +1,14 @@
 #!/usr/bin/env node
 
-module.exports = async function(cli, spinner) {
-  spinner.text = 'Figuring out who you are';
+import ora from "ora";
+
+export default async function (cli) {
+  const spinner = ora().start();
+
+  spinner.text = "Figuring out who you are";
 
   const { token, username } = await cli.getCredentials();
   const { user } = await cli.getUserDetails({ token, username });
 
-  spinner.stop();
-  
-  console.log(`currently logged in as ${user.username}`); // eslint-disable-line
-};
+  spinner.info(`currently logged in as ${user.username}`); // eslint-disable-line
+}