Merge pull request #41 from AmedeeBulle/tokens

Misc python & terraform updates

Author: AmedeeBulle

samples/python/command-response/README.md

@@ -15,6 +15,14 @@ It will listen for commands by subscribing to topics ending in `/cmd` and acknow
 by sending a response.
 The script will terminate when it receives a _shutdown_ command or a keyboard interrupt (Control-C).
 
+Notes:
+
+- The MQTT client must connect with `clean_session` set to false. This informs the
+  IoT Platform that the device accepts commands. The platform will also ensure messages
+  are retained while the device is disconnected.
+- The command handler runs in a separate thread so that the on_message handler returns
+  quickly and does not block the MQTT client loop.
+
 ## Prerequisites
 
 Install the Python dependencies

samples/python/command-response/command-response.py

@@ -12,6 +12,7 @@
 
 import json
 import os
+import queue
 import sys
 import threading
 import time
@@ -39,12 +40,13 @@ def on_connect(client, userdata, flags, reason_code, properties=None):
     client.subscribe("#", qos=config.qos)
 
 
-# Callback for MQTT message received event.
-def on_message(client, userdata, message, properties=None):
-    topic = message.topic
-    payload = message.payload.decode()
-    state = userdata
-    if topic.endswith("/cmd"):
+# Command handler thread
+def command_handler():
+    while True:
+        try:
+            topic, payload, state = command_handler_queue.get()
+        except queue.ShutDown:
+            break
         print(f"Received command on {topic}: {payload}")
         # Command handling logic goes here.
         # For this example, only the shutdown command is handled, which will
@@ -63,22 +65,36 @@ def on_message(client, userdata, message, properties=None):
         ack_msg = json.dumps(
             {"status": "acknowledged", "time": current_epoch_microseconds()}
         )
-        state["ack_msg_info"].append(
-            client.publish(topic=rsp_topic, payload=ack_msg, qos=config.qos)
-        )
+        rc_pub = client.publish(topic=rsp_topic, payload=ack_msg, qos=config.qos)
+        rc_pub.wait_for_publish()
+        print(f"Finished command handling for: {topic}")
+        command_handler_queue.task_done()
+
+
+# Callback for MQTT message received event.
+def on_message(client, userdata, message, properties=None):
+    topic = message.topic
+    payload = message.payload.decode()
+    state = userdata
+    if topic.endswith("/cmd"):
+        command_handler_queue.put((topic, payload, state))
 
 
 if config.auth_type not in ("basic", "cert"):
     raise ValueError("auth_type must be 'basic' or 'cert'")
 
+# Initialize queue and start command handler thread
+command_handler_queue = queue.Queue()
+command_handler_thread = threading.Thread(target=command_handler)
+command_handler_thread.start()
+
 client = mqtt.Client(
     client_id=config.client_id,  # Ensure client_id is set for persistent sessions.
     clean_session=False,  # Enable persistent session.
     protocol=mqtt.MQTTv311,  # Use v311 unless v5 features are needed.
     callback_api_version=mqtt.CallbackAPIVersion.VERSION2,  # type: ignore
 )
 state = {
-    "ack_msg_info": [],
     "shutdown_event": threading.Event(),
 }
 client.user_data_set(state)
@@ -121,19 +137,14 @@ def on_message(client, userdata, message, properties=None):
         rc_pub.wait_for_publish()
         count += 1
         time.sleep(config.message_delay)
-        # Drain ack_msg_info
-        while state["ack_msg_info"]:
-            state["ack_msg_info"].pop(0).wait_for_publish()
 
 except KeyboardInterrupt:
     print("\nInterrupted by user. Exiting...")
 
-# Wait to process any potential /cmd messages before exit.
-print("Waiting 2 seconds to process possible /cmd messages...")
-time.sleep(2)
-# Drain ack_msg_info
-while state["ack_msg_info"]:
-    state["ack_msg_info"].pop(0).wait_for_publish()
+# Wait for the queue to drain
+print("Waiting for commands to be processed...")
+command_handler_queue.shutdown()
+command_handler_thread.join()
 
 # Tear down the client and exit.
 client.loop_stop()

samples/python/manage-dt/README.md

@@ -162,7 +162,7 @@ Options:
   -d, --debug                     Debug mode
   --profile TEXT                  The profile in the config file to load.
                                   [default: wim-iot-fra]
-  --auth [api_key|instance_principal|resource_principal]
+  --auth [api_key|instance_principal|resource_principal|security_token]
                                   The type of auth to use for the API request.
                                   [default: api_key]
   --data-dir DIRECTORY            Data directory  [default: ./data]

samples/python/manage-dt/manage_dt/mdt_oci.py

@@ -83,9 +83,6 @@ def get_oci_config(
         case "security_token":
             logger.debug("OCI authentication: Session Token")
             config = oci_config.from_file(profile_name=profile)
-            if os.getenv("OCI_CLI_TENANCY"):
-                logger.debug("Overriding tenancy OCID")
-                config["tenancy"] = os.getenv("OCI_CLI_TENANCY")
             token_file = config["security_token_file"]
             token = None
             with open(token_file, "r") as f:

samples/python/query-db/README.md

@@ -65,7 +65,7 @@ Copy `config.distr.py` to `config.py` and set the following variables:
 - `db_token_scope`: The dbTokenScope property of your IoT Domain Group.
 - `iot_domain_short_name`: The hostname part of the deviceHost property of your IoT Domain.
 - `oci_auth_type`: The OCI Authentication type. Must be either "ConfigFileAuthentication"
-   for API Key authentication or "InstancePrincipal".
+   for API Key authentication,  "InstancePrincipal" or "SecurityToken".
 - `oci_profile`: OCI CLI profile to use for token retrieval when using API Key authentication.
 - `row_count`: The number of rows retrieved by the sample queries.
 - `thick_mode`: Set to `True` to use the `oracledb` Thick mode driver.

samples/python/query-db/config.distr.py

@@ -16,7 +16,8 @@
 #     jq -r '.'data."device-host"' | split(".")[0]'
 iot_domain_short_name = "<Domain SHort Name>"
 
-# OCI Authentication type. Must be either "ConfigFileAuthentication" or "InstancePrincipal"
+# OCI Authentication type. Must be either "ConfigFileAuthentication", "InstancePrincipal"
+# or "SecurityToken"
 # oci_auth_type = "ConfigFileAuthentication"
 oci_auth_type = "InstancePrincipal"
 

samples/python/query-db/query_db.py

@@ -88,7 +88,7 @@ def get_blob(blob: oracledb.LOB) -> Tuple[str, str]:
     "auth_type": config.oci_auth_type,
     "scope": config.db_token_scope,
 }
-if config.oci_auth_type == "ConfigFileAuthentication":
+if config.oci_auth_type in ["ConfigFileAuthentication", "SecurityToken"]:
     token_based_auth["profile"] = config.oci_profile
 
 extra_connect_params = {}

samples/python/queues/README.md

@@ -76,8 +76,8 @@ Copy `config.distr.py` to `config.py` and set the following variables:
 - `db_connect_string`: The `dbConnectionString` property of your IoT Domain Group.
 - `db_token_scope`: The `dbTokenScope` property of your IoT Domain Group.
 - `iot_domain_short_name`: The hostname part of the `deviceHost` property of your IoT Domain.
-- `oci_auth_type`: The OCI authentication type. Use "ConfigFileAuthentication"
-  for API key authentication, or "InstancePrincipal".
+- `oci_auth_type`: The OCI Authentication type. Must be either "ConfigFileAuthentication"
+   for API Key authentication,  "InstancePrincipal" or "SecurityToken".
 - `oci_profile`: OCI CLI profile to use for token retrieval (API key authentication only).
 - `thick_mode`: Set to `True` to use the `oracledb` thick mode driver.
 - `subscriber_name`: Name of the durable subscriber for the `sub-norm` sample.

samples/python/queues/config.distr.py

@@ -22,7 +22,8 @@
 #     jq -r '.'data."device-host"' | split(".")[0]'
 iot_domain_short_name = "<Domain SHort Name>"
 
-# OCI Authentication type. Must be either "ConfigFileAuthentication" or "InstancePrincipal"
+# OCI Authentication type. Must be either "ConfigFileAuthentication", "InstancePrincipal"
+# or "SecurityToken"
 # oci_auth_type = "ConfigFileAuthentication"
 oci_auth_type = "InstancePrincipal"
 

samples/python/queues/sub-norm.py

@@ -52,7 +52,7 @@ def db_connect() -> oracledb.Connection:
         "auth_type": config.oci_auth_type,
         "scope": config.db_token_scope,
     }
-    if config.oci_auth_type == "ConfigFileAuthentication":
+    if config.oci_auth_type in ["ConfigFileAuthentication", "SecurityToken"]:
         token_based_auth["profile"] = config.oci_profile
 
     extra_connect_params = {}