gown 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b50d1abff868ef58f5cf85ccc97fdc953dd640d1
+  data.tar.gz: 753ac251809cb2399c40cec6b59008e7b307a980
+SHA512:
+  metadata.gz: 5c51505226bd35c0bf8cfb82f719377999c05427931ad9c68a4101f1507bddf876caa2d24ac79977ef4830814d90c3a4e827472df1f9557fe43aad021c3d472d
+  data.tar.gz: b20bc992afa979c84865768fd9bee76c204d83011a8c51f183f5704cc628da376de02c89ce1b98941ab98ca5dca291f7ca2421e2aeb81c993ab1c972da24f3ea

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at github@dylanlacey.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in gown.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 dylanlacey
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# Gown
+
+Sauce Connect's verbose logs are big and hard to read.  Replace all those puffy KGP lines, bulky CMDs and tightly cinched MAINs with a breezy gown!
+
+## Installation
+
+Gown is intended to be installed as a standalone tool:
+
+    $ gem install gown
+
+But, you can use it in the normal way by adding it to your Gemfile.  If you want to do this, you should probably already know how ;)
+
+## Usage
+
+### Default Operation
+Gown takes one required argument, `file_to_strip`:
+
+`   $ gown original_filename.log`
+
+By default, it will write the stripped log to `original_filename.log.stripped`.  To write to a desired file, pass a second argument:
+
+`   $ gown original_filename.log new_filename.log`
+
+### Custom Filtering
+The patterns for filtering are defined in `gown/lib/gown/patterns.rb`.  They're added to the pattern collection in `gown/gown.rb`.
+
+The ability to edit these is coming.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gown. 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 & Support
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+Additionally, this gem is subject to the following support guarantee:  None.  Neither the author, contributors, nor Sauce Labs warrant this gem's fitness for any purpose, nor is any support of any kind promised.  Seriously, don't lodge tickets with Sauce Labs.  This isn't even an official offering of theirs.
+
+## Code of Conduct
+
+Everyone interacting in the Gown project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/gown/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gown"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/gown

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'gown'
+
+file_to_strip = ARGV[0]
+file_to_write = ARGV[1]
+
+if file_to_write.nil?
+	file_to_write = file_to_strip + ".stripped"
+end
+
+Gown.strip_file file_to_strip, file_to_write

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gown.gemspec

@@ -0,0 +1,37 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "gown/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "gown"
+  spec.version       = Gown::VERSION
+  spec.authors       = ["dylanlacey"]
+  spec.email         = ["github@dylanlacey.com"]
+
+  spec.summary       = %q{Strips out un-nescessary lines from verbose Sauce Connect logs.}
+  spec.homepage      = "https://www.github.com/dylanlacey/gown"
+  spec.license       = "MIT"
+
+  # # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "tty-spinner", "~> 0.8.0"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/gown/patterns.rb

@@ -0,0 +1,49 @@
+module Gown
+  class Patterns
+
+    Timestamp = '(?<date>[[:digit:]]{8})[[:blank:]](?<time>[[:digit:]]{6}\.[[:digit:]]{,3})[[:blank:]]\[[[:digit:]]{1,5}\][[:blank:]]'
+
+    KGP_lifecycle = [
+      'KGP got keepalive request',
+      'KGP got keepalive ack',
+      'CMD got KGP last_status_change query',
+      'CMD got KGP is_connected query',
+      'CMD sent reply [[:digit:]]+',
+      'KGP rescheduling timer',
+      'KGP connected to server',
+      'MAIN connecting to KGP server [[:alnum:]]+\.miso\.saucelabs\.com took [[:digit:]]+ ms',
+    ]
+
+    KGP_warnings = [
+      'KGP warning: no keepalive ack for > 5s',       
+      'KGP warning: time since last keepalive has exceeded maximum allowed timelimit',
+      'KGP warning: the last keepalive ack was received [[:digit:]]+ seconds ago',
+    ]
+
+    KGP_metadata = [
+      'KGP -> announcement metadata=\{"username"\: "[[:alnum:]]+", "access_key"\: "([[:alnum:]]|-)+"\}',
+      'KGP <- announcement [[:digit:]]+ bytes, metadata: \{"last_seen_seq": [[:digit:]]+\}', 
+    ]
+
+    KGP_traffic = [
+      'KGP (new packet|-> packet|<-|-> keepalive ack|-> keepalive|-> resend)? conn=[[:digit:]]{1,} seq=[[:digit:]]{1,} ack=[[:digit:]]{1,} ctrl=[[:digit:]]{1,} len=[[:digit:]]{1,}',
+      'KGP got packet [[:digit:]]+ bytes',
+      'KGP -> close conn=[[:digit:]]{1,} seq=[[:digit:]]{1,} ack=[[:digit:]]{1,} ctrl=[[:digit:]]{1,} half=[[:digit:]]+',
+      'KGP packet [[:digit:]]+ \<= [[:digit:]]+, removing from cache',
+      'KGP got close for conn=[[:digit:]]+',
+    ]
+
+    CHANNEL_events = [
+      'CHANNEL (<-|->) [[:digit:]]+ (read|sent) [[:digit:]]+ bytes',
+      'CHANNEL [[:digit:]]+ connected to ext server',
+    ]
+
+    MAIN_lifecycle = [
+      'MAIN using socket [[:digit:]]+ for connection',
+      'MAIN client event loop exiting: [[:digit:]]+',
+      'MAIN main loop exited, return code: [[:digit:]]+',
+      'MAIN starting client event loop',
+      'MAIN connecting to [[:alnum:]]+\.miso\.saucelabs\.com\:443 via ([[:alnum:]]|/|\.|\?|&|=|-|_|:|%|,){1,}:[[:digit:]]{1,5}',
+    ]
+  end
+end

data/lib/gown/version.rb

@@ -0,0 +1,3 @@
+module Gown
+  VERSION = "0.1.0"
+end

data/lib/gown.rb

@@ -0,0 +1,50 @@
+require "gown/version"
+require "gown/patterns"
+require "tty-spinner"
+
+module Gown
+
+  class << self
+    def strip_file input_filename, output_filename
+      patterns_to_remove = (
+        Gown::Patterns::KGP_lifecycle + 
+        Gown::Patterns::KGP_warnings +
+        Gown::Patterns::KGP_metadata +
+        Gown::Patterns::KGP_traffic +
+        Gown::Patterns::CHANNEL_events +
+        Gown::Patterns::MAIN_lifecycle
+      ).map {|pattern| Regexp.new (Gown::Patterns::Timestamp + pattern)}
+
+      puts "Checking for #{patterns_to_remove.length} patterns"
+
+      spinner = TTY::Spinner.new("[:spinner] Parsing #{input_filename}")
+      begin
+
+        lines_removed = 0
+
+        spinner.auto_spin
+        input = File.open input_filename
+        input.advise(:sequential)
+
+        output = File.new output_filename, "a"
+
+        input.each do |line|
+          filtered = patterns_to_remove.find { |pattern| pattern.match line }
+          if !filtered
+            output.puts line
+          else
+            lines_removed+= 1
+          end
+        end
+
+        spinner.success " -- Removed #{lines_removed} lines"
+      rescue => e
+        spinner.error "Something dire happened!"
+        puts e
+      ensure
+        input.close if input
+        output.close if output
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: gown
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- dylanlacey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tty-spinner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- github@dylanlacey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/gown
+- bin/setup
+- gown.gemspec
+- lib/gown.rb
+- lib/gown/patterns.rb
+- lib/gown/version.rb
+homepage: https://www.github.com/dylanlacey/gown
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Strips out un-nescessary lines from verbose Sauce Connect logs.
+test_files: []