MuranoCLI 3.0.8 → 3.1.0.beta.1

data/lib/MrMurano/commands/solution_picker.rb

@@ -15,8 +15,8 @@ MSG_SOLUTIONS_NONE_FOUND = 'No solutions found' unless defined? MSG_SOLUTIONS_NO
 # *** For some commands: let user restrict to specific solution --type.
 # ---------------------------------------------------------------------
 
-def cmd_add_solntype_pickers(c, exclude_all: false)
-  # 2017-07-26: HA! The --type option can get masked by aliases.
+def cmd_add_solntype_pickers(cmd, exclude_all: false)
+  # 2017-07-26 (landonb): HA! The --type option can get masked by aliases.
   # For instance, if the option is required ("--type TYPE"), then
   #   murano domain --type product
   # fails, because the "domain product" alias steals the --type argument,
@@ -31,7 +31,7 @@ def cmd_add_solntype_pickers(c, exclude_all: false)
   allowed_types += [:all] unless exclude_all
   allowed_types.map!(&:to_s).sort!
   default = exclude_all && 'application' || 'all'
-  c.option(
+  cmd.option(
     '--type [TYPE]',
     allowed_types,
     %(Apply to solution(s) of type [#{allowed_types.join('|')}] (default: #{default}))
@@ -194,16 +194,16 @@ end
 # *** For murano init: specify --business, --application, and/or --product.
 # -------------------------------------------------------------------------
 
-def cmd_option_application_pickers(c)
-  c.option('--application-id ID', String, %(ID of Application to use))
-  c.option('--application-name NAME', String, %(Name of Application to use))
-  c.option('--application APPLICATION', String, %(Name or ID of Application to use))
+def cmd_option_application_pickers(cmd)
+  cmd.option('--application-id ID', String, %(ID of Application to use))
+  cmd.option('--application-name NAME', String, %(Name of Application to use))
+  cmd.option('--application APPLICATION', String, %(Name or ID of Application to use))
 end
 
-def cmd_option_product_pickers(c)
-  c.option('--product-id ID', String, %(ID of Product to use))
-  c.option('--product-name NAME', String, %(Name of Product to use))
-  c.option('--product PRODUCT', String, %(Name or ID of Product to use))
+def cmd_option_product_pickers(cmd)
+  cmd.option('--product-id ID', String, %(ID of Product to use))
+  cmd.option('--product-name NAME', String, %(Name of Product to use))
+  cmd.option('--product PRODUCT', String, %(Name or ID of Product to use))
 end
 
 def any_solution_pickers!(options)

data/lib/MrMurano/makePretty.rb

@@ -11,14 +11,17 @@ require 'highline'
 
 module MrMurano
   module Pretties
-    HighLine::Style.new(name: :on_aliceblue, code: "\e[48;5;231m", rgb: [240, 248, 255])
     PRETTIES_COLORSCHEME = HighLine::ColorScheme.new do |cs|
-      cs[:subject] = %i[red on_aliceblue]
-      cs[:timestamp] = [:blue]
       cs[:json] = [:magenta]
+      cs[:record_type] = [:magenta]
+      cs[:subject] = [:cyan]
+      cs[:timestamp] = [:blue]
+      cs[:tracking] = [:yellow]
     end
     HighLine.color_scheme = PRETTIES_COLORSCHEME
 
+    TERM_WIDTH, _rows = HighLine::SystemExtensions.terminal_size
+
     # rubocop:disable Style/MethodName: "Use snake_case for method names."
     def self.makeJsonPretty(data, options, indent: nil, object_nl: nil)
       if options.pretty
@@ -85,7 +88,14 @@ module MrMurano
       out + log_pretty_assemble_body(line, options)
     end
 
-    def self.fmt_text_padded(text, style, out, raw, min_width: 0)
+    def self.fmt_text_padded(text, style, out, raw, options, min_width: 0)
+      inter_spaces = (min_width == 0) && 0 || options.one_line && 1 || 3
+      min_width = text.length + inter_spaces unless options.align
+      if !options.one_line && options.align && min_width == 0
+        prefix = TERM_WIDTH - raw.length - text.length
+        out += ' ' * prefix
+        raw += ' ' * prefix
+      end
       padding = min_width - text.length
       padding = ' ' * (padding > 0 && padding || 0)
       out += HighLine.color(text, style) + padding
@@ -96,30 +106,31 @@ module MrMurano
     def self.log_pretty_assemble_header(line, options)
       out = ''
       raw = ''
-      out, raw = log_pretty_header_add_abbreviated_sev(line, out, raw, options)
-      out, raw = log_pretty_header_add_log_record_type(line, out, raw, options)
       out, raw = log_pretty_header_add_event_timestamp(line, out, raw, options)
       out, raw = log_pretty_header_add_murano_tracking(line, out, raw, options)
-      out, _raw = log_pretty_header_add_a_service_event(line, out, raw, options)
+      out, raw = log_pretty_header_add_log_record_type(line, out, raw, options)
+      out, raw = log_pretty_header_add_abbreviated_sev(line, out, raw, options)
+      out, raw = log_pretty_header_add_a_service_event(line, out, raw, options)
+      out, _raw = log_pretty_header_add_message(line, out, raw, options)
       out + "\n"
     end
 
-    def self.log_pretty_header_add_abbreviated_sev(line, out, raw, _options)
-      fmt_abbreviated_severity(line[:severity], out, raw)
+    def self.log_pretty_header_add_abbreviated_sev(line, out, raw, options)
+      fmt_abbreviated_severity(line[:severity], out, raw, options)
     end
 
-    def self.log_pretty_header_add_loquacious_sev(line, out, raw, _options)
-      fmt_loquacious_severity(line[:severity], out, raw)
+    def self.log_pretty_header_add_loquacious_sev(line, out, raw, options)
+      fmt_loquacious_severity(line[:severity], out, raw, options)
     end
 
-    def self.fmt_abbreviated_severity(severity, out, raw, min_width: 7)
+    def self.fmt_abbreviated_severity(severity, out, raw, options, min_width: 7)
       abbrev, _loquac, style = styled_severity(severity)
-      fmt_text_padded(abbrev, style, out, raw, min_width: min_width)
+      fmt_text_padded(abbrev, style, out, raw, options, min_width: min_width)
     end
 
-    def self.fmt_loquacious_severity(severity, min_width: 11)
+    def self.fmt_loquacious_severity(severity, out, raw, options, min_width: 11)
       _abbrev, loquac, style = styled_severity(severity)
-      fmt_text_padded(loquac, style, out, raw, min_width: min_width)
+      fmt_text_padded(loquac, style, out, raw, options, min_width: min_width)
     end
 
     def self.styled_severity(severity)
@@ -145,14 +156,16 @@ module MrMurano
       end
     end
 
-    def self.log_pretty_header_add_log_record_type(line, out, raw, _options)
+    def self.log_pretty_header_add_log_record_type(line, out, raw, options)
       log_type = line[:type].to_s.empty? && '--' || line[:type]
-      fmt_text_padded(log_type.upcase, :magenta, out, raw, min_width: 10)
+      fmt_text_padded(log_type.upcase, :record_type, out, raw, options, min_width: 10)
     end
 
     def self.log_pretty_header_add_event_timestamp(line, out, raw, options)
       curtime = fmt_log_record_timestamp(line, options)
-      fmt_text_padded(curtime, :timestamp, out, raw, min_width: 18)
+      inter_spaces = options.one_line && 1 || 3
+      min_width = curtime.length + inter_spaces
+      fmt_text_padded(curtime, :timestamp, out, raw, options, min_width: min_width)
     end
 
     def self.fmt_log_record_timestamp(line, options)
@@ -164,7 +177,9 @@ module MrMurano
           else
             curtime = time_secs_epoch.gmtime
           end
-          curtime = curtime.strftime('%Y-%m-%d %H:%M:%S')
+          format = options.sprintf
+          format = '%Y-%m-%d %H:%M:%S' if format.to_s.empty?
+          curtime = curtime.strftime(format)
         else
           curtime = line[:timestamp]
         end
@@ -177,23 +192,33 @@ module MrMurano
     def self.log_pretty_header_add_murano_tracking(line, out, raw, options)
       return [out, raw] unless options.tracking
       tid = line[:tracking_id].to_s.empty? && '--------' || line[:tracking_id].slice(0, 8)
-      fmt_text_padded(tid, :yellow, out, raw, min_width: 10)
+      fmt_text_padded(tid, :tracking, out, raw, options, min_width: 11)
     end
 
-    def self.log_pretty_header_add_a_service_event(line, out, raw, _options)
+    def self.log_pretty_header_add_a_service_event(line, out, raw, options)
+      pad = options.align && '    ' || ''
+      out += pad
+      raw += pad
       svc_evt = []
       svc_evt += [line[:service]] unless line[:service].to_s.empty?
       svc_evt += [line[:event]] unless line[:event].to_s.empty?
       svc_evt = "[#{svc_evt.join(' ').upcase}]"
-      out += HighLine.color(svc_evt, :subject)
-      raw += svc_evt
-      [out, raw]
+      fmt_text_padded(svc_evt, :subject, out, raw, options, min_width: 0)
+    end
+
+    def self.log_pretty_header_add_message(line, out, raw, options)
+      return [out, raw] unless options.one_line
+      return [out, raw] unless line.key?(:message) && !line[:message].to_s.empty?
+      msg = ' ' + line[:message]
+      [out + msg, raw + msg]
     end
 
     def self.log_pretty_assemble_body(line, options)
       out = ''
-      @body_prefix = '  '
+      return out if options.one_line
+      @body_prefix = options.indent && '  ' || ''
       out += log_pretty_assemble_message(line, options)
+      return out if options.message_only
       out += log_pretty_assemble_data(line, options)
       out += log_pretty_assemble_remainder(line, options)
       out + log_pretty_assemble_tracking_id(line, options)
@@ -219,7 +244,7 @@ module MrMurano
 
     def self.log_pretty_emphasize_entry(entry, hash, options)
       return '' unless hash.key?(entry) && !hash[entry].empty?
-      out = @body_prefix + "---------\n"
+      out = @body_prefix + "---------\n" if options.separators
       out += @body_prefix + "#{entry}: "
       out += log_pretty_json(hash[entry], options)
       out + "\n"
@@ -232,7 +257,7 @@ module MrMurano
       ]
       data = data.reject { |key, _val| known_keys.include?(key) }
       return '' if data.empty?
-      out = @body_prefix + "---------\n"
+      out = options.separators && (@body_prefix + "---------\n") || ''
       out + @body_prefix + 'data: ' + log_pretty_json(data, options) + "\n"
     end
 
@@ -253,13 +278,15 @@ module MrMurano
     end
 
     def self.log_pretty_assemble_tracking_id(line, options)
+      return '' unless options.tracking
       log_pretty_emphasize_entry(:tracking_id, line, options)
     end
 
     def self.log_pretty_json(hash, options)
       return '' if hash.empty?
+      prefix = @body_prefix.to_s.empty? && '  ' || @body_prefix
       makeJsonPretty(
-        hash, options, indent: @body_prefix, object_nl: "\n" + @body_prefix
+        hash, options, indent: prefix, object_nl: "\n" + @body_prefix
       )
     end
   end

data/lib/MrMurano/version.rb

@@ -26,7 +26,7 @@ module MrMurano
   #     '3.0.0-beta.2' is changed to '3.0.0.pre.beta.2'
   #   which breaks our build (which expects the version to match herein).
   #   So stick to using the '.pre.X' syntax, which ruby/gems knows.
-  VERSION = '3.0.8'
+  VERSION = '3.1.0.beta.1'
   EXE_NAME = File.basename($PROGRAM_NAME)
   SIGN_UP_URL = 'https://exosite.com/signup/'
 end

data/spec/fixtures/websocket/README.rst

@@ -0,0 +1,110 @@
+############################
+Murano CLI WebSocket Servers
+############################
+
+========
+Overview
+========
+
+There are 2 WebSocket servers under ``spec/fixtures/websocket/``:
+
+- ``wss-fake-logs.rb``: Run this for developing. It'll spit out a fake log record every second to any client that connect.
+
+- ``wss-echo.rb``: The spec tests use this to test the new logs command code. Whatever the server receives on stdin it just echos to any client that's connected.
+
+=====
+Usage
+=====
+
+From one terminal, start the fake logs server:
+
+.. code-block:: bash
+
+  cd /path/to/exosite-murcli/spec/fixtures/websocket
+
+  ./wss-fake-logs.rb
+
+From another terminal, you can use any WebSocket client.
+
+\1. Using Murano CLI.:
+
+.. code-block:: bash
+
+  murano logs -f -c net.host=127.0.0.1:4180 -c net.protocol=http --tracking --trace
+
+\2. Using ``esphen/wsta``:
+
+.. code-block:: bash
+
+  # Locally
+  wsta --ping 10 "ws://127.0.0.1:4180/path/does/not/matter?limit=1000"
+
+  # Against BizAPI.
+  wsta --ping 10 "wss://bizapi-dev.hosted.exosite.io/api/v1/solution/m1ti0dv29pb340000/logs?token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&limit=1000"
+
+\3. Using ``hashrocket/ws``:
+
+.. code-block:: bash
+
+  ws "wss://bizapi-dev.hosted.exosite.io/api/v1/solution/m1ti0dv29pb340000/logs?token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&limit=1000"
+
+-----------------
+Token Shenanigans
+-----------------
+
+To run ``murano logs`` locally, against 127.0.0.1, you'll probably
+need to disable the token mechanism.
+
+Add this to ``lib/MrMurano/Account.rb``::
+
+    def token_fetch
+      @token = 'XXX'
+      return
+
+=========================
+Non-Murano CLI WS Clients
+=========================
+
+---------------
+``esphen/wsta``
+---------------
+
+- ``esphen/wsta`` is a WebSocket CLI client written in Rust.
+
+  As of late 2017, it's 1 year old and appears to be the most sophisticated client.
+
+  https://github.com/esphen/wsta
+
+To install:
+
+.. code-block:: bash
+
+  sudo sh -c "echo 'deb http://download.opensuse.org/repositories/home:/esphen/xUbuntu_16.04/ /' > /etc/apt/sources.list.d/wsta.list"
+  wget -nv https://download.opensuse.org/repositories/home:esphen/xUbuntu_16.04/Release.key -O Release.key
+  sudo apt-key add - < Release.key
+  rm Release.key
+  sudo apt-get update
+  sudo apt-get install wsta
+
+-----------------
+``hashrocket/ws``
+-----------------
+
+- ``hashrocket/ws`` is WebSocket CLI client written in Go.
+
+  As of late 2017, it's 1 year old.
+
+  https://github.com/hashrocket/ws
+
+To install:
+
+.. code-block:: bash
+
+  go get -u github.com/hashrocket/ws
+
+---------------------------------------
+Browser-based "Simple WebSocket Client"
+---------------------------------------
+
+https://chrome.google.com/webstore/detail/simple-websocket-client/pfdhoblngboilpfeibdedpjgfnlcodoo?hl=en
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: MuranoCLI
 version: !ruby/object:Gem::Version
-  version: 3.0.8
+  version: 3.1.0.beta.1
 platform: ruby
 authors:
 - Michael Conrad Tadpol Tilstra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-19 00:00:00.000000000 Z
+date: 2018-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: certified
@@ -627,6 +627,7 @@ files:
 - spec/fixtures/syncable_content/modules/table_util.lua
 - spec/fixtures/syncable_content/routes/manyRoutes.lua
 - spec/fixtures/syncable_content/routes/singleRoute.lua
+- spec/fixtures/websocket/README.rst
 - spec/fixtures/websocket/logs_blather.rb
 - spec/fixtures/websocket/logs_faker.rb
 - spec/fixtures/websocket/simple_connection.rb
@@ -659,9 +660,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5.2