Merge lp:~barryprice/juju-deployer/lp1893162 into lp:juju-deployer

[Barry Price]

Document dependencies (LP:1893162)

[lp:~barryprice/juju-deployer/lp1893162]

223. By Barry Price on 2020-11-02

Clean up

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

This merge proposal is being monitored by mergebot. Change the status to Approved to merge.

[lp:~barryprice/juju-deployer/lp1893162]

224. By Barry Price on 2020-11-02

Move deps logic to separate shell scripts

225. By Barry Price on 2020-11-03

Bugfix

226. By Barry Price on 2020-11-03

shellcheck

[Tom Haddon (mthaddon)]

I think it'd be worth changing the names of the scripts to reflect that they prompt you to install dependencies (which I think is the right thing to do - I don't think we should actually be installing dependencies here). Currently ./install_deps.sh to me suggests they're installing things, so maybe ./suggest_install_deps.sh and ./suggest_install_test_deps.sh or something like that?

[lp:~barryprice/juju-deployer/lp1893162]

227. By Barry Price on 2021-02-05

More accurate helper script names

[Tom Haddon (mthaddon)]

LGTM, thx

review: Approve

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

Change successfully merged at revision 222

=== modified file 'Makefile'
--- Makefile	2017-03-01 10:04:15 +0000
+++ Makefile	2021-02-05 09:33:39 +0000
@@ -9,6 +9,13 @@
 	toxcmd = tox
 endif
 
+deps:
+	@./suggest_install_deps.sh
+
+test-deps: deps
+	@./suggest_install_test_deps.sh
+
+
 test:
 	# launchpad build farm target
 	TEST_OFFLINE=1 JUJU_HOME=/tmp nosetests -s --verbosity=2 --with-coverage --cover-package=deployer deployer/tests
@@ -17,3 +24,5 @@
 local_test:
 	# local test target
 	$(toxcmd)
+
+.PHONY: deps test-deps test local_test
 
=== modified file 'README'
--- README	2015-03-16 23:53:59 +0000
+++ README	2021-02-05 09:33:39 +0000
@@ -13,6 +13,17 @@
   $ ./deployer/bin/easy_install juju-deployer
   $ ./deployer/bin/juju-deployer -h
 
+Requirements
+------------
+
+juju-deployer requires 'juju' itself to be installed:
+
+https://juju.is/docs/installing
+
+Development of juju-deployer will also require the 'bzr', 'make' and 'tox'
+packages to be installed:
+
+  $ apt-get install bzr make tox
 
 Usage
 -----
 
=== added file 'suggest_install_deps.sh'
--- suggest_install_deps.sh	1970-01-01 00:00:00 +0000
+++ suggest_install_deps.sh	2021-02-05 09:33:39 +0000
@@ -0,0 +1,13 @@
+#!/bin/bash
+
+set -eu
+
+if [ -x "$(command -v juju)" ]; then
+    :
+else
+    if [ -x "$(command -v snap)" ]; then
+        echo "Please run: sudo snap install juju --classic"
+    else
+        echo "Please install Juju <https://juju.is/docs/installing>"
+    fi
+fi
 
=== added file 'suggest_install_test_deps.sh'
--- suggest_install_test_deps.sh	1970-01-01 00:00:00 +0000
+++ suggest_install_test_deps.sh	2021-02-05 09:33:39 +0000
@@ -0,0 +1,26 @@
+#!/bin/bash
+
+set -eu
+
+PKG_DEPS="make tox"
+
+RELEASE=$(lsb_release -r | cut -f 2)
+
+if (( $(echo "$RELEASE >= 20.04" |bc -l) )); then
+    PKG_DEPS="$PKG_DEPS brz"
+elif [ "$RELEASE" == "18.04" ]; then
+    PKG_DEPS="$PKG_DEPS brz"
+else
+    PKG_DEPS="$PKG_DEPS bzr"
+fi
+
+PKGS_TO_INSTALL=""
+
+for PKG_DEP in $PKG_DEPS;
+do
+    command -v "${PKG_DEP?}" >/dev/null || PKGS_TO_INSTALL="$TO_INSTALL $PKG_DEP"
+done
+
+if [ "$PKGS_TO_INSTALL" != "" ]; then
+    echo "Please run: sudo apt-get install $PKGS_TO_INSTALL"
+fi