Fix nats-servers format in docs, examples, and specs

The Ruby MCollective server_resolver splits middleware_hosts on ':',
so 'nats://broker:4222' produces three elements instead of
two and breaks the NATS connection. The correct format is 'host:port'
without the nats:// prefix because the NATS connector adds the scheme
itself when constructing URIs.

Signed-off-by: nmburgan <13688219+nmburgan@users.noreply.github.com>

Author: nmburgan

developer-docs/choria/choria-transport-testing.md

@@ -146,7 +146,7 @@ libdir = /opt/puppetlabs/mcollective/plugins
 logger_type = console
 loglevel = warn
 securityprovider = choria
-plugin.choria.middleware_hosts = nats://primary.example.com:4222
+plugin.choria.middleware_hosts = primary.example.com:4222
 plugin.security.provider = file
 plugin.security.file.certificate = ~/.puppetlabs/etc/puppet/ssl/certs/<username>.mcollective.pem
 plugin.security.file.key = ~/.puppetlabs/etc/puppet/ssl/private_keys/<username>.mcollective.pem

documentation/choria-transport.md

@@ -52,8 +52,8 @@ targets:
       choria:
         collective: production
         nats-servers:
-          - nats://broker1:4222
-          - nats://broker2:4222
+          - broker1:4222
+          - broker2:4222
 ```
 
 If the config file is in one of the auto-detected locations (`~/.choriarc`,
@@ -97,7 +97,7 @@ targets:
 | `interpreters` | | Hash | (none) | File extension to interpreter mapping (e.g., `{".rb": "/usr/bin/ruby"}`). |
 | `mcollective-certname` | `--choria-mcollective-certname` | String | (auto) | Override the MCollective certname for Choria client identity. See [Non-root certname](#non-root-certname) below. |
 | `nats-connection-timeout` | `--nats-connection-timeout` | Integer | `30` | Seconds to wait for the TCP connection to the NATS broker. |
-| `nats-servers` | `--nats-servers` | String or Array | (from config file) | NATS broker addresses in `nats://host:port` format (comma-separated for multiple). Multiple servers provide failover if a broker is unavailable. Overrides the config file. |
+| `nats-servers` | `--nats-servers` | String or Array | (from config file) | NATS broker addresses in `host:port` format (comma-separated for multiple). Do not use the `nats://` prefix. Multiple servers provide failover if a broker is unavailable. Overrides the config file. |
 | `puppet-environment` | `--choria-puppet-environment` | String | `production` | Puppet environment for bolt_tasks file URIs. |
 | `rpc-timeout` | `--choria-rpc-timeout` | Integer | `30` | Seconds to wait for replies to individual RPC calls. |
 | `ssl-ca` | `--choria-ssl-ca` | String | (from config file) | CA certificate path for TLS. |

lib/bolt/bolt_option_parser.rb

@@ -1150,7 +1150,7 @@ def initialize(options)
         @options[:'command-timeout'] = timeout
       end
       define('--nats-servers SERVERS',
-             'NATS broker addresses in nats://host:port format (comma-separated for multiple).') do |servers|
+             'NATS broker addresses in host:port format (comma-separated for multiple). Do not use the nats:// prefix.') do |servers|
         @options[:'nats-servers'] = servers
       end
       define('--nats-connection-timeout SECONDS', Integer,

lib/bolt/config/transport/options.rb

@@ -286,13 +286,14 @@ module Options
           },
           "nats-servers" => {
             type: [String, Array],
-            description: "One or more NATS server addresses for the Choria transport. Overrides the middleware " \
-                         "hosts from the Choria client configuration file. Can be a single string or an array.",
+            description: "One or more NATS server addresses in host:port format for the Choria transport. " \
+                         "Do not use the nats:// prefix. Overrides the middleware hosts from the Choria " \
+                         "client configuration file. Can be a single string or an array.",
             items: {
               type: String
             },
             _plugin: true,
-            _example: ["nats://broker1:4222", "nats://broker2:4222"]
+            _example: ["broker1:4222", "broker2:4222"]
           },
           "native-ssh" => {
             type: [TrueClass, FalseClass],

schemas/bolt-defaults.schema.json

@@ -2167,7 +2167,7 @@
       ]
     },
     "nats-servers": {
-      "description": "One or more NATS server addresses for the Choria transport. Overrides the middleware hosts from the Choria client configuration file. Can be a single string or an array.",
+      "description": "One or more NATS server addresses in host:port format for the Choria transport. Do not use the nats:// prefix. Overrides the middleware hosts from the Choria client configuration file. Can be a single string or an array.",
       "oneOf": [
         {
           "type": [

schemas/bolt-inventory.schema.json

@@ -163,7 +163,7 @@
                       ]
                     },
                     "nats-servers": {
-                      "description": "One or more NATS server addresses for the Choria transport. Overrides the middleware hosts from the Choria client configuration file. Can be a single string or an array.",
+                      "description": "One or more NATS server addresses in host:port format for the Choria transport. Do not use the nats:// prefix. Overrides the middleware hosts from the Choria client configuration file. Can be a single string or an array.",
                       "oneOf": [
                         {
                           "type": [

spec/unit/config/transport/choria_spec.rb

@@ -37,12 +37,12 @@
     end
 
     it 'nats-servers accepts a string' do
-      data['nats-servers'] = 'nats://broker:4222'
+      data['nats-servers'] = 'broker:4222'
       expect { transport.new(data) }.not_to raise_error
     end
 
     it 'nats-servers accepts an array' do
-      data['nats-servers'] = ['nats://broker1:4222', 'nats://broker2:4222']
+      data['nats-servers'] = ['broker1:4222', 'broker2:4222']
       expect { transport.new(data) }.not_to raise_error
     end
 

spec/unit/transport/choria/client_spec.rb

@@ -75,12 +75,12 @@
     end
 
     it 'applies NATS server overrides to pluginconf' do
-      inventory.set_config(target, %w[choria nats-servers], %w[nats://broker1:4222 nats://broker2:4222])
+      inventory.set_config(target, %w[choria nats-servers], %w[broker1:4222 broker2:4222])
 
       transport.configure_client(target)
 
       mc_config = MCollective::Config.instance
-      expect(mc_config.pluginconf['choria.middleware_hosts']).to eq('nats://broker1:4222,nats://broker2:4222')
+      expect(mc_config.pluginconf['choria.middleware_hosts']).to eq('broker1:4222,broker2:4222')
     end
 
     it 'applies TLS overrides to pluginconf' do