MuranoCLI 3.0.7 → 3.0.8

data/spec/cmd_usage_spec.rb

@@ -1,13 +1,12 @@
-# Last Modified: 2017.09.12 /coding: utf-8
+# Copyright © 2016-2017 Exosite LLC. All Rights Reserved
+# License: PROPRIETARY. See LICENSE.txt.
 # frozen_string_literal: true
 
-# Copyright © 2016-2017 Exosite LLC.
-# License: MIT. See LICENSE.txt.
-#  vim:tw=0:ts=2:sw=2:et:ai
+# vim:tw=0:ts=2:sw=2:et:ai
+# Unauthorized copying of this file is strictly prohibited.
 
 require 'fileutils'
 require 'open3'
-require 'pathname'
 require 'cmd_common'
 
 RSpec.describe 'murano usage', :cmd, :needs_password do

data/spec/fixtures/dumped_config

@@ -7,6 +7,7 @@ outformat = best
 
 [net]
 host = bizapi.hosted.exosite.io
+protocol = https
 
 [location]
 base = <%= File.realpath(@project_dir) %>

data/spec/fixtures/websocket/logs_blather.rb

@@ -0,0 +1,27 @@
+# Copyright © 2016-2017 Exosite LLC. All Rights Reserved
+# frozen_string_literal: true
+
+# License: PROPRIETARY. See LICENSE.txt.
+# Unauthorized copying of this file is strictly prohibited.
+# vim:tw=0:ts=2:sw=2:et:ai
+
+require 'json'
+
+require 'eventmachine'
+
+require_relative 'simple_connection'
+require_relative 'logs_faker'
+
+class LogsBlatherConnection < SimpleWebSocket::SimpleConnection
+  include LogsFakerModule
+  def conn_on_open(event)
+    super(event)
+    _timer = EventMachine::PeriodicTimer.new(1) do
+      resp = JSON.generate(random_example)
+      @driver.text(resp)
+      # If we needed to stop the timer:
+      #   _timer.cancel
+    end
+  end
+end
+

data/spec/fixtures/websocket/logs_faker.rb

@@ -0,0 +1,153 @@
+# Copyright © 2016-2017 Exosite LLC. All Rights Reserved
+# frozen_string_literal: true
+
+# License: PROPRIETARY. See LICENSE.txt.
+# Unauthorized copying of this file is strictly prohibited.
+# vim:tw=0:ts=2:sw=2:et:ai
+
+module LogsFakerModule
+  def initialize
+    super
+    @examples = [
+      example_type_script,
+      example_type_call,
+      example_type_event,
+      example_type_config_device_v1,
+      example_type_config_null,
+      example_type_config_newservice,
+      example_severity_build(0),
+      example_severity_build(1),
+      example_severity_build(2),
+      example_severity_build(3),
+      example_severity_build(4),
+      example_severity_build(5),
+      example_severity_build(6),
+      example_severity_build(7),
+      example_severity_build(8),
+    ]
+  end
+
+  def random_example
+    @examples[Random.rand(@examples.length)]
+  end
+
+  # The examples below are from the Service & Script Debug Log RFC:
+  #   https://docs.google.com/document/d/1mlLSLXJj0lMDqpblzEwfAew_G8C3e5HCtAgjyyrGaKc/edit#heading=h.nrw8qx9k0clk
+
+  def example_type_script
+    {
+      type: 'script',
+      timestamp: 1_474_489_282_537,
+      severity: 6, # info
+      message: 'abc from lua',
+      tracking_id: '<UUID>',
+      service: 'webservice',
+      event: 'request',
+      data: { # Type specific
+        endpoint: 'GET:/index',
+        location: 'GET:/index:123',
+        elapsed: 10,
+      },
+    }
+  end
+
+  def example_type_call
+    {
+      type: 'call',
+      timestamp: 1_474_489_282_537,
+      severity: 3, # error
+      message: 'Service Call failed with error: timeout',
+      tracking_id: '<UUID>',
+      service: 'keystore',
+      event: 'get', # The operation id
+      data: { # Type specific
+        request: '{..}',
+        response: '{..}',
+        code: 504,
+      },
+    }
+  end
+
+  def example_type_event
+    {
+      type: 'event',
+      timestamp: 1_474_489_282_537,
+      severity: 3, # error
+      message: 'Event trigger failed with: event handler not found',
+      tracking_id: '<UUID>',
+      service: 'timer',
+      event: 'timer',
+      data: { # Type specific
+        request: '<incoming payload>',
+        response: '<lua response payload>',
+        code: 404,
+      },
+    }
+  end
+
+  def example_type_config_device_v1
+    {
+      type: 'config',
+      timestamp: 1_474_489_282_537,
+      severity: 4, # warning
+      message: "The service 'Device' used by the solution has been deprecated. Refer to the Service documentation for more information.",
+      tracking_id: '<UUID>',
+      service: 'deviceV1',
+      event: nil,
+      data: {},
+    }
+  end
+
+  def example_type_config_null
+    {
+      type: 'config',
+      timestamp: 1_474_489_282_537,
+      severity: 5, # notice
+      message: 'The module ‘util’ has been updated',
+      tracking_id: '<UUID>',
+      service: nil, # if eventhandler here fill the service alias
+      event: nil, # if eventhandler script here fill the event
+      data: {
+        module: 'util',
+        code: 200,
+      },
+    }
+  end
+
+  def example_type_config_newservice
+    {
+      type: 'config',
+      timestamp: 1_474_489_282_537,
+      severity: 5, # notice
+      message: 'The service ‘newservice’ has been added to the solution',
+      tracking_id: '<UUID>',
+      service: 'newservice',
+      event: nil,
+      data: {
+        parameters: {},
+        code: 200,
+      },
+    }
+  end
+
+  def example_severity_build(severity)
+    {
+      type: 'config',
+      timestamp: 1_474_489_282_537,
+      severity: severity,
+      message: 'The service ‘newservice’ has been added to the solution',
+      tracking_id: '<UUID>',
+      service: 'websocket',
+      event: '/api/v1/foo/long/event/name',
+      data: {
+        parameters: {},
+        code: 200,
+      },
+    }
+  end
+end
+
+class LogsFaker
+  include LogsFakerModule
+end
+

data/spec/fixtures/websocket/simple_connection.rb

@@ -0,0 +1,45 @@
+# Copyright © 2016-2017 Exosite LLC. All Rights Reserved
+# frozen_string_literal: true
+
+# License: PROPRIETARY. See LICENSE.txt.
+# Unauthorized copying of this file is strictly prohibited.
+# vim:tw=0:ts=2:sw=2:et:ai
+
+require 'eventmachine'
+require 'websocket/driver'
+
+module SimpleWebSocket
+  class SimpleConnection < EventMachine::Connection
+    def initialize
+      @driver = WebSocket::Driver.server(self)
+
+      @driver.on :connect, &method(:conn_on_open)
+
+      @driver.on :message, (lambda do |e|
+        @driver.text(e.data)
+      end)
+
+      @driver.on :close, (lambda do |_e|
+        close_connection_after_writing
+      end)
+    end
+
+    def receive_data(data)
+      @driver.parse(data)
+    end
+
+    def write(data)
+      send_data(data)
+    end
+
+    def conn_on_open(event)
+      if WebSocket::Driver.websocket?(@driver.env)
+        @driver.start
+      else
+        # Other HTTP requests.
+        warn "WARNING: unhandled request: #{event}"
+      end
+    end
+  end
+end
+

data/spec/fixtures/websocket/simple_options.rb

@@ -0,0 +1,77 @@
+# Copyright © 2016-2017 Exosite LLC. All Rights Reserved
+# frozen_string_literal: true
+
+# License: PROPRIETARY. See LICENSE.txt.
+# Unauthorized copying of this file is strictly prohibited.
+# vim:tw=0:ts=2:sw=2:et:ai
+
+require 'optparse'
+
+require_relative 'simple_server'
+
+module SimpleWebSocket
+  class Options
+    def initialize
+      reset_opts
+    end
+
+    def reset_opts
+      @options = {
+        behave: '',
+        timeout: 0,
+      }
+      @options[:port] = SimpleWebSocket::Server::DEFAULT_WS_PORT
+    end
+
+    def setup_and_parse_opts
+      opt_parser = OptionParser.new do |parser|
+        parser.banner = "Usage: #{File.basename($PROGRAM_NAME)} [options]"
+        opt_setup_help(parser)
+        opt_setup_behavior(parser)
+        opt_setup_timeout(parser)
+      end
+      opt_parser.parse!
+      # The optparse library pulls values out of ARGV, so if we wanted to
+      #   use positional parameters, we could inspect ARGV. But we don't.
+      @options
+    end
+
+    def opt_setup_help(parser)
+      parser.on('-h', '--help', 'Show this help message') do
+        puts parser
+      end
+    end
+
+    def opt_setup_behavior(parser)
+      parser.on(
+        '-b',
+        '--behavior FLAVOR',
+        "[reserved] How to behave. We probably don't need this..."
+      ) do |flavor|
+        @options[:behave] = flavor
+      end
+    end
+
+    def opt_setup_port(parser)
+      def_port = SimpleWebSocket::Server::DEFAULT_WS_PORT
+      parser.on(
+        '-p',
+        '--port PORT',
+        "Port on which to run server. Default: #{def_port}"
+      ) do |msecs|
+        @options[:timeout] = msecs.to_i / 1000.0
+      end
+    end
+
+    def opt_setup_timeout(parser)
+      parser.on(
+        '-t',
+        '--timeout MSECS',
+        'How long to run before exiting. O to run forever.'
+      ) do |msecs|
+        @options[:timeout] = msecs.to_i / 1000.0
+      end
+    end
+  end
+end
+

data/spec/fixtures/websocket/simple_server.rb

@@ -0,0 +1,69 @@
+# Copyright © 2016-2017 Exosite LLC. All Rights Reserved
+# frozen_string_literal: true
+
+# License: PROPRIETARY. See LICENSE.txt.
+# Unauthorized copying of this file is strictly prohibited.
+# vim:tw=0:ts=2:sw=2:et:ai
+
+require 'eventmachine'
+require 'faye/websocket'
+require 'websocket/driver'
+
+begin
+  # From RSpec.
+  require 'fixtures/websocket/simple_connection'
+rescue LoadError
+  # From invocation.
+  require_relative 'simple_connection'
+end
+
+module SimpleWebSocket
+  class Server
+    DEFAULT_WS_PORT = 4180
+
+    attr_writer :connection
+
+    def initialize(options={}, connection=SimpleWebSocket::SimpleConnection)
+      @options = options
+      @connection = connection
+    end
+
+    def start_timer
+      return if !@options[:timeout] || @options[:timeout] <= 0
+      _timer = EventMachine::Timer.new(@options[:timeout]) do
+        EM.stop_event_loop
+      end
+    end
+
+    def start_server
+      trap_interrupt
+      trap_termination
+      start_event_loop
+    end
+
+    def trap_interrupt
+      Signal.trap('INT') do
+        EM.stop_event_loop
+      end
+    end
+
+    def trap_termination
+      Signal.trap('TERM') do
+        EM.stop_event_loop
+      end
+    end
+
+    def start_event_loop
+      EM.run do
+        start_timer
+        EM.start_server(
+          '127.0.0.1',
+          @options[:port],
+          @connection
+        )
+      end
+      # EM event loop runs until we tell it to stop.
+    end
+  end
+end
+

data/spec/fixtures/websocket/wss-echo.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+# Copyright © 2016-2017 Exosite LLC. All Rights Reserved
+# frozen_string_literal: true
+
+# License: PROPRIETARY. See LICENSE.txt.
+# Unauthorized copying of this file is strictly prohibited.
+# vim:tw=0:ts=2:sw=2:et:ai
+
+require 'json'
+
+require 'eventmachine'
+
+require_relative 'simple_connection'
+require_relative 'simple_options'
+
+module EchoReceiver
+  def initialize(driver)
+    @driver = driver
+  end
+
+  def receive_data(data)
+    # If we don't encode correctly, websocket-driver barfs. E.g., if we
+    # tried to transmit "something with ‘curly quotes’", we'd get:
+    #   `encode': "\xE2" from ASCII-8BIT to UTF-8 (Encoding::UndefinedConversionError)
+    msg = data.chomp.force_encoding('UTF-8')
+    puts "receive_data: #{msg}"
+    # (landonb): What does the parse method do? I don't think we care.
+    #   @driver.parse(data)
+    EM.stop_event_loop if msg == 'EXIT'
+    @driver.text(msg)
+  end
+end
+
+class WSStdinPassthru < SimpleWebSocket::SimpleConnection
+  def conn_on_open(event)
+    super(event)
+    EM.attach $stdin, EchoReceiver, @driver
+  end
+end
+
+def main
+  options = SimpleWebSocket::Options.new.setup_and_parse_opts
+  ws_svr = SimpleWebSocket::Server.new(options, WSStdinPassthru)
+  ws_svr.start_server
+end
+
+main
+