greenhat 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf89eef7afeef6861dde013e8cc7992a92d1c9f4dca79ca0a438913f6d9a7a89
-  data.tar.gz: eed033653f4723f19962f5643ac02c71d9f950f97aa4a68375cc3174152e5513
+  metadata.gz: db336e98cd2a446c371d866d068eb9b485f9782b2ea7182f4b4da651011e2083
+  data.tar.gz: 90b1858171c14ebe93e3a0ff42dffe2965602835f8f2cc98178f6a81ec816352
 SHA512:
-  metadata.gz: 90c1a58ef0334bd864480ad422957758850ecacd39bc85db1fd47233192e09bda768e15331dc179d8860f4842aed58fafb439f4f9499ff22d1c25e3ebf8bff74
-  data.tar.gz: aea2b938e6b1a5956d7811084b1ab725cf41f2d0766affffed696755ac497cc41a67ebfc562ce516ce448ebb983e6e504a493e772348fd536f1e5c711954f612
+  metadata.gz: 94d78c52d3e4b800ac90798d8030dfa9962c7e7c628bd8b636f5471fcf2c35044aa044a91edbd412827db2daf36117ab47cfecc4c6a85e49875e3e6d7756e1d0
+  data.tar.gz: fad9f87be4735b5d028ccc7e251fce423de9cf0d440253b65dbaddbc36b268234ffedc7277f9207131692bcf8ea74cd9a4b70c433f55e158b6cd30aae73edf1d

data/lib/greenhat/cli.rb

@@ -65,7 +65,9 @@ module GreenHat
     # Auto Complete
     # =========================================================
     def self.auto
-      word = reader.line.word
+      word = @list.last
+      # This is being weird with auto complete
+      # word = reader.line.word
 
       if word.blank?
         help
@@ -74,6 +76,10 @@ module GreenHat
       end
     end
 
+    def self.file_matches(word)
+      files.select { |x| x[/^#{Regexp.escape(word)}/] }
+    end
+
     def self.auto_match(matches, word)
       matches.select! { |x| x[/^#{Regexp.escape(word)}/] }
 
@@ -88,11 +94,14 @@ module GreenHat
       elsif matches.count > 1
         puts matches.join("\t").pastel(:bright_green)
 
-      # No other Matches
-      else
-        file_matches = files.select { |x| x[/^#{Regexp.escape(word)}/] }
-        auto_files(file_matches, word) unless file_matches.empty?
+      # General Filename Matching
+      elsif !file_matches(word).empty?
+        auto_files(file_matches(word), word)
 
+      # Submodule Autocompletion
+      elsif current_methods.include?('auto_complete')
+        update_text = current_location.auto_complete(@list, word)
+        auto_update(update_text, word) unless update_text.blank?
       end
     end
 
@@ -237,13 +246,17 @@ module GreenHat
       @list.any? { |x| x.include?(cmd) } && current_methods.include?('default')
     end
 
+    def self.current_commands
+      current_location.methods(false).map(&:to_s).sort - %w[auto_complete]
+    end
+
     # General Helper
     def self.help(long = true)
       if current_location.methods(false).count.zero?
         puts 'No Commands'.pastel(:red)
       else
         puts 'Commands: '
-        current_location.methods(false).map(&:to_s).sort.each do |item|
+        current_commands.each do |item|
           next if %w[default help].any? { |x| x == item }
 
           puts "=> #{item.to_s.pastel(:blue)}"
@@ -340,6 +353,7 @@ module GreenHat
       puts
       puts 'Usage'.pastel(:yellow)
       puts '  greenhat  <sos-archive.tgz> <sos-archive2.tgz> '
+      puts '  greenhat  <sos-archive.tgz> -q --command=df'
       puts
 
       puts 'Options'.pastel(:yellow)

data/lib/greenhat/shell/args.rb

@@ -70,8 +70,8 @@ module GreenHat
     # 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
+        archive end except exists json limit pluck reverse round slice sort start
+        stats truncate uniq page time_zone table_style
       ]
     end
 

data/lib/greenhat/shell/faststats.rb

@@ -67,8 +67,20 @@ module GreenHat
       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')
 
@@ -96,6 +108,11 @@ module GreenHat
 
       # Vanilla Fast Stats
       def self.default(raw, _other = nil)
+        unless TTY::Which.exist? 'fast-stats'
+          faststats_installation
+          return false
+        end
+
         files, flags, cmd = ShellHelper::Faststats.parse(raw)
 
         LogBot.debug('FastStats CMD', cmd) if ENV['DEBUG']
@@ -121,6 +138,11 @@ module GreenHat
       # --sort=count,fail,max,median,min,p95,p99,rps,score
       # ========================================================================
       def self.top(raw)
+        unless TTY::Which.exist? 'fast-stats'
+          faststats_installation
+          return false
+        end
+
         files, flags, cmd = ShellHelper::Faststats.parse(raw)
 
         LogBot.debug('FastStats CMD', cmd) if ENV['DEBUG']
@@ -141,6 +163,11 @@ module GreenHat
       # ===== [ Fast Stats - Errors ] ====================
       # ========================================================================
       def self.errors(raw)
+        unless TTY::Which.exist? 'fast-stats'
+          faststats_installation
+          return false
+        end
+
         # Add Color Output
         raw.push '--color-output'
         files, flags, cmd = ShellHelper::Faststats.parse(raw)

data/lib/greenhat/shell/field_helper.rb

@@ -0,0 +1,75 @@
+module GreenHat
+  # Common Helpers
+  module FieldHelper
+    def self.fields_find(files, word, flags = {})
+      fields = ShellHelper.find_things(files, flags).map(&:fields).flatten.uniq
+
+      if word.blank?
+        puts 'Possible Fields:'.pastel(:bright_blue)
+        puts ShellHelper.field_table(fields)
+
+        return [] # Empty Result
+      end
+
+      list_select(fields, word)
+    end
+
+    def self.list_select(list, word)
+      list.select! { |x| x[/^#{Regexp.escape(word)}/] }
+    end
+
+    def self.filter_flags(word)
+      if word.blank?
+        puts 'Filter Options:'.pastel(:bright_blue)
+        puts ShellHelper.field_table(filter_opts, 6)
+        puts
+
+        return []
+      end
+
+      list_select(filter_opts, word)
+    end
+
+    def self.filter_opts
+      %w[
+        archive case combine end exact except exists json limit or page pluck
+        raw reverse round slice sort start stats table_style text time_zone
+        total truncate uniq
+      ]
+    end
+
+    def self.filter_auto_completes
+      %w[
+        except exists pluck slice sort stats uniq
+      ]
+    end
+
+    def self.field_auto_complete?(word)
+      return false if word.blank?
+
+      filter_auto_completes.include? word.split('=', 2).first
+    end
+
+    def self.field_auto_complete(word, files, flags = {})
+      # Prevent weird dupes
+      return nil if word[-1] == ','
+
+      # Command Manipulation
+      cmd, fields = word.split('=', 2)
+      complete = fields.split(',')[0..-2]
+      auto = fields.split(',').last
+
+      # Field Finder
+      matches = fields_find(files, auto, flags)
+
+      if matches.count == 1
+        "--#{cmd}=#{(complete + matches).join(',')}"
+      elsif matches.count > 1
+        puts "#{'Field Options:'.pastel(:bright_blue)} #{matches.join(' ').pastel(:bright_green)}"
+
+        list = [Cli.common_substr(matches.map(&:to_s))]
+        "--#{cmd}=#{(complete + list).join(',')}"
+      end
+    end
+  end
+end

data/lib/greenhat/shell/filter_help.rb

@@ -11,7 +11,7 @@ module GreenHat
 
         puts 'Options'.pastel(:blue)
         puts '--raw'.pastel(:green)
-        puts '  Do not use less/paging'
+        puts '  Disable formatting and page/less'
         puts
 
         puts '--page'.pastel(:green)
@@ -41,6 +41,10 @@ module GreenHat
         puts '  Print only total count of matching entries'
         puts
 
+        puts '--fields'.pastel(:green)
+        puts '  Print only Available fields for selected files'
+        puts
+
         puts '--slice'.pastel(:green)
         puts '  Extract specific fields from entries (slice multiple with comma)'
         puts '  Ex: --slice=path or --slice=path,params'
@@ -57,7 +61,7 @@ module GreenHat
         puts
 
         puts '--stats'.pastel(:green)
-        puts '  Order/Count occurrances by field'
+        puts '  Order/Count occurrances by field. Combine with `truncate` for key names'
         puts '  Ex: --stats=params --except=params,path'
         puts
 
@@ -113,6 +117,21 @@ module GreenHat
         puts '  Ex: log filter --end="2021-06-22"'
         puts
 
+        puts '--time_zone'.pastel(:green)
+        puts '  Manipulate the `time` field into a specific timezone'
+        puts '  Ex: log filter --time_zone=EDT'
+        puts
+
+        puts '--text'.pastel(:green)
+        puts '  Full entry text searching (slow)'
+        puts '    --text="anything here"'
+        puts
+
+        puts '--table_style'.pastel(:green)
+        puts '  Renderer used for formatted output. basic, ascii, or unicode(default)'
+        puts '  Ex: log filter --table_style=base'
+        puts
+
         puts '--truncate'.pastel(:green)
         puts '  Truncate field length. On by default (4 rows). Performance issues!'
         puts '  Disable with --truncate=0'.pastel(:bright_red)

data/lib/greenhat/shell/log.rb

@@ -3,6 +3,41 @@ module GreenHat
   module Shell
     # Logs
     module Log
+      def self.auto_complete(list, word)
+        # Argument Parsing
+        files, flags, _args = Args.parse(list)
+
+        # Don't try to autocomplete anything else
+        return nil unless word =~ /^-/
+
+        # Clean Up
+        word.delete!('-')
+        matches = FieldHelper.filter_flags(word)
+
+        if matches.count == 1
+          "--#{matches.first}"
+        elsif matches.count > 1
+          puts "#{'Filter Options:'.pastel(:bright_blue)} #{matches.join(' ').pastel(:bright_green)}"
+          "--#{Cli.common_substr(matches)}"
+        # -----------------------------------
+        # TODO: Fix Icky Double Nesting
+        elsif files.count.nonzero?
+          matches = FieldHelper.fields_find(files, word, flags)
+
+          return nil if matches.nil?
+
+          if matches.count == 1
+            "--#{matches.first}"
+          elsif matches.count > 1
+            puts "#{'Field Options:'.pastel(:bright_blue)} #{matches.join(' ').pastel(:bright_green)}"
+            "--#{Cli.common_substr(matches.map(&:to_s))}"
+          elsif FieldHelper.field_auto_complete?(word)
+            FieldHelper.field_auto_complete(word, files, flags)
+          end
+          # -----------------------------------
+        end
+      end
+
       def self.help
         puts "\u2500".pastel(:cyan) * 20
         puts "#{'Logs'.pastel(:yellow)} find stuff"
@@ -73,6 +108,12 @@ module GreenHat
           return true
         end
 
+        # Skip and Print Total if set
+        if flags[:fields]
+          ShellHelper.fields_print(results)
+          return true
+        end
+
         # Check Search Results
         if results.instance_of?(Hash) && results.values.flatten.empty?
           puts 'No results'.pastel(:red)

data/lib/greenhat/shell/shell_helper.rb

@@ -120,10 +120,12 @@ module GreenHat
       entry = entry.map { |k, v| [k, format_table_entry(flags, v, k)] }.to_h
       # Pre-format Entry
 
+      table_style = flags[:table_style]&.to_sym || :unicode
+
       table = TTY::Table.new(header: entry.keys, rows: [entry], orientation: :vertical)
 
       LogBot.debug('Rendering Entries') if ENV['DEBUG']
-      table.render(:unicode, padding: [0, 1, 0, 1], multiline: true) do |renderer|
+      table.render(table_style, padding: [0, 1, 0, 1], multiline: true) do |renderer|
         renderer.border.style = :cyan
       end
 
@@ -182,7 +184,10 @@ module GreenHat
     # TODO: Simplify
     # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
     def self.filter(data, flags = {}, args = {})
-      results = data.clone.flatten.compact
+      # results = data.clone.flatten.compact
+
+      # Experimenting with deep clone
+      results = Marshal.load(Marshal.dump(data))
       results.select! do |row|
         args.send(flags.logic) do |arg|
           filter_row_key(row, arg, flags)
@@ -192,6 +197,9 @@ module GreenHat
       # Ensure presecense of a specific field
       results = filter_exists(results, flags[:exists]) if flags.key?(:exists)
 
+      # Time Zone
+      results = filter_modify_timezone(results, flags[:time_zone]) if flags.key?(:time_zone)
+
       # Time Filtering
       results = filter_time(results, flags) if flags.key?(:start) || flags.key?(:end)
 
@@ -217,24 +225,34 @@ module GreenHat
       results.reverse! if flags[:reverse]
 
       # Count occurrences / Skip Results
-      return filter_stats(results, flags[:stats]) if flags.key?(:stats)
+      return filter_stats(results, flags) if flags.key?(:stats)
+
+      # Limit before Pluck / Flattening
+      results = filter_limit(results, flags[:limit]) if flags.key?(:limit)
 
       # Pluck
       results = filter_pluck(results, flags[:pluck]) if flags.key?(:pluck)
 
-      # Limit / Ensure Exists and Valid Number
-      if flags.key?(:limit) && flags[:limit]
-        # Old
-        # results[0..flags[:limit].map(&:to_s).join.to_i - 1]
+      results
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
-        # New
-        results.shift flags[:limit]
+    # Limit / Ensure Exists and Valid Number
+    def self.filter_limit(results, limit)
+      return results unless limit.integer? && limit.positive?
 
-      else
-        results
+      results.shift limit
+    end
+
+    def self.filter_modify_timezone(results, time_zone)
+      results.each do |x|
+        next unless x.key? :time
+
+        x[:time] = x[:time].in_time_zone time_zone
       end
+
+      results
     end
-    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
     # Filter Start and End Times
     # rubocop:disable Metrics/MethodLength
@@ -339,7 +357,9 @@ module GreenHat
       end.inject(:&)
     end
 
-    def self.filter_stats(results, stats)
+    def self.filter_stats(results, flags)
+      stats = flags[:stats]
+
       # Avoid Empty Results
       if stats.empty?
         filter_empty_arg('stats')
@@ -367,6 +387,13 @@ module GreenHat
         # Append Header / Total with field name
         output.unshift([field.to_s.pastel(:bright_black), total])
 
+        # Use Truncate For Long Keys
+        if flags[:truncate]
+          output.map! do |key, value|
+            [key.to_s[0..flags[:truncate]], value]
+          end
+        end
+
         # Format
         output.to_h
       end
@@ -440,6 +467,32 @@ module GreenHat
       end
     end
 
+    # Total Count Helper
+    def self.fields_print(results)
+      results.each do |k, v|
+        puts k
+        puts field_table(v.map(&:keys).flatten.uniq.sort)
+        puts
+      end
+    end
+
+    def self.field_table(list, columns = 4)
+      return nil if list.size.zero?
+
+      # Keep Alphabetical Sort
+      groups = list.each_slice((list.size / columns.to_f).round).to_a
+
+      table = TTY::Table.new do |t|
+        loop do
+          break if groups.all?(&:empty?)
+
+          t << groups.map(&:shift)
+        end
+      end
+
+      table.render(:unicode, padding: [0, 1, 0, 1])
+    end
+
     # Unified Files Interface
     def self.files(file_list, base_list = nil, flags = {})
       base_list ||= Thing.all

data/lib/greenhat/thing/formatters/nginx.rb

@@ -34,10 +34,10 @@ module GreenHat
       :ok
     end
 
-    # rubocop:disable Metrics/LineLength
+    # rubocop:disable Layout/LineLength
     # NGINX Conf: /var/opt/gitlab/nginx/conf/nginx.conf
     # log_format gitlab_access '$remote_addr - $remote_user [$time_local] "$request_method $filtered_request_uri $server_protocol" $status $body_bytes_sent "$filtered_http_referer" "$http_user_agent" $gzip_ratio';
-    # rubocop:enable Metrics/LineLength
+    # rubocop:enable Layout/LineLength
 
     # ==========================================================================
   end

data/lib/greenhat/thing.rb

@@ -26,6 +26,7 @@ class Thing < Teron
   field :parsed # Flag for Parsing
   field :result # Processed Data
   field :raw_result # Flag for reading raw data
+  field :result_fields # All available fields
 
   def friendly_name
     "#{archive.friendly_name.pastel(:blue)} #{name.pastel(:green)}"
@@ -49,6 +50,13 @@ class Thing < Teron
     result
   end
 
+  # Processor
+  def fields
+    process unless parsed
+
+    result_fields
+  end
+
   def raw
     raw_read if raw_result.nil?
 
@@ -116,6 +124,20 @@ class Thing < Teron
 
     self.parsed = true
 
+    self.result_fields = field_processing
+
     save!
   end
+
+  def field_processing
+    if data.instance_of?(Array)
+      data.select { |x| x.instance_of?(Hash) }.map(&:keys).flatten.uniq
+    else
+      []
+    end
+  rescue StandardError => e
+    LogBot.fatal('Process', message: e.message, backtrace: e.backtrace.first)
+
+    []
+  end
 end

data/lib/greenhat/version.rb

@@ -1,3 +1,3 @@
 module GreenHat
-  VERSION = '0.3.1'.freeze
+  VERSION = '0.3.2'.freeze
 end

data/lib/greenhat.rb

@@ -21,6 +21,7 @@ require 'tty-prompt'
 require 'tty-reader'
 require 'tty-spinner'
 require 'tty-table'
+require 'tty-which'
 require 'warning'
 
 # Custom Gem

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: greenhat
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Davin Walker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-14 00:00:00.000000000 Z
+date: 2021-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amazing_print
@@ -360,6 +360,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: tty-which
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: warning
   requirement: !ruby/object:Gem::Requirement
@@ -405,6 +419,7 @@ files:
 - lib/greenhat/shell/color_string.rb
 - lib/greenhat/shell/disk.rb
 - lib/greenhat/shell/faststats.rb
+- lib/greenhat/shell/field_helper.rb
 - lib/greenhat/shell/filter_help.rb
 - lib/greenhat/shell/gitlab.rb
 - lib/greenhat/shell/help.rb