Re-implement CLI in Go, automate release process (#62)

Author: djones6

.gitignore

@@ -1 +1,4 @@
-node_modules/
+# Generated files that should never be checked into git
+install.sh
+linux-amd64/DEBIAN/control
+kitura.rb

.npmignore

@@ -1,14 +1,33 @@
-language: node_js
-sudo: required
+language: go
+go:
+  - 1.12.x
+
 branches:
   only:
-  - master
-  - "/^issue.*$/"
-  - /^greenkeeper/.*$/
-node_js:
-- '8'
-- '10'
+    - master
+    - "/^issue.*$/"
+    - /^\d+.\d+.\d+$/
+
 os:
-- linux
-- osx
-osx_image: xcode10.2
+  - linux
+  - osx
+osx_image: xcode11
+dist: xenial
+sudo: required
+
+script:
+  - "./build.sh ${TRAVIS_TAG:-0.0.1}"
+
+deploy:
+  provider: releases
+  api_key:
+    secure: Eag3dXonpciJXsxoG7PPF7lvp8v/VVZa9ggWb7mcbdVS1lgS6C6eN2t5B9ziTyZ7G5M8ScN8nVSeTIDBf8mNVgjRQghAhuIf9inblS1OxzbqPOPlAVPLYawCUUnKygpReVQY96UR9+2mWFXJUzt1GvwqVlHcGJE2wMBTR3Feg7Py1Gpmb8DVgMhG+r5UCF9l0m4r2z54NOxfyNlbjXYjIbAqI8IkDtWgYCPsO4qBA7COBkeULXNB2rvK2Vc9UVW0mdV76PbxXTWAEYniFQR3LriUF6lWRu9YP9Swhm3aKQOo1xwUz5inX3VFIfdEf1W/ef3oSQyoGC3e7cAnJl3Ycm2VgcDxaKDhQ5x796fKrPS9YHscBUZ56cy+1VDuMpa++iz4W1/ZroHnYdSHgakSlyAKvfEixUsWqJx62Ylm6JqnAD7VFb4a331oQuB6Rl3rwIfOQQuJFVdvSMwxeeyX97BEfVobusB7AOMkH+ZdOQs0A903BJgfdw598Pbjsni+jSJmGfd3PdQaGNDxXHNY4gRdLloQP9+U7+D/K2bNAl1l4xYfSsnsxEk7iV4sITWtxygB3ttmqOJ9aMfPEnpjErBDChPvgF+seYCbqqvH/ndTWtMTXwRre9Tu+HLjATfxxjkYCIpEnAPHWnxt6OT701g7X0WW9jfAx62vlJFr23I=
+  file: 
+   - kitura-cli_${TRAVIS_TAG}_amd64.deb
+   - kitura-cli_${TRAVIS_TAG}_darwin.tar.gz
+   - install.sh
+   - kitura.rb
+  skip_cleanup: true
+  on:
+    tags: true
+    repo: IBM-Swift/kitura-cli

.travis.yml

@@ -0,0 +1,79 @@
+GOCMD=go
+GOBUILD=$(GOCMD) build
+GOGET=$(GOCMD) get
+GOCLEAN=$(GOCMD) clean
+GOTEST=$(GOCMD) test
+
+BINARY_NAME=kitura
+PACKAGE_NAME=kitura-cli
+LINUX_DIR=linux-amd64
+LINUX_PATH=/usr/local/bin
+LINUX_BINARY=$(LINUX_DIR)$(LINUX_PATH)/$(BINARY_NAME)
+MACOS_DIR=darwin-amd64
+MACOS_PATH=/
+MACOS_BINARY=$(MACOS_DIR)$(MACOS_PATH)/$(BINARY_NAME)
+
+GOPATH=$(HOME)/kitura-cli-$(RELEASE)
+KITURA_SRC=$(GOPATH)/src/kitura
+
+# Handle additional param for sed -i on Darwin
+SED_FLAGS=
+UNAME_S := $(shell uname -s)
+ifeq ($(UNAME_S),Darwin)
+    SED_FLAGS := ""
+endif
+
+all: build package
+build: build-linux build-darwin
+package: package-linux package-darwin
+clean: 
+	$(GOCLEAN)
+	rm -f install.sh
+	rm -f $(LINUX_DIR)/DEBIAN/control
+	rm -rf $(LINUX_DIR)/usr
+	rm -rf $(MACOS_DIR)
+
+setup:
+	# Check RELEASE is set
+ifndef RELEASE
+	$(error RELEASE is not set)
+endif
+	
+	# Copy kitura/cmd module into GOPATH
+	mkdir -p $(KITURA_SRC)
+	cp -R -p cmd $(KITURA_SRC)
+	# Replace release placeholders in sources
+	cp install.sh.ver install.sh
+	cp kitura.rb.ver kitura.rb
+	cp $(LINUX_DIR)/DEBIAN/control.ver $(LINUX_DIR)/DEBIAN/control
+	sed -i $(SED_FLAGS) -e"s#@@RELEASE@@#$(RELEASE)#g" install.sh $(LINUX_DIR)/DEBIAN/control $(KITURA_SRC)/cmd/root.go kitura.rb
+deps:
+	# Install dependencies
+	$(GOGET) github.com/spf13/cobra/cobra
+	$(GOGET) gopkg.in/src-d/go-git.v4/...
+
+build-linux: setup deps
+	GOOS=linux GOARCH=amd64 $(GOBUILD) -o $(LINUX_BINARY) -v
+
+build-darwin: setup deps
+	GOOS=darwin GOARCH=amd64 $(GOBUILD) -o $(MACOS_BINARY) -v
+
+test:
+	cd $(KITURA_SRC)
+	$(GOTEST) kitura/cmd
+
+package-linux: build-linux
+	cp -R -p $(LINUX_DIR) $(PACKAGE_NAME)_$(RELEASE)
+	chmod -R 755 $(LINUX_DIR)$(LINUX_PATH)
+	dpkg-deb --build $(PACKAGE_NAME)_$(RELEASE)
+	mv $(PACKAGE_NAME)_$(RELEASE).deb $(PACKAGE_NAME)_$(RELEASE)_amd64.deb
+	rm -r $(PACKAGE_NAME)_$(RELEASE)
+
+package-darwin-tar: build-darwin
+	tar -czf $(PACKAGE_NAME)_$(RELEASE)_darwin.tar.gz $(MACOS_DIR)
+
+package-darwin: package-darwin-tar
+	# This syntax defines SHA_VALUE at rule execution time.
+	# Note: separate rule to delay evaluation until tar.gz has been written
+	$(eval SHA_VALUE := $(shell shasum -a 256 $(PACKAGE_NAME)_$(RELEASE)_darwin.tar.gz | cut -d' ' -f1))
+	sed -i $(SED_FLAGS) -e"s#@@SHA256@@#$(SHA_VALUE)#" kitura.rb

Makefile

@@ -1,49 +1,56 @@
 # Kitura command-line interface
 
-This Node.js package provides a `kitura` command-line interface, to simplify the process of creating [Kitura](https://github.com/IBM-Swift/Kitura) applications.
+This Go package provides a `kitura` command-line interface, to simplify the process of creating [Kitura](https://github.com/IBM-Swift/Kitura) applications.
 
-## Installation via Homebrew
+## Installation on macOS (via Homebrew)
 
+Kitura's CLI may be installed using [Homebrew](https://brew.sh):
 ```
 $ brew tap ibm-swift/kitura
 $ brew install kitura
 ```
 
-Installing via Homebrew will also install the latest version of Node.js on your system.
-
-## Installation via NPM
+## Installation (simple)
 
+You can install (either on Mac or Linux) with this one-liner:
 ```
-$ npm install -g kitura-cli
+$ curl -fsSL https://github.com/IBM-Swift/kitura-cli/releases/latest/download/install.sh | sudo bash
 ```
+The `kitura` binary will be placed in your `/usr/local/bin` directory.
 
-> If you encounter permissions errors such as `ENOENT` you may need to make changes to your NPM configuration. See [here](https://docs.npmjs.com/getting-started/fixing-npm-permissions) for further details.
+## Installation (manual)
 
-## Usage
+If you'd prefer not to use a script, the binary can be installed manually by downloading the release binary from GitHub. In the following commands, substitute `<release>` for the version of the CLI you are installing.
 
+On Mac:
+```
+$ curl -LO https://github.com/IBM-Swift/kitura-cli/releases/download/<release>/kitura-cli_<release>_darwin.tar.gz
+$ tar -xzf kitura-cli_<release>_darwin.tar.gz
+$ sudo mv darwin-amd64/kitura /usr/local/bin/
 ```
-$ kitura
-
-  Usage: kitura [options] [command]
-
-  Kitura command-line interface
-
-
-  Options:
-
-    -V, --version  output the version number
-    -h, --help     output usage information
 
+On Linux:
+```
+curl -LO https://github.com/IBM-Swift/kitura-cli/releases/download/<release>/kitura-cli_<release>_amd64.deb
+sudo dpkg -i kitura-cli_<release>_amd64.deb
+```
 
-  Commands:
+## Usage
 
-    build       build the project in a local container
-    create      interactively create a Kitura project
-    idt         install IBM Cloud Developer Tools
-    init        scaffold a bare-bones Kitura project
-    kit         print Cocoapods boilerplate for KituraKit
-    run         run the project in a local container
-    help [cmd]  display help for [cmd]
+```
+Usage:
+  kitura [command]
+
+Available Commands:
+  build       Build the project in a local container
+  help        Help about any command
+  idt         Install IBM Cloud Developer Tools
+  init        Initialize a Kitura project
+  run         Run the project in a local container.
+
+Flags:
+  -h, --help     help for kitura
+  -v, --version   Prints the kitura-cli version number.
 ```
 
 ## Release process

README.md

@@ -1,28 +1,14 @@
 ## kitura-cli Release Process
 
-The following instructions are for releasing a new version of kitura-cli on both npm and homebrew:
+The following instructions are for releasing a new version of kitura-cli:
 
+- Tag the release using the format `0.0.17`, which will trigger a build.
+  - Travis will then execute `build.sh <TAG>`, building and packaging the binary.
+  - Travis will attach the `kitura-cli_0.0.17_amd64.deb`, `kitura-cli_0.0.17_darwin.tar.gz`, `install.sh` and `kitura.rb` files to the release.
 
-**Make sure you run `npm test` on your changes before creating a PR.**
-
-Once your PR has been merged:
-
-### npm
-
-- Run `npm version patch` (or replace 'patch' with 'major'/'minor' based on your changes).
-- Check that the right version has been created by running `git tag` and making sure the new version is listed.
-- Run `git status` and `git diff <commit hash of previous commit>` to check that the version has been updated by npm in the project. You can find the previous commit hash by using `git log`.
-- If everything looks ok, switch to a new branch by running `git checkout -b update-version` and run `git push` to push the update version changes.
-- Run `git push --tags`.
-- Raise and merge the PR with your tag changes.
-- `git checkout master && git pull` to make sure you have the updated code.
-- Run `npm publish`. You'll need to log in using `npm adduser` and make sure you are a collaborator on https://www.npmjs.com/package/kitura-cli/).
-- Check to make sure the [npm package](https://www.npmjs.com/package/kitura-cli/) has been updated.
-
-### homebrew
+### Updating homebrew
 
 - Clone https://github.com/IBM-Swift/homebrew-kitura and create a new branch.
-- In `kitura.rb` change the strings specified by `url` and `version` to match the new version you've just uploaded to npm.
-- Download the new .tgz file specified by `url` and run `shasum -a 256 <name of .tgz file>`. Change then string specified by `sha256` to the the hash that came out of running this command.
+- Replace the `kitura.rb` file with the one that is attached to the release.
 - Push your changes, then raise and merge the PR.
 - Update your version of the cli by running `brew upgrade kitura` and do a final check to make sure your updates are running as expected.

Release-Process.md

@@ -0,0 +1,64 @@
+#!/bin/bash
+set -ex
+
+if [ -z "$1" ]; then
+    echo "Usage: build.sh <release>"
+    echo " - where <release> is a SemVer version in the format x.y.z"
+    exit 1
+fi
+
+export RELEASE=$1
+
+function failCmdFound() {
+    echo "Error - 'kitura' command already exists"
+    echo "Existing  kitura --version: `kitura --version`"
+    exit 1
+}
+
+function test_Darwin() {
+    # Todo: Test brew installation
+    # Check that command does not already exist
+    kitura && failCmdFound || echo "Command 'kitura' not found - OK"
+    # Check reported CLI version matches our release
+    cliVersion=`./darwin-amd64/kitura --version`
+    if [ "$cliVersion" == $RELEASE ]; then
+        echo "kitura --version reports $cliVersion - OK"
+    else
+        echo "Error - kitura --version reports $cliVersion, expected $RELEASE"
+	exit 1
+    fi
+    # Check that kitura init successfully produces a project
+    ./darwin-amd64/kitura init --dir TestProj
+    rm -rf TestProj
+}
+
+function test_Linux() {
+    # Check that command does not already exist
+    kitura && failCmdFound || echo "Command 'kitura' not found - OK"
+    sudo dpkg -i kitura-cli_${RELEASE}_amd64.deb
+    # Check reported CLI version matches our release
+    cliVersion=`kitura --version`
+    if [ "$cliVersion" == $RELEASE ]; then
+        echo "kitura --version reports $cliVersion - OK"
+    else
+        echo "Error - kitura --version reports $cliVersion, expected $RELEASE"
+	exit 1
+    fi
+    # Check that kitura init successfully produces a project
+    kitura init --dir TestProj
+    rm -rf TestProj
+}
+
+case `uname` in
+  Darwin)
+    make build-darwin package-darwin
+    test_Darwin
+    ;;
+  Linux)
+    make
+    test_Linux
+    ;;
+  *)
+    echo "Unsupported OS: `uname`"
+    exit 1
+esac

build.sh

@@ -0,0 +1,66 @@
+// Copyright © 2019 NAME HERE <EMAIL ADDRESS>
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package cmd
+
+import (
+	"bufio"
+	"fmt"
+	"os/exec"
+
+	"github.com/spf13/cobra"
+)
+
+// buildCmd represents the build command
+var buildCmd = &cobra.Command{
+	Use:   "build",
+	Short: "Build the project in a local container",
+	Long: `Builds your project in a local container. You must have the IBM Developer Tools installed to run this command.
+If you do not have the IBM Developer Tools installed you can run 'kitura idt' to install them.`,
+	Run: func(cmd *cobra.Command, args []string) {
+
+		devBuild := exec.Command("ibmcloud", "dev", "build")
+
+		stdOut, _ := devBuild.StdoutPipe()
+		devBuild.Start()
+
+		scanner := bufio.NewScanner(stdOut)
+
+		for scanner.Scan() {
+			m := scanner.Text()
+			fmt.Println(m)
+		}
+
+		err := devBuild.Wait()
+		if err != nil {
+			println("Error: failed to run IBM Cloud Developer Tools")
+			println("Run 'kitura idt' to install")
+		}
+
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(buildCmd)
+
+	// Here you will define your flags and configuration settings.
+
+	// Cobra supports Persistent Flags which will work for this command
+	// and all subcommands, e.g.:
+	// buildCmd.PersistentFlags().String("foo", "", "A help for foo")
+
+	// Cobra supports local flags which will only run when this command
+	// is called directly, e.g.:
+	// buildCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
+}