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

data/docs/develop.rst

@@ -174,7 +174,7 @@ If you use ``chruby``, tell it what version of ruby you want:
 
 .. code-block:: bash
 
-    cd /exo/clients/exosite/MuranoCLI
+    cd /path/to/MuranoCLI
     echo "ruby-2.3" > .ruby-version
 
 (You can also do this for ``rvm``, which recognizes the
@@ -184,7 +184,7 @@ Now tell chruby to load the version of ruby you want:
 
 .. code-block:: bash
 
-    cd /exo/clients/exosite/MuranoCLI
+    cd /path/to/MuranoCLI
     chruby $(cat .ruby-version)
 
 Install dependencies
@@ -213,7 +213,7 @@ Install the gems listed in the MuranoCLI Gemfile:
 
 .. code-block:: bash
 
-    cd /exo/clients/exosite/MuranoCLI
+    cd /path/to/MuranoCLI
     bundle install --path $(ruby -rubygems -e 'puts Gem.dir') --with test
 
 Build and Install MuranoCLI
@@ -223,7 +223,7 @@ Build and install the Gem locally to your local gem directory.
 
 .. code-block:: bash
 
-    cd /exo/clients/exosite/MuranoCLI
+    cd /path/to/MuranoCLI
 
     rake install:user
 
@@ -263,10 +263,11 @@ so I enable ``curldebug`` and redirect the verbose output to a file,
     id = xxxxxxxxxxxxxxxx
 
     [tool]
-    #curldebug = false
+    developer = true
+    no-page = true
+    curlfile = "/path/to/MuranoCLI/curldebug.out"
     curldebug = true
-
-    curlfile = "/exo/clients/exosite/MuranoCLI/curldebug.out"
+    curlfancy = true
 
 Save the file outside the MuranoCLI repo, e.g., to
 ``/exo/clients/exosite/.murano.test``
@@ -304,7 +305,7 @@ under your business.
 
 .. code-block:: bash
 
-    cd /exo/clients/exosite/MuranoCLI
+    cd /path/to/MuranoCLI
 
     rake test_clean_up
 
@@ -365,7 +366,7 @@ Run All Tests and Capture Colorful Output to HTML
 
     rspec --format html \
         --out report/index-$( \
-            ruby -e 'require "/exo/clients/exosite/MuranoCLI/lib/MrMurano/version.rb"; \
+            ruby -e 'require "/path/to/MuranoCLI/lib/MrMurano/version.rb"; \
             puts MrMurano::VERSION').html 
         --format documentation \
         --tag '~not_in_okami' \

data/lib/MrMurano/AccountBase.rb

@@ -39,8 +39,8 @@ module MrMurano
       MrMurano::HttpAuthed.instance.ensure_token!
     end
 
-    def token_reset
-      MrMurano::HttpAuthed.instance.token_reset
+    def token_reset(new_token='')
+      MrMurano::HttpAuthed.instance.token_reset(new_token)
     end
 
     # ---------------------------------------------------------------------
@@ -53,15 +53,15 @@ module MrMurano
     ).strip.gsub(/^\s+/, '')
 
     def login_info
+      verify_cfg_auth!
       # (lb): This is a little hokey, but someone has to init the Singleton,
       # so we make sure it's ready anytime a new AccountBase instance is created.
       email_pwd = MrMurano::HttpAuthed.instance.login_info
       return email_pwd unless email_pwd.nil?
-      verify_cfg_auth!
       @warned_once = false
       ask_for_user! if user.empty?
       # Do not prompt for password if using token.
-      if !@logging_on && $cfg['auth.scheme-token']
+      if !MrMurano::HttpAuthed.instance.logging_on && $cfg['auth.scheme-token']
         token = MrMurano::HttpAuthed.instance.token_resolve
         return unless token.to_s.empty?
       end
@@ -73,6 +73,10 @@ module MrMurano
       MrMurano::HttpAuthed.instance.login_info = email_pwd
     end
 
+    def credentials_reset
+      MrMurano::HttpAuthed.instance.credentials_reset
+    end
+
     def ask_for_user!
       prologue = 'No Murano user account found.'
       must_prompt_if_logged_off!(prologue)
@@ -145,7 +149,7 @@ module MrMurano
     # ---------------------------------------------------------------------
 
     def logout(keep_user: false, keep_password: false, no_invalidate: false)
-      @logging_on = true
+      MrMurano::HttpAuthed.instance.logging_on = true
 
       token = MrMurano::HttpAuthed.instance.token_lookup
       invalidate_token(token) unless no_invalidate
@@ -162,7 +166,7 @@ module MrMurano
 
       cfg_clear_user_and_business(net_host, user_name) unless keep_user
 
-      @logging_on = false
+      MrMurano::HttpAuthed.instance.logging_on = false
     end
 
     def invalidate_token(tok)
@@ -209,6 +213,91 @@ module MrMurano
       end
       cfg_val
     end
+
+    # ---------------------------------------------------------------------
+
+    # Handle pagination for all commands derived from this class.
+    def get(path='', query=nil, &block)
+      aggregate = nil
+      total = nil
+      remaining = -1
+      first_count = nil
+      orig_query = (query || []).dup
+      while remaining != 0
+        ret = super
+        return nil if ret.nil?
+        # Return now if not paginating.
+        if (!ret.is_a?(Hash) ||
+            !ret.key?(:items) ||
+            !(ret.key?(:total) || ret.key?(:count))
+           )
+          # ret is not a hash, or it's missing :items or :total/:count.
+          unless aggregate.nil?
+            warning %(Unexpected: aggregate set: #{aggregate} / ret: #{ret})
+          end
+          aggregate = ret
+          remaining = 0
+          break
+        end
+        query = orig_query.dup
+        if ret.key?(:total)
+          if total.nil?
+            total = ret[:total]
+            remaining = total
+            # The response also includes a hint of how to get the next page.
+            #   ret[:next] == "/api/v1/eventhandler?query={\
+            #     \"solution_id\":\"XXXXXXXXXXXXXXXX\"}&limit=20&offset=20"
+            # But note that the URL we use is a little different
+            #   https://bizapi.hosted.exosite.io/api:1/solution/<sid>/eventhandler
+          elsif total != ret[:total]
+            warning %(
+              Unexpected subsequence total: #{ret[:total]} != #{total}
+            ).strip
+          end
+          remaining -= ret[:items].length
+        else
+          # This should be true:
+          #   assert(ret.key?(:count))
+          #   assert(ret[:count] == ret[:items].length)
+          # Not all pageable commands indicate :total (ahem, /exchange/).
+          if total.nil?
+            first_count = ret[:items].length
+            total = first_count
+          elsif ret[:items].length < first_count
+            # Last batch!
+            first_count = 0
+          end
+          # Our next command will grab the next batch of limit size.
+          total += ret[:items].length
+          remaining = first_count
+        end
+        if remaining > 0
+          # DEVS: You can test pagination, e.g.,
+          #   query.push ['limit', 5]
+          query.push ['offset', total - remaining]
+        elsif remaining != 0
+          warning %(Unexpected: negative remaining: #{fancy_ticks(total)})
+          remaining = 0
+        end
+        if aggregate.nil?
+          aggregate = ret
+        else
+          aggregate[:items].concat ret[:items]
+          aggregate[:count] = aggregate[:items].length
+        end
+      end
+      aggregate
+    end
+
+    def self.warn_configfile_env_maybe
+      if !$cfg.get('business.id', :env).to_s.empty? &&
+         !$cfg.get('business.id', :project).to_s.empty? &&
+         $cfg.get('business.id', :env) != $cfg.get('business.id', :project)
+        MrMurano::Verbose.warning %(
+          NOTE: MURANO_CONFIGFILE specifies different business.id than local project file
+        ).strip
+      end
+    end
   end
 end
 

data/lib/MrMurano/Commander-Entry.rb

@@ -5,10 +5,10 @@
 # vim:tw=0:ts=2:sw=2:et:ai
 # Unauthorized copying of this file is strictly prohibited.
 
-require 'commander/import'
 require 'dotenv'
 require 'English'
 require 'highline'
+require 'murano-cli-commander/import'
 require 'pathname'
 #require 'pp'
 require 'rainbow'
@@ -36,15 +36,20 @@ program :description, %(
   Manage Applications and Products in Exosite's Murano
 ).strip
 
+def argv_push_option(switch)
+  # Put the --switch before the -- positional argument delimiter, if any.
+  i_positional = ARGV.index('--') || -1
+  ARGV.insert(i_positional, switch)
+end
 # If being piped, e.g.,
 #   murano command ... | ...
 # or
 #   VAR=$(murano command ...)
 # etc., then do not do progress.
 # TEST/2017-08-23: Does this work on Windows?
-ARGV.push('--no-progress') unless $stdout.tty? || ARGV.include?('--no-progress')
-ARGV.push('--ascii') unless $stdout.tty? || ARGV.include?('--ascii')
-ARGV.push('--ascii') if ''.encode('ASCII').encoding == __ENCODING__
+argv_push_option('--no-progress') unless $stdout.tty? || ARGV.include?('--no-progress')
+argv_push_option('--ascii') unless $stdout.tty? || ARGV.include?('--ascii')
+argv_push_option('--ascii') if ''.encode('ASCII').encoding == __ENCODING__
 
 default_command :help
 

data/lib/MrMurano/Config-Migrate.rb

@@ -7,6 +7,8 @@
 
 require 'pathname'
 require 'yaml'
+require 'MrMurano/Passwords'
+require 'MrMurano/verbosing'
 
 module MrMurano
   class ConfigMigrate

data/lib/MrMurano/Config.rb

@@ -30,7 +30,7 @@ module MrMurano
 
     CFG_HOST_BIZAPI = 'bizapi.hosted.exosite.io'
 
-    ConfigFile = Struct.new(:kind, :path, :data) do
+    ConfigFile = Struct.new(:kind, :path, :cfg, :data) do
       def load
         return if kind == :internal
         return if kind == :defaults
@@ -45,7 +45,7 @@ module MrMurano
       def write
         return if kind == :internal
         return if kind == :defaults
-        if defined?($cfg) && !$cfg.nil? && $cfg['tool.dry']
+        if !self[:cfg].nil? && self[:cfg]['tool.dry']
           # $cfg.nil? when run from spec tests that don't load it with:
           #   include_context "CI_CMD"
           warning('--dry: Not writing config file')
@@ -120,11 +120,15 @@ module MrMurano
     end
 
     def initialize(cmd_runner=nil)
+      # Be sneaky: Avoid warning if init code looks at $cfg.
+      #   "warning: global variable `$cfg' not initialized"
+      $cfg = nil
+
       @runner = cmd_runner
       @curlfile_f = nil
 
       @paths = []
-      @paths << ConfigFile.new(:internal, nil, IniFile.new)
+      @paths << ConfigFile.new(:internal, nil, self, IniFile.new)
       # :specified --configfile FILE goes here. (see load_specific)
 
       migrate_old_env
@@ -132,7 +136,7 @@ module MrMurano
         # if it exists, must be a file
         # if it doesn't exist, that's ok
         ep = Pathname.new(ENV[CFG_ENV_NAME])
-        @paths << ConfigFile.new(:env, ep) if ep.file? || !ep.exist?
+        @paths << ConfigFile.new(:env, ep, self) if ep.file? || !ep.exist?
       end
 
       @project_dir, @project_exists = find_project_dir
@@ -144,11 +148,11 @@ module MrMurano
           @project_exists = false
         end
       end
-      @paths << ConfigFile.new(:project, @project_dir + CFG_FILE_NAME)
+      @paths << ConfigFile.new(:project, @project_dir + CFG_FILE_NAME, self)
 
-      @paths << ConfigFile.new(:user, Pathname.new(Dir.home) + CFG_FILE_NAME)
+      @paths << ConfigFile.new(:user, Pathname.new(Dir.home) + CFG_FILE_NAME, self)
 
-      @paths << ConfigFile.new(:defaults, nil, IniFile.new)
+      @paths << ConfigFile.new(:defaults, nil, self, IniFile.new)
 
       # The user can exclude certain scopes.
       @exclude_scopes = []
@@ -164,17 +168,42 @@ module MrMurano
       # All these set()'s are against the :defaults config.
       # So no disk writing ensues. And these serve as defaults
       # unless, say, a SolutionFile says otherwise.
-
+      set_defaults_tool
+      set_defaults_net
+      set_defaults_auth
+      set_defaults_location
+      set_defaults_sync
+      set_defaults_files
+      set_defaults_endpoints
+      set_defaults_eventhandler
+      set_defaults_modules
+      set_defaults_diff
+      set_defaults_postgresql
+    end
+
+    def set_defaults_tool
       set('tool.verbose', false, :defaults)
       set('tool.debug', false, :defaults)
+      set('tool.developer', false, :defaults)
       set('tool.dry', false, :defaults)
       set('tool.fullerror', false, :defaults)
       set('tool.outformat', 'best', :defaults)
+      set('tool.ascii', false, :defaults)
+      set('tool.curldebug', false, :defaults)
+      set('tool.curlfile', '', :defaults)
+      set('tool.curlfancy', false, :defaults)
+      set('tool.no-page', false, :defaults)
+      set('tool.no-progress', false, :defaults)
+      set('tool.show-password', false, :defaults)
+    end
 
+    def set_defaults_net
       set('net.host', CFG_HOST_BIZAPI, :defaults)
       set('net.protocol', 'https', :defaults)
       @value_options['net.protocol'] = CFG_NET_PROTOCOLS
+    end
 
+    def set_defaults_auth
       set('auth.ttl', nil, :defaults)
       # See global options --[no-]token and --[no-]basic.
       set('auth.scheme-token', nil, :defaults)
@@ -182,7 +211,9 @@ module MrMurano
       # See global options --[no-]login and --[no-]cache.
       set('auth.persist-token', nil, :defaults)
       set('auth.persist-basic', nil, :defaults)
+    end
 
+    def set_defaults_location
       set('location.base', @project_dir, :defaults) unless @project_dir.nil?
       set('location.files', 'files', :defaults)
       set('location.endpoints', 'routes', :defaults)
@@ -190,15 +221,32 @@ module MrMurano
       set('location.eventhandlers', 'services', :defaults)
       set('location.resources', 'specs/resources.yaml', :defaults)
       set('location.cors', 'cors.yaml', :defaults)
+      # MUR-6562/MUR-6329: Changing defaults: files => assets; routes => endpoints.
+      set_defaults_location_MUR_6562('location.files', 'files', 'assets')
+      set_defaults_location_MUR_6562('location.endpoints', 'routes', 'endpoints')
+    end
 
-      if defined? SyncRoot
-        set('sync.bydefault', SyncRoot.instance.bydefault.join(' '), :defaults)
+    # rubocop:disable Style/MethodName: Use snake_case for method names.
+    def set_defaults_location_MUR_6562(key, formerly, currently)
+      if @project_dir && !@project_dir.join(formerly).exist?
+        set(key, currently, :defaults)
+      elsif @project_dir.join(currently).exist?
+        warning %(Conflicting directories exist for #{key}: #{formerly} / #{currently})
       end
+    end
+
+    def set_defaults_sync
+      return unless defined? SyncRoot
+      set('sync.bydefault', SyncRoot.instance.bydefault.join(' '), :defaults)
+    end
 
+    def set_defaults_files
       set('files.default_page', 'index.html', :defaults)
       set('files.searchFor', '**/*', :defaults)
       set('files.ignoring', '', :defaults)
+    end
 
+    def set_defaults_endpoints
       set('endpoints.searchFor', %w[
         {,../endpoints}/*.lua
         {,../endpoints}s/*/*.lua
@@ -208,7 +256,9 @@ module MrMurano
         *_spec.lua
         .*
       ].join(' '), :defaults)
+    end
 
+    def set_defaults_eventhandler
       set('eventhandler.searchFor', %w[
         *.lua
         */*.lua
@@ -242,7 +292,9 @@ module MrMurano
         tsdb.exportJob
         user.account
       ].join(' '), :defaults)
+    end
 
+    def set_defaults_modules
       # 2017-07-26: Nested Lua support: Change '*/*.lua' to '**/*.lua'.
       #   There are similar changes made to the ProjectFile,
       #   to modules.include and modules.exclude, which, if set,
@@ -262,13 +314,17 @@ module MrMurano
       ].join(' '), :defaults)
 
       set('modules.no-nesting', false, :defaults)
+    end
 
+    def set_defaults_diff
       if Gem.win_platform?
         set('diff.cmd', 'fc', :defaults)
       else
         set('diff.cmd', 'diff -u', :defaults)
       end
+    end
 
+    def set_defaults_postgresql
       set('postgresql.migrations_dir', 'sql-migrations', :defaults)
     end
 
@@ -318,18 +374,17 @@ module MrMurano
       Please change to a project directory, or run `murano init` to create a new project.
     ).strip
 
-    def validate_cmd(cmd=nil)
-      return unless validate_cmd_business_and_project(cmd)
+    def validate_cmd
       migrate_old_config(@project_dir)
       migrate_old_config(Pathname.new(Dir.home))
     end
 
-    def validate_cmd_business_and_project(cmd)
+    def validate_cmd_business_and_project(the_cmd)
       # Most commands should be run from within a Murano project (sub-)directory.
       # If user is running a project command not within a project directory,
       # we'll print a message now and exit the app from run_active_command later.
       unless @runner.nil?
-        the_cmd = @runner.active_command if cmd.nil?
+        the_cmd = @runner.active_command if the_cmd.nil?
         the_cmd = command(cmd) if the_cmd.nil?
         the_cmd.project_not_required = false unless defined?(the_cmd.project_not_required)
         if the_cmd.name != 'help' && !the_cmd.project_not_required && !@project_exists
@@ -363,10 +418,8 @@ module MrMurano
         root = nil
       when :project
         root = @project_dir + CFG_DIR_NAME
-        verbose %(file_at: @project_dir: #{@project_dir} / + #{CFG_DIR_NAME} / #{root})
       when :user
         root = Pathname.new(Dir.home) + CFG_DIR_NAME
-        verbose %(file_at: Dir.home: #{Dir.home} / + #{CFG_DIR_NAME} / #{root})
       when :defaults
         root = nil
       end
@@ -411,15 +464,22 @@ module MrMurano
       # If user wants curl commands dumped to a file, open that file.
       init_curl_file
       # If user doesn't want paging, disable it.
-      program :help_paging, !$cfg['tool.no-page'] unless $cfg['tool.no-page'].nil?
+      # The program method is not available when called via rspec.
+      unless !defined?(program) || self['tool.no-page'].nil?
+        program :help_paging, !self['tool.no-page']
+      end
       # Check for errors.
       must_be_valid_values!
     end
 
+    def unload(scope)
+      @paths = @paths.reject { |path| path.kind == scope }
+    end
+
     ## Load specified file into the config stack
     # This can be called multiple times and each will get loaded into the config
     def load_specific(file)
-      spc = ConfigFile.new(:specified, Pathname.new(file))
+      spc = ConfigFile.new(:specified, Pathname.new(file), self)
       spc.load
       @paths.insert(1, spc)
     end
@@ -687,8 +747,16 @@ module MrMurano
           open_curl_file
           return if @curlfile_f.nil?
           # MEH: Call @curlfile_f.close() at some point? Or let Ruby do on exit.
-          @curlfile_f << Time.now.to_s + "\n"
-          @curlfile_f << "murano #{ARGV.join(' ')}\n"
+          if self['tool.curlfancy']
+            was_enabled = Rainbow.enabled
+            Rainbow.enabled = true
+            @curlfile_f << Rainbow(
+              "#############################################################\n\n"
+            ).foreground(:white).background(:red)
+            Rainbow.enabled = was_enabled
+          end
+          @curlfile_f << Time.now.to_s + "\n\n"
+          @curlfile_f << "murano #{ARGV.join(' ')}\n\n"
           @curlfile_f.flush
         end
       elsif !@curlfile_f.nil?
@@ -709,17 +777,17 @@ module MrMurano
     def set_net_host(url_or_host, scope=:internal)
       return if url_or_host.nil?
       if url_or_host.to_s.empty?
-        $cfg.set('net.protocol', 'https', scope)
-        $cfg.set('net.host', CFG_HOST_BIZAPI, scope)
+        set('net.protocol', 'https', scope)
+        set('net.host', CFG_HOST_BIZAPI, scope)
         return
       end
       protocol_or_host, host_maybe = url_or_host.split('://', 2)
       if !host_maybe.nil?
-        $cfg.set('net.protocol', protocol_or_host, scope)
-        $cfg.set('net.host', host_maybe, scope)
+        set('net.protocol', protocol_or_host, scope)
+        set('net.host', host_maybe, scope)
       else
-        $cfg.set('net.protocol', 'https', scope)
-        $cfg.set('net.host', protocol_or_host, scope)
+        set('net.protocol', 'https', scope)
+        set('net.host', protocol_or_host, scope)
       end
     end
   end

data/lib/MrMurano/Content.rb

@@ -65,7 +65,7 @@ module MrMurano
 
       # Get details of a single item in content area
       # @param name [String] Name of content
-      def fetch(name)
+      def fetch(name, _untainted=false)
         get("/#{CGI.escape(name)}")
       end
       alias info fetch