Squashed 'tools/' changes from b990f48..8ab80e8

8ab80e8 Merge pull request #45 from weaveworks/lint 83d5bd1 getting integration/config and test shellcheck-compliant cff9ec3 Fix some shellcheck errors 7a843d6 run shellcheck as part of lint if it is installed 31552a0 removing spurious space from test 6ca7c5f Merge pull request #44 from weaveworks/shfmt 952356d Allow lint to lint itself b7ac59c Run shfmt on all shell files in this repo 5570b0e Add shfmt formatting of shell files in lint 0a67594 fix circle build by splatting gopath permissions git-subtree-dir: tools git-subtree-split: 8ab80e8
weaveworks · Oct 26, 2016 · c03f7d5 · c03f7d5
1 parent 7eb07ee
commit c03f7d5
Show file tree

Hide file tree

Showing 11 changed files with 407 additions and 357 deletions.
diff --git a/circle.yml b/circle.yml
@@ -8,11 +8,17 @@ machine:
 
 dependencies:
   post:
+    - sudo chmod a+wr --recursive /usr/local/go/pkg
     - go clean -i net
     - go install -tags netgo std
     - mkdir -p $(dirname $SRCDIR)
     - cp -r $(pwd)/ $SRCDIR
-    - go get github.com/golang/lint/golint github.com/fzipp/gocyclo github.com/kisielk/errcheck
+    - |
+      go get \
+        github.com/fzipp/gocyclo \
+        github.com/golang/lint/golint \
+        github.com/kisielk/errcheck \
+        github.com/mvdan/sh/cmd/shfmt
 
 test:
   override:

diff --git a/image-tag b/image-tag
@@ -4,9 +4,6 @@ set -o errexit
 set -o nounset
 set -o pipefail
 
-WORKING_SUFFIX=$(if ! git diff --exit-code --quiet HEAD >&2; \
-                 then echo "-WIP"; \
-                 else echo ""; \
-                 fi)
+WORKING_SUFFIX=$(if ! git diff --exit-code --quiet HEAD >&2; then echo "-WIP"; else echo ""; fi)
 BRANCH_PREFIX=$(git rev-parse --abbrev-ref HEAD)
 echo "${BRANCH_PREFIX//\//-}-$(git rev-parse --short HEAD)$WORKING_SUFFIX"
diff --git a/integration/assert.sh b/integration/assert.sh
@@ -25,14 +25,15 @@ export CONTINUE=${CONTINUE:-}
 
 args="$(getopt -n "$0" -l \
     verbose,help,stop,discover,invariant,continue vhxdic "$@")" \
-|| exit -1
+    || exit -1
 for arg in $args; do
     case "$arg" in
         -h)
             echo "$0 [-vxidc]" \
                 "[--verbose] [--stop] [--invariant] [--discover] [--continue]"
-            echo "$(sed 's/./ /g' <<< "$0") [-h] [--help]"
-            exit 0;;
+            echo "$(sed 's/./ /g' <<<"$0") [-h] [--help]"
+            exit 0
+            ;;
         --help)
             cat <<EOF
 Usage: $0 [options]
@@ -47,17 +48,23 @@ Options:
   -h               show brief usage information and exit
   --help           show this help message and exit
 EOF
-            exit 0;;
-        -v|--verbose)
-            DEBUG=1;;
-        -x|--stop)
-            STOP=1;;
-        -i|--invariant)
-            INVARIANT=1;;
-        -d|--discover)
-            DISCOVERONLY=1;;
-        -c|--continue)
-            CONTINUE=1;;
+            exit 0
+            ;;
+        -v | --verbose)
+            DEBUG=1
+            ;;
+        -x | --stop)
+            STOP=1
+            ;;
+        -i | --invariant)
+            INVARIANT=1
+            ;;
+        -d | --discover)
+            DISCOVERONLY=1
+            ;;
+        -c | --continue)
+            CONTINUE=1
+            ;;
     esac
 done
 
@@ -74,9 +81,9 @@ assert_end() {
     # assert_end [suite ..]
     tests_endtime="$(date +%s%N)"
     # required visible decimal place for seconds (leading zeros if needed)
-    tests_time="$( \
-        printf "%010d" "$(( ${tests_endtime/%N/000000000}
-                            - ${tests_starttime/%N/000000000} ))")"  # in ns
+    tests_time="$(
+        printf "%010d" "$((${tests_endtime/%N/000000000} - ${tests_starttime/%N/000000000}))"
+    )" # in ns
     tests="$tests_ran ${*:+$* }tests"
     [[ -n "$DISCOVERONLY" ]] && echo "collected $tests." && _assert_reset && return
     [[ -n "$DEBUG" ]] && echo
@@ -100,26 +107,26 @@ assert_end() {
 
 assert() {
     # assert <command> <expected stdout> [stdin]
-    (( tests_ran++ )) || :
+    ((tests_ran++)) || :
     [[ -z "$DISCOVERONLY" ]] || return
     expected=$(echo -ne "${2:-}")
-    result="$(eval 2>/dev/null "$1" <<< "${3:-}")" || true
+    result="$(eval "$1" 2>/dev/null <<<"${3:-}")" || true
     if [[ "$result" == "$expected" ]]; then
         [[ -z "$DEBUG" ]] || echo -n .
         return
     fi
-    result="$(sed -e :a -e '$!N;s/\n/\\n/;ta' <<< "$result")"
+    result="$(sed -e :a -e '$!N;s/\n/\\n/;ta' <<<"$result")"
     [[ -z "$result" ]] && result="nothing" || result="\"$result\""
     [[ -z "$2" ]] && expected="nothing" || expected="\"$2\""
     _assert_fail "expected $expected${_indent}got $result" "$1" "$3"
 }
 
 assert_raises() {
     # assert_raises <command> <expected code> [stdin]
-    (( tests_ran++ )) || :
+    ((tests_ran++)) || :
     [[ -z "$DISCOVERONLY" ]] || return
     status=0
-    (eval "$1" <<< "${3:-}") > /dev/null 2>&1 || status=$?
+    (eval "$1" <<<"${3:-}") >/dev/null 2>&1 || status=$?
     expected=${2:-0}
     if [[ "$status" -eq "$expected" ]]; then
         [[ -z "$DEBUG" ]] || echo -n .
@@ -138,12 +145,12 @@ _assert_fail() {
         exit 1
     fi
     tests_errors[$tests_failed]="$report"
-    (( tests_failed++ )) || :
+    ((tests_failed++)) || :
 }
 
 skip_if() {
     # skip_if <command ..>
-    (eval "$@") > /dev/null 2>&1 && status=0 || status=$?
+    (eval "$@") >/dev/null 2>&1 && status=0 || status=$?
     [[ "$status" -eq 0 ]] || return
     skip
 }
@@ -175,9 +182,8 @@ _skip() {
     fi
 }
 
-
 _assert_reset
-: ${tests_suite_status:=0}  # remember if any of the tests failed so far
+: ${tests_suite_status:=0} # remember if any of the tests failed so far
 _assert_cleanup() {
     local status=$?
     # modify exit code if it's not already non-zero

diff --git a/integration/config.sh b/integration/config.sh
@@ -1,3 +1,4 @@
+#!/bin/bash
 # NB only to be sourced
 
 set -e
@@ -16,49 +17,55 @@ N_MACHINES=${N_MACHINES:-3}
 IP_PREFIX=${IP_PREFIX:-192.168.48}
 IP_SUFFIX_BASE=${IP_SUFFIX_BASE:-10}
 
-if [ -z "$HOSTS" ] ; then
-    for i in $(seq 1 $N_MACHINES); do
-        IP="${IP_PREFIX}.$((${IP_SUFFIX_BASE}+$i))"
+if [ -z "$HOSTS" ]; then
+    for i in $(seq 1 "$N_MACHINES"); do
+        IP="${IP_PREFIX}.$((IP_SUFFIX_BASE + i))"
         HOSTS="$HOSTS $IP"
     done
 fi
 
 # these are used by the tests
-HOST1=$(echo $HOSTS | cut -f 1 -d ' ')
-HOST2=$(echo $HOSTS | cut -f 2 -d ' ')
-HOST3=$(echo $HOSTS | cut -f 3 -d ' ')
-
+# shellcheck disable=SC2034
+HOST1=$(echo "$HOSTS" | cut -f 1 -d ' ')
+# shellcheck disable=SC2034
+HOST2=$(echo "$HOSTS" | cut -f 2 -d ' ')
+# shellcheck disable=SC2034
+HOST3=$(echo "$HOSTS" | cut -f 3 -d ' ')
+
+# shellcheck disable=SC1090
 . "$DIR/assert.sh"
 
 SSH_DIR=${SSH_DIR:-$DIR}
-SSH=${SSH:-ssh -l vagrant -i "$SSH_DIR/insecure_private_key" -o "UserKnownHostsFile=$SSH_DIR/.ssh_known_hosts" -o CheckHostIP=no -o StrictHostKeyChecking=no}
+SSH=${SSH:-ssh -l vagrant -i \"$SSH_DIR/insecure_private_key\" -o \"UserKnownHostsFile=$SSH_DIR/.ssh_known_hosts\" -o CheckHostIP=no -o StrictHostKeyChecking=no}
 
 SMALL_IMAGE="alpine"
+# shellcheck disable=SC2034
 TEST_IMAGES="$SMALL_IMAGE"
 
+# shellcheck disable=SC2034
 PING="ping -nq -W 1 -c 1"
 DOCKER_PORT=2375
 
 remote() {
     rem=$1
     shift 1
-    "$@" > >(while read line; do echo -e $'\e[0;34m'"$rem>"$'\e[0m'" $line"; done)
+    "$@" > >(while read -r line; do echo -e $'\e[0;34m'"$rem>"$'\e[0m'" $line"; done)
 }
 
 colourise() {
-    [ -t 0 ] && echo -ne $'\e['$1'm' || true
+    ([ -t 0 ] && echo -ne $'\e['"$1"'m') || true
     shift
     # It's important that we don't do this in a subshell, as some
     # commands we execute need to modify global state
     "$@"
-    [ -t 0 ] && echo -ne $'\e[0m' || true
+    ([ -t 0 ] && echo -ne $'\e[0m') || true
 }
 
 whitely() {
     colourise '1;37' "$@"
 }
 
-greyly () {
+greyly() {
     colourise '0;37' "$@"
 }
 
@@ -73,46 +80,46 @@ greenly() {
 run_on() {
     host=$1
     shift 1
-    [ -z "$DEBUG" ] || greyly echo "Running on $host: $@" >&2
-    remote $host $SSH $host "$@"
+    [ -z "$DEBUG" ] || greyly echo "Running on $host:" "$@" >&2
+    remote "$host" "$SSH" "$host" "$@"
 }
 
 docker_on() {
     host=$1
     shift 1
-    [ -z "$DEBUG" ] || greyly echo "Docker on $host:$DOCKER_PORT: $@" >&2
-    docker -H tcp://$host:$DOCKER_PORT "$@"
+    [ -z "$DEBUG" ] || greyly echo "Docker on $host:$DOCKER_PORT:" "$@" >&2
+    docker -H "tcp://$host:$DOCKER_PORT" "$@"
 }
 
 weave_on() {
     host=$1
     shift 1
-    [ -z "$DEBUG" ] || greyly echo "Weave on $host:$DOCKER_PORT: $@" >&2
+    [ -z "$DEBUG" ] || greyly echo "Weave on $host:$DOCKER_PORT:" "$@" >&2
     DOCKER_HOST=tcp://$host:$DOCKER_PORT $WEAVE "$@"
 }
 
 exec_on() {
     host=$1
     container=$2
     shift 2
-    docker -H tcp://$host:$DOCKER_PORT exec $container "$@"
+    docker -H "tcp://$host:$DOCKER_PORT" exec "$container" "$@"
 }
 
 rm_containers() {
     host=$1
     shift
-    [ $# -eq 0 ] || docker_on $host rm -f "$@" >/dev/null
+    [ $# -eq 0 ] || docker_on "$host" rm -f "$@" >/dev/null
 }
 
 start_suite() {
     for host in $HOSTS; do
         [ -z "$DEBUG" ] || echo "Cleaning up on $host: removing all containers and resetting weave"
-        PLUGIN_ID=$(docker_on $host ps -aq --filter=name=weaveplugin)
+        PLUGIN_ID=$(docker_on "$host" ps -aq --filter=name=weaveplugin)
         PLUGIN_FILTER="cat"
         [ -n "$PLUGIN_ID" ] && PLUGIN_FILTER="grep -v $PLUGIN_ID"
-        rm_containers $host $(docker_on $host ps -aq 2>/dev/null | $PLUGIN_FILTER)
-        run_on $host "docker network ls | grep -q ' weave ' && docker network rm weave" || true
-        weave_on $host reset 2>/dev/null
+        rm_containers "$host" "$(docker_on "$host" ps -aq 2>/dev/null | "$PLUGIN_FILTER")"
+        run_on "$host" "docker network ls | grep -q ' weave ' && docker network rm weave" || true
+        weave_on "$host" reset 2>/dev/null
     done
     whitely echo "$@"
 }
@@ -122,4 +129,3 @@ end_suite() {
 }
 
 WEAVE=$DIR/../weave
-