fix: update ibmcloud plugin compilation to use client version

This PR also adds a Makefile to facilitate builds.

Fixes #4359

Author: starpit

.travis.yml

@@ -39,6 +39,7 @@ after_script: if [ -n "$NYC" ]; then cd "${TRAVIS_BUILD_DIR}" && ./tools/codecov
 install:
   - if [ -n "$NEEDS_K8S" ]; then ./tools/travis/microk8s.sh & k8s=$!; fi
   - npm ci
+  - if [ -n "$NEEDS_IBMCLOUD" ]; then ./tools/travis/ibmcloud.sh && ./tools/travis/ibmcloud-plugin-build-install.sh; fi
   - ./bin/switch-client.sh ${CLIENT-default}
   - ./tools/codecov/instrument.sh
   - if [ "$MOCHA_RUN_TARGET" = "webpack" ]; then export KUI_USE_PROXY=true; if [ "$DEPLOY" = "cluster" ]; then npx kui-build-webpack && npx kui-build-docker-with-proxy && (kui-run-cproxy &); else npm run watch:webpack; fi; elif [ -z "$TEST_FROM_BUILD" ]; then npm run watch:electron; else npm run build:electron:$TRAVIS_OS_NAME; fi
@@ -54,8 +55,7 @@ jobs:
 
   include:
     - env: DEPLOY="cluster" LAYERS="core" MOCHA_RUN_TARGET=webpack
-    - env: LAYERS="k8s k8s-popup helm logs" NEEDS_K8S=true NEEDS_HELM=true TEST_FROM_BUILD="${TRAVIS_BUILD_DIR}/dist/electron/Kui-linux-x64/Kui" KUI_DIST_PATH=${TEST_FROM_BUILD}
-      before_install: ./tools/travis/ibmcloud.sh; ./tools/travis/ibmcloud-plugin-build-install.sh
+    - env: LAYERS="k8s k8s-popup helm logs" NEEDS_K8S=true NEEDS_HELM=true TEST_FROM_BUILD="${TRAVIS_BUILD_DIR}/dist/electron/Kui-linux-x64/Kui" KUI_DIST_PATH=${TEST_FROM_BUILD} NEEDS_IBMCLOUD=true
 
     - env: LAYERS=k8s1 MOCHA_RUN_TARGET=webpack  NEEDS_K8S=true NEEDS_OC=true
     - env: LAYERS=k8s2 MOCHA_RUN_TARGET=webpack  NEEDS_K8S=true NEEDS_OC=true   NEEDS_TOP=true

tools/go/ibmcloud/.gitignore

@@ -22,3 +22,4 @@ bin/node_modules/*
 
 # local testing binaries
 kui
+kui-ibmcloud-plugin*

tools/go/ibmcloud/Makefile

@@ -0,0 +1,30 @@
+BINARY=kui-ibmcloud-plugin
+
+PLATFORMS=darwin linux windows
+ARCHITECTURES=amd64
+
+VERSION=$(shell node -e 'console.log(require("@kui-shell/client/package.json").version)')
+LDFLAGS=-ldflags "-X github.com/IBM/kui/launcher.PLUGIN_VERSION=$(VERSION)"
+
+all: clean build
+
+# build for current platform
+build: main.go launcher/launcher.go
+	go build ${LDFLAGS} -o ${BINARY}
+
+# build for all platforms and architectures
+build_all:
+	$(foreach GOOS, $(PLATFORMS),\
+	$(foreach GOARCH, $(ARCHITECTURES), $(shell export GOOS=$(GOOS); export GOARCH=$(GOARCH); go build ${LDFLAGS} -o $(BINARY)-$(GOOS)-$(GOARCH))))
+
+# install as ibmcloud plugin
+install: build
+	ibmcloud plugin install ${BINARY}
+
+test: all
+	go test ./... ${LDFLAGS}
+
+clean:
+	rm -f ${BINARY}
+	$(foreach GOOS, $(PLATFORMS),\
+	$(foreach GOARCH, $(ARCHITECTURES), rm -f $(BINARY)-$(GOOS)-$(GOARCH)))

tools/go/ibmcloud/README.md

@@ -1,26 +1,48 @@
-# IBMCloud CLI Plugin for Kui
+# ibmcloud CLI Plugin for Kui
 
-## Getting Started
+This directory offers Kui as a plugin to the [`ibmcloud` CLI](https://clis.ng.bluemix.net).
 
-Download and install the Bluemix CLI. See instructions [here](https://clis.ng.bluemix.net).
+## Prebuilt Binaries
 
-To build the plugin, you firstly need [Go](http://www.golang.org) (1.12+) installed on your
-machine. Next, compile the plugin source code with `go build` command, for example
+> Coming Soon
+
+## Usage
+
+For example:
 
 ```bash
-$ go build
+ibmcloud kui kubectl get pods
 ```
 
-Install the plugin:
+## Building the Plugin Yourself
+
+If you wish to develop the plugin, first
+download and install the Bluemix CLI. See instructions [here](https://clis.ng.bluemix.net).
+
+The plugin is written in [go](https://golang.org/), and depends on go
+1.12+. To compile the plugin, you may leverage the Makefile:
 
 ```bash
-$ ibmcloud plugin install ./kui
+$ make
 ```
 
-Use the plugin:
+This should produce a binary `kui-ibmcloud-plugin`. You may then
+install the plugin:
 
-For example:
+```bash
+$ make install
+```
+
+To run unit tests:
 
 ```bash
-ibmcloud kui kubectl get pods
+$ make test
+```
+
+### Building for multiple platforms
+
+If you wish to build for all supported Electron platforms, you may leverage the
+
+```bash
+$ make build_all
 ```

tools/go/ibmcloud/go.mod

@@ -16,6 +16,7 @@ require (
 	github.com/nicksnyder/go-i18n v1.10.1
 	github.com/nwaples/rardecode v1.1.0 // indirect
 	github.com/pierrec/lz4 v2.5.1+incompatible // indirect
+	github.com/stretchr/testify v1.5.1
 	github.com/ulikunitz/xz v0.5.7 // indirect
 	github.com/xi2/xz v0.0.0-20171230120015-48954b6210f8 // indirect
 	golang.org/x/crypto v0.0.0-20200420104511-884d27f42877 // indirect

tools/go/ibmcloud/go.sum

@@ -4,6 +4,8 @@ github.com/IBM-Cloud/ibm-cloud-cli-sdk v0.4.0 h1:gCN1sOP5aCjHOgWlNK3buvZTl91GxCz
 github.com/IBM-Cloud/ibm-cloud-cli-sdk v0.4.0/go.mod h1:RiUvKuHKTBmBApDMUQzBL14pQUGKcx/IioKQPIcRQjs=
 github.com/cloudfoundry-attic/jibber_jabber v0.0.0-20151120183258-bcc4c8345a21 h1:Yg2hDs4b13Evkpj42FU2idX2cVXVFqQSheXYKM86Qsk=
 github.com/cloudfoundry-attic/jibber_jabber v0.0.0-20151120183258-bcc4c8345a21/go.mod h1:MgJyK38wkzZbiZSKeIeFankxxSA8gayko/nr5x5bgBA=
+github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/dsnet/compress v0.0.1 h1:PlZu0n3Tuv04TzpfPbrnI0HW/YwodEXDS+oPKahKF0Q=
 github.com/dsnet/compress v0.0.1/go.mod h1:Aw8dCMJ7RioblQeTqt88akK31OvO8Dhf5JflhBbQEHo=
 github.com/dsnet/golib v0.0.0-20171103203638-1ea166775780/go.mod h1:Lj+Z9rebOhdfkVLjJ8T6VcRQv3SXugXy999NBtR9aFY=
@@ -35,6 +37,11 @@ github.com/pelletier/go-toml v1.2.0 h1:T5zMGML61Wp+FlcbWjRDT7yAxhJNAiPPLOFECq181
 github.com/pelletier/go-toml v1.2.0/go.mod h1:5z9KED0ma1S8pY6P1sdut58dfprrGBbd/94hg7ilaic=
 github.com/pierrec/lz4 v2.5.1+incompatible h1:Yq0up0149Hh5Ekhm/91lgkZuD1ZDnXNM26bycpTzYBM=
 github.com/pierrec/lz4 v2.5.1+incompatible/go.mod h1:pdkljMzZIN41W+lC3N2tnIh5sFi+IEE17M5jbnwPHcY=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.5.1 h1:nOGnQDM7FYENwehXlg/kFVnos3rEvtKTjRvOWSzb6H4=
+github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
 github.com/ulikunitz/xz v0.5.6/go.mod h1:2bypXElzHzzJZwzH67Y6wb67pO62Rzfn7BSiF4ABRW8=
 github.com/ulikunitz/xz v0.5.7 h1:YvTNdFzX6+W5m9msiYg/zpkSURPPtOlzbqYjrFn7Yt4=
 github.com/ulikunitz/xz v0.5.7/go.mod h1:nbz6k7qbPmH4IRqmfOplQw/tblSgqTqBwxkY0oWt/14=
@@ -57,3 +64,5 @@ gopkg.in/cheggaaa/pb.v1 v1.0.28 h1:n1tBJnnK2r7g9OW2btFH91V92STTUevLXYFb8gy9EMk=
 gopkg.in/cheggaaa/pb.v1 v1.0.28/go.mod h1:V/YB90LKu/1FcN3WVnfiiE5oMCibMjukxqG/qStrOgw=
 gopkg.in/yaml.v2 v2.2.1 h1:mUhvW9EsL+naU5Q3cakzfE91YhliOondGd6ZrsDBHQE=
 gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=
+gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=

tools/go/ibmcloud/launcher/launcher.go

@@ -21,8 +21,10 @@ type CloudShellPlugin struct {
 	ui terminal.UI
 }
 
-// THE PLUGIN_VERSION CONSTANT SHOULD BE LEFT EXACTLY AS-IS SINCE IT CAN BE PROGRAMMATICALLY SUBSTITUTED
-const PLUGIN_VERSION = "8.4.3"
+// this value will be injected at build time, e.g. via
+// go build -ldflags "-X github.com/IBM/kui/launcher.PLUGIN_VERSION=$(node -e 'console.log(require("@kui-shell/client/package.json").version)')"
+// which pulls the version from @kui-shell/client/package.json
+var PLUGIN_VERSION string
 
 func Start() {
 	argsWithoutProg := os.Args[1:]

tools/travis/ibmcloud-plugin-build-install.sh

@@ -6,10 +6,10 @@ echo "Installing Go Stable"
 eval "$(gimme stable)";
 
 echo "Building ibmcloud kui binary"
-go build
+make
 
 echo "Installing ibmcloud kui plugin"
-ibmcloud plugin install ./kui
+make install
 
 echo "Testing Kui dist download and duplicate download"
-go test ./...
+make test