log_weaver 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTUxZmMwMjA5ZWY3ZGMwOGIyYmUwMzEyZDVhZWM4MjFkMzUwODAwYw==
+  data.tar.gz: !binary |-
+    M2QzN2Y3OWNmM2ZiMjAwNTFjNzQ4NmM0NzFjMTM3MDA4YWNiZWY1Yg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MDQ2NzQ3Y2U2NDAwODk2NmRmMmU3MWUzNDMzNDVjYzQ3MmVhNTQ0NzllOGUz
+    MTg5ZjdiNmE0YjYxMTFmYmVlYmFlZjE3MmQ4ZWM2ZTk2NDA2NjIyZDQ1Zjkw
+    ODJkMDU1NDAxODBmYjViMDg5OTc2OWJhYzk0MGUzMzVjYTM5NTA=
+  data.tar.gz: !binary |-
+    NzRmMmUyZTA0OTY1YzdjZTJmNTAxZDNjYWE2YjcyNWQ4ZGI5MGFjNjFjYTlm
+    YWMzMGExNDU4ZDQwYzAxODJlMTNjMjk2NGVlOTE1ZWIyNDUyMTg3NzE2ODhh
+    NzI4NDBiOWUwY2Y4MzZlMTc3MzM0MDgwMzMyNjNjMTViYmFmNjk=

data/.hgignore

@@ -0,0 +1,9 @@
+.DS_Store
+results.html
+pkg
+html
+.idea
+
+tmp
+test.rb
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in log_weaver.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    log_weaver (0.0.1)
+      methadone (~> 1.2)
+      require_all (~> 1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    aruba (0.5.2)
+      childprocess (~> 0.3.6)
+      cucumber (>= 1.1.1)
+      rspec-expectations (>= 2.7.0)
+    builder (3.2.0)
+    childprocess (0.3.9)
+      ffi (~> 1.0, >= 1.0.11)
+    cucumber (1.3.1)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12.0)
+      multi_json (~> 1.3)
+    diff-lcs (1.2.4)
+    factory_girl (4.2.0)
+      activesupport (>= 3.0.0)
+    ffi (1.7.0-x86-mingw32)
+    gherkin (2.12.0-x86-mingw32)
+      multi_json (~> 1.3)
+    i18n (0.6.1)
+    methadone (1.2.6)
+      bundler
+    multi_json (1.7.2)
+    rake (0.9.6)
+    readme (0.1.0)
+    require_all (1.2.1)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    unindent (1.0)
+    yard (0.8.6.1)
+
+PLATFORMS
+  x86-mingw32
+
+DEPENDENCIES
+  aruba (~> 0.5)
+  cucumber (~> 1.2)
+  factory_girl (~> 4.2)
+  log_weaver!
+  rake (~> 0.9)
+  readme (~> 0.1)
+  rspec (~> 2.13)
+  unindent (~> 1.0)
+  yard (~> 0.8)

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 raphael
+
+MIT License
+
+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,31 @@
+# LogWeaver
+
+[Website](http://fakeleft.github.com/log_weaver) /
+[Development](http://github.com/fakeleft/log_weaver) /
+[Issue Tracker](http://github.com/fakeleft/log_weaver/issues) /
+
+
+##Description
+
+Weaves multiple log files into a single one using the timestamp in log entries.
+Precedes each line with a portion of the source log file name so you can tell
+which file a line came from.
+
+## Installation
+
+gem install log_weaver
+
+## Usage
+
+log_weaver --help
+
+## Copyright
+
+Copyright (c) 2012 Raphael Borowiecki. All rights reserved.
+
+## License
+
+MIT
+
+
+

data/Rakefile

@@ -0,0 +1,56 @@
+require 'bundler'
+require 'rake/clean'
+
+require 'rspec/core/rake_task'
+
+require 'cucumber'
+require 'cucumber/rake/task'
+
+include Rake::DSL
+
+Bundler::GemHelper.install_tasks
+
+
+RSpec::Core::RakeTask.new do |t|
+  # Put spec opts in a file named .rspec in root
+end
+
+
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty --no-source -x"
+  t.fork = false
+end
+
+desc "Generate RDoc"
+task :doc => ['doc:generate']
+
+namespace :doc do
+  project_root = File.expand_path(File.join(File.dirname(__FILE__), '.'))
+  doc_destination = File.join(project_root, 'doc', 'rdoc')
+
+  begin
+    require 'yard'
+    require 'yard/rake/yardoc_task'
+
+    YARD::Rake::YardocTask.new(:generate) do |yt|
+      yt.files   = Dir.glob(File.join(project_root, 'lib', '**', '*.rb'))
+      yt.options = ['--output-dir', doc_destination, '--readme', 'README.md']
+    end
+  rescue LoadError
+    desc "Generate YARD Documentation"
+    task :generate do
+      abort "Please install the YARD gem to generate rdoc."
+    end
+  end
+
+  desc "Remove generated documenation"
+  task :clean do
+    rm_r doc_destination if File.exists?(doc_destination)
+  end
+
+end
+
+task :default => [:spec,:features]
+

data/bin/log_weaver

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'methadone'
+
+require 'log_weaver'
+
+include LogWeaver::PrefixGenerator
+
+
+module Methadone
+  module Main
+    include LogWeaver
+
+
+    def do_main(file1, file2, additional_files)
+      files = [file1, file2, *additional_files ]
+      files.each{ |f| exit_now!("File '#{f}' does not exist!") unless File.exists? f }
+
+      begin
+        file_prefixes = get_file_prefixes(files)
+      rescue ArgumentError => e
+        exit_now!(e.message)
+      end
+
+      parsed_logs = files.map{ |f| ParsedLog.new(file_prefixes[f], StringIO.new(File.open(f).read)) }
+      overall_log = CombinedLog.new(parsed_logs)
+      puts overall_log
+    end
+
+
+  end
+end
+
+
+class App
+  include Methadone::Main
+  include Methadone::CLILogging
+
+  main do |file1, file2, additional_files|
+    do_main file1, file2, additional_files
+  end
+
+  description "Weaves logs by timestamp."
+
+  arg :file1, "Path to first log file."
+  arg :file2, "Path to second log file."
+  #TODO: how do you capture variable number of optional args?
+  arg :additional_files, :optional, "Paths to subsequent log files."
+
+  version LogWeaver::VERSION
+
+  use_log_level_option
+
+  go!
+
+end

data/cucumber.yml

@@ -0,0 +1,2 @@
+default: FAILFAST=true
+

data/features/log_weaver.feature

@@ -0,0 +1,430 @@
+Feature: run command line app; weave log files by timestamp
+  As a log weaver user
+  I want to weave log files together into a single file
+  So troubleshooting doesn't drive me insane
+
+  Scenario: app has banner stating options and required arguments
+    When I get help for "log_weaver"
+    Then the exit status should be 0
+    And the banner should be present
+    And the banner should document that this app takes options
+    And the following options should be documented:
+      |--version|
+    And the banner should document that this app's arguments are:
+      | file1            | which is required |
+      | file2            | which is required |
+      | additional_files | which is optional |
+
+
+  Scenario: First file does not exist
+    Given no file named "file1"
+    And an empty file named "file2"
+    When I run `log_weaver file1 file2`
+    Then the exit status should not be 0
+    And the stderr should contain "File 'file1' does not exist!"
+
+  Scenario: Second file does not exist
+    Given an empty file named "file1"
+    And no file named "file2"
+    When I run `log_weaver file1 file2`
+    Then the exit status should not be 0
+    And the stderr should contain "File 'file2' does not exist!"
+
+  Scenario: Third file does not exist
+    Given an empty file named "file1"
+    And an empty file named "file2"
+    When I run `log_weaver file1 file2 file3`
+    Then the exit status should not be 0
+    And the stderr should contain "File 'file3' does not exist!"
+
+  #TODO: test (file2 file1 file1), (file1, file2, file1), etc
+  Scenario: file1 given twice
+    Given a file named "file1" with:
+    """
+    2012-01-01 00:00:00.001 - line1
+    """
+    When I run `log_weaver file1 file1`
+    Then the exit status should not be 0
+    And the stderr should contain "File list is not unique."
+
+
+  # TODO: replace with scenarios
+  # each line in the output should be prefixed by a portion of its file name so it's clear
+  # which file it came from; use at least 4 characters, less if file name is shorter
+  # than 4, more if resulting prefixes match; pad things so lines start in the same column
+  # scenarios below use lines with no timestamp - output is in the same order as the file
+  # arguments
+  Scenario: first file has name shorter than 4
+    Given a file named "fil" with:
+    """
+    2012-01-01 00:00:00.001 - line1
+    """
+    And a file named "file2" with:
+    """
+    2012-01-01 00:00:00.002 - line2
+    """
+    When I successfully run `log_weaver fil file2`
+    Then the output should match:
+    """
+    fil:  2012-01-01 00:00:00.001 - line1
+    file: 2012-01-01 00:00:00.002 - line2
+    """
+
+  Scenario: 2 files with first 4 chars of file name match
+    Given a file named "file1" with:
+    """
+    2012-01-01 00:00:00.001 - line1
+    """
+    And a file named "file2" with:
+    """
+    2012-01-01 00:00:00.002 - line2
+    """
+    When I successfully run `log_weaver file1 file2`
+    Then the output should match:
+    """
+    file1: 2012-01-01 00:00:00.001 - line1
+    file2: 2012-01-01 00:00:00.002 - line2
+    """
+
+  Scenario: same file name, diff directory
+    Given a file named "a/file" with:
+    """
+    2012-01-01 00:00:00.001 - line1
+    """
+    And a file named "b/file" with:
+    """
+    2012-01-01 00:00:00.002 - line2
+    """
+    When I successfully run `log_weaver a/file b/file`
+    Then the output should match:
+    """
+    a/file: 2012-01-01 00:00:00.001 - line1
+    b/file: 2012-01-01 00:00:00.002 - line2
+    """
+
+  Scenario: 2 files where timestamps in file1 come before timestamps in file2
+    Given a file named "file1" with:
+    """
+    2012-01-01 00:00:00.001 - line1
+    2012-01-01 00:00:00.002 - line2
+    """
+    And a file named "file2" with:
+    """
+    2012-01-01 00:00:00.003 - line3
+    2012-01-01 00:00:00.004 - line4
+    """
+    When I successfully run `log_weaver file1 file2`
+    Then the output should match:
+    """
+    file1: 2012-01-01 00:00:00.001 - line1
+    file1: 2012-01-01 00:00:00.002 - line2
+    file2: 2012-01-01 00:00:00.003 - line3
+    file2: 2012-01-01 00:00:00.004 - line4
+    """
+
+  Scenario: timestamp repeats within file
+    Given a file named "file1" with:
+    """
+    2012-01-01 00:00:00.001 - line1
+    2012-01-01 00:00:00.001 - line1 again
+    """
+    And a file named "file2" with:
+    """
+    2012-01-01 00:00:00.002 - line2
+    """
+    When I successfully run `log_weaver file1 file2`
+    Then the output should match:
+    """
+    file1: 2012-01-01 00:00:00.001 - line1
+    file1: 2012-01-01 00:00:00.001 - line1 again
+    file2: 2012-01-01 00:00:00.002 - line2
+    """
+
+  Scenario: 2 files, same timestamps
+    Given a file named "file1" with:
+    """
+    2012-01-01 00:00:00.001 - line1
+    2012-01-01 00:00:00.002 - line2 from file1
+    """
+    And a file named "file2" with:
+    """
+    2012-01-01 00:00:00.002 - line2 from file2
+    2012-01-01 00:00:00.003 - line3
+    """
+    When I successfully run `log_weaver file1 file2`
+    Then the output should match:
+    """
+    file1: 2012-01-01 00:00:00.001 - line1
+    file1: 2012-01-01 00:00:00.002 - line2 from file1
+    file2: 2012-01-01 00:00:00.002 - line2 from file2
+    file2: 2012-01-01 00:00:00.003 - line3
+    """
+
+  Scenario: 2 files, timestamp repeats within file and across files
+    Given a file named "file1" with:
+    """
+    2012-01-01 00:00:00.001 - line1
+    2012-01-01 00:00:00.001 - line1b
+    """
+    And a file named "file2" with:
+    """
+    2012-01-01 00:00:00.001 - line1c
+    2012-01-01 00:00:00.001 - line1d
+    """
+    When I successfully run `log_weaver file1 file2`
+    Then the output should match:
+    #NOTE: pushing the file2 line to the bottom here (by sorting on prefix) while preserving the timestamp
+    # sort order seems to require quite a bit of rework of the data structure used to store and sort the lines;
+    # I think the sort order below actually works fine (because it makes all the interacting logs show up
+    # immediately
+    """
+    file1: 2012-01-01 00:00:00.001 - line1
+    file1: 2012-01-01 00:00:00.001 - line1b
+    file2: 2012-01-01 00:00:00.001 - line1c
+    file2: 2012-01-01 00:00:00.001 - line1d
+    """
+
+  Scenario: 2 files where timestamps in file1 come after timestamps in file2
+    Given a file named "file1" with:
+    """
+    2012-01-01 00:00:00.003 - line3
+    2012-01-01 00:00:00.004 - line4
+    """
+    And a file named "file2" with:
+    """
+    2012-01-01 00:00:00.001 - line1
+    2012-01-01 00:00:00.002 - line2
+    """
+    When I successfully run `log_weaver file1 file2`
+    Then the output should match:
+    """
+    file2: 2012-01-01 00:00:00.001 - line1
+    file2: 2012-01-01 00:00:00.002 - line2
+    file1: 2012-01-01 00:00:00.003 - line3
+    file1: 2012-01-01 00:00:00.004 - line4
+    """
+
+ Scenario: 2 files, mixed timestamps
+    Given a file named "file1" with:
+    """
+    2012-01-01 00:00:00.001 - line1
+    2012-01-01 00:00:00.003 - line3
+    """
+    And a file named "file2" with:
+    """
+    2012-01-01 00:00:00.002 - line2
+    2012-01-01 00:00:00.004 - line4
+    """
+    When I successfully run `log_weaver file1 file2`
+    Then the output should match:
+    """
+    file1: 2012-01-01 00:00:00.001 - line1
+    file2: 2012-01-01 00:00:00.002 - line2
+    file1: 2012-01-01 00:00:00.003 - line3
+    file2: 2012-01-01 00:00:00.004 - line4
+    """
+
+  Scenario: 2 files, timestamps out of order within a file (NOTE: having a log file with unordered timestamps is weird, but oh well)
+    Given a file named "file1" with:
+    """
+    2012-01-01 00:00:00.002 - line2
+    2012-01-01 00:00:00.001 - line1
+    """
+    And a file named "file2" with:
+    """
+    2012-01-01 00:00:00.003 - line3
+    """
+    When I successfully run `log_weaver file1 file2`
+    Then the output should match:
+    """
+    file1: 2012-01-01 00:00:00.001 - line1
+    file1: 2012-01-01 00:00:00.002 - line2
+    file2: 2012-01-01 00:00:00.003 - line3
+    """
+
+# ---------------------------------------------------------------
+# lines with no timestamp stick to preceding timestamp
+# ---------------------------------------------------------------
+  Scenario: 2 files, ordered timestamps, lines with no timestamp
+    Given a file named "file1" with:
+    """
+    2012-01-01 00:00:00.001 - line1
+    line1 with no timestamp
+    line2 with no timestamp
+    2012-01-01 00:00:00.002 - line2
+    """
+    And a file named "file2" with:
+    """
+    2012-01-01 00:00:00.003 - line3
+    line3 with no timestamp
+    2012-01-01 00:00:00.004 - line4
+    """
+    When I successfully run `log_weaver file1 file2`
+    Then the output should match:
+    """
+    file1: 2012-01-01 00:00:00.001 - line1
+    file1: line1 with no timestamp
+    file1: line2 with no timestamp
+    file1: 2012-01-01 00:00:00.002 - line2
+    file2: 2012-01-01 00:00:00.003 - line3
+    file2: line3 with no timestamp
+    file2: 2012-01-01 00:00:00.004 - line4
+    """
+
+  Scenario: 2 files, timestamps in file1 come after timestamps in file2, lines with no timestamp
+    Given a file named "file1" with:
+    """
+    2012-01-01 00:00:00.003 - line3
+    line3 with no timestamp
+    2012-01-01 00:00:00.004 - line4
+    line4 with no timestamp
+    """
+    And a file named "file2" with:
+    """
+    2012-01-01 00:00:00.001 - line1
+    line1 with no timestamp
+    2012-01-01 00:00:00.002 - line2
+    line2 with no timestamp
+    """
+    When I successfully run `log_weaver file1 file2`
+    Then the output should match:
+    """
+    file2: 2012-01-01 00:00:00.001 - line1
+    file2: line1 with no timestamp
+    file2: 2012-01-01 00:00:00.002 - line2
+    file2: line2 with no timestamp
+    file1: 2012-01-01 00:00:00.003 - line3
+    file1: line3 with no timestamp
+    file1: 2012-01-01 00:00:00.004 - line4
+    file1: line4 with no timestamp
+    """
+
+  Scenario: 2 files, mixed timestamps, lines with no timestamp
+    Given a file named "file1" with:
+    """
+    2012-01-01 00:00:00.001 - line1
+    line1 with no timestamp
+    2012-01-01 00:00:00.003 - line3
+    line3 with no timestamp
+    """
+    And a file named "file2" with:
+    """
+    2012-01-01 00:00:00.002 - line2
+    line2 with no timestamp
+    2012-01-01 00:00:00.004 - line4
+    line4 with no timestamp
+    """
+    When I successfully run `log_weaver file1 file2`
+    Then the output should match:
+    """
+    file1: 2012-01-01 00:00:00.001 - line1
+    file1: line1 with no timestamp
+    file2: 2012-01-01 00:00:00.002 - line2
+    file2: line2 with no timestamp
+    file1: 2012-01-01 00:00:00.003 - line3
+    file1: line3 with no timestamp
+    file2: 2012-01-01 00:00:00.004 - line4
+    file2: line4 with no timestamp
+    """
+
+  Scenario: 2 files, timestamps out of order within a file (NOTE: having a log file with unordered timestamps is weird, but oh well)
+    Given a file named "file1" with:
+    """
+    2012-01-01 00:00:00.002 - line2
+    line2 with no timestamp
+    2012-01-01 00:00:00.001 - line1
+    line1 with no timestamp
+    """
+    And a file named "file2" with:
+    """
+    2012-01-01 00:00:00.003 - line3
+    line3 with no timestamp
+    """
+    When I successfully run `log_weaver file1 file2`
+    Then the output should match:
+    """
+    file1: 2012-01-01 00:00:00.001 - line1
+    file1: line1 with no timestamp
+    file1: 2012-01-01 00:00:00.002 - line2
+    file1: line2 with no timestamp
+    file2: 2012-01-01 00:00:00.003 - line3
+    file2: line3 with no timestamp
+    """
+
+# ---------------------------------------------------------------
+# 3 files
+# ---------------------------------------------------------------
+  Scenario: 3 files, ordered timestamps, lines with no timestamp
+    Given a file named "file1" with:
+    """
+    2012-01-01 00:00:00.001 - line1
+    line1 with no timestamp
+    line2 with no timestamp
+    2012-01-01 00:00:00.002 - line2
+    """
+    And a file named "file2" with:
+    """
+    2012-01-01 00:00:00.003 - line3
+    line3 with no timestamp
+    2012-01-01 00:00:00.004 - line4
+    """
+    And a file named "file3" with:
+    """
+    2012-01-01 00:00:00.005 - line5
+    2012-01-01 00:00:00.006 - line6
+    line6 with no timestamp
+    """
+    When I successfully run `log_weaver file1 file2 file3`
+    Then the output should match:
+    """
+    file1: 2012-01-01 00:00:00.001 - line1
+    file1: line1 with no timestamp
+    file1: line2 with no timestamp
+    file1: 2012-01-01 00:00:00.002 - line2
+    file2: 2012-01-01 00:00:00.003 - line3
+    file2: line3 with no timestamp
+    file2: 2012-01-01 00:00:00.004 - line4
+    file3: 2012-01-01 00:00:00.005 - line5
+    file3: 2012-01-01 00:00:00.006 - line6
+    file3: line6 with no timestamp
+    """
+
+  Scenario: 3 files, mixed timestamps, lines with no timestamp
+    Given a file named "file1" with:
+    """
+    2012-01-01 00:00:00.001 - line1
+    line1 with no timestamp
+    2012-01-01 00:00:00.006 - line6
+    line6 with no timestamp
+    """
+    And a file named "file2" with:
+    """
+    2012-01-01 00:00:00.002 - line2
+    line2 with no timestamp
+    2012-01-01 00:00:00.005 - line5
+    line5 with no timestamp
+    """
+    And a file named "file3" with:
+    """
+    2012-01-01 00:00:00.003 - line3
+    line3 with no timestamp
+    2012-01-01 00:00:00.004 - line4
+    line4 with no timestamp
+    """
+    When I successfully run `log_weaver file1 file2 file3`
+    Then the output should match:
+    """
+    file1: 2012-01-01 00:00:00.001 - line1
+    file1: line1 with no timestamp
+    file2: 2012-01-01 00:00:00.002 - line2
+    file2: line2 with no timestamp
+    file3: 2012-01-01 00:00:00.003 - line3
+    file3: line3 with no timestamp
+    file3: 2012-01-01 00:00:00.004 - line4
+    file3: line4 with no timestamp
+    file2: 2012-01-01 00:00:00.005 - line5
+    file2: line5 with no timestamp
+    file1: 2012-01-01 00:00:00.006 - line6
+    file1: line6 with no timestamp
+    """
+