greenhat 0.2.0 → 0.3.3

data/lib/greenhat/shell/args.rb

@@ -0,0 +1,146 @@
+module GreenHat
+  # Module for Argument Parsing
+  # Possible Args
+  # --value=thing
+  # --value / Default => --value=thing
+  # --flag
+  # --slice=value,value2
+  # files
+
+  # Variable Breakdown
+  # Args:Array supplied or default values for entry looping action
+  # Flags:Hash Key/Value filter Actionables
+  # Files:Array/String are any non start `-` dash entries
+  module Args
+    def self.parse(raw, skip_flags = [])
+      # Don't affect original object / Better deep clone?
+      cmd = raw.clone
+      # cmd = Marshal.load(Marshal.dump(raw))
+
+      # Extract Files
+      files = cmd.grep_v(/^-+([^=]+)/)
+
+      # Collect and Naturalize Arguments
+      args = cmd.flat_map { |arg| arg_scan(arg) }
+
+      # Collect all Flags to Hash
+      flags = cmd.flat_map { |flag| flag_scan(flag) }.to_h
+
+      # Move Flags to Args
+      arg_to_flag(flags, args)
+
+      # Logic
+      # And / Or
+      flag_defaults(flags, skip_flags)
+
+      [files, flags, args]
+    end
+
+    def self.flag_defaults(flags, skip_flags)
+      # Update other user defaults
+      Settings.default_log_flags(flags, skip_flags)
+
+      # FastStats / Don't set default flags
+      return if skip_flags.include? :logic
+
+      # Default Logic
+      if flags.key?(:or)
+        flags.logic = :any?
+        flags.delete(:or)
+      else
+        flags.logic = :all?
+      end
+    end
+
+    # Move Valued Flags to arguments (--truncate=5)
+    def self.arg_to_flag(flags, args)
+      args.reject! do |arg|
+        # Entries specifically to move to Args
+        if arg_to_flag_list.include?(arg.field)
+          flags[arg.field] = arg.value
+
+          true
+        # Ignore Good Entries
+        else
+          false
+        end
+      end
+    end
+
+    # Flags Anything that isn't sent as a key/filter
+    def self.arg_to_flag_list
+      %i[
+        archive end except exists json limit pluck reverse round slice sort start
+        stats truncate uniq page time_zone table_style
+      ]
+    end
+
+    # Arg Scan (Split -- values into keys)
+    def self.arg_scan(arg)
+      arg.scan(/^-+([^=]+)=(.*)/).map do |field, value|
+        bang = false
+        if field.include? '!'
+          field.delete!('!')
+          bang = true
+        end
+
+        # Symbolize
+        field = field.to_sym
+
+        {
+          field: field,
+          value: arg_normalize(field, value),
+          bang: bang
+        }
+      end
+    end
+
+    # Collect All Flags
+    def self.flag_scan(arg)
+      arg.scan(/^-+([^=]+)$/).map do |field, _val|
+        # Symbolize
+        field = field.to_sym
+
+        [field, flag_arg_defaults(field)]
+      end
+    end
+
+    # Naturlalize Values, Manipluate Special Values
+    def self.arg_normalize(field, value)
+      # Special Comma Params With Symbol
+      return value.split(',').map(&:to_sym) if arg_special_split.include?(field)
+
+      # Integer Arguments
+      return value.to_i if value.numeric?
+
+      # Other Field Manipulation
+      case field
+      when :page then value == 'true'
+      else
+
+        # Default Original
+        value
+      end
+    end
+
+    # Arguments that Accept multiple options / Comma Delimted
+    def self.arg_special_split
+      %i[
+        slice except uniq pluck sort archive stats exists
+      ]
+    end
+
+    # Arg Defaults
+    def self.flag_arg_defaults(field)
+      case field
+      when :round then 2
+      when :limit then (TTY::Screen.height / 3) - 3
+      when :truncate then TTY::Screen.width * 4
+      # when :page, :case, :exact then :true # Override Specials
+      when *arg_special_split then []
+      else
+        true
+      end
+    end
+  end
+end

data/lib/greenhat/shell/cat.rb

@@ -3,60 +3,38 @@ module GreenHat
   module Shell
     # Common File Reader File
     module Cat
-      # rubocop:disable Metrics/MethodLength
       def self.help
-        puts "\u2500".colorize(:cyan) * 20
-        puts "#{'Cat'.colorize(:yellow)} All the files"
-        puts "\u2500".colorize(:cyan) * 20
+        puts "\u2500".pastel(:cyan) * 20
+        puts "#{'Cat'.pastel(:yellow)} All the files"
+        puts "\u2500".pastel(:cyan) * 20
         puts 'Print raw file by just entering the file name'
         puts
 
-        puts 'Common Options'.colorize(:blue)
-        puts '  --raw'.colorize(:green)
-        puts '    Do not use less/paging'
-        puts
-        puts '  --archive'.colorize(:green)
-        puts '    Limit to specific archvie name (inclusive). Matching SOS tar.gz name'
-        puts '    Ex: --archive=dev-gitlab_20210622154626, --archive=202106,202107'
-        puts '    cat mount --archive=dev-gitlab_202106221546'
-        puts
+        ShellHelper.common_opts
 
-        puts 'Commands'.colorize(:blue)
-        puts 'ls'.colorize(:green)
-        puts '  List available files'
-        puts '  Options'
-        puts '    -a, --all, show all files including source'
-        puts
+        puts 'Commands'.pastel(:blue)
+        puts ShellHelper::List.help
 
-        puts '<file names+>'.colorize(:green)
-        puts '  Print any file names'
-        puts '  Ex: `free_m`'
-        puts '  Ex: `ps mount --raw`'
+        puts '  <file names+>'.pastel(:green)
+        puts '    Print any file names'
+        puts '    Ex: `free_m`'
+        puts '    Ex: `ps mount --raw`'
         puts
 
-        puts "#{'show'.colorize(:green)} <file names>"
-        puts '  Attempt to print formatted output'
-        puts '  Ex: show `free_m`'
-
-        puts '--archive'.colorize(:green)
-        puts '  Limit to specific archvie name (inclusive). Matching SOS tar.gz name'
-        puts '  Ex: --archive=dev-gitlab_20210622154626, --archive=202106,202107'
-        puts
+        puts "  #{'show'.pastel(:green)} <file names>"
+        puts '    Attempt to print formatted output'
+        puts '    Ex: show `free_m`'
       end
-      # rubocop:enable Metrics/MethodLength
 
       # ========================================================================
       # Default
       # ========================================================================
-      def self.default(file_list)
+      def self.default(raw)
         # Extract Args
-        file_list, _opts, args = ShellHelper.param_parse(file_list)
-
-        # Prepare Log List
-        file_list = ShellHelper.prepare_list(file_list, Thing.all)
+        files_list, flags, _args = Args.parse(raw)
 
-        # Convert to Things
-        files = ShellHelper.find_things(file_list, args)
+        # Collect Files
+        files = ShellHelper.files(files_list, Thing.all, flags)
 
         results = ShellHelper.file_process(files) do |file|
           [
@@ -66,58 +44,32 @@ module GreenHat
           ]
         end
 
-        ShellHelper.show(results.flatten, args)
+        ShellHelper.show(results.flatten, flags)
       end
 
       # ========================================================================
       # Show Attempted Formatting
       # ========================================================================
-      def self.show(file_list)
+      def self.show(raw)
         # Extract Args
-        file_list, _opts, args = ShellHelper.param_parse(file_list)
+        files_list, flags, _args = Args.parse(raw)
 
-        # Prepare Log List
-        file_list = ShellHelper.prepare_list(file_list, Thing.all)
-
-        # Convert to Things
-        files = ShellHelper.find_things(file_list, args)
+        # Collect Files
+        files = ShellHelper.files(files_list, Thing.all, flags)
 
         results = ShellHelper.file_process(files) do |file|
           [
             file.friendly_name,
-            file.output(false),
+            file.data,
             "\n"
           ]
         end
 
-        ShellHelper.show(results.flatten, args)
-      end
-
-      # List Files Helpers
-      def self.list(args = [])
-        all = false
-        all = true if args.include?('-a') || args.include?('--all')
-
-        files = Thing.all
-
-        # Sort
-        files.sort_by!(&:name)
-
-        # Short & Uniq
-        files.uniq!(&:name) unless all
-
-        # Print
-        files.each do |log|
-          if all
-            puts "- #{log.friendly_name}"
-          else
-            puts "- #{log.name.colorize(:yellow)}"
-          end
-        end
+        ShellHelper.show(results.flatten, flags)
       end
 
       def self.ls(args = [])
-        list(args)
+        ShellHelper::List.list(args, Thing.all)
       end
       # ------------------------------------------------------------------------
     end

data/lib/greenhat/shell/color_string.rb

@@ -6,20 +6,20 @@ module GreenHat
         LogBot.debug('Unknown Format', entry.class) if ENV['DEBUG'] && !entry.instance_of?(String)
 
         # Other Helpful colorizers
-        if colorize?(key)
-          colorize(key, entry)
+        if pastel?(key)
+          pastel(key, entry)
         else
           entry.to_s
         end
       end
 
       # Add Color?
-      def self.colorize?(key)
+      def self.pastel?(key)
         [:severity].any? key
       end
 
       # General Key/Value Coloring
-      def self.colorize(key, value)
+      def self.pastel(key, value)
         case key
         when :severity then severity(value)
         else
@@ -30,10 +30,10 @@ module GreenHat
 
       def self.severity(value)
         case value.to_s.downcase.to_sym
-        when :debug then value.colorize(:blue)
-        when :info then value.colorize(:cyan)
-        when :warn then value.colorize(:yellow)
-        when :fatal, :error then value.colorize(:light_red)
+        when :debug then value.pastel(:blue)
+        when :info then value.pastel(:cyan)
+        when :warn then value.pastel(:yellow)
+        when :fatal, :error then value.pastel(:bright_red)
         else
           value.to_s
         end

data/lib/greenhat/shell/disk.rb

@@ -8,15 +8,42 @@ module GreenHat
         Cli.help
       end
 
+      def self.help
+        puts "\u2500".pastel(:cyan) * 22
+        puts "#{'Disk'.pastel(:yellow)} -  Storage Helper"
+        puts "\u2500".pastel(:cyan) * 22
+
+        ShellHelper.common_opts
+
+        puts 'Command Summary'.pastel(:blue)
+        puts '  df'.pastel(:green)
+        puts "    Raw #{'df'.pastel(:cyan)} output"
+        puts
+        puts '  free'.pastel(:green)
+        puts '    Formatted / Bar Output'
+        puts
+      end
+
       # Easy Show All
-      def self.df
-        ShellHelper.file_output GreenHat::Disk.df
+      def self.df(raw = {})
+        # Extract Args
+        files_list, flags, _args = Args.parse(raw)
+
+        # Collect Files
+        files = ShellHelper.files(files_list, GreenHat::Disk.df, flags)
+
+        # Output
+        ShellHelper.file_output(files, flags)
       end
 
       def self.free(raw = {})
-        _log_list, _1opts, args = ShellHelper.param_parse(raw)
+        # Extract Args
+        files_list, flags, _args = Args.parse(raw)
+
+        # Collect Files
+        files = ShellHelper.files(files_list, GreenHat::Disk.df, flags)
 
-        GreenHat::Disk.df(args).each do |file|
+        files.each do |file|
           puts GreenHat::Disk.format_output(file, true)
 
           # File End Loop / Break

data/lib/greenhat/shell/faststats.rb

@@ -5,52 +5,82 @@ module GreenHat
     module Faststats
       # rubocop:disable Metrics/MethodLength)
       def self.help
-        puts "\u2500".colorize(:cyan) * 25
-        puts "Gimme #{'Performance Stats'.colorize(:yellow)}"
-        puts "\u2500".colorize(:cyan) * 25
+        puts "\u2500".pastel(:cyan) * 25
+        puts "Gimme #{'Performance Stats'.pastel(:yellow)}"
+        puts "\u2500".pastel(:cyan) * 25
 
-        puts 'General'.colorize(:blue)
-        puts "  Any double dash arguments (e.g. #{'--color-output'.colorize(:green)}) are passed directly to fast-stats"
-        puts "  See #{'`fast-stats --help`'.colorize(:light_black)} for all available options"
+        puts 'General'.pastel(:blue)
+        puts "  Any double dash arguments (e.g. #{'--color-output'.pastel(:green)}) are passed directly to fast-stats"
+        puts "  See #{'`fast-stats --help`'.pastel(:bright_black)} for all available options"
         puts
 
-        puts 'Common Options'.colorize(:blue)
-        puts '  --raw'.colorize(:green)
+        puts 'Common Options'.pastel(:blue)
+        puts '  --raw'.pastel(:green)
         puts '    Do not use less/paging'
-        puts '  --display'.colorize(:green)
-        puts '     Show percentage of totals and/or actual durations (value, perc, both, default: both)'
-        puts '  --sort'.colorize(:green)
+        puts '  --search'.pastel(:green)
+        puts '     Case-insensitive search of controller/method/worker field'
+        puts '  --sort'.pastel(:green)
         puts '     count,fail,max,median,min,p95,p99,rps,score'
-        puts '  --limit'.colorize(:green)
+        puts '  --limit'.pastel(:green)
         puts '     The number of rows to print'
-        puts '  --verbose'.colorize(:green)
+        puts '  --verbose'.pastel(:green)
         puts '     Prints the component details of the maximum, P99, P95, and median events by total duration for each'
         puts
 
-        puts 'Commands'.colorize(:blue)
-        puts 'ls'.colorize(:green)
+        puts 'Commands'.pastel(:blue)
+        puts 'ls'.pastel(:green)
         puts '  List available files'
         puts '  Options'
         puts '    -a, --all, show all files including source'
         puts
 
-        puts '<file names+>'.colorize(:green)
+        puts '<file names+>'.pastel(:green)
         puts '  Print any file names'
         puts '  Ex: `gitaly/current`'
         puts '  Ex: `gitlab-rails/api_json.log gitlab-rails/production_json.log --raw`'
         puts
 
-        puts 'top'.colorize(:green)
+        puts 'top'.pastel(:green)
         puts '  Print a summary of top items in a category'
         puts
 
-        puts 'errors'.colorize(:green)
+        puts 'errors'.pastel(:green)
         puts '  Show summary of errors captured in log'
+        puts
+
+        puts 'Examples'.pastel(:blue)
+        puts '  Default'.pastel(:bright_white)
+        puts '    gitaly/current'
+        puts '    --raw gitlab-rails/production_json.log'
+        puts '    gitlab-rails/api_json.log --sort=count'
+        puts '    --search=pipeline sidekiq/current'
+        puts
+
+        puts '  Top'.pastel(:bright_white)
+        puts '    top gitaly/current'
+        puts '    top --limit=5 sidekiq/current'
+        puts
+
+        puts '  Errors'.pastel(:bright_white)
+        puts '    errors gitaly/current'
+        puts '    errors gitaly/current --no-border'
       end
       # rubocop:enable Metrics/MethodLength)
 
+      def self.faststats_installation
+        puts "#{'Unable to find'.pastel(:red)} #{'fast-stats'.pastel(:blue)}"
+        puts '  Release Downloads here'
+        puts '    - https://gitlab.com/gitlab-com/support/toolbox/fast-stats/-/releases'.pastel(:yellow)
+        puts ''
+      end
+
       # List Files Helpers
       def self.list(args = [])
+        unless TTY::Which.exist? 'fast-stats'
+          faststats_installation
+          return false
+        end
+
         all = false
         all = true if args.include?('-a') || args.include?('--all')
 
@@ -67,7 +97,7 @@ module GreenHat
           if all
             puts "- #{log.friendly_name}"
           else
-            puts "- #{log.name.colorize(:yellow)}"
+            puts "- #{log.name.pastel(:yellow)}"
           end
         end
       end
@@ -77,18 +107,15 @@ module GreenHat
       end
 
       # Vanilla Fast Stats
-      def self.default(file_list, _other = nil)
-        # Extract Args
-        file_list, opts, args = ShellHelper.param_parse(file_list)
-
-        cmd = opts.map { |opt| "--#{opt.field}=#{opt.value}" }.join(' ')
-        cmd += args.keys.map { |arg| "--#{arg}" }.join(' ')
+      def self.default(raw, _other = nil)
+        unless TTY::Which.exist? 'fast-stats'
+          faststats_installation
+          return false
+        end
 
-        # Prepare List
-        file_list = ShellHelper.prepare_list(file_list, ShellHelper::Faststats.things)
+        files, flags, cmd = ShellHelper::Faststats.parse(raw)
 
-        # Convert to Things
-        files = ShellHelper.find_things(file_list)
+        LogBot.debug('FastStats CMD', cmd) if ENV['DEBUG']
 
         results = ShellHelper.file_process(files) do |file|
           [
@@ -98,7 +125,7 @@ module GreenHat
           ]
         end
 
-        ShellHelper.show(results.flatten, args)
+        ShellHelper.show(results.flatten, flags)
       end
 
       # ========================================================================
@@ -110,18 +137,15 @@ module GreenHat
       # --limit=X
       # --sort=count,fail,max,median,min,p95,p99,rps,score
       # ========================================================================
-      def self.top(log_list)
-        # Extract Args,  No Round / Truncate for Fast Stats
-        log_list, opts, args = ShellHelper.param_parse(log_list, %i[page round truncate])
-
-        cmd = opts.map { |opt| "--#{opt.field}=#{opt.value}" }.join(' ')
-        cmd += args.keys.map { |arg| "--#{arg}" }.join(' ')
+      def self.top(raw)
+        unless TTY::Which.exist? 'fast-stats'
+          faststats_installation
+          return false
+        end
 
-        # Prepare Log List
-        log_list = ShellHelper.prepare_list(log_list, ShellHelper::Faststats.things)
+        files, flags, cmd = ShellHelper::Faststats.parse(raw)
 
-        # Convert to Things
-        files = ShellHelper.find_things(log_list)
+        LogBot.debug('FastStats CMD', cmd) if ENV['DEBUG']
 
         results = ShellHelper.file_process(files) do |file|
           [
@@ -131,28 +155,22 @@ module GreenHat
           ]
         end
 
-        ShellHelper.show(results.flatten, args)
+        ShellHelper.show(results.flatten, flags)
       end
       # ========================================================================
 
       # ========================================================================
       # ===== [ Fast Stats - Errors ] ====================
       # ========================================================================
-      def self.errors(log_list)
-        # Extract Args,  No Round / Truncate for Fast Stats
-        log_list, opts, args = ShellHelper.param_parse(log_list, %i[page round truncate])
-
-        # Default to color output
-        args['color-output'] ||= true
-
-        cmd = opts.map { |opt| "--#{opt.field}=#{opt.value}" }.join(' ')
-        cmd += args.keys.map { |arg| "--#{arg}" }.join(' ')
-
-        # Prepare Log List
-        log_list = ShellHelper.prepare_list(log_list, ShellHelper::Faststats.things)
+      def self.errors(raw)
+        unless TTY::Which.exist? 'fast-stats'
+          faststats_installation
+          return false
+        end
 
-        # Convert to Things
-        files = ShellHelper.find_things(log_list)
+        # Add Color Output
+        raw.push '--color-output'
+        files, flags, cmd = ShellHelper::Faststats.parse(raw)
 
         LogBot.debug('FastStats CMD', cmd) if ENV['DEBUG']
 
@@ -164,7 +182,7 @@ module GreenHat
           ]
         end
 
-        ShellHelper.show(results.flatten, args)
+        ShellHelper.show(results.flatten, flags)
       end
       # ========================================================================
     end
@@ -175,6 +193,35 @@ module GreenHat
   module ShellHelper
     # Hide from Commands
     module Faststats
+      # Default Settings from arg parse that won't work
+      def self.invalid_settings
+        %i[page round truncate logic fuzzy_file_match]
+      end
+
+      def self.parse(raw)
+        file_list, flags, args = Args.parse(raw, invalid_settings)
+        cmd = args.map { |opt| "--#{opt.field}=#{opt.value}" }.join(' ')
+        cmd += flags.map do |flag, value|
+          # Don't Include Raw
+          next if flag == :raw
+
+          case value
+          when true then "--#{flag}"
+          when Array then "--#{flag}=#{value.join}"
+          else
+            "--#{flag}=#{value}"
+          end
+        end.join(' ')
+
+        # Prepare Log List
+        file_list = ShellHelper.prepare_list(file_list, ShellHelper::Faststats.things, flags)
+
+        # Convert to Things
+        files = ShellHelper.find_things(file_list)
+
+        [files, flags, cmd]
+      end
+
       def self.files
         %w[
           production_json