MuranoCLI 3.2.2.beta.2 → 3.2.2.beta.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12d344b05fe0a8a403f5d166b1ac75b5b111a476111612b4ba45134e307d5df3
-  data.tar.gz: d53c7a3d60aac2088cf707616e0bcfdcef62d96a722bd1f438221b962866f5b8
+  metadata.gz: 873b8cb25d9f921b8f7d516d3af89f9a8c00c0fca3563185c20e8f309e399e66
+  data.tar.gz: ce2ebb53424b1630afdc8792e55f557f4a16106ae52a309b6de895f6795269bb
 SHA512:
-  metadata.gz: 7e79ea5d8fd3e7cdb3f947f801523d6c8c663ea2d2cd59ac97ef2c328052215660986f0698ba7f1351f039c9af9106a0cf54fa144ad930b8e6da6eb469870e88
-  data.tar.gz: 58c1a02f8df8d9f4d9cf868d70e8280b7f2b763a3627471dcf8d91b6fc28dab7ed7be2f1ed1b190aed20a7a4b0b54a7bacb9f2756988a7b3e27529b23e31b72f
+  metadata.gz: 1c745b425de12f64871b71c930b6caf3d57d5000e2b5971f199b2e40a47a90d4bcee6508a145bb05d219f76f73f4487ab06c1408a2ac24d1841b6fcce2001370
+  data.tar.gz: 396c7e304790dcc1dd8f0d4e5e9be70abf212e687a0396c74a7d7874c4fbb107c262af9ddef9a55217863f85b7097bffb731b815a2e3c33dda92fc34ba58cbb4

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,60 @@
+### Issue Reference
+
+*Please fill in the Issue number.*
+
+https://jira.exosite.com/browse/MUR-XXXX
+
+### Additional Notes
+
+*Please add optional, supplementary information for the reviewer.*
+
+### Git and GitHub Etiquette
+
+Please follow the guidelines documented in [Git Best Practices](https://github.com/exosite/MuranoCLI/blob/develop/docs/gitflow.md).
+
+### Readiness Checklist
+
+*Please complete this checklist before asking for a review.*
+
+- [ ] Linting checked with `rake lint`
+
+- [ ] New unit tests added (if applicable)
+
+- [ ] All unit tests pass with `rake rspec`
+      *(2018-09-07: Should be >= 537 active tests)*
+
+- [ ] New unit tests provide coverage of new code
+      (peruse `report/index-*.html` to verify)
+
+- [ ] New commands and all options tested using CLI
+
+- [ ] All inline `--help` updated and verified using CLI
+
+- [ ] Full walkthrough of current Epic performed (if applicable)
+
+- [ ] New features and bugfixes tested against the appropriate
+      environments (`dev`, `staging`, and/or `production`)
+
+- [ ] Developer documentation updated and compiles (if applicable)
+
+### When you Merge
+
+*Follow these steps after your PR has been approved by a coworker.* 
+
+1. Click the 'Merge pull request' button.
+
+   - Do not squash; we want to preserve your beautiful commit history
+     in the codebase.
+
+2. Edit the title of the merge message.
+
+   - Message format: **<JIRA_Ticket_Title> (<ticket_nums>) (PR_num)**
+
+   - For example: **Foo Bar Bug (MUR-1234) (#666)**
+
+3. Clear out the body text of the merge message.
+
+4. Click the 'Confirm merge' button.
+
+5. Delete your old branch.
+

data/.rubocop.yml

@@ -261,6 +261,7 @@ Style/TrailingCommaInLiteral:
   EnforcedStyleForMultiline: "consistent_comma"
 
 AllCops:
+  TargetRubyVersion: 2.3.7
   Include:
     - 'bin/murano'
     # These are included by default:
@@ -285,7 +286,4 @@ AllCops:
     #
     # The spec_helper is a generated file; don't care.
     - 'spec/spec_helper.rb'
-    # The unit test for syncdown has a ton of copy-paste curl output,
-    # which would be super duper tedious to clean up for the linter.
-    - 'spec/cmd_syncdown_unit_spec.rb'
 

data/Gemfile

@@ -20,6 +20,7 @@ gem 'inflecto'
 gem 'inifile', '~> 3.0'
 gem 'json', '~> 2.1.0'
 gem 'json-schema', '~> 2.7.0'
+gem 'launchy', '~> 2.4.3'
 gem 'mime-types', '~> 3.1'
 gem 'mime-types-data', '~> 3.2016.0521'
 # We forked commander to fix empty-string --args issue.
@@ -35,6 +36,7 @@ gem 'paint', '~> 2.0.0'
 #   It's included by json, so make sure it's the old one.
 gem 'public_suffix', '~> 2.0.5'
 gem 'rainbow', '~> 2.2.2'
+gem 'redcarpet', '~> 3.4.0'
 # LATER/2017-09-12: See MRMUR-160 and MRMUR-161:
 #   Windows build fails unless `rake` is packaged.
 gem 'rake', '~> 12.1.0'

data/HISTORY.md

@@ -2,6 +2,34 @@
 
 ---------------------------------------------------------------------------
 
+## Murano CLI v3.2.2.beta.3 (2018-09-06)
+
+### New
+
+- Expose ``device2.event`` event handler. (Issue: [MUR-4543](https://i.exosite.com/jira/browse/MUR-4543))
+
+### Improved
+
+- Fail early on ``content upload`` if file size exceeds maximum allowed (users may specify ``--no-limit`` to skip check and force upload). (Issue: [MUR-898](https://i.exosite.com/jira/browse/MUR-898))
+
+- Do not crash on corrupt cache. Show warning instead, and ask user to email the corrupt cache file to the Murano Exchange team. (Issue: [MUR-4669](https://i.exosite.com/jira/browse/MUR-4669))
+
+### Fixed
+
+- Fix ``migrate up`` and ``migrate down`` to sort and order migration scripts numerically, not alphabetically. (E.g., migrating from version ``9`` to ``10`` was broken.) (Issue: [MUR-7570](https://i.exosite.com/jira/browse/MUR-7570))
+
+- Display platform error when ``postgresql`` or ``tsdb`` commands file, rather than crashing. (Issue: [MUR-7878](https://i.exosite.com/jira/browse/MUR-7878))
+
+- Read keystore value from STDIN if not specified in command arguments. (Issue: [MUR-4410](https://i.exosite.com/jira/browse/MUR-4410))
+
+- Prevent external HighLine library from crashing on "Error: Infinity" during ``murano init``. (Issue: [MUR-6474](https://i.exosite.com/jira/browse/MUR-6474))
+
+### Developer improvements
+
+- Update developer documentation and add ``rake`` tasks for macOS development. (Issue: [MUR-8114](https://i.exosite.com/jira/browse/MUR-8114))
+
+---------------------------------------------------------------------------
+
 ## Murano CLI v3.2.2.beta.2 (2018-08-30)
 
 ### Improved

data/MuranoCLI.gemspec

@@ -101,6 +101,7 @@ And so much more.
   s.add_runtime_dependency('rainbow', '~> 2.2.2')
   # 2017-09-12: MRMUR-160/MRMUR-161: (lb): Windows build fails without `rake`.
   s.add_runtime_dependency('rake', '~> 12.1.0')
+  s.add_runtime_dependency('redcarpet', '~> 3.4.0')
   s.add_runtime_dependency('terminal-table', '~> 1.8.0')
   s.add_runtime_dependency('tty-editor', '~> 0.4.0')
   s.add_runtime_dependency('vine', '~> 0.4')

data/Rakefile

@@ -10,10 +10,15 @@ require 'open3'
 require 'shellwords'
 require 'tmpdir'
 
-task default: %i[test]
+task default: %i[tasks]
 
 # ***
 
+desc 'Show list of tasks'
+task :tasks do
+  sh %(rake --tasks)
+end
+
 def current_ver
   Bundler::GemHelper.gemspec.version.version
 end
@@ -65,6 +70,16 @@ task :'install:user' do
   build_gem_install_user
 end
 
+def build_gem_install_user_mac(gem_ver=nil)
+  Rake::Task['install'].invoke
+  sh %(gem install #{built_gem(gem_ver)})
+end
+
+desc 'Build and install into user gems directory on mac using rvm'
+task :'install:user:mac' do
+  build_gem_install_user_mac
+end
+
 desc 'Uninstall gem from user gems directory'
 task :'uninstall:user' do
   # HINT: Replace #{built_gem} with any version to uninstall a specific version.
@@ -347,6 +362,18 @@ end
 
 # ***
 
+# (lb): Shadow bundler's release task, which we don't use.
+#   The task looks like this:
+#     (byebug) Rake::Task['release']
+#     <Rake::Task release => [
+#       build, release:guard_clean, release:source_control_push, release:rubygem_push
+#     ]>
+task :release do
+  shamings = ['Nope!', 'Wrong!!', 'Think again!!!']
+  $stdout.puts shamings[Random.rand(shamings.length)]
+  exit 1
+end
+
 namespace :package do
   GH_OWNER = 'exosite'
   GH_REPO = 'MuranoCLI'
@@ -418,22 +445,6 @@ Here's some light reading if you need help:
     exit 1
   end
 
-  def api_gh_fetch_releases
-    # If the GitHub project was public, we could just `wget https://....gem`,
-    # but the project is private, so we gotta use the GitHub API to fetch it.
-    _out, _err, _status = Open3.capture3(
-      %(
-        curl --header "Authorization: token #{ENV['GITHUB_TOKEN']}" \
-             --header "Accept: application/json" \
-             --remote-name \
-             --location \
-               https://api.github.com/repos/#{GH_OWNER}/#{GH_REPO}/releases
-      )
-    )
-    sh %(cat releases | head -n 14)
-    $stdout.puts %(...\n\n)
-  end
-
   def api_gh_fetch_asset_id
     _out, _err, _status = Open3.capture3(
       %(
@@ -444,12 +455,15 @@ Here's some light reading if you need help:
                https://api.github.com/repos/#{GH_OWNER}/#{GH_REPO}/releases/tags/v#{current_ver}
       )
     )
-    sh %(cat v#{current_ver} | head -n 14)
-    $stdout.puts %(...\n\n)
-
-    asset_id, _err, _status = Open3.capture3(%(cat v#{current_ver} | jq '.assets[0].id'))
-    $stdout.puts %(asset_id: #{asset_id}\n)
-    asset_id
+    # If there's no such release, you'll see, e.g.,
+    #  { "message": "Not Found", "documentation_url": "..." }
+    # Otherwise, you'll find an assets array in the JSON.
+    # NOTE: Use -M to disable output coloring.
+    asset_id, _err, _status = Open3.capture3(
+      %(cat v#{current_ver} | jq -M '.assets[0].id')
+    )
+    asset_id.chomp!
+    (asset_id != 'null') && asset_id || nil
   end
 
   def api_gh_fetch_asset(asset_id)
@@ -524,7 +538,6 @@ Now, smoke test!
     must_env_github_token!
     Dir.mktmpdir do |tmpdir|
       Dir.chdir(tmpdir)
-      api_gh_fetch_releases
       asset_id = api_gh_fetch_asset_id
       gem_name = api_gh_fetch_asset(asset_id)
       must_gem_downloaded!(gem_name)
@@ -537,6 +550,18 @@ Now, smoke test!
       # it (and we might need it to troubleshoot!).
     end
   end
+
+  # rake package:pushed?
+  desc 'Check if the Gem has been built and pushed to GitHub'
+  task :pushed? do
+    must_env_github_token!
+    Dir.mktmpdir do |tmpdir|
+      Dir.chdir(tmpdir)
+      asset_id = api_gh_fetch_asset_id
+      $stdout.puts(asset_id.to_s.empty? && 'no' || 'yes')
+      exit asset_id.to_s.empty? && 1 || 0
+    end
+  end
 end
 
 # *** Push tasks (used by Jenkins CI release job).

data/lib/MrMurano/Config-Migrate.rb

@@ -20,29 +20,45 @@ module MrMurano
       # Is in JSON, which as a subset of YAML, so use YAML parser
       solsecret.open do |io|
         ss = YAML.load(io)
-
         pff = $cfg.file_at('passwords', :user)
         pwd = MrMurano::Passwords.new(pff)
-        pwd.load
-        ps = pwd.get($cfg['net.host'], ss['email'])
-        if ps.nil?
+        ps = load_passwords_maybe(pwd, pff, ss)
+        update_passwords_maybe(pwd, ps, ss)
+        update_config_from_secrets(ss)
+      end
+    end
+
+    def load_passwords_maybe(pwd, pff, ss)
+      # 2018-09-05: (lb): I added a new warning for when the passwords file
+      # is not present, which is uncommon for normal users, but for tests,
+      # it's all too common. So do not expect the passwords file to be there.
+      return nil unless pff.exist?
+      pwd.load
+      pwd.get($cfg['net.host'], ss['email'])
+    end
+
+    def update_passwords_maybe(pwd, ps, ss)
+      if ps.nil?
+        pwd.set($cfg['net.host'], ss['email'], ss['password'])
+        pwd.save
+      elsif ps != ss['password']
+        okay = ask(
+          'A different password for this account already exists. Overwrite? N/y'
+        )
+        if okay =~ /^y/i
           pwd.set($cfg['net.host'], ss['email'], ss['password'])
           pwd.save
-        elsif ps != ss['password']
-          y = ask('A different password for this account already exists. Overwrite? N/y')
-          if y =~ /^y/i
-            pwd.set($cfg['net.host'], ss['email'], ss['password'])
-            pwd.save
-          end
-        # else, already set, nothing to do.
         end
+      # else, already set, nothing to do.
+      end
+    end
 
-        $cfg.set('user.name', ss['email'])
-        $project.refresh_user_name
+    def update_config_from_secrets(ss)
+      $cfg.set('user.name', ss['email'])
+      $project.refresh_user_name
 
-        $cfg.set('application.id', ss['solution_id']) if ss.key? 'solution_id'
-        $cfg.set('product.id', ss['product_id']) if ss.key? 'product_id'
-      end
+      $cfg.set('application.id', ss['solution_id']) if ss.key? 'solution_id'
+      $cfg.set('product.id', ss['product_id']) if ss.key? 'product_id'
     end
   end
 end

data/lib/MrMurano/Config.rb

@@ -284,7 +284,6 @@ module MrMurano
       #   that we don't want to touch.
       set('eventhandler.skiplist', %w[
         device.service_call
-        device2.event
         interface
         webservice
         websocket
@@ -344,6 +343,13 @@ module MrMurano
       set('business.name', nil, :defaults)
       set('application.name', nil, :defaults)
       set('product.name', nil, :defaults)
+      # (lb): The maximum allowed size the platform indicates is different
+      # between deployed environments. As measured on 2018-09-05:
+      #                         134_219_813  # dev
+      #                         134_219_804  # staging
+      #                         134_219_808  # prod
+      # Let's just use the least common value, otherwise we'll be here all day.
+      set('content.size_limit', 134_219_804, :defaults) # Content service upload limit from Pegasus
     end
 
     ## Find the root of this project Directory.

data/lib/MrMurano/HttpAuthed.rb

@@ -65,7 +65,8 @@ module MrMurano
       return @pass_file unless @pass_file.nil?
       pwd_path = $cfg.file_at(MrMurano::Passwords::FILENAME, :user)
       @pass_file = MrMurano::Passwords.new(pwd_path)
-      @pass_file.load
+      # Check password file exists to avoid not-found warning.
+      @pass_file.load if pwd_path.exist?
       @pass_file
     end
 

data/lib/MrMurano/Passwords.rb

@@ -27,30 +27,75 @@ module MrMurano
       @data = nil
     end
 
+    def trace_type
+      fancy_ticks(@val_type || self.class)
+    end
+
     def load
-      return unless @path.exist?
+      return if clear_data_unless_storage_file_exists
+      fix_permissions_storage_file
+      load_data_from_storage_file
+    end
+
+    def clear_data_unless_storage_file_exists
+      return false if @path.exist?
+      warning %(Could not load #{trace_type} file at: #{@path})
+      @data = {}
+      true
+    end
+
+    def fix_permissions_storage_file
+      # (lb): This acts like SSH would, and makes file read-write only to
+      # owner, just in case.
       @path.chmod(0o600)
+    rescue StandardError => err
+      warning %(Could not chmod #{trace_type} file at: #{@path})
+      error err.message
+      exit 1
+    end
+
+    def load_data_from_storage_file
       @path.open('rb') do |io|
         @data = YAML.load(io)
         # The @data is, e.g., false, if the file exists but is empty.
         @data = {} unless @data.is_a?(Hash)
       end
     rescue StandardError => err
-      warning %(Could not load #{fancy_ticks(@val_type)} file at: #{@path})
+      warning %(Could not load #{trace_type} file at: #{@path})
       error err.message
       exit 1
     end
 
     def save
-      if $cfg['tool.dry']
-        say '--dry: Not saving config'
-        return
-      end
+      return if say_if_dry_run
+      ensure_dirpath!
+      store_data!
+    end
+
+    def say_if_dry_run
+      return false unless $cfg['tool.dry']
+      say '--dry: Not saving config'
+      true
+    end
+
+    def ensure_dirpath!
       @path.dirname.mkpath unless @path.dirname.exist?
+    rescue StandardError => err
+      # E.g., Errno::EACCES.
+      warning %(Could not create path to #{trace_type} file at: #{@path.dirname})
+      error err.message
+      exit 1
+    end
+
+    def store_data!
       @path.open('wb') do |io|
         io << @data.to_yaml
       end
       @path.chmod(0o600)
+    rescue StandardError => err
+      warning %(Could not store #{trace_type} file at: #{@path})
+      error err.message
+      exit 1
     end
 
     def get(key1, key2)
@@ -85,7 +130,7 @@ module MrMurano
       return unless !hd.nil? && hd.is_a?(Hash)
       if $cfg['tool.dry']
         MrMurano::Verbose.whirly_interject do
-          say(%(--dry: Not removing #{@val_type} for #{fancy_ticks("#{key2}@#{host}")}))
+          say(%(--dry: Not removing #{trace_type} for #{fancy_ticks("#{key2}@#{host}")}))
         end
         return
       end

data/lib/MrMurano/Solution-ServiceConfig.rb

@@ -38,7 +38,11 @@ module MrMurano
 
     def must_id!(id)
       return unless id.nil?
-      raise "ID not set, or Service '#{@service_name}' not enabled for this Solution"
+      service_missing_msg = %(
+        The #{fancy_ticks(@service_name)} service is not enabled for this Solution
+      ).strip
+      warning "#{service_missing_msg}, or the Solution ID is missing."
+      exit 1
     end
 
     def scid_for_name(name)
@@ -194,5 +198,34 @@ module MrMurano
       super
     end
   end
+
+  class PlatformService < ServiceConfig
+    def call_platform(query_or_queries, aqr)
+      # Send a block to call so that the response or error is returned
+      # and no post-processing is done (without the block, http.workit
+      # only returns success JSON; on failure, workit prints a generic
+      # error (the HTTP code) and returns nil).
+      call(query_or_queries, :post, aqr) do |request, http|
+        response = http.request(request)
+        json = workit_response(response)
+        return nil if json.empty?
+        json
+      end
+    end
+
+    def self.must_return_nonnil_nonerror!(ret)
+      # (lb): 2018-08-27: This behavior is old, but feels weird:
+      #   If ret.nil?, silently exit on error; but if ret[:error],
+      #   print the error, then exit on error. My question: why
+      #   not print a generic error message when ret.nil? Or, maybe
+      #   I need to know first, when and why would ret be nil anyway?
+      exit 1 if ret.nil?
+      return if ret[:error].nil?
+      MrMurano::Verbose.error(
+        "ERROR: #{MrMurano::Verbose.fancy_ticks(ret[:error])}"
+      )
+      exit 1
+    end
+  end
 end