Merge ~sylvain-pineau/checkbox-provider-edgex:hanoi-add-config-test into ~checkbox-dev/checkbox-provider-edgex:master

[Sylvain Pineau]

Follow up of https://code.launchpad.net/~awe/+git/checkbox-provider-edgex/+merge/401656

[Sylvain Pineau (sylvain-pineau)]

Based on Siggi's review

review: Approve

diff --git a/data/hanoi/test-config-hook.sh b/data/hanoi/test-config-hook.sh
new file mode 100755
index 0000000..38807eb
--- /dev/null
+++ b/data/hanoi/test-config-hook.sh
@@ -0,0 +1,253 @@
+#!/bin/bash -e
+#
+# This test validates the snap configure hook settings that are supported by
+# the edgexfoundry snap.
+#
+# TODO:
+#
+# - add negative test (i.e. bad key(s)) -- should be ignored
+# - add support for service restart
+#   - ensure service has restarted!
+#   - when services are restarted, overrides all work!
+# - add support for redis options
+
+# get the directory of this script
+# snippet from https://stackoverflow.com/a/246128/10102404
+SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null && pwd )"
+
+declare services
+services[0]=core-data
+services[1]=core-metadata
+services[2]=core-command
+services[3]=support-notifications
+services[4]=support-scheduler
+services[5]=device-virtual
+services[6]=sys-mgmt-agent
+
+# define config to EdgeX environment variable mappings
+#
+# TODO: add scoping support (i.e. add a csv prefix to the keys
+# which scopes the setting to one or more services. No prefix
+# means "applies to all".
+#
+declare -A conf_to_env
+conf_to_env[service_boot-timeout]="SERVICE_BOOTTIMEOUT/60000"
+conf_to_env[service_check-interval]="SERVICE_CHECKINTERVAL/'20s'"
+conf_to_env[service_host]="SERVICE_HOST/127.0.0.1"
+conf_to_env[service_server-bind-addr]="SERVICE_SERVERBINDADDR/'localhost'"
+conf_to_env[service_port]="SERVICE_PORT/2112"
+conf_to_env[service_protocol]="SERVICE_PROTOCOL/'http'"
+conf_to_env[service_max-result-count]="SERVICE_MAXRESULTCOUNT/25000"
+conf_to_env[service_read-max-limit]="SERVICE_READMAXLIMIT/200"
+conf_to_env[service_startup-msg]="SERVICE_STARTUPMSG/'hello,world!'"
+conf_to_env[service_timeout]="SERVICE_TIMEOUT/10000"
+
+# [Clients.Command]
+conf_to_env[clients_command_port]="CLIENTS_COMMAND_PORT/12"
+
+# [Clients.Coredata]
+conf_to_env[clients_coredata_port]="CLIENTS_COREDATA_PORT/12"
+
+# [Clients.Data]
+#
+# NOTE - this key is present because device-sdk-go used a different
+# key for CoreData than the core services, which use the previous key.
+#
+conf_to_env[clients_data_port]="CLIENTS_DATA_PORT/12"
+
+# [Clients.Metadata]
+conf_to_env[clients_metadata_port]="CLIENTS_METADATA_PORT/13"
+
+# [Clients.Notifications]
+conf_to_env[clients_notifications_port]="CLIENTS_NOTIFICATIONS_PORT/14"
+
+# [Clients.Scheduler] - sys-mgmt-only
+conf_to_env[clients_scheduler_port]="CLIENTS_SCHEDULER_PORT/14"
+
+# [MessageQueue] -- core-data ONLY!
+conf_to_env[messagequeue_topic]="MESSAGEQUEUE_TOPIC/'fubar'"
+
+# [SecretStore] -- !app-service-configurable
+conf_to_env[secretstore_additional-retry-attempts]="SECRETSTORE_ADDITIONALRETRYATTEMPTS/20"
+conf_to_env[secretstore_retry-wait-period]="SECRETSTORE_RETRYWAITPERIOD/'10s'"
+
+# load the utils
+# shellcheck source=/dev/null
+source "$SCRIPT_DIR/utils.sh"
+
+DEFAULT_TEST_CHANNEL=${DEFAULT_TEST_CHANNEL:-beta}
+
+snap_remove
+
+# install the snap to make sure it installs
+if [ -n "$REVISION_TO_TEST" ]; then
+    snap_install "$REVISION_TO_TEST" "$REVISION_TO_TEST_CHANNEL" "$REVISION_TO_TEST_CONFINEMENT"
+else
+    snap_install edgexfoundry "$DEFAULT_TEST_CHANNEL"
+fi
+
+# wait for services to come online
+# NOTE: this may have to be significantly increased on arm64 or low RAM platforms
+# to accomodate time for everything to come online
+sleep 120
+
+test_smtp() {
+    # [Smtp] support-notifications options
+    declare -A smtp_to_env
+    smtp_to_env[smtp_host]="SMTP_HOST/127.0.0.1"
+    smtp_to_env[smtp_username]="SMTP_USERNAME/'joe'"
+    smtp_to_env[smtp_password]="SMTP_PASSWORD/'password!'"
+    smtp_to_env[smtp_port]="SMTP_PORT/2112"
+    smtp_to_env[smtp_sender]="SMTP_SENDER/'henry'"
+    smtp_to_env[smtp_enable-self-signed-cert]="SMTP_ENABLE_SELF_SIGNED_CERT/true"
+
+    for key in "${!smtp_to_env[@]}"; do
+        echo "$key" --- ${smtp_to_env[$key]};
+
+        option=${key/_/.}
+        echo "$option"
+        env=$(echo ${smtp_to_env[$key]} | cut -d / -f 1)
+        val=$(echo ${smtp_to_env[$key]} | cut -d / -f 2)
+        service_key="env.support-notifications.$option"
+        snap set edgexfoundry "$service_key=$val"
+    done
+}
+
+# test config hook service-specific config options
+#
+# Note, this test iterates through all of the possible configuration options.
+# It currently only validates that the service.env for each service is created.
+#
+test_options()
+{
+    service="$1"
+    for key in "${!conf_to_env[@]}"; do
+        echo "$key" --- ${conf_to_env[$key]};
+
+        if [ "$key" == "service_read-max-limit" ] &&
+	   [ "$service" != "app-service-configurable" ]; then
+	    continue
+	fi
+
+        if [ "$key" == "messagequeue_topic" ] &&
+	   [ "$service" != "core-data" ]; then
+	    continue
+	fi
+
+	# handle mismatched client keys due device-sdk-go bug
+        if [ "$key" == "clients_coredata_port" ] &&
+           [ "$service" == "device-virtual" ]; then
+	    continue
+	fi
+
+	if [ "$key" == "clients_data_port" ] &&
+           [ "$service" != "device-virtual" ]; then
+            continue
+	fi
+
+        option=${key//_/.}
+        echo "$option"
+        env=$(echo ${conf_to_env[$key]} | cut -d / -f 1)
+        val=$(echo ${conf_to_env[$key]} | cut -d / -f 2)
+        service_key="env.$service.$option"
+        snap set edgexfoundry "$service_key=$val"
+        echo "$env=$val"
+    done
+
+    if [ "$service" == "support-notifications" ]; then
+	test_smtp
+    fi
+}
+
+validate_service_env()
+{
+    service="$1"
+    snapFile=$(cat "/var/snap/edgexfoundry/current/config/$service/res/$service.env" | sort)
+    testFile=$(cat "./test-files/$service.env" | sort)
+
+    if [ "$snapFile" != "$testFile" ]; then
+	snap_remove
+	echo "$service.env file doesn't match test file."
+	exit 1
+    fi
+}
+
+test_base_services()
+{
+	for key in "${!services[@]}"; do
+            service=${services[key]}
+            echo "*****${service}*******"
+            test_options "$service"
+	    validate_service_env "$service"
+        done
+}
+
+# test-proxy
+#
+# ADD_PROXY_ROUTE is a csv list of URLs to be added to the
+# API Gateway (aka Kong). For references:
+#
+# https://docs.edgexfoundry.org/1.3/microservices/security/Ch-APIGateway/
+#
+# NOTE - this setting is not a configuration override, it's a top-level
+# environment variable used by the security-proxy-setup.
+#
+# KONGAUTH_NAME can be "jwt" (default) or "oauth2"
+test_proxy()
+{
+    snap set edgexfoundry "env.security-proxy.add-proxy-route=myservice.http://localhost:2112"
+    set +e
+    match=$(grep "export ADD_PROXY_ROUTE=myservice.http://localhost:2112" \
+	 /var/snap/edgexfoundry/current/config/security-proxy-setup/res/security-proxy-setup.env)
+    set -e
+
+    if [ -z "$match" ]; then
+	snap_remove
+	echo "security-proxy-setup.env file missing correct ADD_PROXY_ROUTE env export."
+	exit 1
+    fi
+
+    snap set edgexfoundry "env.security-proxy.kongauth.name=oauth2"
+    set +e
+    match=$(grep "export KONGAUTH_NAME=oauth2" \
+	 /var/snap/edgexfoundry/current/config/security-proxy-setup/res/security-proxy-setup.env)
+    set -e
+
+    if [ -z "$match" ]; then
+	snap_remove
+	echo "security-proxy-setup.env file missing correct KONGAUTH_NAME env export."
+	exit 1
+    fi
+}
+
+# security-secret-store
+#
+# ADD_SECRETSTORE_TOKENS is a csv list of service keys to be added to the
+# list of Vault tokens that security-file-token-provider (launched by
+# security-secretstore-setup) creates.
+#
+# NOTE - this setting is not a configuration override, it's a top-level
+# environment variable used by the security-secretstore-setup.
+#
+test_secret-store()
+{
+    snap set edgexfoundry "env.security-secret-store.add-secretstore-tokens=myservice,yourservice"
+
+    set +e
+    match=$(grep "export ADD_SECRETSTORE_TOKENS=myservice,yourservice" \
+	 /var/snap/edgexfoundry/current/config/security-secretstore-setup/res/security-secretstore-setup.env)
+    set -e
+
+    if [ -z "$match" ]; then
+	snap_remove
+	echo "security-secretstore-setup.env file missing correct env export."
+	exit 1
+    fi
+}
+
+test_base_services
+test_proxy
+test_secret-store
+
+# remove the snap to run the next test
+snap_remove
diff --git a/data/hanoi/test-files/core-command.env b/data/hanoi/test-files/core-command.env
new file mode 100644
index 0000000..48e95cc
--- /dev/null
+++ b/data/hanoi/test-files/core-command.env
@@ -0,0 +1,16 @@
+export CLIENTS_METADATA_PORT=13
+export CLIENTS_COMMAND_PORT=12
+export SECRETSTORE_ADDITIONALRETRYATTEMPTS=20
+export SERVICE_BOOTTIMEOUT=60000
+export SERVICE_PORT=2112
+export SERVICE_SERVERBINDADDR='localhost'
+export CLIENTS_SCHEDULER_PORT=14
+export CLIENTS_COREDATA_PORT=12
+export SERVICE_CHECKINTERVAL='20s'
+export SERVICE_TIMEOUT=10000
+export SERVICE_MAXRESULTCOUNT=25000
+export SERVICE_STARTUPMSG='hello,world!'
+export CLIENTS_NOTIFICATIONS_PORT=14
+export SECRETSTORE_RETRYWAITPERIOD='10s'
+export SERVICE_HOST=127.0.0.1
+export SERVICE_PROTOCOL='http'
diff --git a/data/hanoi/test-files/core-data.env b/data/hanoi/test-files/core-data.env
new file mode 100644
index 0000000..7f2e3f3
--- /dev/null
+++ b/data/hanoi/test-files/core-data.env
@@ -0,0 +1,17 @@
+export SECRETSTORE_ADDITIONALRETRYATTEMPTS=20
+export SECRETSTORE_RETRYWAITPERIOD='10s'
+export SERVICE_STARTUPMSG='hello,world!'
+export SERVICE_CHECKINTERVAL='20s'
+export CLIENTS_SCHEDULER_PORT=14
+export SERVICE_BOOTTIMEOUT=60000
+export SERVICE_MAXRESULTCOUNT=25000
+export SERVICE_PROTOCOL='http'
+export CLIENTS_COREDATA_PORT=12
+export SERVICE_HOST=127.0.0.1
+export SERVICE_PORT=2112
+export CLIENTS_COMMAND_PORT=12
+export CLIENTS_METADATA_PORT=13
+export MESSAGEQUEUE_TOPIC='fubar'
+export SERVICE_SERVERBINDADDR='localhost'
+export SERVICE_TIMEOUT=10000
+export CLIENTS_NOTIFICATIONS_PORT=14
diff --git a/data/hanoi/test-files/core-metadata.env b/data/hanoi/test-files/core-metadata.env
new file mode 100644
index 0000000..1aa2ef6
--- /dev/null
+++ b/data/hanoi/test-files/core-metadata.env
@@ -0,0 +1,16 @@
+export CLIENTS_COREDATA_PORT=12
+export CLIENTS_SCHEDULER_PORT=14
+export SECRETSTORE_ADDITIONALRETRYATTEMPTS=20
+export SERVICE_HOST=127.0.0.1
+export SERVICE_CHECKINTERVAL='20s'
+export CLIENTS_METADATA_PORT=13
+export CLIENTS_NOTIFICATIONS_PORT=14
+export SERVICE_BOOTTIMEOUT=60000
+export SERVICE_TIMEOUT=10000
+export CLIENTS_COMMAND_PORT=12
+export SECRETSTORE_RETRYWAITPERIOD='10s'
+export SERVICE_PORT=2112
+export SERVICE_PROTOCOL='http'
+export SERVICE_MAXRESULTCOUNT=25000
+export SERVICE_SERVERBINDADDR='localhost'
+export SERVICE_STARTUPMSG='hello,world!'
diff --git a/data/hanoi/test-files/device-virtual.env b/data/hanoi/test-files/device-virtual.env
new file mode 100644
index 0000000..e028b84
--- /dev/null
+++ b/data/hanoi/test-files/device-virtual.env
@@ -0,0 +1,16 @@
+export CLIENTS_SCHEDULER_PORT=14
+export SERVICE_PROTOCOL='http'
+export SERVICE_BOOTTIMEOUT=60000
+export SERVICE_MAXRESULTCOUNT=25000
+export CLIENTS_METADATA_PORT=13
+export SERVICE_STARTUPMSG='hello,world!'
+export SERVICE_TIMEOUT=10000
+export SERVICE_PORT=2112
+export CLIENTS_COMMAND_PORT=12
+export SECRETSTORE_ADDITIONALRETRYATTEMPTS=20
+export SECRETSTORE_RETRYWAITPERIOD='10s'
+export SERVICE_CHECKINTERVAL='20s'
+export SERVICE_SERVERBINDADDR='localhost'
+export SERVICE_HOST=127.0.0.1
+export CLIENTS_DATA_PORT=12
+export CLIENTS_NOTIFICATIONS_PORT=14
diff --git a/data/hanoi/test-files/support-notifications.env b/data/hanoi/test-files/support-notifications.env
new file mode 100644
index 0000000..77faad9
--- /dev/null
+++ b/data/hanoi/test-files/support-notifications.env
@@ -0,0 +1,22 @@
+export SERVICE_STARTUPMSG='hello,world!'
+export SERVICE_TIMEOUT=10000
+export SERVICE_CHECKINTERVAL='20s'
+export SERVICE_HOST=127.0.0.1
+export SMTP_ENABLE_SELF_SIGNED_CERT=true
+export CLIENTS_COMMAND_PORT=12
+export CLIENTS_COREDATA_PORT=12
+export SECRETSTORE_ADDITIONALRETRYATTEMPTS=20
+export CLIENTS_METADATA_PORT=13
+export SMTP_PORT=2112
+export CLIENTS_SCHEDULER_PORT=14
+export SERVICE_BOOTTIMEOUT=60000
+export SERVICE_PROTOCOL='http'
+export SMTP_PASSWORD='password!'
+export CLIENTS_NOTIFICATIONS_PORT=14
+export SERVICE_MAXRESULTCOUNT=25000
+export SERVICE_SERVERBINDADDR='localhost'
+export SERVICE_PORT=2112
+export SMTP_SENDER='henry'
+export SMTP_USERNAME='joe'
+export SMTP_HOST=127.0.0.1
+export SECRETSTORE_RETRYWAITPERIOD='10s'
diff --git a/data/hanoi/test-files/support-scheduler.env b/data/hanoi/test-files/support-scheduler.env
new file mode 100644
index 0000000..de028d9
--- /dev/null
+++ b/data/hanoi/test-files/support-scheduler.env
@@ -0,0 +1,16 @@
+export SERVICE_BOOTTIMEOUT=60000
+export SERVICE_CHECKINTERVAL='20s'
+export SERVICE_STARTUPMSG='hello,world!'
+export CLIENTS_SCHEDULER_PORT=14
+export SECRETSTORE_ADDITIONALRETRYATTEMPTS=20
+export SERVICE_PROTOCOL='http'
+export SERVICE_SERVERBINDADDR='localhost'
+export CLIENTS_METADATA_PORT=13
+export CLIENTS_NOTIFICATIONS_PORT=14
+export CLIENTS_COREDATA_PORT=12
+export SECRETSTORE_RETRYWAITPERIOD='10s'
+export SERVICE_HOST=127.0.0.1
+export SERVICE_TIMEOUT=10000
+export SERVICE_PORT=2112
+export CLIENTS_COMMAND_PORT=12
+export SERVICE_MAXRESULTCOUNT=25000
diff --git a/data/hanoi/test-files/sys-mgmt-agent.env b/data/hanoi/test-files/sys-mgmt-agent.env
new file mode 100644
index 0000000..956d8f7
--- /dev/null
+++ b/data/hanoi/test-files/sys-mgmt-agent.env
@@ -0,0 +1,16 @@
+export SERVICE_PORT=2112
+export SERVICE_SERVERBINDADDR='localhost'
+export SERVICE_CHECKINTERVAL='20s'
+export CLIENTS_COREDATA_PORT=12
+export CLIENTS_METADATA_PORT=13
+export SECRETSTORE_ADDITIONALRETRYATTEMPTS=20
+export SERVICE_PROTOCOL='http'
+export SERVICE_STARTUPMSG='hello,world!'
+export SERVICE_MAXRESULTCOUNT=25000
+export CLIENTS_NOTIFICATIONS_PORT=14
+export CLIENTS_SCHEDULER_PORT=14
+export SECRETSTORE_RETRYWAITPERIOD='10s'
+export SERVICE_HOST=127.0.0.1
+export CLIENTS_COMMAND_PORT=12
+export SERVICE_TIMEOUT=10000
+export SERVICE_BOOTTIMEOUT=60000