tfv 1.1.0

package/.github/workflows/publish.yml

@@ -0,0 +1,21 @@
+name: Publish tfv to npm registry
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v2
+      - name: setup node
+        uses: actions/setup-node@v1
+        with:
+          node-version: 12
+          registry-url: https://registry.npmjs.org
+      - name: publish
+        run: npm publish --access public
+        env:
+            NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Marcus Chukwuoma
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,72 @@
+### Use `tfv` to manage multiple versions of terraform with ease.
+         _        ________        __
+       _| |__   / _____|\ \      / /
+      |_  ___\ | |___    \ \    / /
+        | |    |  ___|    \ \  / /
+        | |___ | |         \ \/ /
+        \______\_|          \__/
+
+        Happy terraforming 😍🥂!
+  ---------------------------------------
+
+## Installation
+> **_NOTE:_** `tfv` should be installed `globally` so that it can be run from anywhere on your computer.
+```sh
+npm install -g tfv
+```
+# Table of Contents
+
+<!--ts-->
+* [Table of Contents](#table-of-contents)
+  * [Usage](#usage)
+    * [Modules](#modules)
+      * [install](#install)
+      * [use](#use)
+      * [list](#list)
+<!--te-->
+
+## Usag
+
+### Modules
+#### *install*
+```sh
+tfv install <version>
+```
+or
+```sh
+tfv i <version>
+```
+| Version          | Description                               |
+| ---------------- | ----------------------------------------- |
+| x.x.x            | Installs terraform version x.x.x          |
+| x^               | Installs latest version of series x       |
+| x.x.^            | Installs latest version of series x.x     |
+| latest           | Installs latest version of terraform      |
+
+#### *use*
+```sh
+tfv use <version>
+```
+
+| Version          | Description                               |
+| ---------------- | ----------------------------------------- |
+| x.x.x            | use terraform version x.x.x               |
+| x^               | use latest version of series x            |
+| x.x.^            | use latest version of series x.x          |
+| latest           | use latest version of terraform           |
+
+> **_NOTE:_** If you're using windows OS, you would be prompted for admin privilege. Accept it. This is a one-time request to set terraform location in you system path. Unix machines would also get password prompt, as this requires permission to copy terraform to your bin directory.
+
+#### *list*
+```sh
+tfv list [option]
+```
+or
+```sh
+tfv ls [option]
+```
+| Option         | Option Alias  |                Description                                             |
+| ---------------|---------------|----------------------------------------------------------------------- |
+| `--local`      |  `-l`         |  Lists all terraform versions installed locally                        |
+| `--remote`     |  `-r`         |  Lists all terraform versions available remotely, on terraform server  |
+|                |               |  Defaults to listing terraform versions installed locally              |

package/index.js

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+
+const yargs = require('yargs')
+const {join} = require('path')
+
+yargs
+	.commandDir(join(__dirname, 'lib', 'commands'))
+	.alias('help', 'h')
+	.scriptName('tfv')
+	.demandCommand(1, 'You need at least one command before moving on')
+	.strictOptions()
+	// .strictCommands()
+	.showHelpOnFail()
+	.argv

package/lib/commands/install.js

@@ -0,0 +1,43 @@
+'use strict'
+
+const yargs = require('yargs');
+const {install} = require('../modules/install');
+const {fetchAllVersions} = require('../modules/remote');
+const {P_END, P_ERROR, P_OK} = require('../utils/colors');
+
+exports.command = 'install <version>'
+exports.aliases = ['i']
+exports.desc = 'Example: tfv install 1.0.11'
+exports.builder = {
+  'verbose': {
+    describe: 'Produce detailed output',
+    alias: 'v'
+  }
+}
+
+exports.handler = async () => {
+  let [,version] = yargs.argv._;
+  const result = await fetchAllVersions();
+
+  if (version === 'latest') {
+    [version] = result.filter(v => {
+      const [, inTest] = v.split('-');
+      if (!inTest) return v;
+    });
+  }
+
+  if (`${version}`.endsWith('^')) {
+    [version] = result.filter(v => {
+      const [, inTest] = v.split('-');
+      if (v.startsWith(version.replace('^', '')) && !inTest) return v
+    });
+  }
+
+  if (!result.find(v => v === version)) {
+    console.log(`${P_ERROR}Terraform ${version} not found.${P_END}`);
+    console.log(`To view a list of available version, run ${P_OK}tfv list --remote${P_END}`);
+    process.exit(1);
+  }
+
+  await install(version);
+}

package/lib/commands/list.js

@@ -0,0 +1,26 @@
+'use strict'
+
+const yargs = require('yargs');
+const {list} = require('../modules/list');
+
+exports.command = 'list [option]'
+exports.aliases = ['ls']
+exports.desc = 'Example: tfv list --local'
+exports.builder = {
+  local: {
+    alias: 'l',
+    describe: 'List terraform versions you have installed using tfv',
+    type: 'boolean',
+    default: true,
+  },
+  remote: {
+    alias: 'r',
+    describe: 'List all available terraform versions',
+    type: 'boolean',
+  }
+}
+
+exports.handler = async () => {
+  const {local, remote} = yargs.argv;
+  await list(local, remote);
+}

package/lib/commands/use.js

@@ -0,0 +1,27 @@
+'use strict'
+
+const yargs = require('yargs');
+const {existsSync} = require('fs');
+const {join} = require('path');
+const {use} = require('../modules/use');
+const {P_ERROR, P_END, P_OK} = require('../utils/colors');
+
+exports.command = 'use <version>'
+exports.desc = 'Example: tfv use 1.0.11'
+exports.builder = {
+  verbose: {
+    alias: 'v',
+    describe: 'Produce detailed output'
+  }
+}
+
+exports.handler = async () => {
+  const [,version] = yargs.argv._;
+
+  if (!existsSync(join(__dirname, '../../', 'store'))) {
+    console.log(`${P_ERROR}You're yet to install terraform with tfv${P_END}`);
+    return console.log(`For guidance, run ${P_OK}tfv -h${P_END}`);
+  }
+
+  await use(version);
+}

package/lib/modules/install.js

@@ -0,0 +1,73 @@
+const https = require('https');
+const os = require('os');
+const fs = require('fs');
+const {join} = require('path');
+const {arch} = process;
+const unzip = require('decompress');
+const {P_END, P_ERROR, P_INFO, P_OK, P_WARN} = require('../utils/colors');
+
+exports.install = async (version) => {
+  try {
+    const store = join(__dirname, '../..', 'store');
+    const fileName = join(__dirname, '../..', `${version}.zip`);
+    const getVersion = os.platform() === 'win32' ? `${version}.exe` : version;
+
+    if (fs.existsSync(`${store}/${getVersion}`)) {
+      console.log(`${P_WARN}Terraform ${version} is already installed${P_END}`);
+      return console.log(`To use this version Run: ${P_OK}tfv use ${version}${P_END}`)
+    }
+
+    const sysOs = os.platform() === 'win32' ? 'windows' : os.platform();
+    let sysArch = arch === 'x64' ? 'amd64' : '386';
+
+    const url = `https://releases.hashicorp.com/terraform/${version}/terraform_${version}_${sysOs}_${sysArch}.zip`;
+
+    const req = https.get(url, (res) => {
+      console.log(`${P_INFO}Installing terraform ${version}${P_END}`);
+
+      const fileStream = fs.createWriteStream(fileName);
+      res.pipe(fileStream);
+
+      fileStream.on('error', (err) => {
+        console.log(`${P_ERROR}Error writing stream ${P_END}\n`, err);
+      });
+
+      fileStream.on('close', async () => {
+        await clean(version);
+        makeExecutable(version);
+      });
+
+      fileStream.on('finish', () => {
+        fileStream.close();
+        console.log(`${P_OK}Successful!${P_END}`);
+        console.log(`To use this version Run: ${P_OK}tfv use ${version}${P_END}`);
+      })
+    });
+
+    req.on('error', (err) => {
+      console.log(`${P_ERROR}Error downloading the terraform ${version}${P_END}\n`, err)
+    });
+
+    const clean = async (version) => {
+      if (fs.existsSync(fileName)) {
+        await unzip(fileName, store, {
+          map: file => {
+            const [, ext] = `${file.path}`.split('.');
+            file.path = ext ? `${version}.${ext}` : `${version}`;
+            return file;
+          }
+        });
+
+        fs.unlinkSync(fileName);
+      }
+    }
+
+    const makeExecutable = async (version) => {
+      if (sysOs !== 'windows') {
+        fs.chmodSync(`${store}/${version}`, '755');
+      }
+    }
+  } catch ({message}) {
+    console.log('ERROR:', message)
+  }
+}

package/lib/modules/list.js

@@ -0,0 +1,30 @@
+const fs = require('fs');
+const {join} = require('path');
+const {fetchAllVersions} = require('./remote');
+const {P_END, P_OK} = require('../utils/colors');
+
+exports.list = async (local, remote) => {
+  try {
+    let versions;
+
+    const result = (message, v) => {
+      console.log(`${P_OK}${message}${P_END}` + '\n');
+      console.log(v.join('\n'));
+    }
+
+    if (remote) {
+      versions = await fetchAllVersions();
+
+      return result('List of all available terraform versions', versions)
+    }
+
+    if (local) {
+      const store = join(__dirname, '../..', 'store');
+      versions = fs.readdirSync(store).map(v => v.replace('.exe', ''));
+
+      return result('Terraform versions managed by tfv', versions);
+    }
+  } catch ({message}) {
+    console.log(message)
+  }
+}

package/lib/modules/ps1.js

@@ -0,0 +1,38 @@
+const {spawnSync} = require("child_process");
+const {P_END, P_ERROR} = require('../utils/colors');
+
+exports.setWindowsTerraform = async () => {
+  const getSystemEnv = spawnSync(
+    "powershell",
+    ["(Get-ItemProperty -Path 'Registry::HKEY_LOCAL_MACHINE\\System\\CurrentControlSet\\Control\\Session Manager\\Environment' -Name PATH).path"],
+    {stdio: 'pipe'}
+  );
+
+  if (!getSystemEnv || getSystemEnv.status === 1) {
+    console.log(`${P_ERROR}Error ocurred while fetching windows environment${P_END}`);
+    process.exit(1);
+  }
+
+  const systemEnv = getSystemEnv.stdout.toString().trim();
+
+  const terraformPath = 'C:\\terraform';
+  const getTerraformEnv = systemEnv.split(';').find(v => v === terraformPath);
+
+  if (!getTerraformEnv) {
+    const newSystemEnv = `${terraformPath};${systemEnv}`;
+
+    const updateEnv = spawnSync(
+      "powershell",
+      [
+        "-command",
+        `start-process powershell -verb runas -argumentlist "Set-ItemProperty -Path 'Registry::HKEY_LOCAL_MACHINE\\System\\CurrentControlSet\\Control\\Session Manager\\Environment' -Name PATH -Value '${newSystemEnv}'"`
+      ],
+      {stdio: 'pipe'}
+    );
+
+    if (!updateEnv || updateEnv.status === 1) {
+      console.log(`${P_ERROR}Error ocurred while setting windows Environment${P_END}`);
+      process.exit(1);
+    }
+  }
+}

package/lib/modules/remote.js

@@ -0,0 +1,29 @@
+const client = require('https');
+
+const getAvailableVersions = (url) => {
+	return new Promise((resolve, reject) => {
+		client.get(url, (resp) => {
+			let data = '';
+
+			// A chunk of data has been received.
+			resp.on('data', (chunk) => {
+				data += chunk;
+			});
+
+			// The whole response has been received. Print out the result.
+			resp.on('end', () => {
+				resolve(data);
+			});
+		}).on("error", (err) => {
+				reject(err);
+		});
+	});
+};
+
+exports.fetchAllVersions = async () => {
+	const content = await getAvailableVersions('https://releases.hashicorp.com/terraform/');
+	const pattern = /(>terraform_).*(?=<\/a>)/g;
+	const versions = content.match(pattern).map(v => v.replace('>terraform_', ''));
+
+	return versions;
+};

package/lib/modules/use.js

@@ -0,0 +1,52 @@
+const os = require('os');
+const {join} = require('path');
+const {spawnSync} = require('child_process');
+const {readdirSync, mkdirSync, copyFileSync, existsSync} = require('fs');
+const {setWindowsTerraform} = require('./ps1');
+const {P_END, P_OK, P_INFO, P_ERROR} = require('../utils/colors');
+
+exports.use = async (tfVer) => {
+  try {
+    let version = os.platform() === 'win32' ? `${tfVer}.exe` : tfVer;
+
+    if (tfVer === 'latest') {
+      [version] = readdirSync(join(__dirname, '../../store')).sort((a, b) => {
+        const aVer = a.replace(/(.exe)|\./g, '')
+        const bVer = b.replace(/(.exe)|\./g, '')
+        return Number(bVer) - Number(aVer)
+      });
+
+      console.log(`${P_INFO}Your latest installed version is ${version}${P_END}`);
+    }
+
+    console.log(`${P_INFO}Switching to terraform ${version}${P_END}`);
+
+    const source = join(__dirname, '../../store', version);
+
+    if (!existsSync(source)) {
+      console.log(`${P_ERROR}terraform ${version} is not installed${P_END}`);
+      return console.log(`To install this version Run: ${P_OK}tfv install ${version}${P_END}`);
+    }
+
+    let destination;
+
+    if (['darwin', 'linux'].includes(os.platform())) {
+      const bin = os.platform() === 'darwin' ? '/usr/local/bin' : `${os.homedir()}/bin`;
+
+      destination = `${bin}/terraform`;
+      spawnSync('sudo', ['cp', `${source}`, `${destination}`], {stdio: 'inherit', shell: true});
+    }
+
+    if (os.platform() === 'win32') {
+      mkdirSync('C:\\terraform', { recursive: true });
+      destination = 'C:\\terraform\\terraform.exe';
+
+      copyFileSync(source, destination);
+      setWindowsTerraform();
+    }
+
+    console.log(`${P_OK}Successful!${P_END}`)
+  } catch ({message}) {
+    console.log('ERROR:', message)
+  }
+}

package/lib/utils/colors.js

@@ -0,0 +1,6 @@
+// console log colours
+exports.P_OK = '\x1b[32m\x1b[1m'; // Green
+exports.P_WARN = '\x1b[33m\x1b[1m'; // Yellow
+exports.P_ERROR = '\x1b[31m\x1b[1m'; // Red
+exports.P_END = '\x1b[0m'; // Reset
+exports.P_INFO = '\x1b[35m' // Magenta

package/lib/utils/postInstall.js

@@ -0,0 +1,15 @@
+const {P_END, P_OK, P_INFO, P_ERROR} = require('./colors');
+
+const message = `\n\
+         _        ________        __\n\
+       _| |__   / _____|\\ \\      / /\n\
+      |_  ___\\ | |___    \\ \\    / /\n\
+        | |    |  ___|    \\ \\  / /\n\
+        | |___ | |         \\ \\/ /\n\
+        \\______\\_|          \\__/\n\
+      \n\
+        ${P_OK}Happy terraforming!${P_END} 😍🥂\n\
+    ---------------------------------\n\
+`;
+
+console.log(message);

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "tfv",
+  "version": "1.1.0",
+  "description": "Terraform version manager",
+  "main": "index.js",
+  "directories": {
+    "lib": "lib",
+    "store": "store"
+  },
+  "scripts": {
+    "postinstall": "node lib/utils/postInstall.js"
+  },
+  "bin": {
+    "tfv": "index.js"
+  },
+  "keywords": [
+    "Terraform",
+    "version"
+  ],
+  "author": "Marcus Chukwuoma <marcus2cu@gmail.com> (https://github.com/marcdomain)",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/marcdomain/tfv.git"
+  },
+  "dependencies": {
+    "decompress": "^4.2.1",
+    "yargs": "^17.2.1"
+  }
+}