MuranoCLI 2.2.4 → 3.0.0

data/lib/MrMurano/commands/completion.rb

@@ -1,31 +1,50 @@
-require 'pp'
+# 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 'erb'
+require 'pp'
+require 'MrMurano/ReCommander'
+
+# USAGE: See: lib/MrMurano/commands.rb
 
 class CompletionContext < ::Commander::HelpFormatter::Context
 end
 
+# rubocop:disable Style/ClassAndModuleChildren
+#   "Use nested module/class definitions instead of compact style."
+#   except that nested style (class [::]Commander\nclass Runner)
+#   does not work.
 class ::Commander::Runner
-
   # Not so sure this should go in Runner, but where else?
 
+  # rubocop:disable Style/MethodName "Use snake_case for method names."
+
+  # The shells for which we have completion templates.
+  SHELL_TYPES = %i[bash zsh].freeze
+
   ##
   # Change the '--[no-]foo' switch into '--no-foo' and '--foo'
   def flatswitches(option)
     # if there is a --[no-]foo format, break that into two switches.
-    option[:switches].map{ |switch|
-      switch = switch.sub(/\s.*$/,'') # drop argument spec if exists.
-      if switch =~ /\[no-\]/ then
-        [switch.sub(/\[no-\]/, ''), switch.gsub(/[\[\]]/,'')]
+    switches = option[:switches].map do |switch|
+      switch = switch.sub(/\s.*$/, '') # drop argument spec if exists.
+      if switch =~ /\[no-\]/
+        [switch.sub(/\[no-\]/, ''), switch.gsub(/[\[\]]/, '')]
       else
         switch
       end
-    }.flatten
+    end
+    switches.flatten
   end
 
   ##
-  # If the switches take an argument, retun =
+  # If the switches take an argument, return =
   def takesArg(option, yes='=', no='')
-    if option[:switches].select { |switch| switch =~ /\s\S+$/ }.empty? then
+    if option[:switches].select { |switch| switch =~ /\s\S+$/ }.empty?
       no
     else
       yes
@@ -35,18 +54,18 @@ class ::Commander::Runner
   ##
   # truncate the description of an option
   def optionDesc(option)
-    option[:description].sub(/\n.*$/,'')
+    option[:description].sub(/\n.*$/, '')
   end
 
   ##
   # Get a tree of all commands and sub commands
   def cmdTree
-    tree={}
-    @commands.sort.each do |name,cmd|
+    tree = {}
+    @commands.sort.each do |name, cmd|
       levels = name.split
       pos = tree
       levels.each do |step|
-        pos[step] = {} unless pos.has_key? step
+        pos[step] = {} unless pos.key? step
         pos = pos[step]
       end
       pos["\0cmd"] = cmd
@@ -57,8 +76,8 @@ class ::Commander::Runner
   ##
   # Get maximum depth of sub-commands.
   def cmdMaxDepth
-    depth=0
-    @commands.sort.each do |name,cmd|
+    depth = 0
+    @commands.sort.each do |name, _cmd|
       levels = name.split
       depth = levels.count if levels.count > depth
     end
@@ -68,17 +87,17 @@ class ::Commander::Runner
   ##
   # Alternate tree of sub-commands.
   def cmdTreeB
-    tree={}
-    @commands.sort.each do |name,cmd|
+    tree = {}
+    @commands.sort.each do |name, cmd|
       levels = name.split
-      tree[levels.join(' ')] = {:cmd=>cmd}
+      tree[levels.join(' ')] = { cmd: cmd }
 
       # load parent.
       left = levels[0..-2]
       right = levels[-1]
       key = left.join(' ')
-      tree[key] = {} unless tree.has_key? key
-      if tree[key].has_key?(:subs) then
+      tree[key] = {} unless tree.key? key
+      if tree[key].key?(:subs)
         tree[key][:subs] << right
       else
         tree[key][:subs] = [right]
@@ -86,31 +105,44 @@ class ::Commander::Runner
     end
     tree
   end
-
 end
 
 command :completion do |c|
-  c.syntax = %{murano completion}
-  c.summary = %{Generate a completion file}
-  c.description = %{For starts, this is zsh only. Because that is what I use.
+  c.syntax = %(murano completion)
+  c.summary = %(Generate a completion file)
+  c.description = %(
+Create a Tab completion file for either the Bash or Z shell.
+
+E.g.,
+
+  eval "$(murano completion)"
 
-eval "$(murano completion)"
 or
-murano completion > _murano
-source _murano
-}
+
+  murano completion > _murano
+  source _murano
+  ).strip
+  c.project_not_required = true
+
   c.option '--subs', 'List sub commands'
   #c.option '--opts CMD', 'List options for subcommand'
   #c.option '--gopts', 'List global options'
+  c.option(
+    '--shell TYPE',
+    Commander::Runner::SHELL_TYPES,
+    %(Shell flavor of output (default: Bash))
+  )
 
   # Changing direction.
   # Will poop out the file to be included as the completion script.
 
   c.action do |args, options|
+    c.verify_arg_count!(args)
+    options.default shell: :bash
 
     runner = ::Commander::Runner.instance
 
-    if options.gopts then
+    if options.gopts
       opts = runner.instance_variable_get(:@options)
       pp opts.first
       pp runner.takesArg(opts.first)
@@ -118,14 +150,14 @@ source _murano
 #        puts runner.optionLine o, 'GlobalOption'
 #      end
 
-    elsif options.subs then
-      runner.instance_variable_get(:@commands).sort.each do |name,cmd|
-        #desc = cmd.instance_variable_get(:@summary) #.lines[0]
+    elsif options.subs
+      runner.instance_variable_get(:@commands).sort.each do |name, _cmd|
+        #desc = _cmd.instance_variable_get(:@summary) #.lines[0]
         #say "#{name}:'#{desc}'"
-        say "#{name}"
+        say name.to_s
       end
 
-    elsif options.opts then
+    elsif options.opts
       cmds = runner.instance_variable_get(:@commands)
       cmd = cmds[options.opts]
       pp cmd.syntax
@@ -138,15 +170,20 @@ source _murano
       end
 
     else
-
-      tmpl=ERB.new(File.read(File.join(File.dirname(__FILE__), "zshcomplete.erb")), nil, '-<>')
+      case options.shell
+      when :bash
+        cmpltn_tmplt = 'completion-bash.erb'
+      when :zsh
+        cmpltn_tmplt = 'completion-zsh.erb'
+      else
+        MrMurano::Verbose.error "Impossible shell option specified: #{options.shell}"
+        exit 2
+      end
+      tmpl = ERB.new(File.read(File.join(File.dirname(__FILE__), cmpltn_tmplt)), nil, '-<>')
 
       pc = CompletionContext.new(runner)
       puts tmpl.result(pc.get_binding)
     end
-
-
   end
 end
 
-#  vim: set ai et sw=2 ts=2 :

data/lib/MrMurano/commands/config.rb

@@ -1,23 +1,54 @@
+# 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 'MrMurano/ReCommander'
 
 command :config do |c|
-  c.syntax = %{murano config [options] <key> [<new value>]}
-  c.summary = %{Get and set options}
-  c.description = %{
-  You can get, set, or query config options with this command.  All config
-  options are in a 'section.key' format.  There is also a layer of scopes
-  that the keys can be saved in.
+  c.syntax = %(murano config [--options] [<key> [<new value>]])
+  c.summary = %(Get and set options)
+  c.description = %(
+Get, set, or query config options.
+
+All config options are in a 'section.key' format.
+
+There is also a layer of scopes that the keys can be saved in.
+
+If section is left out, then key is assumed to be in the 'tool' section.
+  ).strip
+
+  c.example %(
+    View the combined config
+  ).strip, 'murano config --dump'
+
+  c.example %(
+    View the config and path for each config file
+  ).strip, 'murano config --locations'
 
-  If section is left out, then key is assumed to be in the 'tool' section.
+  c.example %(
+    Query a value
+  ).strip, 'murano config application.id'
 
-  }
+  c.example %(
+    Show all ID values
+  ).strip, %(murano config '*.id')
 
-  c.example %{See what the current combined config is}, 'murano config --dump'
-  c.example %{Query a value}, 'murano config solution.id'
-  c.example %{Set a new value; writing to the project config file}, 'murano config solution.id XXXXXXXX'
-  c.example %{Set a new value; writing to the user config file}, 'murano config --user user.name my@email.address'
-  c.example %{Unset a value in a configfile. (lower scopes will become visible when unset)},
-    'murano config diff.cmd --unset'
+  c.example %(
+    Set a new value, which writes to the project config file
+  ).strip, 'murano config application.id XXXXXXXX'
 
+  c.example %(
+    Set a new value, and write it to the user config file
+  ).strip, 'murano config user.name my@email.address --user'
+
+  c.example %(
+    Unset a value. If the value is set in multiple config files,
+    # this unsets it from the outermost config file and unmasks
+    # a value set in a lower scope
+  ).strip, 'murano config diff.cmd --unset'
 
   c.option '--user', 'Use only the config file in $HOME (.mrmuranorc)'
   c.option '--project', 'Use only the config file in the project (.mrmuranorc)'
@@ -26,42 +57,75 @@ command :config do |c|
 
   c.option '--unset', 'Remove key from config file.'
   c.option '--dump', 'Dump the current combined view of the config'
+  c.option '--locations', 'List the locations of all known configs'
+
+  c.project_not_required = true
 
   c.action do |args, options|
+    c.verify_arg_count!(args, 2)
+    options.default(
+      user: false,
+      project: false,
+      env: false,
+      specified: false,
+      unset: false,
+      dump: false,
+      locations: false,
+    )
 
-    if options.dump then
-      puts $cfg.dump()
-    elsif args.count == 0 then
-      say_error "Need a config key"
-    elsif args.count == 1 and not options.unset then
-      options.default :user=>false, :project=>false,
-        :specified=>false, :env=>false
-
-      # For read, if no scopes, than all. Otherwise just those specified
-      scopes = []
-      scopes << :user if options.user
-      scopes << :project if options.project
-      scopes << :env if options.env
-      scopes << :specified if options.specified
-      scopes = MrMurano::Config::CFG_SCOPES if scopes.empty?
-
-      say $cfg.get(args[0], scopes)
+    if options.dump
+      puts $cfg.dump
+    elsif options.locations
+      puts 'This list is ordered. The first value found for a key is the value used.'
+      puts $cfg.locations
+    elsif args.count.zero?
+      say_error 'Need a config key'
     else
-
-      options.default :user=>false, :project=>false,
-        :specified=>false, :env=>false
-      # For write, if scope is specified, only write to that scope.
-      scope = :project
-      scope = :user if options.user
-      scope = :project if options.project
-      scope = :env if options.env
-      scope = :specified if options.specified
-
-      args[1] = nil if options.unset
-      $cfg.set(args[0], args[1], scope)
+      scope = get_scope_from_options(options)
+      if args.count == 1 && !options.unset
+        # For read, if no scopes, than all. Otherwise just those specified
+        scopes = []
+        scopes << scope unless scope.nil?
+        scopes = MrMurano::Config::CFG_SCOPES if scopes.empty?
+        is_wild = $cfg.wild?(args[0])
+        if !is_wild
+          puts $cfg.get(args[0], scopes)
+        else
+          kvals = $cfg.get_wild(args[0], scopes)
+          # LATER/2017-08-16: Honor --json option.
+          kvals.each { |kv| puts %(#{kv[0]} => "#{kv[1]}" (#{kv[2]})) }
+        end
+      else
+        # For write, if scope is specified, only write to that scope.
+        scope = :project if scope.nil?
+        args[1] = nil if options.unset
+        $cfg.set(args[0], args[1], scope)
+      end
     end
   end
 
+  def get_scope_from_options(options)
+    num_scopes = verify_scope_options!(options)
+    return nil if num_scopes.zero?
+    scope = nil
+    scope = :user if options.user
+    scope = :project if options.project
+    scope = :env if options.env
+    scope = :specified if options.specified
+    scope
+  end
+
+  def verify_scope_options!(options)
+    num_scopes = 0
+    num_scopes += 1 if options.user
+    num_scopes += 1 if options.project
+    num_scopes += 1 if options.env
+    num_scopes += 1 if options.specified
+    return num_scopes unless num_scopes > 1
+    MrMurano::Verbose.error(
+      'Ambiguous: Please specify only one of --user, --project, --env, or --specified'
+    )
+    exit 1
+  end
 end
 
-#  vim: set ai et sw=2 ts=2 :

data/lib/MrMurano/commands/content.rb

@@ -1,130 +1,173 @@
-require 'MrMurano/Product'
+# 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 'MrMurano/Content'
+require 'MrMurano/ReCommander'
 
 command :content do |c|
-  c.syntax = %{murano content}
-  c.summary = %{About Content Area}
-  c.description = %{This set of commands let you interact with the content area for a product.
+  c.syntax = %(murano content)
+  c.summary = %(About Content Area)
+  c.description = %(
+This set of commands let you interact with the content area for a product.
 
 This is where OTA data can be stored so that devices can easily download it.
-}
+  ).strip
+  c.project_not_required = true
 
-  c.action do |args, options|
+  c.action do |_args, _options|
     ::Commander::UI.enable_paging
     say MrMurano::SubCmdGroupHelp.new(c).get_help
   end
 end
 
 command 'content list' do |c|
-  c.syntax = %{murano content list}
-  c.summary = %{List downloadable content for a product}
-  c.description = %{List downloadable content for a product
+  c.syntax = %(murano content list)
+  c.summary = %(List downloadable content for a product)
+  c.description = %(
+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.option '-l', '--long', %(Include more info for each file)
+
   c.action do |args, options|
-    prd = MrMurano::ProductContent.new
-    prd.outf prd.list
+    c.verify_arg_count!(args)
+
+    prd = MrMurano::Content::Base.new
+
+    MrMurano::Verbose.whirly_start 'Looking for content...'
+    items = prd.list
+    exit 2 if items.nil?
+    MrMurano::Verbose.whirly_stop
+    if !items.empty?
+      prd.outf(items) do |dd, ios|
+        if options.long
+          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]
+          rows = dd.map { |d| [d[:id], d[:length]] }
+        end
+        prd.tabularize({ headers: headers, rows: rows }, ios)
+      end
+    else
+      prd.warning 'Did not find any content'
+    end
   end
 end
 
 command 'content info' do |c|
-  c.syntax = %{murano content info <content id>}
-  c.summary = %{Show more info for a content item}
-  c.description = %{Show more info for a content item
+  c.syntax = %(murano content info <content name>)
+  c.summary = %(Show more info for a content item)
+  c.description = %(
+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.
-  }
-  c.action do |args, options|
-    prd = MrMurano::ProductContent.new
-    if args[0].nil? then
-      prd.error "Missing <content id>"
-    else
-      prd.tabularize prd.info(args[0])
+  ).strip
+
+  c.action do |args, _options|
+    c.verify_arg_count!(args, 1, ['Missing <content name>'])
+    prd = MrMurano::Content::Base.new
+    info = prd.info(args[0])
+    prd.outf(info) do |dd, ios|
+      ios.puts Hash.transform_keys_to_strings(dd).to_yaml
     end
   end
 end
 
 command 'content delete' do |c|
-  c.syntax = %{murano content delete <content id>}
-  c.summary = %{Delete a content item}
-  c.description = %{Delete a content item
+  c.syntax = %(murano content delete <content name>)
+  c.summary = %(Delete a content item)
+  c.description = %(
+Delete a content item.
 
 Data uploaded to a product's content area can be downloaded by devices using
 the HTTP Device API.
-  }
+  ).strip
+
+  c.option('-y', '--[no-]yes', %(Answer "yes" to all prompts and run non-interactively))
+
   c.action do |args, options|
-    prd = MrMurano::ProductContent.new
-    if args[0].nil? then
-      prd.error "Missing <content id>"
-    else
-      ret = prd.remove(args[0])
-      prd.outf(ret) unless ret.nil? or ret.empty?
-    end
+    c.verify_arg_count!(args, 1, ['Missing <content name>'])
+    prd = MrMurano::Content::Base.new
+    prd.cmd_confirm_delete!(args[0], options.yes, 'abort!')
+    ret = prd.remove(args[0])
+    prd.outf(ret) if !ret.nil? && ret.count > 1
   end
 end
 
 command 'content upload' do |c|
-  c.syntax = %{murano content upload <content id> <file>}
-  c.summary = %{Upload content}
-  c.description = %{Upload a content item
+  tags = {}
+  c.syntax = %(murano content upload <file>)
+  c.summary = %(Upload content)
+  c.description = %(
+Upload a content item.
 
 Data uploaded to a product's content area can be downloaded by devices using
 the HTTP Device API.
-  }
-  c.option '--meta STRING', %{Add extra meta info to the content item}
+  ).strip
+
+  c.option('--tags KEY=VALUE', %(Add extra meta info to the content item)) do |ec|
+    key, value = ec.split('=', 2)
+    # a=b :> ["a","b"]
+    # a= :> ["a",""]
+    # a :> ["a"]
+    raise "Bad tag key '#{param}'" if key.to_s.empty?
+    raise "Bad tag value '#{param}'" if value.to_s.empty?
+    key = key.downcase if key.casecmp('name').zero?
+    tags[key] = value
+  end
 
   c.action do |args, options|
-    options.default :meta=>' '
-    prd = MrMurano::ProductContent.new
-
-    if args[0].nil? then
-      prd.error "Missing <content id>"
-    elsif args[1].nil? then
-      prd.error "Missing <file>"
-    else
+    c.verify_arg_count!(args, 1, ['Missing <file>'])
+    options.default meta: ' '
 
-      ret = prd.info(args[0])
-      if ret.nil? then
-        ret = prd.create(args[0], options.meta)
-        prd.outf(ret) unless ret.nil? or ret.empty?
-      end
+    prd = MrMurano::Content::Base.new
 
-      ret = prd.upload(args[0], args[1])
-      prd.outf(ret) unless ret.nil? or ret.empty?
+    name = ::File.basename(args[0])
+    name = tags['name'] if tags.key? 'name'
+    if name.to_s.empty?
+      prd.error 'Bad file name'
+      exit 2
     end
+
+    tags = nil if tags.empty?
+    prd.upload(name, args[0], tags)
   end
 end
 
 command 'content download' do |c|
-  c.syntax = %{murano content download <content id>}
-  c.summary = %{Download a content item}
-  c.description = %{Download a content item
+  c.syntax = %(murano content download <content name>)
+  c.summary = %(Download a content item)
+  c.description = %(
+Download a content item.
 
 Data uploaded to a product's content area can be downloaded by devices using
 the HTTP Device API.
-  }
-  c.option '-o','--output FILE',%{save to this file}
+  ).strip
+
+  c.option '-o', '--output FILE', %(Save content to a file)
+
   c.action do |args, options|
-    prd = MrMurano::ProductContent.new
-    if args[0].nil? then
-      prd.error "Missing <content id>"
+    c.verify_arg_count!(args, 1, ['Missing <content name>'])
+    prd = MrMurano::Content::Base.new
+    if options.output.nil?
+      prd.download(args[0]) # to stdout
     else
-
-      if options.output.nil? then
-        prd.download(args[0]) # to stdout
-      else
-        outFile = Pathname.new(options.output)
-        outFile.open('w') do |io|
-          prd.download(args[0]) do |chunk|
-            io << chunk
-          end
+      out_file = Pathname.new(options.output)
+      out_file.open('w') do |io|
+        prd.download(args[0]) do |chunk|
+          io << chunk
         end
       end
     end
   end
 end
 
-
-#  vim: set ai et sw=2 ts=2 :