samples-wide factoring start

Author: sbSteveK

samples/basic_discovery.py

@@ -1,11 +1,11 @@
 # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0.
 
-import time, json
-from awscrt import io, http
-from awscrt.mqtt import QoS
 from awsiot.greengrass_discovery import DiscoveryClient
 from awsiot import mqtt_connection_builder
+from awscrt import io, http
+from awscrt.mqtt import QoS
+import time, json
 
 allowed_actions = ['both', 'publish', 'subscribe']
 
@@ -14,10 +14,11 @@
 
 def parse_sample_input():
     parser = argparse.ArgumentParser(
-        description="Greengrass basic discovery",
+        description="Greengrass Basic Discovery",
         formatter_class=argparse.ArgumentDefaultsHelpFormatter,
     )
 
+    # Connection / TLS
     parser.add_argument("--cert", required=True, dest="input_cert",
                         help="Path to the certificate file to use during mTLS connection establishment")
     parser.add_argument("--key", required=True, dest="input_key",
@@ -36,7 +37,7 @@ def parse_sample_input():
     parser.add_argument("--mode", default='both', dest="input_mode", 
                         help=f"The operation mode (optional, default='both').\nModes:{allowed_actions}")
 
-    # Proxy (optional)
+    # Proxy
     parser.add_argument("--proxy-host", dest="input_proxy_host", help="HTTP proxy host")
     parser.add_argument("--proxy-port", type=int, default=0, dest="input_proxy_port", help="HTTP proxy port")
 
@@ -46,10 +47,12 @@ def parse_sample_input():
 
     return parser.parse_args()
 
+# args contains all the parsed commandline arguments used by the sample
 args = parse_sample_input()
 
 # --------------------------------- ARGUMENT PARSING END -----------------------------------------
 
+
 tls_options = io.TlsContextOptions.create_client_with_mtls_from_path(args.input_cert, args.input_key)
 if (args.input_ca is not None):
     tls_options.override_default_trust_store_from_path(None, args.input_ca)

samples/fleet_provisioning_basic.py

@@ -1,12 +1,15 @@
 # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0.
 
-from awscrt import mqtt5, mqtt_request_response
 from awsiot import iotidentity, mqtt5_client_builder
+from awscrt import mqtt5, mqtt_request_response
 from concurrent.futures import Future
+import json, uuid
+
+# --------------------------------- ARGUMENT PARSING -----------------------------------------
 import argparse
-import json
-import uuid
+
+# --------------------------------- ARGUMENT PARSING END -----------------------------------------
 
 
 if __name__ == '__main__':

samples/fleet_provisioning_csr.py

@@ -1,12 +1,15 @@
 # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0.
 
-from awscrt import mqtt5, mqtt_request_response
 from awsiot import iotidentity, mqtt5_client_builder
+from awscrt import mqtt5, mqtt_request_response
 from concurrent.futures import Future
+import json, uuid
+
+# --------------------------------- ARGUMENT PARSING -----------------------------------------
 import argparse
-import json
-import uuid
+
+# --------------------------------- ARGUMENT PARSING END -----------------------------------------
 
 
 if __name__ == '__main__':

samples/ipc_greengrass.py

@@ -19,10 +19,7 @@
 
 """
 
-import json
-import time
-import os
-import sys
+import json, time, os, sys
 
 import awsiot.greengrasscoreipc
 import awsiot.greengrasscoreipc.model as model

samples/jobs.py

@@ -1,15 +1,18 @@
 # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0.
 
-from awscrt import mqtt5, mqtt_request_response
 from awsiot import iotjobs, mqtt5_client_builder
+from awscrt import mqtt5, mqtt_request_response
 import boto3
 from concurrent.futures import Future
 from dataclasses import dataclass
 from typing import Optional
-import awsiot
+import awsiot, sys
+
+# --------------------------------- ARGUMENT PARSING -----------------------------------------
 import argparse
-import sys
+
+# --------------------------------- ARGUMENT PARSING END -----------------------------------------
 
 
 @dataclass

samples/mqtt5_custom_authorizer_connect.py

@@ -1,18 +1,27 @@
 # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0.
 
+from awsiot import mqtt5_client_builder
+from awscrt import mqtt5
+from concurrent.futures import Future
+
 # --------------------------------- ARGUMENT PARSING -----------------------------------------
 import argparse, uuid
 
 def parse_sample_input():
     parser = argparse.ArgumentParser(
-        description="MQTT5 pub/sub sample (mTLS).",
+        description="MQTT5 Custom Authorizer Sample.",
         formatter_class=argparse.ArgumentDefaultsHelpFormatter,
     )
 
+    # Connection
     parser.add_argument("--endpoint", required=True, dest="input_endpoint", help="IoT endpoint hostname")
-    parser.add_argument("--ca", dest="input_ca", help="Path to optional CA bundle (PEM)")
+    parser.add_argument("--ca_file", dest="input_ca", help="Path to optional CA bundle (PEM)")
+    parser.add_argument("--use_websockets", dest="input_use_websockets",
+                        action="store_const", const=True, default=None,
+                        help="Use WebSockets instead of direct TLS")
 
+    # Custom Auth
     parser.add_argument("--custom_auth_username", dest="input_custom_auth_username",
                         help="The name to send when connecting through the custom authorizer (optional)")
     parser.add_argument("--custom_auth_authorizer_name", dest="input_custom_authorizer_name",
@@ -25,10 +34,6 @@ def parse_sample_input():
                         help="Key used to extract the custom authorizer token (optional)")
     parser.add_argument("--custom_auth_token_value", dest="input_custom_authorizer_token_value",
                         help="The opaque token value for the custom authorizer (optional)")
-    
-    parser.add_argument("--use_websockets", dest="input_use_websockets",
-                        action="store_const", const=True, default=None,
-                        help="Use WebSockets instead of direct TLS")
 
     # Misc
     parser.add_argument("--client-id", dest="input_clientId",
@@ -47,13 +52,11 @@ def parse_sample_input():
 
     return args
 
+# args contains all the parsed commandline arguments used by the sample
 args = parse_sample_input()
 
 # --------------------------------- ARGUMENT PARSING END -----------------------------------------
 
-from awsiot import mqtt5_client_builder
-from awscrt import mqtt5
-from concurrent.futures import Future
 
 TIMEOUT = 100
 

samples/mqtt5_pkcs11_connect.py

@@ -1,12 +1,16 @@
 # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0.
 
+from awsiot import mqtt5_client_builder
+from awscrt import mqtt5, io
+from concurrent.futures import Future
+
 # --------------------------------- ARGUMENT PARSING -----------------------------------------
 import argparse, uuid
 
 def parse_sample_input():
     parser = argparse.ArgumentParser(
-        description="MQTT5 pub/sub sample (mTLS).",
+        description="MQTT5 PKCS11 Sample.",
         formatter_class=argparse.ArgumentDefaultsHelpFormatter,
     )
 
@@ -15,7 +19,14 @@ def parse_sample_input():
     parser.add_argument("--port", type=int, default=8883, dest="input_port", help="Port (8883 mTLS, 443 ALPN)")
     parser.add_argument("--cert", required=True, dest="input_cert",
                         help="Path to the certificate file to use during mTLS connection establishment")
-    parser.add_argument("--ca", dest="input_ca", help="Path to optional CA bundle (PEM)")
+    parser.add_argument("--ca_file", dest="input_ca", help="Path to optional CA bundle (PEM)")
+
+    # PKCS11
+    parser.add_argument("--pkcs11_lib", required=True, dest="input_pkcs11_lib_path", help="Path to PKCS#11 Library")
+    parser.add_argument("--pin", required=True, dest="input_pkcs11_user_pin", help="User PIN for logging into PKCS#11 token")
+    parser.add_argument("--token_label", dest="input_pkcs11_token_label", help="Label of the PKCS#11 token to use (optional).")
+    parser.add_argument("--slot_id", dest="input_pkcs11_slot_id", help="Slot ID containing the PKCS#11 token to use (optional).")
+    parser.add_argument("--key_label", dest="input_pkcs11_key_label", help="Label of private key on the PKCS#11 token (optional).")
 
     # Messaging
     parser.add_argument("--topic", default="test/topic", dest="input_topic", help="Topic")
@@ -30,22 +41,14 @@ def parse_sample_input():
     # Misc
     parser.add_argument("--client-id", dest="input_clientId",
                         default=f"test-{uuid.uuid4().hex[:8]}", help="Client ID")
-    
-    parser.add_argument("--pkcs11_lib", required=True, dest="input_pkcs11_lib_path", help="Path to PKCS#11 Library")
-    parser.add_argument("--pin", required=True, dest="input_pkcs11_user_pin", help="User PIN for logging into PKCS#11 token")
-    parser.add_argument("--token_label", dest="input_pkcs11_token_label", help="Label of the PKCS#11 token to use (optional).")
-    parser.add_argument("--slot_id", dest="input_pkcs11_slot_id", help="Slot ID containing the PKCS#11 token to use (optional).")
-    parser.add_argument("--key_label", dest="input_pkcs11_key_label", help="Label of private key on the PKCS#11 token (optional).")
 
     return parser.parse_args()
 
+# args contains all the parsed commandline arguments used by the sample
 args = parse_sample_input()
 
 # --------------------------------- ARGUMENT PARSING END -----------------------------------------
 
-from awscrt import mqtt5, io
-from awsiot import mqtt5_client_builder
-from concurrent.futures import Future
 
 TIMEOUT = 100
 

samples/mqtt5_pubsub.py

@@ -1,12 +1,17 @@
 # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0.
 
+from awsiot import mqtt5_client_builder
+from awscrt import mqtt5, http
+import threading, time, json
+from concurrent.futures import Future
+
 # --------------------------------- ARGUMENT PARSING -----------------------------------------
 import argparse, uuid
 
 def parse_sample_input():
     parser = argparse.ArgumentParser(
-        description="MQTT5 pub/sub sample (mTLS).",
+        description="MQTT5 pub/sub Sample (mTLS).",
         formatter_class=argparse.ArgumentDefaultsHelpFormatter,
     )
 
@@ -17,15 +22,15 @@ def parse_sample_input():
                         help="Path to the certificate file to use during mTLS connection establishment")
     parser.add_argument("--key", required=True, dest="input_key",
                         help="Path to the private key file to use during mTLS connection establishment")
-    parser.add_argument("--ca", dest="input_ca", help="Path to optional CA bundle (PEM)")
+    parser.add_argument("--ca_file", dest="input_ca", help="Path to optional CA bundle (PEM)")
 
     # Messaging
     parser.add_argument("--topic", default="test/topic", dest="input_topic", help="Topic")
     parser.add_argument("--message", default="Hello from mqtt5 sample", dest="input_message", help="Message payload")
     parser.add_argument("--count", default=5, dest="input_count",
                         help="Messages to publish (0 = infinite)")
 
-    # Proxy (optional)
+    # Proxy
     parser.add_argument("--proxy-host", dest="input_proxy_host", help="HTTP proxy host")
     parser.add_argument("--proxy-port", type=int, default=0, dest="input_proxy_port", help="HTTP proxy port")
 
@@ -35,14 +40,11 @@ def parse_sample_input():
 
     return parser.parse_args()
 
+# args contains all the parsed commandline arguments used by the sample
 args = parse_sample_input()
 
 # --------------------------------- ARGUMENT PARSING END -----------------------------------------
 
-from awsiot import mqtt5_client_builder
-from awscrt import mqtt5, http
-import threading, time, json
-from concurrent.futures import Future
 
 TIMEOUT = 100
 topic_filter = "test/topic"

samples/mqtt5_shared_subscription.py

@@ -1,12 +1,17 @@
 # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0.
 
+from awsiot import mqtt5_client_builder
+from awscrt import mqtt5
+from concurrent.futures import Future
+import time, json
+
 # --------------------------------- ARGUMENT PARSING -----------------------------------------
 import argparse, uuid
 
 def parse_sample_input():
     parser = argparse.ArgumentParser(
-        description="MQTT5 pub/sub sample (mTLS).",
+        description="MQTT5 Shared Subscription Sample.",
         formatter_class=argparse.ArgumentDefaultsHelpFormatter,
     )
 
@@ -17,13 +22,15 @@ def parse_sample_input():
                         help="Path to the certificate file to use during mTLS connection establishment")
     parser.add_argument("--key", required=True, dest="input_key",
                         help="Path to the private key file to use during mTLS connection establishment")
-    parser.add_argument("--ca", dest="input_ca", help="Path to optional CA bundle (PEM)")
+    parser.add_argument("--ca_file", dest="input_ca", help="Path to optional CA bundle (PEM)")
 
     # Messaging
     parser.add_argument("--topic", default="test/topic", dest="input_topic", help="Topic")
     parser.add_argument("--message", default="Hello from mqtt5 sample", dest="input_message", help="Message payload")
     parser.add_argument("--count", default=5, dest="input_count",
                         help="Messages to publish (0 = infinite)")
+    parser.add_argument("--group_identifier", default="python-sample", dest="input_group_identifier", 
+                        help="The group identifier to use in the shared subscription (optional, default='python-sample').")
 
     # Proxy (optional)
     parser.add_argument("--proxy-host", dest="input_proxy_host", help="HTTP proxy host")
@@ -32,22 +39,14 @@ def parse_sample_input():
     # Misc
     parser.add_argument("--client-id", dest="input_clientId", default=f"test-{uuid.uuid4().hex[:8]}", 
                         help="Client ID to use for MQTT5 connection (optional, default=None). Note that '1', '2', and '3' will be added for to the given clientIDs since this sample uses 3 clients.")
-    
-    parser.add_argument("--group_identifier", default="python-sample", dest="input_group_identifier", 
-                        help="The group identifier to use in the shared subscription (optional, default='python-sample').")
 
     return parser.parse_args()
 
+# args contains all the parsed commandline arguments used by the sample
 args = parse_sample_input()
 
 # --------------------------------- ARGUMENT PARSING END -----------------------------------------
 
-from awscrt import mqtt5
-from awsiot import mqtt5_client_builder
-import threading
-from concurrent.futures import Future
-import time
-import json
 
 # For the purposes of this sample, we need to associate certain variables with a particular MQTT5 client
 # and to do so we use this class to hold all the data for a particular client used in the sample.

samples/shadow.py

@@ -1,15 +1,17 @@
 # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0.
 
-from awscrt import mqtt5, mqtt_request_response, io
 from awsiot import iotshadow, mqtt5_client_builder
+from awscrt import mqtt5, mqtt_request_response
 from concurrent.futures import Future
 from dataclasses import dataclass
 from typing import Optional
-import awsiot
+import awsiot, json, sys
+
+# --------------------------------- ARGUMENT PARSING -----------------------------------------
 import argparse
-import json
-import sys
+# --------------------------------- ARGUMENT PARSING END -----------------------------------------
+
 
 
 @dataclass