chopshop-logreader 0.1.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28bcb17ede2f64475a1358925a992e3a1752aa4f8570ef3f556648cb806c2533
-  data.tar.gz: b9e4d97fb42bd7c7a833e274d7fa00147ead346de19e078003e9853c2c15aa33
+  metadata.gz: b4643ced8d7e2c59fbf952f664830b153535e759faec0808a0929fa468e6a527
+  data.tar.gz: b3297dd87e662429b8a7fb8eb8319572d58bddc08dedb8bfc182732b1816bb64
 SHA512:
-  metadata.gz: 4076be9cf0e715d52f13f8d54beb3c6331b3f3779b9b34e7f84cddb2178745bf48e95852e794e50e9f020b14d2449a0dc3ca57eb3b9caafb51c891e91d1ca726
-  data.tar.gz: 692c27baf71477ca943f25a96fdf8286774cbd5eff49de1531162bc01a5dd7d38e667ec5c88a6936fa54c284a8a3007620f3eb30d274b9a2173a97521a28ba96
+  metadata.gz: 6914d2d72ed31d866a8db404d3593e5a8440f4982df84b88a8d012828b2b08d74987337b1f31a97153facff046a6bb3cee4d58af9822bc145556628ca983c127
+  data.tar.gz: 29f0107c67bc1360c89c5f60ea56919b99daa5bc71b1269a694a11b37d74cb2d5be28bef2304251d6776ab8aee6387e150c0b16fd74c19ff1a6491d8258cade6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    chopshop-logreader (0.1.0)
+    chopshop-logreader (0.2.2)
 
 GEM
   remote: https://rubygems.org/
@@ -13,10 +13,10 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
+  bundler (~> 2.2)
   chopshop-logreader!
   minitest (~> 5.0)
   rake (~> 10.0)
 
 BUNDLED WITH
-   1.17.2
+   2.2.33

data/README.md

@@ -1,8 +1,6 @@
 # Chopshop::Logreader
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/chopshop/logreader`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This is a simple CLI tool that allows you to find & follow the logs for the most recently running kubernetes pod with a given name for a given status (default status is "Running"). As of now there is no support for searching for pods that started running in a given window of time, although that is a possible feature add if requested. if a valid pod is not found, it will ping the API once a second until one is found or the program is exited. This primarily just wraps some `kubectl` commands and handles parsing the output in standard way to quickly find a pod's logs.
 
 ## Installation
 
@@ -14,15 +12,66 @@ gem 'chopshop-logreader'
 
 And then execute:
 
-    $ bundle
+```bash
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install chopshop-logreader
+```bash
+gem install chopshop-logreader
+```
+
+## Getting started
+
+This gem assumes 2 things.
+
+1. you will provide a cloud provider profile (think aws) via one of 3 sources:
+    - an option on the command line (`-p PROFILE` or `--profile PROFILE`)
+    - via the ENV VAR `AWS_PROFILE`
+    - via the ENV VAR `PROFILE`
+
+2. you will provide a tenant via one of 2 sources:
+    - an option on the command line (`t TENANT` or `--tenant TENANT`)
+    - via the ENV VAR `DEFAULT_TENANT`
+
+Ideally you will set those env vars before starting.
 
 ## Usage
 
-TODO: Write usage instructions here
+to get help:
+
+```bash
+chopshop-logreader -h
+```
+
+example uses:
+
+```bash
+chopshop-logreader SERVICE_NAME_HERE -n connect -s Completed -l 10 -f false
+```
+
+```bash
+chopshop-logreader SERVICE_NAME_HERE -n connect -s Error -l -1 -f true
+```
+
+```bash
+chopshop-logreader SERVICE_NAME_HERE -n connect -s Error -l -1 -f true -t some-cool-tenant-name -p my-cool-aws-dev-profile
+```
+
+### Default Use
+
+```bash
+chopshop-logreader profile-reader
+```
+
+expands to
+
+```bash
+chopshop-logreader profile-reader -n connect -s Running -l -1 -f true
+```
+
+the default use also assumes your have set the ENV VARS `DEFAULT_TENANT` and either `AWS_PROFILE` or `PROFILE`
 
 ## Development
 
@@ -32,7 +81,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/chopshop-logreader. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/[tperdue321]/chopshop-logreader. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -41,3 +90,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Code of Conduct
 
 Everyone interacting in the Chopshop::Logreader project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/chopshop-logreader/blob/master/CODE_OF_CONDUCT.md).
+
+## Project TODO
+
+- add a startup script that will set the default profile/tenant for a user

data/bin/chopshop-logreader

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "chopshop/logreader"
+
+Chopshop::Logreader::Executor.execute!

data/chopshop-logreader.gemspec

@@ -35,7 +35,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "bundler", "~> 2.2"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
 end

data/lib/chopshop/logreader/executor.rb

@@ -24,22 +24,25 @@ module Chopshop
 
       def execute!
         options = @parser.parse 
+        profile = options.profile || ENV["AWS_PROFILE"] || ENV["PROFILE"]
+        tenant = options.tenant || ENV["DEFAULT_TENANT"]
+        region = options.region || ENV["AWS_REGION"] || "us-east-1"
 
         container = nil
         service = ARGV[0]
+        `rally-kubectl -a #{region} -e #{profile} -t #{tenant}`
         puts "looking for valid container"
         while !container
-          containers = `kubectl get pods --namespace #{options[:namespace]} | grep #{service}`
+          containers = `kubectl get pods --namespace #{options.namespace} | grep #{service}`
           container = containers.split("\n").map {|line| line.split(" ") }.each do |line|
             match_data = REGEX.match(line[4])
             line[5] = TIME_CALCULATOR[match_data.captures[1].downcase] * match_data.captures[0].to_i + TIME_CALCULATOR[match_data.captures[3].downcase] * match_data.captures[2].to_i
-          end.select{|line| line[2] == options[:status] }.sort_by {|line| line[5] }.first
+          end.select{|line| line[2] == options.status }.sort_by {|line| line[5] }.first
 
           if container
-            exec "kubectl logs --follow=#{options[:follow]} --tail=#{options[:lines]} --namespace connect #{container[0]}"
+            exec "kubectl logs --follow=#{options.follow} --tail=#{options.lines} --namespace connect #{container[0]}"
           end
 
-
           print "."
           sleep 1
         end

data/lib/chopshop/logreader/parser.rb

@@ -1,15 +1,20 @@
 require "optparse"
+require 'ostruct'
 
 module Chopshop
   module Logreader
     class Parser
       def parse
-        options = {
+        options = OpenStruct.new(
           follow: true, # follow output from log file
           lines: -1, # whole file always,
           status: "Running", # look for a currently running container
-          namespace: "connect"
-        }
+          namespace: "connect",
+          tenant: nil,
+          profile: nil,
+          region: nil
+        )
+
 
         OptionParser.new do |opts|
           opts.banner = "Usage: ruby log-reader.rb SERVICE [options]"
@@ -30,6 +35,17 @@ module Chopshop
             options[:status] = status
           end
 
+          opts.on("-p [PROFILE]", "--profile [PROFILE]", "chooses the cloud profile to use for permissions. default: nil.  You must provide this value or set the ENV VAR AWS_PROFILE' or the ENV VAR 'PROFILE'", String) do |profile|
+            options[:profile] = profile
+          end
+
+          opts.on("-r [REGION]", "--region [REGION]", "sets the cloud region to look for a tenant within. default: us-east-1.  You may also provide this value via the ENV VAR 'AWS_REGION'", String) do |region|
+            options[:region] = region
+          end
+
+          opts.on("-t [TENANT]", "--tenant [TENANT]", "sets the kubernetes tenant to look for containers in. default: nil.  You must provide this value or set the ENV VAR DEFAULT_TENANT'", String) do |tenant|
+            options[:tenant] = tenant
+          end
 
           opts.on("-h", "--help", "Prints this help") do
             puts opts

data/lib/chopshop/logreader/version.rb

@@ -1,5 +1,5 @@
 module Chopshop
   module Logreader
-    VERSION = "0.1.1"
+    VERSION = "0.2.2"
   end
 end

data/lib/chopshop/logreader.rb

@@ -1,7 +1,6 @@
 module Chopshop
   module Logreader
     class Error < StandardError; end
-    # Your code goes here...
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chopshop-logreader
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Travis Perdue
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-18 00:00:00.000000000 Z
+date: 2021-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,10 +52,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: 
+description:
 email:
 - travis.perdue@rallyhealth.com
 executables:
+- chopshop-logreader
 - chopshop_logreader
 - console
 - setup
@@ -70,6 +71,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/chopshop-logreader
 - bin/chopshop_logreader
 - bin/console
 - bin/setup
@@ -85,7 +87,7 @@ metadata:
   homepage_uri: https://github.com/tperdue321/chopshop-logreader
   source_code_uri: https://github.com/tperdue321/chopshop-logreader
   changelog_uri: https://github.com/tperdue321/chopshop-logreader
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -100,8 +102,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Read logs out of kubernetes
 test_files: []