Implement E2E tests on MQTT subscription

Entity creation, updates and deletions are tested. Also scorpio build is updated to reflect changes on the ScorpioBroker fork. Signed-off-by: Meric Feyzullahoglu <[email protected]>
IndustryFusion · Jul 10, 2024 · 6963887 · 6963887
1 parent 71f4e30
commit 6963887
Show file tree

Hide file tree

Showing 2 changed files with 249 additions and 1 deletion.
diff --git a/test/bats/test-scorpio/test-scorpio-mqtt-subscriptions.bats b/test/bats/test-scorpio/test-scorpio-mqtt-subscriptions.bats
@@ -0,0 +1,248 @@
+#!/usr/bin/env bats
+
+# shellcheck disable=SC2005
+
+DEBUG=${DEBUG:-false}
+SKIP=
+NAMESPACE=iff
+USER_SECRET=secret/credential-iff-realm-user-iff
+USER=realm_user
+CLIENT_ID=scorpio
+KEYCLOAK_URL=http://keycloak.local/auth/realms
+MQTT_URL=emqx-listeners:1883
+MQTT_TOPIC_NAME="scorpio-test"
+MQTT_SUB=/tmp/MQTT_SUB
+PLASMACUTTER_ID=urn:plasmacutter-test:12345
+SUB_ID=urn:subscription-test:1
+CUTTER=/tmp/CUTTER
+CUTTER_MERGE=/tmp/CUTTER_MERGE
+SUBSCRIPTION=/tmp/SUBSCRIPTION
+TMPTMP=/tmp/tmptmp
+
+# Function definitions
+get_adminPassword() {
+    kubectl -n iff get cm/bridge-configmap -o jsonpath="{.data['config\.json']}" | jq .mqtt.adminPassword
+}
+
+get_adminUsername() {
+    kubectl -n iff get cm/bridge-configmap -o jsonpath="{.data['config\.json']}" | jq .mqtt.adminUsername
+}
+
+get_password() {
+    kubectl -n ${NAMESPACE} get ${USER_SECRET} -o jsonpath='{.data.password}' | base64 -d
+}
+
+get_token() {
+    curl -d "client_id=${CLIENT_ID}" -d "username=${USER}" -d "password=$password" -d 'grant_type=password' "${KEYCLOAK_URL}/${NAMESPACE}/protocol/openid-connect/token" | jq ".access_token" | tr -d '"'
+}
+
+create_subscription() {
+    curl -vv -X POST -H "Authorization: Bearer $1" -d @"$2" http://ngsild.local/ngsi-ld/v1/subscriptions/ -H "Content-Type: application/ld+json"
+}
+
+delete_subscription() {
+    curl -vv -X DELETE -H "Authorization: Bearer $1" http://ngsild.local/ngsi-ld/v1/subscriptions/"$2" -H "Content-Type: application/ld+json"
+}
+
+create_ngsild() {
+    curl -vv -X POST -H "Authorization: Bearer $1" -d @"$2" http://ngsild.local/ngsi-ld/v1/entities/ -H "Content-Type: application/ld+json"
+}
+
+delete_ngsild() {
+    curl -vv -X DELETE -H "Authorization: Bearer $1" http://ngsild.local/ngsi-ld/v1/entities/"$2" -H "Content-Type: application/ld+json"
+}
+
+update_ngsild() {
+    curl -vv -X PATCH -H "Authorization: Bearer $1" -d @"$2" http://ngsild.local/ngsi-ld/v1/entities/"$3" -H "Content-Type: application/ld+json"
+}
+
+setup() {
+    if [ "$DEBUG" != "true" ]; then
+        echo "This test works only in debug mode. Set DEBUG=true."
+        exit 1
+    fi
+}
+
+# Create CUTTER file
+cat << EOF > ${CUTTER}
+{
+ "@context": "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld",
+ "id": "${PLASMACUTTER_ID}",
+ "type": "https://industry-fusion.com/types/v0.9/plasmacutter_test",
+ "https://industry-fusion.com/types/v0.9/state": {
+ "type": "Property",
+ "value": "ON",
+ "datasetId": "urn:cutter:test1"
+ }
+}
+EOF
+
+# Update the entity with a new state value
+cat << EOF > ${CUTTER_MERGE}
+{
+  "@context": "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld",
+  "https://industry-fusion.com/types/v0.9/state": {
+    "type": "Property",
+    "value": "OFF",
+    "datasetId": "urn:cutter:test1"
+  }
+}
+EOF
+
+# Create SUBSCRIPTION file
+admin_password=$(get_adminPassword | tr -d '"')
+admin_username=$(get_adminUsername | tr -d '"')
+cat << EOF > ${SUBSCRIPTION}
+{
+ "@context": "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld",
+ "id": "${SUB_ID}",
+ "type": "Subscription",
+ "entities": [{
+ "type": "https://industry-fusion.com/types/v0.9/plasmacutter_test"
+ }],
+ "notification": {
+ "endpoint": {
+ "uri": "mqtt://${admin_username}:${admin_password}@${MQTT_URL}/${MQTT_TOPIC_NAME}",
+ "accept": "application/json"
+ }
+ }
+}
+EOF
+
+compare_mqtt_sub() {
+    local mqtt_file="$1"
+    local temp_file=$TMPTMP
+
+    # Process the MQTT_SUB file to get the last message's data
+    jq -s 'last | .body.data[0]' "$mqtt_file" > "$temp_file"
+
+    # Compare only the fields we're interested in
+    cat << EOF | jq -S | diff <(jq -S '{
+        id,
+        type,
+        "https://industry-fusion.com/types/v0.9/state": {
+            type: ."https://industry-fusion.com/types/v0.9/state".type,
+            value: ."https://industry-fusion.com/types/v0.9/state".value,
+            datasetId: ."https://industry-fusion.com/types/v0.9/state".datasetId
+        }
+    }' "$temp_file") - >&3
+{
+  "id": "${PLASMACUTTER_ID}",
+  "type": "https://industry-fusion.com/types/v0.9/plasmacutter_test",
+  "https://industry-fusion.com/types/v0.9/state": {
+    "type": "Property",
+    "value": "ON",
+    "datasetId": "urn:cutter:test1"
+  }
+}
+EOF
+}
+
+compare_mqtt_sub_update() {
+    local mqtt_file="$1"
+    local temp_file=$TMPTMP
+
+    # Process the MQTT_SUB file to get the last message's data
+    jq -s 'last | .body.data[0]' "$mqtt_file" > "$temp_file"
+
+    # Compare only the fields we're interested in, maintaining the correct structure
+    cat << EOF | jq -S | diff <(jq -S '{
+        id,
+        type,
+        "https://industry-fusion.com/types/v0.9/state": {
+            type: ."https://industry-fusion.com/types/v0.9/state".type,
+            value: ."https://industry-fusion.com/types/v0.9/state".value,
+            datasetId: ."https://industry-fusion.com/types/v0.9/state".datasetId
+        }
+    }' "$temp_file") - >&3
+{
+  "id": "${PLASMACUTTER_ID}",
+  "type": "https://industry-fusion.com/types/v0.9/plasmacutter_test",
+  "https://industry-fusion.com/types/v0.9/state": {
+    "type": "Property",
+    "value": "OFF",
+    "datasetId": "urn:cutter:test1"
+  }
+}
+EOF
+}
+
+check_no_delete_notification() {
+    local message_count
+    message_count=$(jq -s 'length' "$1")
+
+    # We expect to see 2 messages: one for creation, one for update
+    if [ "$message_count" -eq 0 ]; then
+        return 0
+    else
+        echo "Expected 0 messages, but found $message_count" >&2
+        return 1
+    fi
+}
+
+@test "verify mqtt subscription after entity creation" {
+    $SKIP
+    admin_password=$(get_adminPassword | tr -d '"')
+    admin_username=$(get_adminUsername | tr -d '"')
+    password=$(get_password)
+    token=$(get_token)
+    delete_ngsild "$token" "$PLASMACUTTER_ID" || echo "Could not delete $PLASMACUTTER_ID. But that is okay."
+    sleep 2
+    (exec stdbuf -oL mosquitto_sub -L "mqtt://${admin_username}:${admin_password}@${MQTT_URL}/${MQTT_TOPIC_NAME}" >${MQTT_SUB}) &
+    sleep 2
+    create_subscription "$token" "$SUBSCRIPTION"
+    sleep 2
+    create_ngsild "$token" "$CUTTER"
+    sleep 2
+    killall mosquitto_sub
+    delete_subscription "$token" "$SUB_ID"
+
+    run compare_mqtt_sub ${MQTT_SUB}
+    [ "$status" -eq 0 ]
+}
+
+@test "verify mqtt subscription after entity creation and update" {
+    $SKIP
+    admin_password=$(get_adminPassword | tr -d '"')
+    admin_username=$(get_adminUsername | tr -d '"')
+    password=$(get_password)
+    token=$(get_token)
+    delete_ngsild "$token" "$PLASMACUTTER_ID" || echo "Could not delete $PLASMACUTTER_ID. But that is okay."
+    sleep 2
+    (exec stdbuf -oL mosquitto_sub -L "mqtt://${admin_username}:${admin_password}@${MQTT_URL}/${MQTT_TOPIC_NAME}" >${MQTT_SUB}) &
+    sleep 2
+    create_ngsild "$token" "$CUTTER"
+    sleep 2
+    create_subscription "$token" "$SUBSCRIPTION"
+    sleep 2
+    update_ngsild "$token" "$CUTTER_MERGE" "$PLASMACUTTER_ID"
+    sleep 2
+    killall mosquitto_sub
+    delete_subscription "$token" "$SUB_ID"
+
+    run compare_mqtt_sub_update ${MQTT_SUB}
+    [ "$status" -eq 0 ]
+}
+
+@test "verify no mqtt notification after entity creation and deletion" {
+    $SKIP
+    admin_password=$(get_adminPassword | tr -d '"')
+    admin_username=$(get_adminUsername | tr -d '"')
+    password=$(get_password)
+    token=$(get_token)
+    delete_ngsild "$token" "$PLASMACUTTER_ID" || echo "Could not delete $PLASMACUTTER_ID. But that is okay."
+    sleep 2
+    (exec stdbuf -oL mosquitto_sub -L "mqtt://${admin_username}:${admin_password}@${MQTT_URL}/${MQTT_TOPIC_NAME}" >${MQTT_SUB}) &
+    sleep 2
+    create_ngsild "$token" "$CUTTER"
+    sleep 2
+    create_subscription "$token" "$SUBSCRIPTION"
+    sleep 2
+    delete_ngsild "$token" "$PLASMACUTTER_ID"
+    sleep 2
+    killall mosquitto_sub
+    delete_subscription "$token" "$SUB_ID"
+
+    run check_no_delete_notification ${MQTT_SUB}
+    [ "$status" -eq 0 ]
+}
diff --git a/test/build-local-platform.sh b/test/build-local-platform.sh
@@ -27,7 +27,7 @@ echo Build Scorpio containers
 
 if [[ $TEST -eq "true" ]]; then
     ( cd ../.. && git clone https://github.com/IndustryFusion/ScorpioBroker.git)
-    ( cd ../../ScorpioBroker && git checkout e4716f1 ) # Checking out specific commit for CI purposes
+    ( cd ../../ScorpioBroker && git checkout 68f36d8 ) # Checking out specific commit for CI purposes
     ( cd ../../ScorpioBroker && source /etc/profile.d/maven.sh && mvn clean package -DskipTests -Ddocker -Ddocker-tag=$DOCKER_TAG -Dkafka -Pkafka -Dquarkus.profile=kafka -Dos=java)
 else
     ( cd ../.. && git clone https://github.com/IndustryFusion/ScorpioBroker.git )