Add on disconnect callback to samples (#647)

* add on disconnect callback

* update default client id to be mqtt5-sample-*

* remove unused parameters

* update path for folder strucutres

* fix path for test-test-pypi

Author: xiazhvera

codebuild/cd/test-prod-pypi.yml

@@ -28,7 +28,7 @@ phases:
       - CURRENT_TAG_VERSION=$(cat $CODEBUILD_SRC_DIR/VERSION)
       - python3 codebuild/cd/pip-install-with-retry.py --no-cache-dir --user awsiotsdk==$CURRENT_TAG_VERSION
       # Run PubSub sample
-      - python3 samples/mqtt5_pubsub.py --endpoint ${ENDPOINT} --cert /tmp/certificate.pem --key /tmp/privatekey.pem --ca_file /tmp/AmazonRootCA1.pem --verbosity Trace
+      - python3 samples/mqtt/mqtt5_x509.py --endpoint ${ENDPOINT} --cert /tmp/certificate.pem --key /tmp/privatekey.pem --ca_file /tmp/AmazonRootCA1.pem --verbosity Trace
 
   post_build:
     commands:

codebuild/cd/test-test-pypi.yml

@@ -29,7 +29,7 @@ phases:
       - python3 -m pip install typing
       - python3 codebuild/cd/pip-install-with-retry.py -i https://testpypi.python.org/simple --user awsiotsdk==$CURRENT_TAG_VERSION
       # Run PubSub sample
-      - python3 samples/mqtt5_pubsub.py --endpoint ${ENDPOINT} --cert /tmp/certificate.pem --key /tmp/privatekey.pem --ca_file /tmp/AmazonRootCA1.pem --verbosity Trace
+      - python3 samples/mqtt/mqtt5_x509.py --endpoint ${ENDPOINT} --cert /tmp/certificate.pem --key /tmp/privatekey.pem --ca_file /tmp/AmazonRootCA1.pem --verbosity Trace
 
   post_build:
     commands:

documents/FAQ.md

@@ -102,7 +102,7 @@ Here is an example launch.json file to run the pubsub sample
             "name": "PubSub",
             "type": "python",
             "request": "launch",
-            "program": "${workspaceFolder}/samples/pubsub.py",
+            "program": "${workspaceFolder}/samples/mqtt/mqtt5_x509.py",
             "args": [
                 "--endpoint", "<account-number>-ats.iot.<region>.amazonaws.com",
                 "--ca_file", "<path to root-CA>",

documents/MIGRATION_GUIDE.md

@@ -783,7 +783,7 @@ delta_subscribed_future.result()
 For more information, see API documentation for the v2 SDK
 [Device Shadow](https://aws.github.io/aws-iot-device-sdk-python-v2/awsiot/iotshadow.html).
 
-For code examples, see the v2 SDK [Device Shadow](https://github.com/aws/aws-iot-device-sdk-python-v2/blob/main/samples/shadow_mqtt5.py).
+For code examples, see the v2 SDK [Device Shadow](https://github.com/aws/aws-iot-device-sdk-python-v2/blob/main/samples/service_clients/shadow.py).
 
 
 ### Client for AWS IoT Jobs
@@ -1131,7 +1131,7 @@ For detailed descriptions for the topics used to interact with the service, see
 For more information about the service clients, see API documentation for the v2 SDK
 [Jobs](https://aws.github.io/aws-iot-device-sdk-python-v2/awsiot/iotjobs.html).
 
-For code examles, see [Jobs](https://github.com/aws/aws-iot-device-sdk-python/blob/master/samples/jobs/jobsSample.py)
+For code examles, see [Jobs](https://github.com/aws/aws-iot-device-sdk-python/blob/master/samples/service_clients/jobs.py)
 samples.
 
 
@@ -1155,16 +1155,16 @@ AWS IoT Core documentation for [Fleet Provisioning](https://docs.aws.amazon.com/
 For more information about the Fleet Provisioning service client, See API documentation for the v2 SDK
 [Fleet Provisioning](https://aws.github.io/aws-iot-device-sdk-python-v2/awsiot/iotidentity.html).
 
-For code examples, see the v2 SDK [Fleet Provisioning](https://github.com/aws/aws-iot-device-sdk-python-v2/blob/main/samples/fleetprovisioning.md)
+For code examples, see the v2 SDK [Fleet Provisioning](https://github.com/aws/aws-iot-device-sdk-python-v2/blob/main/samples/service_clients/fleet_provisioning_basic.md)
 samples.
 
 
 ### Example
 
 It's always helpful to look at a working example to see how new functionality works, to be able to tweak different options,
 to compare with existing code. For that reason, we implemented a
-[Publish/Subscribe example](https://github.com/aws/aws-iot-device-sdk-python-v2/blob/main/samples/mqtt5_pubsub.md)
-([source code](https://github.com/aws/aws-iot-device-sdk-python-v2/blob/main/samples/mqtt5_pubsub.py))
+[X509 Publish/Subscribe example](https://github.com/aws/aws-iot-device-sdk-python-v2/blob/main/samples/mqtt/mqtt5_x509.md)
+([source code](https://github.com/aws/aws-iot-device-sdk-python-v2/blob/main/samples/mqtt/mqtt5_x509.py))
 in the v2 SDK similar to a sample provided by the v1 SDK (see a corresponding
 [readme section](https://github.com/aws/aws-iot-device-sdk-python/blob/master/README.rst#basicpubsub) and
 [source code](https://github.com/aws/aws-iot-device-sdk-python/blob/master/samples/basicPubSub/basicPubSub.py)).

samples/mqtt/mqtt5_aws_websocket.md

@@ -49,7 +49,7 @@ The AWS IAM permission policy associated with the AWS credentials resolved by th
         "iot:Connect"
       ],
       "Resource": [
-        "arn:aws:iot:<b>region</b>:<b>account</b>:client/test-*"
+        "arn:aws:iot:<b>region</b>:<b>account</b>:client/mqtt5-sample-*"
       ]
     }
   ]
@@ -60,7 +60,7 @@ Replace with the following with the data from your AWS account:
 * `<region>`: The AWS IoT Core region where you created your AWS IoT Core thing you wish to use with this sample. For example `us-east-1`.
 * `<account>`: Your AWS IoT Core account ID. This is the set of numbers in the top right next to your AWS account name when using the AWS IoT Core website.
 
-Note that in a real application, you may want to avoid the use of wildcards in your ClientID or use them selectively. Please follow best practices when working with AWS on production applications using the SDK. Also, for the purposes of this sample, please make sure your policy allows a client ID of `test-*` to connect or use `--client_id <client ID here>` to send the client ID your policy supports.
+Note that in a real application, you may want to avoid the use of wildcards in your ClientID or use them selectively. Please follow best practices when working with AWS on production applications using the SDK. Also, for the purposes of this sample, please make sure your policy allows a client ID of `mqtt5-sample-*` to connect or use `--client_id <client ID here>` to send the client ID your policy supports.
 
 </details>
 
@@ -92,7 +92,7 @@ required arguments:
   --signing_region   Signing region for websocket connection (default: None)
 
 optional arguments:
-  --client_id        Client ID (default: mqtt5-sample-809571c8)
+  --client_id        Client ID (default: mqtt5-sample-<uuid>)
   --topic            Topic (default: test/topic)
   --message          Message payload (default: Hello from mqtt5 sample)
   --count            Messages to publish (0 = infinite) (default: 5)

samples/mqtt/mqtt5_aws_websocket.py

@@ -74,7 +74,7 @@ def on_lifecycle_attempting_connect(lifecycle_attempting_connect_data: mqtt5.Lif
 # Callback for the lifecycle event Connection Success
 def on_lifecycle_connection_success(lifecycle_connect_success_data: mqtt5.LifecycleConnectSuccessData):
     connack_packet = lifecycle_connect_success_data.connack_packet
-    print("Lifecycle Connection Success with reason_code:{}\n".format(
+    print("Lifecycle Connection Success with reason code:{}\n".format(
         repr(connack_packet.reason_code)))
     connection_success_event.set()
 
@@ -85,6 +85,12 @@ def on_lifecycle_connection_failure(lifecycle_connection_failure: mqtt5.Lifecycl
         lifecycle_connection_failure.exception))
 
 
+# Callback for the lifecycle event Disconnection
+def on_lifecycle_disconnection(lifecycle_disconnect_data: mqtt5.LifecycleDisconnectData):
+    print("Lifecycle Disconnected with reason code:{}".format(
+        lifecycle_disconnect_data.disconnect_packet.reason_code if lifecycle_disconnect_data.disconnect_packet else "None"))
+
+
 if __name__ == '__main__':
     print("\nStarting MQTT5 Websocket Sample\n")
     message_count = args.input_count
@@ -105,6 +111,7 @@ def on_lifecycle_connection_failure(lifecycle_connection_failure: mqtt5.Lifecycl
         on_lifecycle_attempting_connect=on_lifecycle_attempting_connect,
         on_lifecycle_connection_success=on_lifecycle_connection_success,
         on_lifecycle_connection_failure=on_lifecycle_connection_failure,
+        on_lifecycle_disconnection=on_lifecycle_disconnection,
         client_id=args.input_clientId)
 
 

samples/mqtt/mqtt5_custom_auth.md

@@ -51,7 +51,7 @@ Below is a sample policy that provides the necessary privileges.
         "iot:Connect"
       ],
       "Resource": [
-        "arn:aws:iot:<b>region</b>:<b>account</b>:client/test-*"
+        "arn:aws:iot:<b>region</b>:<b>account</b>:client/mqtt5-sample-*"
       ]
     }
   ]
@@ -62,7 +62,7 @@ Replace with the following with the data from your AWS account:
 * `<region>`: The AWS IoT Core region where you created your AWS IoT Core thing you wish to use with this sample. For example `us-east-1`.
 * `<account>`: Your AWS IoT Core account ID. This is the set of numbers in the top right next to your AWS account name when using the AWS IoT Core website.
 
-Note that in a real application, you may want to avoid the use of wildcards in your ClientID or use them selectively. Please follow best practices when working with AWS on production applications using the SDK. Also, for the purposes of this sample, please make sure your policy allows a client ID of `test-*` to connect or use `--client_id <client ID here>` to send the client ID your policy supports.
+Note that in a real application, you may want to avoid the use of wildcards in your ClientID or use them selectively. Please follow best practices when working with AWS on production applications using the SDK. Also, for the purposes of this sample, please make sure your policy allows a client ID of `mqtt5-sample-*` to connect or use `--client_id <client ID here>` to send the client ID your policy supports.
 
 </details>
 
@@ -121,7 +121,7 @@ required arguments:
   --auth_password       The password to send when connecting through a custom authorizer (optional) (default: None)
 
 optional arguments:
-  --client_id           Client ID (default: test-f3168b42)
+  --client_id           Client ID (default: mqtt5-sample-<uuid>)
   --topic               Topic (default: test/topic)
   --message             Message payload (default: Hello from mqtt5 sample)
   --count               Messages to publish (0 = infinite) (default: 5)

samples/mqtt/mqtt5_custom_auth_signed.py

@@ -33,7 +33,7 @@
                     help="The password to send when connecting through a custom authorizer (optional)")
 
 # Optional Arguments
-optional.add_argument("--client_id",  metavar="", dest="input_clientId", default=f"test-{uuid.uuid4().hex[:8]}", 
+optional.add_argument("--client_id",  metavar="", dest="input_clientId", default=f"mqtt5-sample-{uuid.uuid4().hex[:8]}", 
                       help="Client ID")
 optional.add_argument("--topic", default="test/topic",  metavar="", dest="input_topic", 
                       help="Topic")
@@ -86,7 +86,7 @@ def on_lifecycle_attempting_connect(lifecycle_attempting_connect_data: mqtt5.Lif
 # Callback for the lifecycle event Connection Success
 def on_lifecycle_connection_success(lifecycle_connect_success_data: mqtt5.LifecycleConnectSuccessData):
     connack_packet = lifecycle_connect_success_data.connack_packet
-    print("Lifecycle Connection Success with reason_code:{}\n".format(
+    print("Lifecycle Connection Success with reason code:{}\n".format(
         repr(connack_packet.reason_code)))
     connection_success_event.set()
 
@@ -97,6 +97,12 @@ def on_lifecycle_connection_failure(lifecycle_connection_failure: mqtt5.Lifecycl
         lifecycle_connection_failure.exception))
 
 
+# Callback for the lifecycle event Disconnection
+def on_lifecycle_disconnection(lifecycle_disconnect_data: mqtt5.LifecycleDisconnectData):
+    print("Lifecycle Disconnected with reason code:{}".format(
+        lifecycle_disconnect_data.disconnect_packet.reason_code if lifecycle_disconnect_data.disconnect_packet else "None"))
+
+
 if __name__ == '__main__':
 
     # Create MQTT5 Client with a custom authorizer
@@ -114,6 +120,7 @@ def on_lifecycle_connection_failure(lifecycle_connection_failure: mqtt5.Lifecycl
         on_lifecycle_attempting_connect=on_lifecycle_attempting_connect,
         on_lifecycle_connection_success=on_lifecycle_connection_success,
         on_lifecycle_connection_failure=on_lifecycle_connection_failure,
+        on_lifecycle_disconnection=on_lifecycle_disconnection,
         client_id=args.input_clientId)
 
 

samples/mqtt/mqtt5_custom_auth_unsigned.py

@@ -26,7 +26,7 @@
                     help="The password to send when connecting through a custom authorizer")
 
 # Optional Arguments
-optional.add_argument("--client_id",  metavar="", dest="input_clientId", default=f"test-{uuid.uuid4().hex[:8]}",
+optional.add_argument("--client_id",  metavar="", dest="input_clientId", default=f"mqtt5-sample-{uuid.uuid4().hex[:8]}",
                       help="Client ID")
 optional.add_argument("--topic", default="test/topic",  metavar="", dest="input_topic",
                       help="Topic")
@@ -79,7 +79,7 @@ def on_lifecycle_attempting_connect(lifecycle_attempting_connect_data: mqtt5.Lif
 # Callback for the lifecycle event Connection Success
 def on_lifecycle_connection_success(lifecycle_connect_success_data: mqtt5.LifecycleConnectSuccessData):
     connack_packet = lifecycle_connect_success_data.connack_packet
-    print("Lifecycle Connection Success with reason_code:{}\n".format(
+    print("Lifecycle Connection Success with reason code:{}\n".format(
         repr(connack_packet.reason_code)))
     connection_success_event.set()
 
@@ -90,6 +90,12 @@ def on_lifecycle_connection_failure(lifecycle_connection_failure: mqtt5.Lifecycl
         lifecycle_connection_failure.exception))
 
 
+# Callback for the lifecycle event Disconnection
+def on_lifecycle_disconnection(lifecycle_disconnect_data: mqtt5.LifecycleDisconnectData):
+    print("Lifecycle Disconnected with reason code:{}".format(
+        lifecycle_disconnect_data.disconnect_packet.reason_code if lifecycle_disconnect_data.disconnect_packet else "None"))
+
+
 if __name__ == '__main__':
 
     # Create MQTT5 Client with a custom authorizer
@@ -104,6 +110,7 @@ def on_lifecycle_connection_failure(lifecycle_connection_failure: mqtt5.Lifecycl
         on_lifecycle_attempting_connect=on_lifecycle_attempting_connect,
         on_lifecycle_connection_success=on_lifecycle_connection_success,
         on_lifecycle_connection_failure=on_lifecycle_connection_failure,
+        on_lifecycle_disconnection=on_lifecycle_disconnection,
         client_id=args.input_clientId)
 
 

samples/mqtt/mqtt5_pkcs11_connect.md

@@ -52,7 +52,7 @@ Your IoT Core Thing's [Policy](https://docs.aws.amazon.com/iot/latest/developerg
         "iot:Connect"
       ],
       "Resource": [
-        "arn:aws:iot:<b>region</b>:<b>account</b>:client/test-*"
+        "arn:aws:iot:<b>region</b>:<b>account</b>:client/mqtt5-sample-*"
       ]
     }
   ]
@@ -63,7 +63,7 @@ Replace with the following with the data from your AWS account:
 * `<region>`: The AWS IoT Core region where you created your AWS IoT Core thing you wish to use with this sample. For example `us-east-1`.
 * `<account>`: Your AWS IoT Core account ID. This is the set of numbers in the top right next to your AWS account name when using the AWS IoT Core website.
 
-Note that in a real application, you may want to avoid the use of wildcards in your ClientID or use them selectively. Please follow best practices when working with AWS on production applications using the SDK. Also, for the purposes of this sample, please make sure your policy allows a client ID of `test-*` to connect or use `--client_id <client ID here>` to send the client ID your policy supports.
+Note that in a real application, you may want to avoid the use of wildcards in your ClientID or use them selectively. Please follow best practices when working with AWS on production applications using the SDK. Also, for the purposes of this sample, please make sure your policy allows a client ID of `mqtt5-sample-*` to connect or use `--client_id <client ID here>` to send the client ID your policy supports.
 
 </details>
 
@@ -109,9 +109,8 @@ optional arguments:
   --topic         Topic (default: test/topic)
   --message       Message payload (default: Hello from mqtt5 sample)
   --count         Messages to publish (0 = infinite) (default: 5)
-  --proxy_host    HTTP proxy host (default: None)
-  --proxy_port    HTTP proxy port (default: 0)
-  --client_id     Client ID (default: test-548e4344)
+
+  --client_id     Client ID (default: mqtt5-sample-<uuid>)
   ```
 
 ### Run sample with SoftHSM