MuranoCLI 3.2.0.beta.5 → 3.2.0.beta.8

data/lib/MrMurano/ReCommander.rb

@@ -8,6 +8,7 @@
 require 'optparse'
 require 'MrMurano/optparse'
 require 'MrMurano/verbosing'
+require 'MrMurano/Business'
 
 module MrMurano
   class Hooked
@@ -51,6 +52,9 @@ module Commander
     attr_accessor :prompt_if_logged_off
     # A command sets subcmdgrouphelp if it's help.
     attr_accessor :subcmdgrouphelp
+    # A command sets must_not_be_managed if its
+    # use is restricted to unmanaged solutions.
+    attr_accessor :must_not_be_managed
 
     def verify_arg_count!(args, max_args=0, mandatory=[])
       if !max_args.nil? && max_args.zero?
@@ -84,6 +88,8 @@ module Commander
       hooked = MrMurano::Hooked.new(section)
       hooked.check_run_pre_hook
 
+      verify_solutions_unmanaged!
+
       begin
         old_run_active_command
       rescue LocalJumpError => _err
@@ -357,6 +363,23 @@ module Commander
       puts mur_msg
       exit 0
     end
+
+    # (lb): I'm not a huge fan of mingling business logic with our
+    # Commander monkey patch, but it's a lot more readable that
+    # having every command make the call!
+    def verify_solutions_unmanaged!
+      return if $cfg['tool.skip-managed']
+      # (lb): All @exosite.com employees are welcome behind the curtain.
+      if $cfg['user.name'].end_with? "@exosite.com"
+        MrMurano::Verbose.verbose(
+          "Welcome behind the curtain, #{$cfg['user.name']}!"
+        )
+        return
+      end
+      # FIXME/LATER: (lb): The Element Author should also be allowed in.
+      return unless active_command.must_not_be_managed
+      MrMurano::Business.must_not_be_managed!
+    end
   end
 end
 

data/lib/MrMurano/Solution.rb

@@ -220,6 +220,10 @@ module MrMurano
       @meta[:domain]
     end
 
+    def managed?
+      @meta[:managed]
+    end
+
     def pretty_desc(add_type: false, raw_url: false)
       # [lb] would normally put presentation code elsewhere (i.e., model
       #   classes should not be formatting output), but this seems okay.
@@ -297,6 +301,12 @@ module MrMurano
     def name_validate_help
       ''
     end
+
+    def must_not_be_managed!
+      return unless managed?
+      error 'Specified command cannot be run against managed solution.'
+      exit 1
+    end
   end
 
   class Application < Solution

data/lib/MrMurano/SyncUpDown-Core.rb

@@ -161,26 +161,89 @@ module MrMurano
     # @param asdown [Boolean] Direction/prespective of diff
     # @return [String] The diff output
     def dodiff(merged, local, _there=nil, options={})
+      localname = dodiff_resolve_localname(merged)
+      trmt, tlcl = dodiff_tempfile_paths(localname)
+      dodiff_header_aware(merged, trmt, tlcl, options)
+    end
+
+    def dodiff_resolve_localname(merged)
       localname = tolocalname(merged, @itemkey)
       # MUR-6488: Beware nested files, e.g., /tmp/js/script.js will
       # not work, because /tmp/js does not exist!
       # First, remove the leading path delimiter.
       localname = localname.gsub(/^#{::File::SEPARATOR}*/, '')
       # Next, replace remaining delimiters with a dot.
-      localname = localname.tr(::File::SEPARATOR, '.')
-      begin
-        # (lb): Not always Lua, e.g., might be PNG. Postfix doesn't matter, though.
-        trmt = Tempfile.new([localname + '_remote_', '.lua'])
-        tlcl = Tempfile.new([localname + '_local_', '.lua'])
-      rescue StandardError => err
-        MrMurano::Verbose.error("Failed to create temporary file: #{err}")
-        raise
+      localname.tr(::File::SEPARATOR, '.')
+    end
+
+    def dodiff_tempfile_paths(localname)
+      # (lb): Not always Lua, e.g., might be PNG. Postfix doesn't matter, though.
+      trmt = Tempfile.new([localname + '_remote_', '.lua'])
+      tlcl = Tempfile.new([localname + '_local_', '.lua'])
+      [trmt, tlcl]
+    rescue StandardError => err
+      MrMurano::Verbose.error("Failed to create temporary file: #{err}")
+      raise
+    end
+
+    def dodiff_header_aware(merged, trmt, tlcl, options)
+      dodiff_download_remote(merged, trmt, options)
+      MrMurano::Verbose.whirly_stop
+      dodiff_prepare_local_and_diff(merged, trmt, tlcl, options)
+    ensure
+      trmt.close
+      trmt.unlink
+      tlcl.close
+      tlcl.unlink
+    end
+
+    def dodiff_download_remote(merged, trmt, options)
+      tmp_path = Pathname.new(trmt.path)
+      diff_download(tmp_path, merged, options)
+    end
+
+    def dodiff_prepare_local_and_diff(merged, trmt, tlcl, options)
+      cmd = dodiff_build_cmd(trmt, tlcl, options)
+      merged[:exclude_header] = true
+      outp = dodiff_flexible(merged, tlcl, local, cmd, use_header=false)
+      return outp if outp.to_s.empty? || !merged.key?(:script)
+      merged[:exclude_header] = false
+      dodiff_diff_dynamic(merged, tlcl, local, cmd, use_header=true)
+    end
+
+    def dodiff_build_cmd(trmt, tlcl, options)
+      # 2017-07-03: No worries, Ruby 3.0 frozen string literals, cmd is a list.
+      cmd = $cfg['diff.cmd'].shellsplit
+      # ALT_SEPARATOR is the platform specific alternative separator,
+      # for Windows support.
+      remote_path = trmt.path.gsub(
+        ::File::SEPARATOR, ::File::ALT_SEPARATOR || ::File::SEPARATOR
+      )
+      local_path = tlcl.path.gsub(
+        ::File::SEPARATOR, ::File::ALT_SEPARATOR || ::File::SEPARATOR
+      )
+      if options[:asdown]
+        cmd << local_path
+        cmd << remote_path
+      else
+        cmd << remote_path
+        cmd << local_path
       end
+      cmd
+    end
+
+    def dodiff_flexible(merged, tlcl, local, cmd, use_header)
+      dodiff_local_to_tempfile(merged, tlcl, local, use_header)
+      dodiff_do_diff(cmd)
+    end
+
+    def dodiff_local_to_tempfile(merged, tlcl, local, use_header)
       Pathname.new(tlcl.path).open('wb') do |io|
         # Copy the local file to a temp file, for the diff command.
         # And for resources, remove the local-only :selected key, as
         # it's not part of the remote item that gets downloaded next.
         if merged.key?(:script)
+          io << config_vars_decode(merged[:header]) if use_header
           io << config_vars_decode(merged[:script])
         else
           # For most items, read the local file.
@@ -191,59 +254,34 @@ module MrMurano
           diff_item_write(io, merged, local, nil)
         end
       end
+    end
 
-      stdout_and_stderr = ''
-      begin
-        tmp_path = Pathname.new(trmt.path)
-        diff_download(tmp_path, merged, options)
-
-        MrMurano::Verbose.whirly_stop
+    def dodiff_do_diff(cmd)
+      stdout_and_stderr, _status = Open3.capture2e(*cmd)
+      dodiff_cull_tempfile_paths(stdout_and_stderr)
+    end
 
-        # 2017-07-03: No worries, Ruby 3.0 frozen string literals, cmd is a list.
-        cmd = $cfg['diff.cmd'].shellsplit
-        # ALT_SEPARATOR is the platform specific alternative separator,
-        # for Windows support.
-        remote_path = trmt.path.gsub(
-          ::File::SEPARATOR, ::File::ALT_SEPARATOR || ::File::SEPARATOR
-        )
-        local_path = tlcl.path.gsub(
-          ::File::SEPARATOR, ::File::ALT_SEPARATOR || ::File::SEPARATOR
-        )
-        if options[:asdown]
-          cmd << local_path
-          cmd << remote_path
+    def dodiff_cull_tempfile_paths(stdout_and_stderr)
+      # How important are the first two lines of the diff? E.g.,
+      #     --- /tmp/raw_data_remote_20170718-20183-gdyeg9.lua	2017-07-18 ...
+      #     +++ /tmp/raw_data_local_20170718-20183-71o4me.lua	2017-07-18 ...
+      # Seems like printing the path to a since-deleted temporary file is
+      # misleading, so cull these lines.
+      unless $cfg['diff.cmd'] == 'diff' || $cfg['diff.cmd'].start_with?('diff ')
+        return stdout_and_stderr
+      end
+      lineno = 0
+      consise = stdout_and_stderr.lines.reject do |line|
+        lineno += 1
+        if lineno == 1 && line.start_with?('--- ')
+          true
+        elsif lineno == 2 && line.start_with?('+++ ')
+          true
         else
-          cmd << remote_path
-          cmd << local_path
-        end
-
-        stdout_and_stderr, _status = Open3.capture2e(*cmd)
-        # How important are the first two lines of the diff? E.g.,
-        #     --- /tmp/raw_data_remote_20170718-20183-gdyeg9.lua	2017-07-18 ...
-        #     +++ /tmp/raw_data_local_20170718-20183-71o4me.lua	2017-07-18 ...
-        # Seems like printing the path to a since-deleted temporary file is
-        # misleading, so cull these lines.
-        if $cfg['diff.cmd'] == 'diff' || $cfg['diff.cmd'].start_with?('diff ')
-          lineno = 0
-          consise = stdout_and_stderr.lines.reject do |line|
-            lineno += 1
-            if lineno == 1 && line.start_with?('--- ')
-              true
-            elsif lineno == 2 && line.start_with?('+++ ')
-              true
-            else
-              false
-            end
-          end
-          stdout_and_stderr = consise.join
+          false
         end
-      ensure
-        trmt.close
-        trmt.unlink
-        tlcl.close
-        tlcl.unlink
       end
-      stdout_and_stderr
+      consise.join
     end
 
     ##

data/lib/MrMurano/SyncUpDown-Item.rb

@@ -28,6 +28,8 @@ module MrMurano
       attr_accessor :line_beg
       # @return [Integer] The line in #local_path where this #script ends.
       attr_accessor :line_end
+      # @return [String] The (optional) #ITEM <method> <path> :script header.
+      attr_accessor :header
       # @return [String] If requested, the diff output.
       attr_accessor :diff
       # @return [Boolean] When filtering, did this item pass.

data/lib/MrMurano/Webservice-Endpoint.rb

@@ -191,19 +191,20 @@ module MrMurano
             #   But on murano diff, MurCLI makes two local temp files
             #   to execute the diff, and it also upcases the method in
             #   both files, so the diff runs clean!
-            #   VERIFY/2017-07-03: [lb] adding upcase here; hope that works!
-            #   OHOHOH/2017-07-03: [lb] also recreating the header line.
-            up_line = "--#ENDPOINT #{md[:method].upcase} #{md[:path]}"
-            up_line += " #{md[:ctype]}" unless md[:ctype].to_s.empty?
-            up_line += "\n"
+            #   2017-07-03: (lb): Adding upcase; and recreating header.
+            #   2018-06-11: (lb): Added :exclude_header to deal with
+            #     service side missing header. Which isn't an error, per se.
+            script_header = "--#ENDPOINT #{md[:method].upcase} #{md[:path]}"
+            script_header += " #{md[:ctype]}" unless md[:ctype].to_s.empty?
+            script_header += "\n"
             cur = RouteItem.new(
-              #method: md[:method],
               method: md[:method].upcase,
               path: md[:path],
               content_type: (md[:ctype] || 'application/json'),
               local_path: path,
               line_beg: lineno,
-              script: up_line,
+              header: script_header,
+              script: '',
             )
           elsif !cur.nil? && !cur[:script].nil?
             # 2017-07-02: Frozen string literal: change << to +=

data/lib/MrMurano/commands/business.rb

@@ -99,6 +99,66 @@ command 'business list' do |c|
   c.summary = %(List businesses)
   c.description = %(
 List businesses.
+
+E.g.,
+
+  $ murano business find my
+  +-------------+-------+--------------------+
+  | bizid       | role  | name               |
+  +-------------+-------+--------------------+
+  | a1b2c3d4e5f | owner | My Murano Business |
+  +-------------+-------+--------------------+
+
+NOTE: To match businesses that use special characters in
+their name, you must either delimit or quote the string.
+
+For example, the Bash shell interprets the pound sign as
+the start of a comment, so if you were to search, e.g.,
+
+  $ murano business find #
+  What would you like to find?
+
+The CLI will not receive the '#' argument, and it'll tell
+you as much.
+
+The proper way to search for such a business is to either
+delimit the query, or quote it. For example,
+
+  $ murano business find "#Hashtag Business"
+  +-------------+-------+-------------------+
+  | bizid       | role  | name              |
+  +-------------+-------+-------------------+
+  | a1b2c3d4e5f | owner | #Hashtag Business |
+  +-------------+-------+-------------------+
+
+The same applies for other special characters, such as:
+
+  '&' (start process in background);
+  '(' and ')' (subshell invocation);
+  '*' (file glob);
+  '~' (home directory expansion);
+  '!' (history expansion);
+  '-' (ignored as an empty option).
+
+For example, to search for a name with a parenthesis, try:
+
+  $ murano business find \\\(
+  +-------------+-------+---------+
+  | bizid       | role  | name    |
+  +-------------+-------+---------+
+  | a1b2c3d4e5f | owner | ( ͝° ͜ʖ͡°) |
+  +-------------+-------+---------+
+
+Finally to search for a business name containing a dash,
+use a double-dash to indicate the end of positional
+arguments. For example,
+
+  $ murano business find -- -
+  +-------------+-------+----------------+
+  | bizid       | role  | name           |
+  +-------------+-------+----------------+
+  | a1b2c3d4e5f | owner | Loch-Busi Ness |
+  +-------------+-------+----------------+
   ).strip
   c.project_not_required = true
 

data/lib/MrMurano/commands/content.rb

@@ -19,6 +19,7 @@ This is where OTA data can be stored so that devices can easily download it.
   ).strip
   c.project_not_required = true
   c.subcmdgrouphelp = true
+  c.must_not_be_managed = true
 
   c.action do |_args, _options|
     ::Commander::UI.enable_paging unless $cfg['tool.no-page']
@@ -35,6 +36,7 @@ List downloadable content for a product.
 Data uploaded to a product's content area can be downloaded by devices using
 the HTTP Device API.
   ).strip
+  c.must_not_be_managed = true
 
   c.option '-l', '--long', %(Include more info for each file)
 
@@ -50,7 +52,7 @@ the HTTP Device API.
     if !items.empty?
       prd.outf(items) do |dd, ios|
         if options.long
-          headers = %i[Name Size 'Last Modified' MIME]
+          headers = %i[Name Size Last\ Modified MIME]
           rows = dd.map { |d| [d[:id], d[:length], d[:last_modified], d[:type]] }
         else
           headers = %i[Name Size]
@@ -73,6 +75,7 @@ Show more info for a content item.
 Data uploaded to a product's content area can be downloaded by devices using
 the HTTP Device API.
   ).strip
+  c.must_not_be_managed = true
 
   c.action do |args, _options|
     c.verify_arg_count!(args, 1, ['Missing <content name>'])
@@ -93,6 +96,7 @@ Delete a content item.
 Data uploaded to a product's content area can be downloaded by devices using
 the HTTP Device API.
   ).strip
+  c.must_not_be_managed = true
 
   c.option('-y', '--[no-]yes', %(Answer "yes" to all prompts and run non-interactively))
 
@@ -115,6 +119,7 @@ Upload a content item.
 Data uploaded to a product's content area can be downloaded by devices using
 the HTTP Device API.
   ).strip
+  c.must_not_be_managed = true
 
   c.option('--tags KEY=VALUE', %(Add extra meta info to the content item)) do |ec|
     key, value = ec.split('=', 2)
@@ -154,6 +159,7 @@ Download a content item.
 Data uploaded to a product's content area can be downloaded by devices using
 the HTTP Device API.
   ).strip
+  c.must_not_be_managed = true
 
   c.option '-o', '--output FILE', %(Save content to a file)
 

data/lib/MrMurano/commands/cors.rb

@@ -61,6 +61,7 @@ command 'cors set' do |c|
 Set the CORS for the project.
   ).strip
   c.project_not_required = true
+  c.must_not_be_managed = true
 
   c.action do |args, _options|
     c.verify_arg_count!(args, 1, ['Missing <file>'])

data/lib/MrMurano/commands/devices.rb

@@ -284,7 +284,7 @@ end
 
 command 'device activate' do |c|
   c.syntax = %(murano device activate <identifier>)
-  c.summary = %(Activate a serial number, retriving its CIK)
+  c.summary = %(Activate a serial number, retrieving its CIK)
   c.description = %(
 Activate an Identifier.
 

data/lib/MrMurano/commands/element.rb

@@ -30,9 +30,10 @@ class ElementCmd
   end
 
   def reset_state
+    @drop_fields = []
     @edit_fields = {}
+    @open_fields = []
     @updated_obj = {}
-    @use_editor = false
     @input_path = nil
     @input_data = nil
   end
@@ -325,7 +326,11 @@ class ElementCmd
       cmd.option(
         "--#{switch} [VALUE]", detail
       ) do |param|
-        @edit_fields[field.to_s] = param
+        if param.nil?
+          @open_fields.push(key)
+        else
+          @edit_fields[field.to_s] = param
+        end
       end
     end
   end
@@ -336,11 +341,19 @@ class ElementCmd
     ) do |param|
       if param.nil?
         # param.nil? means user did not supply key[=val].
-        @edit_fields[''] = nil
+        @open_fields.push('')
       else
         # Otherwise: a=b :> ['a', 'b'] / a=  :> ['a', ''] / a   :> ['a', nil]
         key, value = param.split('=', 2)
-        @edit_fields[key] = value
+        if value.nil?
+          if param =~ /(?<!-)-$/
+            @drop_fields.push(key.chomp('-'))
+          else
+            @open_fields.push(key)
+          end
+        else
+          @edit_fields[key] = value
+        end
       end
     end
   end
@@ -379,17 +392,16 @@ class ElementCmd
     if @input_path.nil?
       # See if all values are specified, or if we should bring up the EDITOR.
       if n_kvals[:n_keys] > 1
-        if n_kvals[:n_keys] != n_kvals[:n_vals]
+        if (n_kvals[:n_keys] + 1) < n_kvals[:n_vals]
+          # EDITOR path, i.e., one key specified without a value.
           error %(
-            Please specify at most one field when not specifing all field values.
+            Please specify at most one field without a value.
           ).strip
           exit 2
         end
-      elsif n_kvals[:n_keys] == 0
+      elsif n_kvals[:n_keys] == 0 && @open_fields.empty?
         error('Please specify one or more -e/--edit options, or an input file.')
         exit 2
-      else
-        @use_editor = n_kvals[:n_vals].zero?
       end
     elsif n_kvals[:n_keys] > 1
       error('Please specify at most a single field when specifing an input file.')
@@ -423,13 +435,17 @@ class ElementCmd
     n_edits = 0
     # When @edit_fields == { '' => '' }, BizAPI replies:
     #   Request Failed: 400: [400] child "type" fails because ["type" is required]
-    if @use_editor
+    if !@open_fields.empty?
+      if (@open_fields.length > 1) && $cfg['tool.developer']
+        warning %(Unexpected: more than one open field specified)
+      end
       n_edits += update_elem_fields_from_editor
     else
       # Verify that at least one option value differs from what's currently set.
       n_edits += update_elem_fields_from_options
       n_edits += update_elem_fields_from_input_f
     end
+    n_edits += update_elem_fields_drop_fields
     if n_edits.zero?
       warning('No new field values specified to update.')
       exit 0
@@ -447,7 +463,7 @@ class ElementCmd
   end
 
   def prepare_field_keys_and_value
-    field = @edit_fields.first[0]
+    field = @open_fields[0]
     keys = []
     keys = field.split('.').map(&:to_sym) unless field.to_s.empty?
     if !keys.nil? && !keys.empty?
@@ -535,10 +551,10 @@ class ElementCmd
   def update_elem_fields_from_input_f
     n_edits = 0
     return n_edits if @input_path.nil?
-    if (@edit_fields.length > 1) && $cfg['tool.developer']
-      warning %(Unexpected: more than one field specified)
+    if (@open_fields.length > 1) && $cfg['tool.developer']
+      warning %(Unexpected: more than one open field specified)
     end
-    keys = @edit_fields.first[0].split('.').map(&:to_sym) unless @edit_fields.empty?
+    keys = @open_fields[0].split('.').map(&:to_sym) unless @open_fields.empty?
     if !keys.nil? && !keys.empty?
       old_val = @updated_obj.dig_safe(*keys)
       if old_val != @input_data
@@ -552,6 +568,16 @@ class ElementCmd
     n_edits
   end
 
+  def update_elem_fields_drop_fields
+    n_edits = 0
+    @drop_fields.each do |field|
+      keys = field.split('.').map(&:to_sym)
+      @updated_obj.deep_delete(*keys)
+      n_edits += 1
+    end
+    n_edits
+  end
+
   def value_specifies_file_input?(field_value)
     field_value =~ /^@(?!@)/
   end

data/lib/MrMurano/commands/keystore.rb

@@ -32,6 +32,7 @@ command 'keystore clearAll' do |c|
   c.description = %(
 Delete all keys in the keystore.
   ).strip
+  c.must_not_be_managed = true
 
   c.action do |args, _options|
     c.verify_arg_count!(args)
@@ -46,6 +47,7 @@ command 'keystore info' do |c|
   c.description = %(
 Show info about the Keystore.
   ).strip
+  c.must_not_be_managed = true
 
   c.action do |args, _options|
     c.verify_arg_count!(args)
@@ -60,6 +62,7 @@ command 'keystore list' do |c|
   c.description = %(
 List all of the keys in the Keystore.
   ).strip
+  c.must_not_be_managed = true
 
   c.action do |args, _options|
     c.verify_arg_count!(args)
@@ -76,6 +79,7 @@ command 'keystore get' do |c|
   c.description = %(
 Get the value of a key in the Keystore.
   ).strip
+  c.must_not_be_managed = true
 
   c.action do |args, _options|
     c.verify_arg_count!(args, 1, ['Missing key'])
@@ -91,6 +95,7 @@ command 'keystore set' do |c|
   c.description = %(
 Set the value of a key in the Keystore.
   ).strip
+  c.must_not_be_managed = true
 
   c.action do |args, _options|
     c.verify_arg_count!(args, nil, ['Missing key', 'Missing value(s)'])
@@ -105,6 +110,7 @@ command 'keystore delete' do |c|
   c.description = %(
 Delete a key from the Keystore.
   ).strip
+  c.must_not_be_managed = true
 
   # MAYBE?/2017-08-16: Verify on delete.
   #c.option('-y', '--[no-]yes', %(Answer "yes" to all prompts and run non-interactively))
@@ -130,6 +136,8 @@ For current list, see:
 
   http://docs.exosite.com/murano/services/keystore/#command
   ).strip
+  c.must_not_be_managed = true
+
   c.example %(murano keystore command lpush mykey myvalue), %(Push a value onto list)
   c.example %(murano keystore command lpush mykey A B C), %(Push three values onto list)
   c.example %(murano keystore command lrem mykey 0 B), %(Remove all B values from list)

data/lib/MrMurano/commands/logs.rb

@@ -76,6 +76,7 @@ class LogsCmd
   def cmd_add_logs_meta(cmd)
     cmd.syntax = %(murano logs [--options])
     cmd.summary = %(Get the logs for a solution)
+    cmd.must_not_be_managed = true
     cmd_add_help(cmd)
     cmd_add_examples(cmd)
   end