greenhat 0.3.6 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9cc86956963d9d4d6a11b8d84b3a047d66bbbd3ac1c0cbb45f7e9f91d0a55e2
-  data.tar.gz: c4df69de408709de93713f4e2a98ce6263f15b83c28bc3c353589368bb325efd
+  metadata.gz: 4205de8b256423c08291a212511d4d6ecd613d21f232d0d6b4641881779f1303
+  data.tar.gz: 695ce3fb852d8a3167b853b3b8c07448f031305e51072f34e7afb3aed75ca50e
 SHA512:
-  metadata.gz: 813350d41deb97b978afc55d3aad33e3bf1b383a721ab3a33b8ed56cfdd4b2158ba5c6e7368839d3f7ac74e53614c644e2f92a3a6ccc64608d1b89c5274396a1
-  data.tar.gz: 78074ff71327905079cbd603d640d09625d4e49bf1dc9e8a7e7823b8ba923d1abb0c69c833a0a956aa6d0e1af92e53bbae97015827d83219d8c384abf8a349b0
+  metadata.gz: 6d4653882946a783ddc0e11094205e42b33338afe53334cc9774956047a1b00eb54bca964925efbed47ca4c410e5007d6e5ac79f10376274b50beb1ffaedc8f0
+  data.tar.gz: c2002b0458b334799e4b04a446a9ca0193091f264e7077b9eac84c310423e6c0547d79094da45fa5fa9ce475d110756952602d3274b34f97b4162e7ee4226871

data/bin/greenhat

@@ -2,11 +2,8 @@
 
 require 'greenhat'
 
-# DEV ONLY
-require 'pry'
-
 Dir.mktmpdir('greenhat-sauce') do |tmp|
   $TMP = tmp
   $STDOUT_CLONE = $stdout.clone
-  GreenHat::Cli.start ARGV
+  GreenHat::Entrypoint.start ARGV
 end

data/lib/greenhat/archive.rb

@@ -7,7 +7,7 @@ module GreenHat
       Dir.mkdir path
 
       # Initially Copy file into tmpdir
-      FileUtils.cp(archive_path, "#{path}/")
+      FileUtils.cp_r(archive_path.to_s, "#{path}/")
 
       # Extract Everything
       loop do
@@ -28,9 +28,6 @@ module GreenHat
 
       archive = Archive.new(name: archive_path, path: path)
       archive.save
-      # file = list[2]
-      # thing = archive.things_create(file: file)
-      # thing.setup
 
       list.each do |file|
         # Ensure Valid Content
@@ -54,8 +51,13 @@ module GreenHat
     # Handle Different Types of Archives
     def self.unpack(archive_path, path)
       case File.extname archive_path
+      when '.tgz'
+        base_path = archive_path.gsub(File.basename(archive_path), '')
+        `bsdtar -xzf "#{archive_path}" -C #{base_path}`
+        FileUtils.rm(archive_path)
       when '.tar'
-        `bsdtar -xf "#{archive_path}" -C #{path}`
+        base_path = archive_path.gsub(File.basename(archive_path), '')
+        `bsdtar -xf "#{archive_path}" -C #{base_path}`
         FileUtils.rm(archive_path)
       when '.gz'
         `gzip -d "#{archive_path}"`
@@ -75,7 +77,7 @@ module GreenHat
     end
 
     def self.archive_types
-      %w[s gz tar]
+      %w[s gz tar tgz]
     end
     # -- Archive Loader ----------------------------------------------
   end

data/lib/greenhat/cli.rb

@@ -1,8 +1,31 @@
 # Top level namespace
 module GreenHat
-  # CLI Methods
+  # CLI Methods / Shell Specific COmmands
   # rubocop:disable Metrics/ModuleLength
   module Cli
+    # CLI Start
+    def self.start
+      value ||= '' # Empty Start
+
+      loop do
+        line = reader.read_line(readline_notch, value: value)
+        value = '' # Remove Afterwards
+
+        if reader.breaker
+          value = line
+          puts ''
+          next
+        end
+
+        break if line =~ /^exit/i
+
+        Settings.cmd_add(line) unless line.blank?
+
+        process
+        run
+      end
+    end
+
     def self.cursor
       @cursor = TTY::Cursor
     end
@@ -348,154 +371,6 @@ module GreenHat
       @quiet = !@quiet
     end
 
-    # rubocop:disable Metrics/MethodLength
-    def self.cli_help
-      Shell.version
-      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)
-      puts '  --report, -r'.pastel(:green)
-      puts '    Run `report` against archives and exit'
-      puts
-
-      puts '  --full-report, -f'.pastel(:green)
-      puts '    Run `report` with all details. e.g. include fast-stats top/errors'
-      puts
-
-      puts '  --markdown, -m'.pastel(:green)
-      puts '    Run `markdown_report` against archives and exit'
-      puts
-
-      puts '  --quiet, -r'.pastel(:green)
-      puts '    Surpress GreenHat logging output'
-      puts
-
-      puts '  --load, -l'.pastel(:green)
-      puts '    Automatically attempt to read/parse/preload all included files'
-      puts
-
-      puts '  --command, -c'.pastel(:green)
-      puts '    Run and then exit a GreenHat Shell command'
-      puts
-
-      puts '  --web, -w'.pastel(:green)
-      puts '    Start Sinatra Webservice on load (4567)'
-      puts
-
-      puts '  --no-color, -n'.pastel(:green)
-      puts '    Disable color output'
-      puts
-
-      puts '  --version, -v'.pastel(:green)
-      puts '    Print version and exit'
-      puts
-    end
-    # rubocop:enable Metrics/MethodLength
-
-    # Arguments before general processing
-    def self.pre_args(flags, files)
-      # Help
-      if flags?(%i[help h], flags)
-        cli_help
-        exit 0
-      end
-
-      # Version
-      if flags?(%i[version v], flags)
-        Shell.version
-        exit 0
-      end
-
-      # Quiet Flag
-      @quiet = true if flags?(%i[quiet q], flags)
-
-      # rubocop:disable Style/GuardClause
-      # MIA Files
-      if files.empty? || files.count { |x| File.exist? x }.zero?
-        puts "No arguments or files don't exist".pastel(:red)
-        puts 'Usage: greenhat  <sos-archive.tgz> <sos-archive2.tgz>'
-        cli_help
-        Shell.version
-      end
-      # rubocop:enable Style/GuardClause
-    end
-
-    # Arguments to be handled after general processing
-    def self.post_args(flags)
-      # Supress Color
-      GreenHat::Settings.settings[:color] = false if flags?(%i[no-color n], flags)
-
-      # Run report and exit / Don't Clear for reports
-      if flags?(%i[report r], flags)
-        @quiet = true
-        # Don't Use Pagination
-        GreenHat::Shell.report(['--raw'])
-        exit 0
-      elsif flags?(%i[full-report f], flags)
-        @quiet = true
-        # Don't Use Pagination
-        GreenHat::Shell.report(['--raw', '--full'])
-        exit 0
-      elsif flags?(%i[markdown m], flags)
-        @quiet = true
-        # Don't Use Pagination
-        GreenHat::Shell.markdown_report(['--raw'])
-        exit 0
-      else
-        clear_screen
-      end
-    end
-
-    def self.post_setup(flags)
-      # CTL Tails need to be parsed for new 'things'
-      Thing.where(kind: :gitlab_tail)&.map(&:process)
-      Thing.where(kind: :kube_webservice)&.map(&:process)
-
-      Thing.all.each(&:process) if flags?(%i[load l], flags)
-
-      Shell.web if flags?(%i[web w], flags)
-    end
-
-    # Helper to Simplify checking flags
-    def self.flags?(list = [], flags = {})
-      list.any? { |x| flags.key? x }
-    end
-
-    # If no arguments Supplied Print and quit - rather than nasty exception
-    def self.start(raw)
-      Settings.start
-      files, flags, args = Args.parse(raw)
-      pre_args(flags, files)
-      load_files files
-      run_command(args) if args.any? { |arg| run_command?(arg) }
-      post_args(flags)
-      post_setup(flags)
-
-      value ||= '' # Empty Start
-
-      loop do
-        line = reader.read_line(readline_notch, value: value)
-        value = '' # Remove Afterwards
-
-        if reader.breaker
-          value = line
-          puts ''
-          next
-        end
-
-        break if line =~ /^exit/i
-
-        Settings.cmd_add(line) unless line.blank?
-
-        process
-        run
-      end
-    end
-
     def self.run_command?(arg)
       %i[command c].any? do |x|
         arg[:field] == x
@@ -515,20 +390,6 @@ module GreenHat
       exit 0
     end
 
-    def self.load_files(files)
-      # TODO: Web Helpers?
-      # suppress_output { GreenHat::Web.start }
-
-      # Don't double up on archives / Only Existing files
-      puts 'Loading Archives'.pastel(:blue) unless Cli.quiet
-      files.uniq.each do |file|
-        next unless File.exist?(file)
-
-        puts "- #{file}".pastel(:magenta) unless Cli.quiet
-        ArchiveLoader.load file
-      end
-    end
-
     def self.suppress_output
       original_stderr = $stderr.clone
       original_stdout = $stdout.clone

data/lib/greenhat/entrypoint.rb

@@ -0,0 +1,170 @@
+# Top level namespace
+module GreenHat
+  # Entrypoint Methods
+  # Command Line Args / File Parsing etc
+  module Entrypoint
+    # If no arguments Supplied Print and quit - rather than nasty exception
+    def self.start(raw)
+      @clear = true # Reset screen by default
+      Settings.start
+      files, flags, args = Args.parse(raw)
+      pre_args(flags, files)
+      load_files files
+      Cli.run_command(args) if args.any? { |arg| Cli.run_command?(arg) }
+      post_args(flags)
+      post_setup(flags)
+
+      Cli.start # Kick over to CLI
+    end
+
+    # Arguments before general processing
+    def self.pre_args(flags, files)
+      # Help
+      if flags?(%i[help h], flags)
+        cli_help
+        exit 0
+      end
+
+      # Version
+      if flags?(%i[version v], flags)
+        Shell.version
+        exit 0
+      end
+
+      # Assume Raw Setting
+      Settings.settings[:assume_raw] = true if flags?(%i[no-prompt np], flags)
+      Settings.settings[:assume_raw] = false if flags?(%i[prompt p], flags)
+
+      # Quiet Flag
+      @quiet = true if flags?(%i[quiet q], flags)
+
+      if flags?(%i[load-local ll], flags)
+        # Hook in loading local
+        Shell.load_local(false)
+      elsif files.empty? || files.count { |x| File.exist? x }.zero?
+        # MIA Files
+        puts "No arguments or files don't exist".pastel(:red)
+        puts 'Usage: greenhat  <sos-archive.tgz> <sos-archive2.tgz>'
+        puts 'See `--help`'
+
+        @clear = false # Don't hide messages
+
+        Shell.version
+      end
+    end
+
+    # Arguments to be handled after general processing
+    def self.post_args(flags)
+      # Supress Color
+      GreenHat::Settings.settings[:color] = false if flags?(%i[no-color n], flags)
+
+      # Run report and exit / Don't Clear for reports
+      if flags?(%i[report r], flags)
+        @quiet = true
+        # Don't Use Pagination
+        GreenHat::Shell.report(['--raw'])
+        exit 0
+      elsif flags?(%i[full-report f], flags)
+        @quiet = true
+        # Don't Use Pagination
+        GreenHat::Shell.report(['--raw', '--full'])
+        exit 0
+      elsif flags?(%i[markdown m], flags)
+        @quiet = true
+        # Don't Use Pagination
+        GreenHat::Shell.markdown_report(['--raw'])
+        exit 0
+      elsif @clear
+        Cli.clear_screen
+      end
+    end
+
+    def self.post_setup(flags)
+      # CTL Tails need to be parsed for new 'things'
+      Thing.where(kind: :gitlab_tail)&.map(&:process)
+      Thing.where(kind: :kube_webservice)&.map(&:process)
+
+      Thing.all.each(&:process) if flags?(%i[load l], flags)
+
+      Shell.web if flags?(%i[web w], flags)
+    end
+
+    # Helper to Simplify checking flags
+    def self.flags?(list = [], flags = {})
+      list.any? { |x| flags.key? x }
+    end
+
+    def self.load_files(files)
+      # Don't double up on archives / Only Existing files
+      puts 'Loading Archives'.pastel(:blue) unless Cli.quiet
+      files.uniq.each do |file|
+        next unless File.exist?(file)
+
+        puts "- #{file}".pastel(:magenta) unless Cli.quiet
+        ArchiveLoader.load file
+      end
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    def self.cli_help
+      Shell.version
+      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)
+      puts '  --report, -r'.pastel(:green)
+      puts '    Run `report` against archives and exit'
+      puts
+
+      puts '  --full-report, -f'.pastel(:green)
+      puts '    Run `report` with all details. e.g. include fast-stats top/errors'
+      puts
+
+      puts '  --markdown, -m'.pastel(:green)
+      puts '    Run `markdown_report` against archives and exit'
+      puts
+
+      puts '  --quiet, -r'.pastel(:green)
+      puts '    Surpress GreenHat logging output'
+      puts
+
+      puts '  --load, -l'.pastel(:green)
+      puts '    Automatically attempt to read/parse/preload all included files'
+      puts
+
+      puts '  --load-local, -ll'.pastel(:green)
+      puts '    Load log files from locations on an Omnibus install'
+      puts
+
+      puts '  --prompt, -p'.pastel(:green)
+      puts '    Override settings / Assume Prompt'
+      puts
+
+      puts '  --no-prompt, -np'.pastel(:green)
+      puts '    Do not prompt for file types / Assume Raw or JSON'
+      puts
+
+      puts '  --command, -c'.pastel(:green)
+      puts '    Run and then exit a GreenHat Shell command'
+      puts
+
+      puts '  --web, -w'.pastel(:green)
+      puts '    Start Sinatra Webservice on load (4567)'
+      puts
+
+      puts '  --no-color, -n'.pastel(:green)
+      puts '    Disable color output'
+      puts
+
+      puts '  --version, -v'.pastel(:green)
+      puts '    Print version and exit'
+      puts
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    # ==========================================================
+  end
+end

data/lib/greenhat/settings.rb

@@ -6,12 +6,14 @@ module GreenHat
       @settings ||= {
         history: [],
         assume_json: true,
+        assume_raw: false,
         fuzzy_file_match: true,
 
         # round: [2],
         # page: [:true] Automatic,
         truncate: TTY::Screen.width * 4,
         color: true
+
       }
     end
 
@@ -19,6 +21,10 @@ module GreenHat
       settings.assume_json
     end
 
+    def self.assume_raw?
+      settings.assume_raw
+    end
+
     # Allow for future disabling of color output
     def self.color?
       settings.color

data/lib/greenhat/shell/shell_helper.rb

@@ -55,12 +55,14 @@ module GreenHat
       # Default Pager
       TTY::Pager.page do |pager|
         data.each do |entry|
-          output = entry_show(flags, entry)
+          output = "\n#{entry_show(flags, entry)}"
+
+          # output += "\n" if flags[:table_style] == 'basic'
 
           # Breaks any intentional spaces
           # next if output.blank?
 
-          pager.write("\n#{output}") # write line to the pager
+          pager.write(output) # write line to the pager
         end
       end
     end
@@ -126,10 +128,15 @@ module GreenHat
       table = TTY::Table.new(header: entry.keys, rows: [entry], orientation: :vertical)
 
       LogBot.debug('Rendering Entries') if ENV['DEBUG']
-      table.render(table_style, padding: [0, 1, 0, 1], multiline: true) do |renderer|
+      output = table.render(table_style, padding: [0, 1, 0, 1], multiline: true) do |renderer|
         renderer.border.style = :cyan
       end
 
+      # Line breaks for basic tables
+      output += "\n" if flags[:table_style] == 'basic'
+
+      output
+
       # LogBot.debug('Finish Render Table') if ENV['DEBUG']
       # Fall Back to Amazing Inspect
     rescue StandardError => e
@@ -201,7 +208,8 @@ module GreenHat
     end
 
     def self.calculate_duration(results)
-      only_with_time = results.select(&:time)
+      # Skip for Pluck
+      only_with_time = results.select { |x| x.instance_of?(Hash) && x.key?(:time) }
 
       # If slice is used ignore
       return nil if only_with_time.empty?

data/lib/greenhat/shell.rb

@@ -30,12 +30,12 @@ module GreenHat
       Memory.free
     end
 
-    def self.load_local
-      return false unless TTY::Prompt.new.yes?('Load local Omnibus GitLab Instance files?')
+    def self.load_local(prompt = true)
+      return false if prompt && !TTY::Prompt.new.yes?('Load local Omnibus GitLab Instance files?')
 
       archive_path = "#{$TMP}/#{Time.now.to_i}_local"
       Dir.mkdir(archive_path)
-      # archive = Archive.new(name: 'local')
+
       archive = Archive.new(name: archive_path, path: archive_path)
 
       file_list = Dir['/var/log/gitlab/*/current'] + Dir['/var/log/gitlab/*/*.log']

data/lib/greenhat/thing/file_types.rb

@@ -67,7 +67,8 @@ module GreenHat
         'etc/fstab' => {
           format: :clean_raw,
           pattern: [
-            %r{etc/fstab}
+            %r{etc/fstab},
+            /fstab/
           ]
         },
         'etc/os-release' => {
@@ -108,6 +109,13 @@ module GreenHat
             %r{gitaly/@.*}
           ]
         },
+        'gitaly/gitaly_hooks.log' => {
+          format: :shellwords,
+          log: true,
+          pattern: [
+            %r{gitaly/gitaly_hooks\.log}
+          ]
+        },
         'consul/current' => {
           format: :time_space,
           log: true,
@@ -803,6 +811,7 @@ module GreenHat
         'gitlab-rails/production.log' => {
           format: :raw,
           pattern: [
+            /production.log/,
             %r{gitlab-rails/production.log},
             %r{webservice.log/production.log}
           ]

data/lib/greenhat/thing/kind.rb

@@ -73,6 +73,11 @@ module GreenHat
         end
       end
 
+      if Settings.assume_raw?
+        self.type = 'raw'
+        return true
+      end
+
       puts "Unable to determine file type for #{name.pastel(:yellow)}"
       puts "Use '#{'json'.pastel(:cyan)}' or '#{'raw'.pastel(:cyan)}' if there are no matches (see file_types.rb)"
 

data/lib/greenhat/thing.rb

@@ -147,6 +147,7 @@ class Thing < Teron
     self.name = name
     self.log = true
     self.parsed = true
+    self.type = 'json'
     self.result_fields = field_processing
     save!
   end

data/lib/greenhat/version.rb

@@ -1,3 +1,3 @@
 module GreenHat
-  VERSION = '0.3.6'.freeze
+  VERSION = '0.4.0'.freeze
 end

data/lib/greenhat.rb

@@ -46,6 +46,7 @@ Hash.hash_dot_use_default = true
 
 # Load Required Files
 require 'greenhat/version'
+require 'greenhat/entrypoint'
 require 'greenhat/cli'
 require 'greenhat/archive'
 require 'greenhat/host'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: greenhat
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.4.0
 platform: ruby
 authors:
 - Davin Walker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-15 00:00:00.000000000 Z
+date: 2021-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amazing_print
@@ -451,6 +451,7 @@ files:
 - lib/greenhat/archive.rb
 - lib/greenhat/cli.rb
 - lib/greenhat/color.rb
+- lib/greenhat/entrypoint.rb
 - lib/greenhat/host.rb
 - lib/greenhat/logbot.rb
 - lib/greenhat/pry_helpers.rb
@@ -549,7 +550,8 @@ files:
 homepage: https://gitlab.com/gitlab-com/support/toolbox/greenhat
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -558,14 +560,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: GitLab SOS Tool