Merge pull request #1456 from relu91/cli-enachements

Update CLI implementation with modern tooling and conventions

Author: relu91

Dockerfile

@@ -35,4 +35,4 @@ STOPSIGNAL SIGINT
 ENTRYPOINT [ "node", "dist/cli.js" ]
 CMD [ "-h" ]
 
-##  docker build -t wot-servient ./docker/Dockerfile
+##  docker build -t node-wot ./docker/Dockerfile

README.md

@@ -118,7 +118,7 @@ You can alternatively use node-wot via its command line interface (CLI). Please
 
 #### As global tool
 
-To make the `wot-servient` command available on your machine, install the CLI tool in the global scope:
+To make the `node-wot` command available on your machine, install the CLI tool in the global scope:
 
 ```
 npm i @node-wot/cli -g
@@ -140,16 +140,16 @@ Go into the repository:
 cd node-wot
 ```
 
-Build the Docker image named `wot-servient` from the `Dockerfile`:
+Build the Docker image named `node-wot` from the `Dockerfile`:
 
 ```
 npm run build:docker
 ```
 
-Run the wot-servient as a container:
+Run the `node-wot` as a container:
 
 ```
-docker run --rm wot-servient -h
+docker run --rm node-wot -h
 ```
 
 ## Examples
@@ -252,12 +252,12 @@ Can't find your preferred MediaType? More codecs can be easily added by implemen
 Run all the steps above including "Link Packages" and then run this:
 
 ```
-wot-servient -h
+node-wot -h
 cd examples/scripts
-wot-servient
+node-wot
 ```
 
-Without the "Link Packages" step, the `wot-servient` command is not available and `node` needs to be used (e.g., Windows CMD shell):
+Without the "Link Packages" step, the `node-wot` command is not available and `node` needs to be used (e.g., Windows CMD shell):
 
 ```
 # expose
@@ -277,9 +277,9 @@ First [build the docker image](#as-a-docker-image) and then run the counter exam
 
 ```
 # expose
-docker run -it --init -p 8080:8080/tcp -p 5683:5683/udp -v "$(pwd)"/examples:/srv/examples --rm wot-servient /srv/examples/scripts/counter.js
+docker run -it --init -p 8080:8080/tcp -p 5683:5683/udp -v "$(pwd)"/examples:/srv/examples --rm node-wot /srv/examples/scripts/counter.js
 # consume
-docker run -it --init -v "$(pwd)"/examples:/srv/examples --rm --net=host wot-servient /srv/examples/scripts/counter-client.js --client-only
+docker run -it --init -v "$(pwd)"/examples:/srv/examples --rm --net=host node-wot /srv/examples/scripts/counter-client.js --client-only
 ```
 
 -   The counter exposes the HTTP endpoint at 8080/tcp and the CoAP endpoint at 5683/udp and they are bound to the host machine (with `-p 8080:8080/tcp -p 5683:5683/udp`).

package-lock.json

@@ -14,7 +14,7 @@
         }
     },
     "scripts": {
-        "build": "tsc -b && npm run build -w packages/browser-bundle",
+        "build": "npm run build:transform -w packages/cli && tsc -b && npm run build -w packages/browser-bundle",
         "pretest": "npm run build",
         "start": "cd packages/cli && npm run start",
         "debug": "cd packages/cli && npm run debug",
@@ -31,8 +31,8 @@
         "prepare": "husky install",
         "publish": "npm publish --workspaces",
         "check:versions": "node utils/check_package_version_consistency.js",
-        "build:docker": "docker build -t wot-servient .",
-        "build:podman": "podman build -t wot-servient .",
+        "build:docker": "docker build -t node-wot .",
+        "build:podman": "podman build -t node-wot .",
         "clean:dist": "npm exec  --workspaces -- npx rimraf tsconfig.tsbuildinfo dist",
         "update:wot-typescript-definitions": "npx npm-check-updates  -u -f \"wot-typescript-definitions\" --deep",
         "link": "npm link -ws",

package.json

@@ -300,7 +300,7 @@ Please setup node-wot as described at the [node-wot main page](https://github.co
 -   example-mqtt-publish.js: Shows when node-wot acts as a MQTT Client that publishes data (latest counter value) to a broker.
     At the same time, another client can invoke an action, such as `resetCounter`, by sending a publication message to the topic of this action.
     This other client does not have to be node-wot, any MQTT client can interact with this Thing.
-    For node-wot clients, make sure to provide MQTT broker details (`host`, `port`, `username`, `password`, `clientId`) in the wot-servient.conf.json:
+    For node-wot clients, make sure to provide MQTT broker details (`host`, `port`, `username`, `password`, `clientId`) in the `node-wot.conf.json`:
 
 ```js
 {
@@ -315,11 +315,11 @@ Please setup node-wot as described at the [node-wot main page](https://github.co
 
 ```
 
-Start the script by the command `wot-servient mqtt-publish.js` or `node ../../packages/cli/dist/cli.js mqtt-publish.js`.
+Start the script by the command `node-wot mqtt-publish.js` or `node ../../packages/cli/dist/cli.js mqtt-publish.js`.
 
 -   example-mqtt-subscription.js: Shows how node-wot consumes a Thing Description to do MQTT subscription on the provided event (=latest counter value) as well as initiate the action (reset counter).
 
-Start the script by the command `wot-servient -c mqtt-subscribe.js` or `node ../../packages/cli/dist/cli.js -c mqtt-subscribe.js`.
+Start the script by the command `node-wot -c mqtt-subscribe.js` or `node ../../packages/cli/dist/cli.js -c mqtt-subscribe.js`.
 
 ### More Details
 

packages/binding-mqtt/README.md

@@ -65,7 +65,7 @@ export default class MqttBrokerServer implements ProtocolServer {
     private port = -1;
     private address?: string = undefined;
 
-    private brokerURI: string;
+    private brokerURI?: string;
 
     private readonly things: Map<string, ExposedThing> = new Map();
 
@@ -77,15 +77,14 @@ export default class MqttBrokerServer implements ProtocolServer {
     private hostedBroker?: net.Server;
 
     constructor(config: MqttBrokerServerConfig) {
-        this.config = config ?? this.defaults;
-        this.config.uri = this.config.uri ?? this.defaults.uri;
-
         // if there is a MQTT protocol indicator missing, add this
-        if (config.uri.indexOf("://") === -1) {
+        if (config.uri?.indexOf("://") === -1) {
             config.uri = this.scheme + "://" + config.uri;
         }
 
         this.brokerURI = config.uri;
+        this.config = config ?? this.defaults;
+        this.config.uri = this.config.uri ?? this.defaults.uri;
     }
 
     public async expose(thing: ExposedThing): Promise<void> {
@@ -446,6 +445,10 @@ export default class MqttBrokerServer implements ProtocolServer {
 
     private async startBroker() {
         return new Promise<void>((resolve, reject) => {
+            if (this.brokerURI == null) {
+                throw new Error("Unexpected configuration state. Broker was started but brokerURI is null");
+            }
+
             this.hostedServer = Server({});
             let server: tls.Server | net.Server;
             if (this.config.key) {

packages/binding-mqtt/src/mqtt-broker-server.ts

@@ -51,7 +51,7 @@ export interface MqttClientConfig {
 }
 
 export interface MqttBrokerServerConfig {
-    uri: string;
+    uri?: string;
     user?: string;
     psw?: string;
     clientId?: string;

packages/binding-mqtt/src/mqtt.ts

@@ -44,7 +44,7 @@ The Binding example in the `./examples` directory provides a TD (`netconf-thing.
 Depending on which NETCONF server is used, the following might have to be changed:
 
 -   IP address and port in `examples/netconf-thing.jsonld`
--   credentials for the NETCONF Thing (id `urn:dev:wot:org:eclipse:netconf-example`) have to be changed in `wot-servient.conf.json`.
+-   credentials for the NETCONF Thing (id `urn:dev:wot:org:eclipse:netconf-example`) have to be changed in `node-wot.conf.json`.
 
 ## New Form Fields for the NETCONF Binding
 
@@ -53,7 +53,7 @@ Depending on which NETCONF server is used, the following might have to be change
 The href contains: URI schema + IP address + port + XPath
 
 -   URI schema: the schema for NETCONF is not registered with IANA; the Binding is using `netconf`.
--   IP address and port: IP address and port of the NETCONF server. The credentials for the SSH connection to the server can be added into the `wot-servient.configuration.json`.
+-   IP address and port: IP address and port of the NETCONF server. The credentials for the SSH connection to the server can be added into the `node-wot.configuration.json`.
 -   XPath: the XPath of the YANG model node addressed by the given InteractionAffordance. The XPath is automatically converted into the corresponding XML needed by the RPC. If an attribute refers to a particular namespace, an alias can be used. The complete URN for the alias should be added to the **nc:NSs** field.
 
 ### nc:target

packages/binding-netconf/README.md

@@ -169,7 +169,7 @@ async function cleanup() {
 
 function controlTestServient() {
     return {
-        name: "wot-servient",
+        name: "node-wot",
 
         async executeCommand({ command }) {
             switch (command) {

packages/browser-bundle/web-test-runner.config.mjs

@@ -0,0 +1,2 @@
+src/generated
+test/resources