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

data/lib/MrMurano/commands/element.rb

@@ -0,0 +1,585 @@
+# Copyright © 2016-2017 Exosite LLC. All Rights Reserved
+# License: PROPRIETARY. See LICENSE.txt.
+# frozen_string_literal: true
+
+# vim:tw=0:ts=2:sw=2:et:ai
+# Unauthorized copying of this file is strictly prohibited.
+
+require 'highline'
+require 'pathname'
+require 'tempfile'
+require 'tty-editor'
+require 'MrMurano/hash'
+require 'MrMurano/makePretty'
+require 'MrMurano/verbosing'
+require 'MrMurano/Exchange'
+require 'MrMurano/ReCommander'
+require 'MrMurano/commands/business'
+require 'MrMurano/commands/exchange'
+require 'MrMurano/variegated/ruby_dig'
+
+# NOTE: For details on the BizAPI Exchange Element API, see:
+#
+#   https://docs.google.com/document/d/1VlFmkiNcBK9AX6BpgV-E_5EDGgt0K_L5exJcgv6gEDQ/edit#heading=h.l6fiheqnpa08
+
+class ElementCmd
+  include MrMurano::Verbose
+
+  def initialize
+    reset_state
+  end
+
+  def reset_state
+    @edit_fields = {}
+    @updated_obj = {}
+    @use_editor = false
+    @input_path = nil
+    @input_data = nil
+  end
+
+  # *** element-help command
+
+  def command_element_help(cmd)
+    cmd.syntax = %(murano element)
+    cmd.summary = %(IoT Marketplace Exchange Element commands)
+    cmd.description = %(
+      Commands for working with IoT Marketplace Exchange Elements.
+    ).strip
+    cmd.project_not_required = true
+    cmd.subcmdgrouphelp = true
+
+    cmd.action do |_args, _options|
+      ::Commander::UI.enable_paging unless $cfg['tool.no-page']
+      say MrMurano::SubCmdGroupHelp.new(cmd).get_help
+      reset_state
+    end
+  end
+
+  def verify_args_id_or_name!(cmd, args, options, max_args: 1)
+    cmd.verify_arg_count!(args, max_args, ['Missing Element name or ID'])
+    cmd_defaults_id_and_name(options)
+  end
+
+  def elems_must_find_one!(args, options)
+    xchg = MrMurano::Exchange.new
+    xchg.must_business_id!
+
+    exchange_cmd = ExchangeCmd.new
+
+    elems, _available, _purchased = exchange_cmd.find_elements(
+      xchg, options, args[0], skip_purchased: true,
+    )
+
+    exchange_cmd.elems_must_found_one!(elems, xchg)
+  end
+
+  # *** element-show command
+
+  NOT_A_BAD_ORDER_ELEMENT_KEYS = %i[
+    bizid
+    elementId
+    name
+    tags
+    type
+    contact
+    source
+    specs
+    description
+    markdown
+    image
+    attachment
+
+    approval
+    active
+    managed
+    pinned
+    access
+    tiers
+  ].freeze
+
+  def command_element_show(cmd)
+    cmd.syntax = %(murano element show [--options] <name-or-ID>)
+    cmd.summary = %(Show details about an IoT Marketplace Exchange Element)
+    cmd.description = %(
+      Show details about an IoT Marketplace Exchange Element.
+    ).strip
+    # We don't need to be in a project directory; we just need the Biz ID.
+    cmd.project_not_required = true
+
+    # Not too DRY: See also cmd_table_output_add_options(cmd), which also
+    # adds --idonly and --[no-]brief.
+    cmd.option '-o', '--output FILE', 'Download to file instead of STDOUT'
+
+    cmd.option '--[no-]truncate', 'Truncate longs lines...'
+    cmd.option '--[no-]wrap', 'Wrap long lines...'
+
+    cmd.example %(Show table of Exchange Element fields, wrapped nicely to fit terminal
+), %(murano element show abcdef1234567890abcdef1234567890abcdef12 --wrap)
+
+    cmd.example %(Store Exchange Element record as JSON in local file
+), %(murano element show 'remote condition monitoring' --json > rcm.json)
+
+    # Add --id and --name options.
+    cmd_options_add_id_and_name(cmd)
+
+    cmd_options_pretty_format_option(cmd)
+
+    cmd.action do |args, options|
+      verify_args_id_or_name!(cmd, args, options)
+      sole_elem = elems_must_find_one!(args, options)
+
+      orig_elem, flatkeys, val_lkup = objectify_elem(sole_elem, options)
+
+      io = File.open(options.output, 'w') if options.output
+      outf(orig_elem, io, pretty: options.pretty) do |elem, ios|
+        if $cfg['tool.outformat'] =~ /csv/i
+          headers, row_lkup = prepare_hash_csv(elem)
+        else
+          # Outformat is table. Make tall, not wide.
+          headers = %w[key value]
+          # Sort by top-level keys first, i.e., group objects, at least.
+          flatkeys = sort_key_hier(flatkeys, elem.keys)
+          row_lkup = Hash[flatkeys.collect { |key| [key, val_lkup[key]] }]
+        end
+        tabularize({ headers: headers, rows: row_lkup }, ios)
+      end
+      reset_state
+    end
+  end
+
+  def cmd_options_pretty_format_option(cmd)
+    cmd.option('-p', '--pretty', %(Whether to pretty-print --json))
+  end
+
+  def objectify_elem(elem, options)
+    lkup = objectify_elem_lkup(elem)
+    flatkeys = objectify_elem_flat(lkup)
+    width_avail = objectify_elem_width(flatkeys, options)
+    val_lkup = objectify_elem_values(flatkeys, lkup, width_avail, options)
+    [lkup, flatkeys, val_lkup]
+  end
+
+  def objectify_elem_lkup(elem)
+    lkup = HashDiggable.new(elem.meta)
+    lkup.default_proc = proc do |hash, key|
+      warning %(Not a symbol!: #{key}) unless key.is_a? Symbol
+      hash[key] = Hash.new(&hash.default_proc)
+    end
+    lkup
+  end
+
+  def objectify_elem_flat(lkup)
+    flatkeys = Hash.flat_hash(lkup).keys.map { |hier| hier.join('.') }
+    flatkeys.sort
+  end
+
+  def objectify_elem_width(flatkeys, options)
+    # This is similar to Pretties.width_last_column
+    width_avail = -1
+    if options.truncate || options.wrap
+      width_taken = 0
+      # Account for the left and right borders.
+      # rubocop:disable Performance/FixedSize
+      width_taken += 2 * ('| '.length)
+      # And account for the middle column split.
+      width_taken += ' | '.length
+      width_taken += flatkeys.max_by(&:length).length
+      term_width, _rows = HighLine::SystemExtensions.terminal_size
+      width_avail = term_width - width_taken
+    end
+    width_avail
+  end
+
+  def objectify_elem_values(flatkeys, lkup, width_avail, options)
+    val_lkup = {}
+    flatkeys.each do |key|
+      layers = key.split('.').map(&:to_sym)
+      val = lkup.dig(*layers).to_s
+      if width_avail > 0
+        if options.truncate
+          val.slice!(width_avail..-1)
+        elsif options.wrap
+          val = MrMurano::Pretties.split_text_on_whitespace(val, width_avail)
+        end
+      end
+      # Store the flattened key-value if a flat lookup, for the table maker.
+      val_lkup[key] = val
+    end
+    val_lkup
+  end
+
+  def sort_key_hier(flattened_keys, top_level_keys)
+    sort_order = (NOT_A_BAD_ORDER_ELEMENT_KEYS + top_level_keys.sort).map(&:to_s).uniq
+    flattened_keys.sort_by do |key|
+      sort_order.index do |top|
+        key.downcase.start_with?(top.downcase)
+      end
+    end
+  end
+
+  # *** element-edit command
+
+  EXCHANGE_ELEMENT_FIELD_DESC = {
+    # Not editable: bizid
+    # Not editable: elementId
+    name: ['elem-name', 'Element name'],
+    # MAYBE/2018-04-26: (lb): Web UI does not reveal tags. Should the CLI?
+    tags: ['', 'Element tags'], # ["...",...]
+    contact: ['', 'Element contact information'],
+    specs: [
+      '',
+      (
+        "Included Capabilities\n\n" \
+        'List exchange element compatibilities, ' \
+        'versions, and or other technically relevant aspects'
+      ),
+    ],
+    description: ['', 'Short description'],
+    markdown: ['', 'Fill item description'],
+    # Dynamic options (use -e ...):
+    #   source.{from|name|url}
+    # Uneditable strings:
+    #   type = [download|service|product|application|contactSales}
+    #   tiers = [free|developer|professional|enterprise]
+    #   access = [public|...]
+    #   approval = [approved|...]
+    # Uneditable booleans:
+    #   active
+    #   pinned
+    #   managed
+    #   publishToBusinessNetwork
+    # Not yet/Not going to be supported options:
+    #   image.detail.{color|filename|type|url}
+    #   image.thumbnail.{color|filename|type|url}
+  }.freeze
+
+  EXCHANGE_ELEMENT_NOT_ALLOWED = %i[
+    tiers
+    approval
+  ].freeze
+
+  def command_element_edit(cmd)
+    cmd.syntax = %(murano element edit [--options] <name-or-ID> [file])
+    cmd.summary = %(Edit details about an IoT Marketplace Exchange Element)
+    cmd.description = %(
+      Edit details about an IoT Marketplace Exchange Element.
+    ).strip
+    # We don't need to be in a project directory; we just need the Biz ID.
+    cmd.project_not_required = true
+
+    # Add --id and --name options.
+    cmd_options_add_id_and_name(cmd)
+
+    cmd_options_add_exchange_element_fields(cmd)
+
+    cmd_options_add_outformat_plain(cmd)
+
+    cmd.example %(Upload Exchange Element record from JSON stored in local file
+), %(murano element edit 'remote condition monitoring' rcm.json)
+
+    cmd.example %(Edit single field of Exchange Element record
+), %(murano element edit 'my element' -e image.thumbnail.color=#5C5D60)
+
+    cmd.example %(Edit single sub dictionary of Exchange Element record using Yaml file
+), %(murano element edit -e source -- 'my element' element-source.yaml)
+
+    cmd.example %(Edit single sub dictionary of Exchange Element record using JSON file
+), %(murano element edit -e source=@element-source.yaml 'my element')
+
+    cmd.example %(Edit Exchange Element fields using your ${EDITOR}
+), %(murano element edit -e -- <Element_ID_or_Name>)
+
+    cmd.action do |args, options|
+      begin
+        cmd_edit_execute(cmd, args, options)
+      ensure
+        # This is for RSpec, so the command instance resets itself between runs.
+        reset_state
+      end
+    end
+  end
+
+  def cmd_edit_execute(cmd, args, options)
+    verify_args_id_or_name!(cmd, args, options, max_args: 2)
+    file_must_find_maybe(args[1])
+    options_must_specify_edits!
+    edit_fields_load_input_files
+    sole_elem = elems_must_find_one!(args, options)
+    update_elem_fields(sole_elem)
+    xchg = MrMurano::Exchange.new
+    xchg.put(sole_elem.elementId, @updated_obj)
+  end
+
+  def cmd_options_add_exchange_element_fields(cmd)
+    cmd_options_add_fields_static(cmd)
+    cmd_options_add_fields_dynamic(cmd)
+  end
+
+  def cmd_options_add_fields_static(cmd)
+    # Add --options from EXCHANGE_ELEMENT_FIELD_DESC but sort them.
+    NOT_A_BAD_ORDER_ELEMENT_KEYS.each do |field|
+      field_desc = EXCHANGE_ELEMENT_FIELD_DESC[field]
+      next if field_desc.nil?
+      switch = !field_desc[0].empty? && field_desc[0] || field.to_s
+      detail = !field_desc[1].empty? && field_desc[1] || field.to_s
+      cmd.option(
+        "--#{switch} [VALUE]", detail
+      ) do |param|
+        @edit_fields[field.to_s] = param
+      end
+    end
+  end
+
+  def cmd_options_add_fields_dynamic(cmd)
+    cmd.option(
+      '-e', '--edit [KEY[=VALUE]]', %(Set the Element field named KEY to VALUE)
+    ) do |param|
+      if param.nil?
+        # param.nil? means user did not supply key[=val].
+        @edit_fields[''] = nil
+      else
+        # Otherwise: a=b :> ['a', 'b'] / a=  :> ['a', ''] / a   :> ['a', nil]
+        key, value = param.split('=', 2)
+        @edit_fields[key] = value
+      end
+    end
+  end
+
+  def cmd_options_add_outformat_plain(cmd)
+    cmd.option(
+      '--plain',
+      'Do not decode input file(s) (e.g., if named specs.yaml, import as plaintext)'
+    ) do
+      $cfg['tool.outformat'] = 'text'
+    end
+  end
+
+  def file_must_find_maybe(path)
+    return if path.nil?
+    @input_path = Pathname.new(path) unless path.is_a?(Pathname)
+    return if @input_path.exist?
+    error %(Input file not found: #{@input_path})
+    exit 1
+  end
+
+  def options_must_specify_edits!
+    n_kvals = { n_keys: 0, n_vals: 0 }
+    options_edits_count(n_kvals)
+    options_edits_verify!(n_kvals)
+  end
+
+  def options_edits_count(n_kvals)
+    @edit_fields.each do |_key, val|
+      n_kvals[:n_keys] += 1
+      n_kvals[:n_vals] += 1 unless val.nil?
+    end
+  end
+
+  def options_edits_verify!(n_kvals)
+    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]
+          error %(
+            Please specify at most one field when not specifing all field values.
+          ).strip
+          exit 2
+        end
+      elsif n_kvals[:n_keys] == 0
+        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.')
+      exit 2
+    elsif n_kvals[:n_vals] > 0
+      error('Please do not specify a value when specifing an input file.')
+      exit 2
+    end
+  end
+
+  def edit_fields_load_input_files
+    set_fields_from_files_from_options
+    set_field_from_file_from_positional
+  end
+
+  def set_fields_from_files_from_options
+    @edit_fields.update(@edit_fields) do |_key, value, _other|
+      next value unless value_specifies_file_input?(value)
+      load_input_maybe(value)
+    end
+  end
+
+  def set_field_from_file_from_positional
+    return if @input_path.nil?
+    @input_data = read_hashf!(@input_path)
+    @input_data.deep_symbolize_keys! if @input_data.is_a? Hash
+  end
+
+  def update_elem_fields(elem)
+    @updated_obj = HashDiggable.new(elem.meta)
+    n_edits = 0
+    # When @edit_fields == { '' => '' }, BizAPI replies:
+    #   Request Failed: 400: [400] child "type" fails because ["type" is required]
+    if @use_editor
+      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
+    if n_edits.zero?
+      warning('No new field values specified to update.')
+      exit 0
+    end
+    @updated_obj.reject! { |key, _val| EXCHANGE_ELEMENT_NOT_ALLOWED.include?(key) }
+  end
+
+  def update_elem_fields_from_editor
+    keys, hash_val = prepare_field_keys_and_value
+    tmpf, fmt = write_editable_tmp_file(hash_val)
+    user_editor_interact(tmpf)
+    edit_val = consume_edited_tmp_file(tmpf, fmt)
+    edit_val.deep_symbolize_keys! if edit_val.is_a? Hash
+    update_field_maybe!(keys, edit_val, hash_val)
+  end
+
+  def prepare_field_keys_and_value
+    field = @edit_fields.first[0]
+    keys = []
+    keys = field.split('.').map(&:to_sym) unless field.to_s.empty?
+    if !keys.nil? && !keys.empty?
+      hash_val = @updated_obj.dig_safe(*keys)
+    else
+      hash_val = @updated_obj
+    end
+    [keys, hash_val]
+  end
+
+  def write_editable_tmp_file(hash_val)
+    fmt = outformat_engine(nil, hash_val)
+    tmpf = Tempfile.new(["murcli_#{@updated_obj[:elementId]}-", ".#{fmt}"])
+    dump_output_file(hash_val, tmpf, fmt, pretty: true)
+    tmpf.close
+    [tmpf, fmt]
+  end
+
+  def outformat_engine(fext, hash_val=nil)
+    if !fext.nil?
+      super(fext)
+    elsif hash_val.is_a? Hash
+      super($cfg['tool.outformat'])
+    else
+      :plain
+    end
+  end
+
+  def user_editor_interact(tmpf)
+    TTY::Editor.open(tmpf.path)
+  end
+
+  def consume_edited_tmp_file(tmpf, fmt)
+    tmpf.open
+    edit_val = load_input_file(tmpf, fmt)
+    tmpf.unlink
+    edit_val
+  end
+
+  def update_field_maybe!(keys, edit_val, hash_val)
+    n_edits = 0
+    if edit_val != hash_val
+      if !keys.nil? && !keys.empty?
+        @updated_obj.fill_safe(edit_val, *keys)
+      else
+        @updated_obj = obj_must_be_hash!(edit_val)
+      end
+      n_edits += 1
+    end
+    n_edits
+  end
+
+  def update_elem_fields_from_options
+    n_edits = 0
+    @edit_fields.each_pair do |key, value|
+      next if value.nil?
+      keys = key.split('.').map(&:to_sym) unless key.nil?
+      if !keys.nil? && !keys.empty?
+        old_val = @updated_obj.dig_safe(*keys)
+      else
+        old_val = @updated_obj
+      end
+      n_edits += update_field_maybe!(keys, value, old_val)
+    end
+    n_edits
+  end
+
+  def obj_must_be_hash!(obj)
+    if obj.is_a? Hash
+      obj
+    elsif obj.empty?
+      {}
+    else
+      begin
+        parsed = JSON.parse(obj)
+      rescue JSON::ParserError => err
+        error %(The document object is not a Hash: #{obj})
+        error err.to_s
+        exit 2
+      end
+      return parsed if parsed.is_a? Hash
+    end
+  end
+
+  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)
+    end
+    keys = @edit_fields.first[0].split('.').map(&:to_sym) unless @edit_fields.empty?
+    if !keys.nil? && !keys.empty?
+      old_val = @updated_obj.dig_safe(*keys)
+      if old_val != @input_data
+        @updated_obj.fill_safe(@input_data, *keys)
+        n_edits += 1
+      end
+    elsif @updated_obj != @input_data
+      @updated_obj = @input_data
+      n_edits += 1
+    end
+    n_edits
+  end
+
+  def value_specifies_file_input?(field_value)
+    field_value =~ /^@(?!@)/
+  end
+
+  def load_input_maybe(field_value)
+    return field_value.gsub(/^@@/, '@') unless value_specifies_file_input?(field_value)
+    # If the -e field=value starts with '@', e.g., input=@in.json,
+    # try to load the field value from the file.
+    path = Pathname.new(field_value.slice(1..-1))
+    read_hashf!(path)
+  end
+
+  def read_hashf!(path, fmt=nil)
+    fmt = :plain if fmt.nil? && ($cfg['tool.outformat'] == 'text')
+    @input_data = super(path, fmt)
+  end
+end
+
+def wire_cmd_element
+  element_cmd = ElementCmd.new
+
+  command(:element) { |cmd| element_cmd.command_element_help(cmd) }
+
+  command('element show') { |cmd| element_cmd.command_element_show(cmd) }
+
+  command('element edit') { |cmd| element_cmd.command_element_edit(cmd) }
+  alias_command 'element update', 'element edit'
+end
+
+wire_cmd_element
+