MuranoCLI 3.2.0.beta.1 → 3.2.0.beta.5

data/lib/MrMurano/Exchange.rb

@@ -6,6 +6,7 @@
 # Unauthorized copying of this file is strictly prohibited.
 
 require 'MrMurano/AccountBase'
+require 'MrMurano/Business'
 require 'MrMurano/Exchange-Element'
 require 'MrMurano/verbosing'
 
@@ -19,56 +20,47 @@ module MrMurano
       super
     end
 
+    def put(element_id, body={}, &block)
+      super('exchange/' + bid + '/element/' + element_id, body, &block)
+    end
+
     def element(element_id)
+      element_by_id(element_id)
+    end
+
+    def element_by_id(element_id)
       ret = get('exchange/' + bid + '/element/' + element_id)
       return nil unless ret.is_a?(Hash) && !ret.key?(:error)
       ret
     end
 
-    def fetch_type(part)
-      # [lb] not super happy about mixing presentation with other logic
-      # but this is quick and dirty.
-      case part
-      when '/element/'
-        qualifier = 'All'
-      when '/purchase/'
-        qualifier = 'Purchased'
-      else
-        raise 'Unexpected error'
-      end
-      whirly_start("Fetching #{qualifier} Elements...")
+    def element_quick(element_id)
+      # Check if ID, a 24-character hexadecimal string.
+      smells_like_id = element_id =~ /^[\h]{24}$/
+      return element_by_id(element_id) if smells_like_id
+      nil
+    end
 
-      # FIXME/2017-09-27: Support Pagination. BizAPI accepts four settings:
-      #                     type, offset, limit, and select.
-      #                   <bizapi>/lib/api/route/exchange/schemas/element.js
-      ret = get('exchange/' + bid + part) do |request, http|
-        response = http.request(request)
-        case response
-        when Net::HTTPSuccess
-          workit_response(response)
-        else
-          showHttpError(request, response)
-        end
-      end
-      whirly_stop
-      return [] unless ret.is_a?(Hash) && !ret.key?(:error)
-      return [] unless ret.key?(:items)
-      unless ret[:count] == ret[:items].length
-        warning(
-          'Unexpected: ret[:count] != ret[:items].length: ' \
-          "#{ret[:count]} != #{ret[:items].length}"
-        )
+    def elements(skip_purchased: false, **opts)
+      # Get the user's Business metadata, including their Business tier.
+      overview if @ometa.nil?
+
+      elems = nil
+      id_maybe = opts[:filter_id] || opts[:filter_fuzzy]
+      if id_maybe && skip_purchased
+        elem = element_quick(id_maybe)
+        elems = [MrMurano::ExchangeElement.new(elem)] unless elem.nil?
       end
-      ret[:items]
+      elems = elements_all(skip_purchased: skip_purchased) if elems.nil?
+
+      prepare_elements(elems, **opts)
     end
 
-    def elements(**opts)
+    def elements_all(skip_purchased: false)
       lookp = {}
-      # Get the user's Business metadata, including their Business tier.
-      overview if @ometa.nil?
       elems = fetch_elements(lookp)
-      fetch_purchased(lookp)
-      prepare_elements(elems, **opts)
+      fetch_purchased(lookp) unless skip_purchased
+      elems
     end
 
     def fetch_elements(lookp)
@@ -82,9 +74,11 @@ module MrMurano
       end
     end
 
-    def fetch_purchased(lookp)
+    def fetch_purchased(lookp=nil, services_only: false)
+      query = [%w[type service]] if services_only
       # Fetch the list of Purchased elements.
-      items = fetch_type('/purchase/')
+      items = fetch_type('/purchase/', query)
+      return items if lookp.nil?
       # Update the list of all Elements to indicate which have been purchased.
       items.each do |meta|
         elem = lookp[meta[:elementId]]
@@ -99,15 +93,56 @@ module MrMurano
             )
           end
         else
-          warning("Unexpected: No Element found for Exchange Purchase: elementId: #{meta[:elementId]}")
+          warning(
+            "No Exchange Element for Purchase: elementId: #{meta[:elementId]}"
+          )
+        end
+      end
+    end
+
+    def fetch_type(part, query=nil)
+      # [lb] not super happy about mixing presentation with other logic
+      # but this is quick and dirty.
+      case part
+      when '/element/'
+        qualifier = 'All'
+      when '/purchase/'
+        qualifier = 'Purchased'
+      else
+        raise 'Unexpected error'
+      end
+      whirly_start("Fetching #{qualifier} Elements...")
+
+      # FIXME/2017-09-27: Support Pagination. BizAPI accepts four settings:
+      #                     type, offset, limit, and select.
+      #                   <bizapi>/lib/api/route/exchange/schemas/element.js
+      ret = get('exchange/' + bid + part, query) do |request, http|
+        response = http.request(request)
+        case response
+        when Net::HTTPSuccess
+          workit_response(response)
+        else
+          showHttpError(request, response)
         end
       end
+      whirly_stop
+      return [] unless ret.is_a?(Hash) && !ret.key?(:error)
+      return [] unless ret.key?(:items)
+      unless ret[:count] == ret[:items].length
+        warning(
+          'Unexpected: ret[:count] != ret[:items].length: ' \
+          "#{ret[:count]} != #{ret[:items].length}"
+        )
+      end
+      ret[:items]
     end
 
     def verify_purchase_vs_element(elem, key, val)
       elem.send(key) == val
     rescue NoMethodError
-      verbose("Unexpected: Exchange Element missing key found in Purchase Element: #{key}")
+      verbose(
+        "Unexpected: Exchange Element missing key found in Purchase Element: #{key}"
+      )
       true
     end
 

data/lib/MrMurano/Gateway.rb

@@ -386,7 +386,7 @@ module MrMurano
 
       ## Get one device
       # @param id [String] The identity to fetch
-      def fetch(id)
+      def fetch(id, _untainted=false)
         get("/#{CGI.escape(id.to_s)}")
       end
 

data/lib/MrMurano/HttpAuthed.rb

@@ -22,14 +22,12 @@ module MrMurano
     include Http
     include Verbose
 
+    attr_accessor :logging_on
     attr_accessor :login_info
     attr_reader :token_biz
 
     def initialize
-      @login_info = nil
-      @pass_file = nil
-      @token_file = nil
-      token_reset
+      credentials_reset
     end
 
     def add_headers(request)
@@ -52,6 +50,15 @@ module MrMurano
       request
     end
 
+    def credentials_reset
+      @logging_on = false
+      @login_info = nil
+      @pass_file = nil
+      @token_file = nil
+      token_reset
+      @password_user = ''
+    end
+
     # ---------------------------------------------------------------------
 
     def pass_file
@@ -118,8 +125,10 @@ module MrMurano
       @token_biz
     end
 
-    def token_reset
-      @token_biz = ''
+    def token_reset(new_token='')
+      # Setting the empty token will cause it to be re-fetched
+      # on next login_info.
+      @token_biz = new_token
     end
 
     def ensure_token!
@@ -140,7 +149,7 @@ module MrMurano
       acc_token = token_file.lookup(net_host, user_name)
       if acc_token.to_s.empty?
         nil
-      elsif acc_token !~ /^[a-fA-F0-9]+$/
+      elsif !token_looks_legit(acc_token)
         warning "Malformed '#{net_host}:#{user_name}' token: #{acc_token}"
         nil
       else
@@ -148,6 +157,10 @@ module MrMurano
       end
     end
 
+    def token_looks_legit(acc_token)
+      (acc_token =~ /^[a-fA-F0-9]{40}$/) == 0
+    end
+
     def token_save(net_host=nil, user_name=nil)
       net_host, user_name = get_host_user_pair(net_host, user_name)
       return unless $cfg['auth.persist-token']

data/lib/MrMurano/Logs.rb

@@ -5,7 +5,16 @@
 # vim:tw=0:ts=2:sw=2:et:ai
 # Unauthorized copying of this file is strictly prohibited.
 
-require 'eventmachine'
+begin
+  require 'eventmachine'
+rescue StandardError => _err
+  # (lb): I started developing in tmux, and I get this error only within it:
+  #   require 'eventmachine'
+  #    Unable to load the EventMachine C extension;
+  #    To use the pure-ruby reactor, require 'em/pure_ruby'
+  require 'em/pure_ruby'
+end
+
 require 'faye/websocket'
 
 require 'MrMurano/http'

data/lib/MrMurano/ProjectFile.rb

@@ -8,9 +8,9 @@
 # 2017-07-01: This ordered list hacks around having
 # individual files include all the files they need.
 
-require 'yaml'
 require 'json-schema'
 require 'pathname'
+require 'yaml'
 require 'MrMurano/verbosing'
 require 'MrMurano/Config'
 require 'MrMurano/hash'

data/lib/MrMurano/ReCommander.rb

@@ -127,12 +127,29 @@ module Commander
       hooked.check_run_post_hook
     end
 
+    alias old_args_without_command_name args_without_command_name
+    def args_without_command_name
+      args_sans = old_args_without_command_name
+      args_sans += ['--'] + @positional unless @positional.empty?
+      args_sans
+    end
+
+    alias old_remove_global_options remove_global_options
+    def remove_global_options(options, args)
+      # Look for sole '--' argument, which signals start of positionals.
+      i_positional = args.index('--')
+      args = args[0, i_positional] unless i_positional.nil?
+      old_remove_global_options(options, args)
+    end
+
     alias old_parse_global_options parse_global_options
     def parse_global_options
       # User can specify, e.g., status.options, to set options for specific commands.
       defopts = ($cfg["#{active_command.name}.options"] || '').split
       @args.push(*defopts)
-      help_hack
+      end_of_options_hack
+      do_help = help_hack
+      $cfg.validate_cmd_business_and_project(active_command) unless do_help
       parse_global_options_real
     end
 
@@ -150,12 +167,21 @@ module Commander
       exit 2
     end
 
+    def end_of_options_hack
+      @positional = []
+      i_positional = @args.index('--')
+      return if i_positional.nil?
+      @positional = @args[i_positional + 1..-1]
+      @args = @args[0, i_positional]
+    end
+
     # 2017-08-22: Commander's help infrastructure is either really weak,
     # or we did something elsewhere that seriously cripples it. In any
     # case, this fixes all its quirks.
     def help_hack
-      do_help = fix_args
+      do_help = fix_args_for_help
       show_alias_help_maybe! if do_help
+      do_help
     end
 
     def help_opts
@@ -166,7 +192,7 @@ module Commander
       %w[-v --version].freeze
     end
 
-    def fix_args
+    def fix_args_for_help
       # If `murano --help` is specified, let rb-commander handle it.
       # But if `murano command --help` is specified, don't let cmdr
       # handle it, otherwise it just shows the command description,
@@ -175,79 +201,110 @@ module Commander
       #   'help' might really be a command argument (e.g., a solution name).
       # Note: `murano -v`'s active_command is 'help'.
       do_help = (@args & %w[-h --help]).any? || active_command.name == 'help'
-      if do_help
-        # If there are options in addition to --help, then Commander
-        # runs the command! So remove all options.
-        #
-        # 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
-        # runs the usage command.
-        #
-        # I [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, and it does not
-        # define any options?). Then it removes the --id switch (after the
-        # --help switch 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"). So in the example
-        # given above, `murano usage --id 1234 --help`, both the `--id` flag
-        # and `--help` flag are moved from @args, and then `murano usage 1234`
-        # is executed (and args are not validated by Commander but merely passed
-        # to the command action, so `usage` gets args=['1234']). Whadda wreck.
-        reject_next = false
-        @args.reject! do |arg|
-          reject = false
-          if reject_next
-            reject = true
-            reject_next = false
-          elsif arg.start_with?('-') && !help_opts.include?(arg) && !vers_opts.include?(arg)
-            reject = true
-            # See if the next argument should also be consumed.
-            arg_opts = @options.select do |opt|
-              if arg =~ /^-[^-]/
-                # Single char abbrev: look for exact match.
-                opt[:switches].include?(arg)
-              else
-                # Long switch: Commander matches abbrevs of longs...
-                opt[:switches].any? { |oarg| oarg =~ /^#{arg}/ }
-              end
-            end
-            if arg =~ /^--/
-              exact = arg_opts.select do |opt|
-                opt[:switches].include?(arg) || opt[:switches].any? do |sw|
-                  sw.start_with?(arg + ' ')
-                end
-              end
-              arg_opts = exact unless exact.empty?
-            end
-            if arg_opts.length > 1
-              # MAYBE/2017-08-23: Always do this check, not just for help.
-              ambig = MrMurano::Verbose.fancy_ticks(arg)
-              match = arg_opts.map do |opt|
-                opt[:switches].map { |sw| MrMurano::Verbose.fancy_ticks(sw) }.join('|')
-              end
-              match = match.flatten
-              match[-1] = "and #{match[-1]}" if match.length > 1
-              match = match.join(', ')
-              MrMurano::Verbose.error("Ambiguous option: #{ambig} matches: #{match}")
-              exit 2
-            elsif arg_opts.length == 1
-              if arg_opts.first[:switches].any? { |opt| opt.start_with?('--') && opt.include?(' ') }
-                # There's a space in the --long setting, e.g., '--config KEY=VAL',
-                # so we know there's an argument following.
-                reject_next = true
-              end
-            end
-          end
-          reject
-        end
-      end
+      trim_options_from_args if do_help
       @purargs = @args - help_opts
       return do_help if active_command.name == 'help'
       # Any command other than `murano help` or `murano --help`.
       return do_help if !do_help || active_command.name.include?(' ')
+      # Command is not --help, or it's help for a single-word command.
+      cleanup_args_simple_command_help
+      do_help
+    end
+
+    # If there are options in addition to --help, then Commander
+    # runs the command! So remove all options.
+    #
+    # 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
+    #
+    # runs the usage command.
+    #
+    # (lb): I 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, and it does not
+    # define any options?). Then it removes the --id switch (after the
+    # --help switch 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"). So in the example
+    # given above, `murano usage --id 1234 --help`, both the `--id` flag
+    # and `--help` flag are moved from @args, and then `murano usage 1234`
+    # is executed (and args are not validated by Commander but merely passed
+    # to the command action, so `usage` gets args=['1234']). Whadda wreck.
+    def trim_options_from_args
+      reject_next = false
+      @args.reject! do |arg|
+        if reject_next
+          reject_next = false
+          true
+        elsif (
+          arg.start_with?('-') &&
+          !help_opts.include?(arg) &&
+          !vers_opts.include?(arg)
+        )
+          # See if the next argument should also be consumed.
+          arg_opts = find_matching_options(arg)
+          arg_opts = find_exact_match_maybe(arg, arg_opts)
+          reject_next = must_be_sane_option!(arg_opts)
+          true
+        else
+          false
+        end
+      end
+    end
+
+    def find_matching_options(arg)
+      @options.select do |opt|
+        if arg =~ /^-[^-]/
+          # Single char abbrev: look for exact match.
+          opt[:switches].include?(arg)
+        else
+          # Long switch: Commander matches abbrevs of longs...
+          opt[:switches].any? { |oarg| oarg =~ /^#{arg}/ }
+        end
+      end
+    end
+
+    def find_exact_match_maybe(arg, arg_opts)
+      return arg_opts unless arg =~ /^--/
+      exact = arg_opts.select do |opt|
+        opt[:switches].include?(arg) || opt[:switches].any? do |sw|
+          sw.start_with?(arg + ' ')
+        end
+      end
+      exact.empty? && exact || arg_opts
+    end
+
+    # Returns true if next arg is input to current --option.
+    def must_be_sane_option!(arg_opts)
+      if arg_opts.length > 1
+        # MAYBE/2017-08-23: Always do this check, not just for help.
+        ambig = MrMurano::Verbose.fancy_ticks(arg)
+        match = arg_opts.map do |opt|
+          opt[:switches].map { |sw| MrMurano::Verbose.fancy_ticks(sw) }.join('|')
+        end
+        match = match.flatten
+        match[-1] = "and #{match[-1]}" if match.length > 1
+        match = match.join(', ')
+        MrMurano::Verbose.error("Ambiguous option: #{ambig} matches: #{match}")
+        exit 2
+      elsif arg_opts.length == 1
+        # See if this option (the only option) has input.
+        arg_opts.first[:switches].any? do |opt|
+          # There may be a space in a --long option, e.g.,
+          # '--config KEY=VAL', which means an argument follows.
+          opt.start_with?('--') && opt.include?(' ')
+        end
+      else
+        false
+      end
+    end
+
+    def cleanup_args_simple_command_help
       # This is a single-word command, e.g., 'link', not 'link list',
       #   as in `murano link --help`, not `murano link list --help`.
       # Positional parameters break Commander. E.g.,
@@ -258,7 +315,6 @@ module Commander
       @args = @args[0..0]
       # Add back in the --help if the command is not a subcommand help.
       @args.push('--help') unless active_command.subcmdgrouphelp
-      do_help
     end
 
     def show_alias_help_maybe!

data/lib/MrMurano/Solution-ServiceConfig.rb

@@ -21,8 +21,6 @@ module MrMurano
       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)
@@ -33,8 +31,14 @@ module MrMurano
       super(svc_name, path)
     end
 
-    def fetch(id)
-      get('/' + id.to_s)
+    def fetch(id, _untainted=false, &block)
+      must_id! id
+      get('/' + id.to_s, &block)
+    end
+
+    def must_id!(id)
+      return unless id.nil?
+      raise "ID not set, or Service '#{@service_name}' not enabled for this Solution"
     end
 
     def scid_for_name(name)
@@ -69,21 +73,24 @@ module MrMurano
       )
     end
 
-    def remove(id)
+    def remove(id, &block)
+      must_id! id
       return unless remove_item_allowed(id)
-      delete("/#{id}")
+      delete("/#{id}", &block)
     end
 
-    def info(id=scid)
-      get("/#{id}/info")
+    def info(id=scid, &block)
+      must_id! id
+      get("/#{id}/info", &block)
     end
 
-    def logs(id=scid)
-      get("/#{id}/logs")
+    def logs(id=scid, &block)
+      must_id! id
+      get("/#{id}/logs", &block)
     end
 
     def call(opid, meth=:get, data=nil, id=scid, &block)
-      raise "Service '#{@service_name}' not enabled for this Solution" if id.nil?
+      must_id! id
       call = "/#{id}/call/#{opid}"
       debug "Will call: #{call}"
       case meth