MuranoCLI 2.2.4 → 3.0.0

data/lib/MrMurano/ReCommander.rb

@@ -1,13 +1,25 @@
+# Last Modified: 2017.08.16 /coding: utf-8
+# frozen_string_literal: true
+
+# Copyright © 2016-2017 Exosite LLC.
+# License: MIT. See LICENSE.txt.
+#  vim:tw=0:ts=2:sw=2:et:ai
+
+require 'optparse'
+require 'MrMurano/optparse'
+
+require 'MrMurano/verbosing'
 
 module MrMurano
   class Hooked
     include Verbose
-    attr :section
 
     def initialize(section)
       @section = section
     end
 
+    attr_reader :section
+
     def check_run_pre_hook
       prehook = $cfg["#{section}.pre-hook"]
       return if prehook.nil?
@@ -23,37 +35,129 @@ module MrMurano
       verbose "calling post-hook: #{posthook}"
       system(posthook)
     end
-
   end
 end
 
 module Commander
+  class Command
+    # A command sets project_not_required if it
+    # can run from without a project directory.
+    attr_accessor :project_not_required
+    # A command sets restrict_to_cur_dir if it
+    # should not climb the directory hierarchy
+    # in search of a .murano/config file.
+    attr_accessor :restrict_to_cur_dir
+    # A command sets prompt_if_logged_off if it
+    # is okay to ask the user for their password.
+    attr_accessor :prompt_if_logged_off
+
+    def verify_arg_count!(args, max_args=0, mandatory=[])
+      if !max_args.nil? && max_args.zero?
+        if args.count > 0
+          MrMurano::Verbose.error('Not expecting any arguments')
+          exit 2
+        end
+      elsif !max_args.nil? && args.count > max_args
+        MrMurano::Verbose.error("Not expecting more than #{max_args} arguments")
+        exit 2
+      elsif args.count < mandatory.length
+        (args.count..(mandatory.length - 1)).to_a.each do |ix|
+          MrMurano::Verbose.error(mandatory[ix])
+        end
+        exit 2
+      end
+    end
+  end
+
   class Runner
-    alias :old_run_active_command :run_active_command
+    attr_accessor :command_exit
+
+    # run_active_command is called by commander-rb's at_exit hook.
+    # We override -- monkey patch -- it to do other stuff.
+    alias old_run_active_command run_active_command
     def run_active_command
+      exit @command_exit if @command_exit
       section = active_command.name
       hooked = MrMurano::Hooked.new(section)
       hooked.check_run_pre_hook
 
       begin
         old_run_active_command
+      rescue LocalJumpError => _err
+        # This happens when you `return` from a command, since
+        # commands are blocks, and returning from a block would
+        # really mean returning from the thing running the block,
+        # which would be bad. So Ruby barfs instead.
+        return
+      rescue OptionParser::InvalidArgument => err
+        MrMurano::Verbose.whirly_stop
+        MrMurano::Verbose.error err.message
+        exit 1
+      rescue OptionParser::InvalidOption => err
+        MrMurano::Verbose.whirly_stop
+        MrMurano::Verbose.error err.message
+        MrMurano::Verbose.error 'invalid command' if section == 'help'
+        exit 1
+      rescue OptionParser::MissingArgument => err
+        MrMurano::Verbose.whirly_stop
+        MrMurano::Verbose.error err.message
+        exit 1
+      rescue OptionParser::NeedlessArgument => err
+        MrMurano::Verbose.whirly_stop
+        MrMurano::Verbose.error err.message
+        pattern = /^needless argument: --(?<arg>[_a-zA-Z0-9]+)=(?<val>.*)/
+        md = pattern.match(err.message)
+        unless md.nil?
+          puts %(Try the option without the equals sign, e.g.,)
+          puts %(  --#{md[:arg]} "#{md[:val]}")
+        end
+        exit 1
       rescue MrMurano::ConfigError => err
-        puts err.message
+        # Clear whirly if it was running.
+        MrMurano::Verbose.whirly_stop
+        MrMurano::Verbose.error err.message
         exit 1
-      rescue StandardError => err
+      rescue StandardError => _err
         raise
       end
 
       hooked.check_run_post_hook
     end
 
-    alias :old_parse_global_options :parse_global_options
+    alias old_parse_global_options parse_global_options
     def parse_global_options
-      defopts = ($cfg["#{active_command.name}.options"] or '').split
-      @args.push( *defopts )
-      old_parse_global_options
+      defopts = ($cfg["#{active_command.name}.options"] || '').split
+      @args.push(*defopts)
+      begin
+        old_parse_global_options
+      rescue OptionParser::MissingArgument => err
+        if err.message.start_with?('missing argument:')
+          puts err.message
+        else
+          MrMurano::Verbose.error(
+            "There was a problem interpreting the options: ‘#{err.message}’"
+          )
+        end
+        exit 2
+      end
     end
+
+    # Weird. --help doesn't work if other flags also specified.
+    # E.g., this shows the help for usage:
+    #   $ murano --help usage
+    # but if a flag is added, the command gets run, e.g.,
+    #   $ murano usage --id 1234 --help
+    # ignores the --help and runs the usage command.
+    # ([lb] walked the code and it looks like when Commander tries to
+    # validate the args, it doesn't like the --id flag (maybe because
+    # the "help" command is being used to validate?). Then it removes
+    # the --id flags (after --help was previously removed) and tries
+    # the command *again* (in gems/commander-4.4.3/lib/commander/runner.rb,
+    # look for the comment, "Remove the offending args and retry").
+    #
+    # 2017-06-14: [lb] tried to override run! here to show help correctly
+    # in this use case, but I could not get it to work. Oh, well... a
+    # minor annoyance; just live with it, I guess.
   end
 end
 
-#  vim: set ai et sw=2 ts=2 :

data/lib/MrMurano/Setting.rb

@@ -0,0 +1,90 @@
+require 'MrMurano/verbosing'
+
+module MrMurano
+  class Setting
+    include Verbose
+
+    SERVICE_MAP = {
+      'Device2' => 'Gateway',
+    }.freeze
+
+    ## Map service names into actual class names.
+    #
+    # Some of the service names have changed over time and no longer match the class
+    # names that implement them. This maps them back, as well as correcting casing.
+    #
+    # @param service [String] User facing service name
+    # @return [String] Internal class name for service
+    def mapservice(service)
+      service = service.to_s.downcase
+      SERVICE_MAP.each_pair do |k, v|
+        if service == k.downcase || service == v.downcase
+          return v
+        end
+      end
+      return service.sub(/(.)(.*)/){"#{$1.upcase}#{$2.downcase}"}
+    end
+
+    def read(service, setting)
+      begin
+        debug %{Looking up class "MrMurano::#{mapservice(service)}::Settings"}
+        gb = Object::const_get("MrMurano::#{mapservice(service)}::Settings").new
+        meth = setting.to_sym
+        debug %{Looking up method "#{meth}"}
+        if gb.respond_to?(meth)
+          return gb.__send__(meth)
+        else
+          error "Unknown setting '#{setting}' on '#{service}'"
+        end
+      rescue NameError => e
+        error "No Settings on \"#{service}\""
+        if $cfg['tool.debug'] then
+          error e.message
+          error e.to_s
+        end
+      end
+    end
+
+    def write(service, setting, value)
+      begin
+        debug %(Looking up class "MrMurano::#{mapservice(service)}::Settings")
+        gb = Object::const_get("MrMurano::#{mapservice(service)}::Settings").new
+        meth = "#{setting}=".to_sym
+        debug %(Looking up method "#{meth}")
+        if gb.respond_to? meth then
+          return gb.__send__(meth, value)
+        else
+          error "Unknown setting '#{setting}' on '#{service}'"
+        end
+      rescue NameError => e
+        error %(No Settings on "#{service}")
+        if $cfg['tool.debug'] then
+          error e.message
+          error e.to_s
+        end
+      end
+    end
+
+    ##
+    # List all Settings classes and the accessors on them.
+    #
+    # This is for letting users know which things can be read and written in the
+    # settings command.
+    def list
+      result = {}
+      ::MrMurano.constants.each do |maybe|
+        begin
+          gb = Object::const_get("MrMurano::#{maybe}::Settings")
+          result[maybe] = gb.instance_methods(false).select{|i| i.to_s[-1] != '='}
+        rescue
+        end
+      end
+      result
+      # MAYBE/2017-08-17:
+      #   sort_by_name(result)
+    end
+  end
+end
+
+#  vim: set ai et sw=2 ts=2 :
+

data/lib/MrMurano/Solution-ServiceConfig.rb

@@ -1,33 +1,76 @@
+# Last Modified: 2017.08.17 /coding: utf-8
+# frozen_string_literal: true
+
+# Copyright © 2016-2017 Exosite LLC.
+# License: MIT. See LICENSE.txt.
+#  vim:tw=0:ts=2:sw=2:et:ai
+
 require 'MrMurano/Solution'
 
 module MrMurano
   # …/serviceconfig
   class ServiceConfig < SolutionBase
-    def initialize
+    def initialize(sid=nil)
       super
-      @uriparts << 'serviceconfig'
+      @uriparts << :serviceconfig
       @scid = nil
     end
 
-    def list
-      ret = get()
-      return [] if ret.is_a? Hash and ret.has_key? :error
+    def list(call=nil, data=nil, &block)
+      ret = get(call, data, &block)
+      return [] unless ret.is_a?(Hash) && !ret.key?(:error)
+      return [] unless ret.key?(:items)
       ret[:items]
+      # MAYBE/2017-08-17:
+      #   sort_by_name(ret[:items])
     end
+
+    def search(svc_name)
+      #path = nil
+      path = '?select=id,service,script_key'
+      # 2017-07-02: This is what yeti-ui queries on:
+      #path = '?select=service,id,solution_id,script_key,alias'
+      super(svc_name, path)
+    end
+
     def fetch(id)
       get('/' + id.to_s)
     end
 
     def scid_for_name(name)
-      name = name.to_s unless name.kind_of? String
-      scr = list().select{|i| i[:service] == name}.first
+      name = name.to_s unless name.is_a? String
+      scr = list.select { |i| i[:service] == name }.first
       return nil if scr.nil?
       scr[:id]
     end
 
     def scid
       return @scid unless @scid.nil?
-      @scid = scid_for_name(@serviceName)
+      @scid = scid_for_name(@service_name)
+    end
+
+    def create(pid, name=nil, &block) #? script_key?
+      name = pid if name.to_s.empty?
+      raise 'Missing name/script_key?' if name.to_s.empty?
+      # See pegasus_registry PostServiceConfig for the POST properties.
+      #   pegasus_registry/api/swagger/paths/serviceconfig.yaml
+      #   pegasus_registry/api/swagger/definitions/serviceconfig.yaml
+      post(
+        '/',
+        {
+          solution_id: @sid,
+          service: pid,
+          # 2017-06-26: "name" seems to work, but "script_key" is what web UI uses.
+          #   See yeti-ui/bridge/src/js/api/services.js::linkApplicationService
+          #name: name,
+          script_key: name,
+        },
+        &block
+      )
+    end
+
+    def remove(id)
+      delete("/#{id}")
     end
 
     def info(id=scid)
@@ -39,8 +82,8 @@ module MrMurano
     end
 
     def call(opid, meth=:get, data=nil, id=scid, &block)
-      raise "Service '#{@serviceName}' not enabled for this Solution" if id.nil?
-      call = "/#{id.to_s}/call/#{opid.to_s}"
+      raise "Service '#{@service_name}' not enabled for this Solution" if id.nil?
+      call = "/#{id}/call/#{opid}"
       debug "Will call: #{call}"
       case meth
       when :get
@@ -57,7 +100,6 @@ module MrMurano
         raise "Unknown method: #{meth}"
       end
     end
-
   end
 
   ## This is only used for debugging and deciphering APIs.
@@ -69,26 +111,29 @@ module MrMurano
   # A much better UI/UX happens with human intervention.
   # :nocov:
   class Services < SolutionBase
-    def initialize
+    def initialize(sid=nil)
       super
-      @uriparts << 'service'
+      @uriparts << :service
     end
 
     def sid_for_name(name)
-      name = name.to_s unless name.kind_of? String
-      scr = list().select{|i| i[:alias] == name}.first
+      name = name.to_s unless name.is_a? String
+      scr = list.select { |i| i[:alias] == name }.first
       scr[:id]
     end
 
     def sid
       return @sid unless @sid.nil?
-      @sid = sid_for_name(@serviceName)
+      @sid = sid_for_name(@service_name)
     end
 
     def list
-      ret = get()
-      return [] if ret.is_a? Hash and ret.has_key? :error
+      ret = get
+      return [] unless ret.is_a?(Hash) && !ret.key?(:error)
+      return [] unless ret.key?(:items)
       ret[:items]
+      # MAYBE/2017-08-17:
+      #   sort_by_name(ret[:items])
     end
 
     def schema(id=sid)
@@ -102,44 +147,43 @@ module MrMurano
       calls = []
       scm[:paths].each do |path, methods|
         methods.each do |method, params|
-          if params.kind_of?(Hash) then
-            call = [method]
-            call << path.to_s if all
-            call << params[:operationId]
-            call << (params['x-internal-use'.to_sym] or false) if all
-            calls << call
-          end
+          next unless params.is_a?(Hash)
+          call = [method]
+          call << path.to_s if all
+          call << params[:operationId]
+          call << (params['x-internal-use'.to_sym] || false) if all
+          calls << call
         end
       end
       calls
     end
+
+    def all_events
+      sevs = list
+      ret = []
+      sevs.each do |srv|
+        scm = schema(srv[:id]) || {}
+        (scm['x-events'.to_sym] || {}).each_pair do |event, _info|
+          ret << [srv[:alias], event]
+        end
+      end
+      ret
+    end
   end
   # :nocov:
 
-  # Device config interface for the assign commands.
-  class SC_Device < ServiceConfig
-    def initialize
+  class ServiceConfigApplication < ServiceConfig
+    def initialize(sid=nil)
+      @solntype = 'application.id'
       super
-      @serviceName = 'device'
     end
+  end
 
-    def assignTriggers(products)
-      details = fetch(scid)
-      products = [products] unless products.kind_of? Array
-      details[:triggers] = {:pid=>products}
-      details[:parameters] = {:pid=>products}
-
-      put('/'+scid, details)
-    end
-
-    def showTriggers
-      details = fetch(scid)
-
-      return [] if details[:triggers].nil?
-      details[:triggers][:pid]
+  class ServiceConfigProduct < ServiceConfig
+    def initialize(sid=nil)
+      @solntype = 'product.id'
+      super
     end
-
   end
 end
 
-#  vim: set ai et sw=2 ts=2 :