Introduce shellcheck

* Enable shellcheck for broker-list.sh file, and fix up errors
* Refactor tests to validate broker-list.sh changes

Author: sscaling

.travis.yml

@@ -9,15 +9,16 @@ install:
   - docker --version
   - docker-compose --version
   - docker build -t wurstmeister/kafka .
+  - docker pull confluentinc/cp-kafkacat
 
 before_script:
   - docker-compose -f test/docker-compose.yml up -d kafka zookeeper
   - docker-compose -f test/docker-compose.yml scale kafka=2
 
 script:
+  - shellcheck -s bash broker-list.sh
   - sleep 5 # Wait for containers to start
-  - export BROKER_LIST=$(./test/internal-broker-list.sh)
-  - docker-compose -f test/docker-compose.yml run tests
+  - cd test && ./runAllTests.sh
 
 after_script:
   - docker-compose stop

broker-list.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
 
 CONTAINERS=$(docker ps | grep 9092 | awk '{print $1}')
-BROKERS=$(for CONTAINER in $CONTAINERS; do docker port $CONTAINER 9092 | sed -e "s/0.0.0.0:/$HOST_IP:/g"; done)
-echo $BROKERS | sed -e 's/ /,/g'
+BROKERS=$(for CONTAINER in ${CONTAINERS}; do docker port "$CONTAINER" 9092 | sed -e "s/0.0.0.0:/$HOST_IP:/g"; done)
+echo "${BROKERS/$'\n'/,}"

test/test-001-read-write.sh renamed to test/001-read-write.kafkacat.sh

@@ -3,7 +3,6 @@
 testReadWrite() {
 	echo 'foo,bar' | kafkacat -b "$BROKER_LIST" -P -D, -t readwrite
 	kafkacat -b "$BROKER_LIST" -C -e -t readwrite
-	return 0
 }
 
 testReadWrite

test/002-broker-list.kafka.sh

@@ -0,0 +1,19 @@
+#!/bin/bash -e
+
+testBrokerList() {
+	# Need to get the proxied ports for kafka
+	PORT1=$(docker inspect -f '{{ index .NetworkSettings.Ports "9092/tcp" 0 "HostPort" }}' test_kafka_1)
+	PORT2=$(docker inspect -f '{{ index .NetworkSettings.Ports "9092/tcp" 0 "HostPort" }}' test_kafka_2)
+
+	RESULT=$(HOST_IP=1.2.3.4 broker-list.sh)
+
+	echo "$RESULT"
+
+	if [[ "$RESULT" == "1.2.3.4$PORT1,1.2.3.4:$PORT2" || "$RESULT" == "1.2.3.4:$PORT2,1.2.3.4:$PORT1" ]]; then
+		return 0
+	else
+		return 1
+	fi
+}
+
+testBrokerList

test/Readme.md

@@ -9,6 +9,6 @@ To execute
 ```
 cd test
 docker-compose up -d zookeeper kafka
-docker-compose scale kafka=2    # or however many nodes you want
-BROKER_LIST=$(./internal-broker-list.sh) docker-compose run tests
+docker-compose scale kafka=2
+./runAllTests.sh
 ```

test/docker-compose.yml

@@ -13,12 +13,24 @@ services:
       KAFKA_ZOOKEEPER_CONNECT: zookeeper:2181
     volumes:
       - /var/run/docker.sock:/var/run/docker.sock
-  tests:
+
+  kafkatest:
+    image: wurstmeister/kafka
+    volumes:
+      - .:/tests
+      - /var/run/docker.sock:/var/run/docker.sock
+    working_dir: /tests
+    entrypoint:
+      - ./runTestPattern.sh
+      - "*.kafka.sh"
+
+  kafkacattest:
     image: confluentinc/cp-kafkacat
     environment:
       BROKER_LIST: ${BROKER_LIST}
     volumes:
       - .:/tests
     working_dir: /tests
     entrypoint:
-      - ./runTests.sh
+      - ./runTestPattern.sh
+      - "*.kafkacat.sh"

test/runAllTests.sh

@@ -0,0 +1,25 @@
+#!/bin/bash -e
+
+BROKER_LIST=$(./internal-broker-list.sh)
+export BROKER_LIST
+
+echo "BROKER_LIST=$BROKER_LIST"
+
+runAll() {
+  # Tests that require kafka
+  docker-compose run --rm kafkatest
+
+  RESULT=$?
+  if [[ $RESULT -eq 0 ]]; then
+    # Tests that require kafkacat
+    docker-compose run --rm kafkacattest
+    RESULT=$?
+  fi
+
+  return $RESULT
+}
+
+runAll
+result=$?
+echo "exit status $result"
+exit $result

test/runTestPattern.sh

@@ -0,0 +1,27 @@
+#!/bin/bash -e
+
+PATTERN=$1
+
+echo ""
+echo ""
+echo "Running tests for pattern $PATTERN"
+
+runPattern() {
+  for t in $PATTERN; do
+    echo
+    echo "===================================="
+    echo "testing '$t'"
+    # shellcheck disable=SC1090
+    ( source "$t" )
+    status=$?
+    if [[ -z "$status" || ! "$status" -eq 0 ]]; then
+      return $status
+    fi
+  done
+
+  return $?
+}
+
+runPattern
+
+exit $?