Split the PubSub sample down into smaller samples (#231)

Splits the pub-sub sample into smaller connect samples and simplifies the sample where possible. Commit log: * Split pub-sub sample into smaller connect samples, simplified samples where possible * Fixed codebuild tests * Fixed websocket region using incorrect name, fixed issue with websocket code build test * Fixed minor grammar mistake in README

Author: TwistedTwigleg

codebuild/samples/pubsub-linux.shrenamed to codebuild/samples/connect-linux.sh

@@ -4,16 +4,22 @@ set -e
 
 env
 
-pushd$CODEBUILD_SRC_DIR/samples/node/pub_sub
+pushd$CODEBUILD_SRC_DIR/samples/node/basic_connect
 
 ENDPOINT=$(aws secretsmanager get-secret-value --secret-id "unit-test/endpoint" --query "SecretString"| cut -f2 -d":"| sed -e 's/[\\\"\}]//g')
 
 npm install --unsafe-perm
 
-echo"Mqtt Direct test"
+echo"Connect Basic (Direct) test"
 node dist/index.js --endpoint $ENDPOINT --key /tmp/privatekey.pem --cert /tmp/certificate.pem
 
-echo"Websocket test"
-node dist/index.js --endpoint $ENDPOINT --use_websocket --signing_region us-east-1
+popd
+
+pushd$CODEBUILD_SRC_DIR/samples/node/websocket_connect
+
+npm install --unsafe-perm
+
+echo"Connect Websocket test"
+node dist/index.js --endpoint $ENDPOINT --signing_region us-east-1
 
 popd

codebuild/samples/linux-smoke-tests.yml

@@ -8,7 +8,7 @@ phases:
 commands:
  - echo Build started on `date`
  - $CODEBUILD_SRC_DIR/codebuild/samples/setup-linux.sh
- - $CODEBUILD_SRC_DIR/codebuild/samples/pubsub-linux.sh
+ - $CODEBUILD_SRC_DIR/codebuild/samples/connect-linux.sh
 post_build:
 commands:
- - echo Build completed on `date`
+ - echo Build completed on `date`

samples/README.md

@@ -2,7 +2,9 @@
 
 *[pub_sub](#nodepub_sub)
 *[pub_sub_js](#nodepub_sub_js)
-*[pub_sub_pkcs11](#nodepub_sub_pkcs11)
+*[basic_connect](#basic_connect)
+*[websocket_connect](#websocket_connect)
+*[pkcs11_connect](#websocket_pkcs11)
 *[shadow](#nodeshadow)
 *[fleet provisioning](#fleet-provisioning)
 *[basic discovery](#nodebasic_discovery)
@@ -99,14 +101,93 @@ npm install
 node index.js --endpoint <endpoint> --ca_file <file> --cert <file> --key <file>
 ```
 
-## Node/pub_sub_pkcs11
+## Node/Basic_Connect
 
-This sample is similar to [pub_sub](#nodepub_sub),
-but the private key for mutual TLS is stored on a PKCS#11 compatible smart card or hardware security module (HSM)
+This sample creates a basic MQTT connection using a certificate and key file.
+On startup, the device connects and then disconnects from the AWS server. This
+sample is for reference on connecting via certificate and key files.
+
+Source: `samples/node/basic_connect`
+
+Run the sample like this:
+```sh
+npm install
+node dist/index.js --endpoint <endpoint> --ca_file <file> --cert <file> --key <file>
+```
+
+Your Thing's
+[Policy](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html)
+must provide privileges for this sample to connect, subscribe, publish,
+and receive.
+<details>
+<summary>(see sample policy)</summary>
+<pre>
+{
+ "Version": "2012-10-17",
+ "Statement": [
+ {
+ "Effect": "Allow",
+ "Action": [
+ "iot:Connect"
+ ],
+ "Resource": [
+ "arn:aws:iot:<b>region</b>:<b>account</b>:client/test-*"
+ ]
+ }
+ ]
+}
+</pre>
+</details>
+
+## Node/Websocket_Connect
+
+This sample creates a basic MQTT connection using websockets.
+On startup, the device connects and then disconnects from the AWS server. This
+sample is for reference on connecting via websockets.
+
+Source: `samples/node/websocket_connect`
+
+Run the sample like this:
+```sh
+npm install
+node dist/index.js --endpoint <endpoint> --ca_file <file> --signing_region <signing region>
+```
+
+Your Thing's
+[Policy](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html)
+must provide privileges for this sample to connect, subscribe, publish,
+and receive.
+<details>
+<summary>(see sample policy)</summary>
+<pre>
+{
+ "Version": "2012-10-17",
+ "Statement": [
+ {
+ "Effect": "Allow",
+ "Action": [
+ "iot:Connect"
+ ],
+ "Resource": [
+ "arn:aws:iot:<b>region</b>:<b>account</b>:client/test-*"
+ ]
+ }
+ ]
+}
+</pre>
+</details>
+
+## Node/Pkcs11_Connect
+
+This sample is similar to the basic connect sample, but the private key for mutual TLS is stored on
+a PKCS#11 compatible smart card or hardware security module (HSM).
+
+On startup, the device connects and then disconnects from the AWS server. This
+sample is for reference on connecting via websockets.
 
 WARNING: Unix only. Node only. Currently, TLS integration with PKCS#11 is only available on Unix devices.
 
-Source: `samples/node/pub_sub_pkcs11`
+Source: `samples/node/pkcs11_connect`
 
 To run this sample using [SoftHSM2](https://www.opendnssec.org/softhsm/) as the PKCS#11 device:
 
@@ -163,8 +244,31 @@ To run this sample using [SoftHSM2](https://www.opendnssec.org/softhsm/) as the
 5) Now you can run the sample:
 ```sh
  npm install
- node dist/index.js --endpoint <xxxx-ats.iot.xxxx.amazonaws.com> --root-ca <AmazonRootCA1.pem> --cert <certificate.pem.crt> --pkcs11_lib <libsofthsm2.so> --pin <user-pin> --token_label <token-label> --key_label <key-label>
-```
+ node dist/index.js --endpoint <endpoint> --ca_file <AmazonRootCA1.pem> --cert <certificate.pem.crt> --pkcs11_lib <libsofthsm2.so> --pin <user-pin> --token_label <token-label> --key_label <key-label>
+
+Your Thing's
+[Policy](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html)
+must provide privileges for this sample to connect, subscribe, publish,
+and receive.
+<details>
+<summary>(see sample policy)</summary>
+<pre>
+{
+ "Version": "2012-10-17",
+ "Statement": [
+ {
+ "Effect": "Allow",
+ "Action": [
+ "iot:Connect"
+ ],
+ "Resource": [
+ "arn:aws:iot:<b>region</b>:<b>account</b>:client/test-*"
+ ]
+ }
+ ]
+}
+</pre>
+</details>
 
 ## Node/shadow
 

samples/node/basic_connect/index.ts

@@ -0,0 +1,64 @@
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
+
+import{mqtt}from'aws-iot-device-sdk-v2';
+import{iot}from'aws-iot-device-sdk-v2';
+import{http}from'aws-iot-device-sdk-v2';
+
+typeArgs={[index: string]: any};
+
+constyargs=require('yargs');
+
+// The relative path is '../../util/cli_args' from here, but the compiled javascript file gets put one level
+// deeper inside the 'dist' folder
+constcommon_args=require('../../../util/cli_args');
+
+yargs.command('*',false,(yargs: any)=>{
+yargs.usage("Connect using certificate and private key files.");
+common_args.add_universal_arguments(yargs);
+common_args.add_common_mqtt_arguments(yargs);
+common_args.add_direct_tls_connect_arguments(yargs,true);
+common_args.add_proxy_arguments(yargs);
+},main).parse();
+
+// Creates and returns a MQTT connection using a certificate file and key file
+functionbuild_connection(argv: Args): mqtt.MqttClientConnection{
+letconfig_builder=iot.AwsIotMqttConnectionConfigBuilder.new_mtls_builder_from_path(argv.cert,argv.key);
+
+if(argv.proxy_host){
+config_builder.with_http_proxy_options(newhttp.HttpProxyOptions(argv.proxy_host,argv.proxy_port));
+}
+if(argv.ca_file!=null){
+config_builder.with_certificate_authority_from_path(undefined,argv.ca_file);
+}
+
+config_builder.with_clean_session(false);
+config_builder.with_client_id(argv.client_id||"test-"+Math.floor(Math.random()*100000000));
+config_builder.with_endpoint(argv.endpoint);
+constconfig=config_builder.build();
+
+constclient=newmqtt.MqttClient();
+returnclient.new_connection(config);
+}
+
+asyncfunctionmain(argv: Args){
+common_args.apply_sample_arguments(argv);
+constconnection=build_connection(argv);
+
+// force node to wait 20 seconds before killing itself, promises do not keep node alive
+// ToDo: we can get rid of this but it requires a refactor of the native connection binding that includes
+// pinning the libuv event loop while the connection is active or potentially active.
+consttimer=setInterval(()=>{},20*1000);
+
+console.log("Connecting...");
+awaitconnection.connect()
+console.log("Connection completed.");
+console.log("Disconnecting...");
+awaitconnection.disconnect()
+console.log("Disconnect completed.");
+
+// Allow node to die if the promise above resolved
+clearTimeout(timer);
+}

samples/node/pub_sub_pkcs11/package.jsonrenamed to samples/node/basic_connect/package.json

@@ -1,7 +1,7 @@
 {
-"name": "pub-sub-pkcs11",
+"name": "basic-connect",
 "version": "1.0.0",
-"description": "NodeJS IoT SDK v2 Pub Sub with PKCS#11 Sample",
+"description": "NodeJS IoT SDK v2 Basic Connect Sample",
 "homepage": "https://github.com/aws/aws-iot-device-sdk-js-v2",
 "repository": {
 "type": "git",

samples/node/pub_sub_pkcs11/tsconfig.jsonrenamed to samples/node/basic_connect/tsconfig.json

@@ -8,9 +8,17 @@ import { TextDecoder } from 'util';
 
 typeArgs={[index: string]: any};
 
+// The relative path is '../../util/cli_args' from here, but the compiled javascript file gets put one level
+// deeper inside the 'dist' folder
+constcommon_args=require('../../../util/cli_args');
+
 constyargs=require('yargs');
 yargs.command('*',false,(yargs: any)=>{
-yargs.option('ca_file',{
+common_args.add_universal_arguments(yargs);
+common_args.add_topic_message_arguments(yargs);
+
+yargs
+.option('ca_file',{
 alias: 'r',
 description: '<path>: path to a Root CA certificate file in PEM format (optional, system trust store used by default).',
 type: 'string',
@@ -34,50 +42,22 @@ yargs.command('*', false, (yargs: any) => {
 type: 'string',
 required: true
 })
-.option('topic',{
-alias: 't',
-description: 'Targeted topic (optional).',
-type: 'string',
-default: 'test/topic'
-})
 .option('mode',{
 alias: 'm',
 description: 'Mode options: [publish, subscribe, both] (optional).',
 type: 'string',
 default: 'both',
 choices: ['publish','subscribe','both']
 })
-.option('message',{
-alias: 'M',
-description: 'Message to publish (optional).',
-type: 'string',
-default: 'Hello world!'
-})
 .option('region',{
-description: 'AWS Region (optional).',
-type: 'string',
-default: 'us-east-1'
-})
-.option('count',{
-description: 'Maximum number of publishes to send (optional).',
-type: 'number',
-default: 10
+description: 'AWS Region.',
+type: 'string'
 })
 .option('print_discover_resp_only',{
 description: 'Only print the response from Greengrass discovery (optional).',
 type: 'boolean',
 default: false
 })
-.option('verbose',{
-alias: 'v',
-description: 'Verbose output (optional).',
-type: 'string',
-default: 'none',
-choices: ['fatal','error','warn','info','debug','trace','none']
-})
-.help()
-.alias('help','h')
-.showHelpOnFail(false)
 },main).parse();
 
 functionfirstResolved<T>(promises: Promise<T>[]){
@@ -181,7 +161,7 @@ async function execute_session(connection: mqtt.MqttClientConnection, argv: Args
 
 asyncfunctionmain(argv: Args){
 if(argv.verbose!='none'){
-constlevel: io.LogLevel=parseInt(io.LogLevel[argv.verbose.toUpperCase()]);
+constlevel: io.LogLevel=parseInt(io.LogLevel[argv.verbose.toUpperCase()]);
 io.enable_logging(level);
 }
 
@@ -198,7 +178,7 @@ async function main(argv: Args) {
 constdiscovery=newgreengrass.DiscoveryClient(client_bootstrap,socket_options,tls_ctx,argv.region);
 
 // force node to wait 60 seconds before killing itself, promises do not keep node alive
-consttimer=setTimeout(()=>{},60*1000);
+consttimer=setTimeout(()=>{},60*1000);
 
 awaitdiscovery.discover(argv.thing_name)
 .then(async(discovery_response: greengrass.model.DiscoverResponse)=>{