bracken 0.1.0

data/README.rdoc

@@ -0,0 +1,11 @@
+= Bracken
+
+Bracken, at present, is a glorified logfile tailer.
+
+== Behold
+
+For now, you're best off looking at the cucumber features.
+
+== Install
+
+ gem install bracken

data/Rakefile

@@ -0,0 +1,15 @@
+begin
+  require 'shoe'
+rescue LoadError
+  abort 'Please `gem install shoe` to get started.'
+end
+
+Shoe.tie('bracken', '0.1.0', 'Bracken, at present, is a glorified logfile tailer.') do |spec|
+  spec.add_runtime_dependency 'open4'
+
+  spec.add_development_dependency 'cucumber'
+  spec.add_development_dependency 'fakefs'
+  spec.add_development_dependency 'jeremymcanally-matchy'
+  spec.add_development_dependency 'redgreen'
+  spec.add_development_dependency 'thoughtbot-shoulda'
+end

data/bin/bracken

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+# Add our lib directory to the load path as necessary
+lib = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+$:.unshift(lib) unless $:.include?(lib)
+
+# And fire off the application
+require 'bracken'
+Bracken::Application.execute(ARGV)

data/examples/console.rb

@@ -0,0 +1,6 @@
+# To run this example:
+#   RUBYOPT=rubygems ./bin/bracken -c examples/console.rb
+
+file '/Library/Logs/Console/501/console.log' do
+  on 'TextMate'
+end

data/features/step_definitions/bracken_steps.rb

@@ -0,0 +1,15 @@
+Given /^these are the contents of "([^\"]*)":$/ do |path, contents|
+  write_to_file(path, contents)
+end
+
+When /^another process appends "([^\"]*)" to "([^\"]*)"$/ do |contents, path|
+  write_to_file(path, contents, 'a')
+end
+
+When /^I run (.*)$/ do |command|
+  run(command)
+end
+
+Then /^I should see "([^\"]*)" on standard out$/ do |expected|
+  standard_out.gets.chomp.should == expected
+end

data/features/support/env.rb

@@ -0,0 +1,49 @@
+require 'open4'
+require 'pathname'
+require 'tmpdir'
+
+class WorkingDirectory
+  PROJECT_ROOT = Pathname.new(File.expand_path(File.join(File.dirname(__FILE__), '..', '..')))
+
+  attr_reader :working_directory
+  attr_reader :standard_out
+
+  def initialize
+    @working_directory ||= Pathname.new(Dir.mktmpdir)
+  end
+
+  def write_to_file(path, contents, mode='w')
+    working_directory.join(path).open(mode) { |file| file.puts(contents) }
+  end
+
+  def run(command)
+    Dir.chdir(working_directory) do
+      @pid, _, @standard_out, _ = Open4.popen4(rejigger_the_path(command))
+    end
+  end
+
+  def terminate_last_run
+    Process.kill('TERM', @pid) if @pid
+    @pid          = nil
+    @standard_out = nil
+  end
+
+  private
+
+  def rejigger_the_path(command)
+    "/usr/bin/env -i PATH='#{PROJECT_ROOT.join('bin')}:#{ENV['PATH']}' RUBYLIB='#{PROJECT_ROOT.join('lib')}' RUBYOPT=rubygems #{command}"
+  end
+end
+
+World do
+  WorkingDirectory.new
+end
+
+Before do
+  working_directory.mkpath
+end
+
+After do
+  terminate_last_run
+  working_directory.rmtree
+end

data/features/tailing.feature

@@ -0,0 +1,33 @@
+Feature: Tailing
+  In order to keep track of what's going on with the system
+  As a system operator
+  I want to simultaneously tail (and filter) a set of logfiles
+
+  Scenario: Tailing an existing file with no filters or transformations
+    Given these are the contents of "config.rb":
+      """
+      file 'syslog'
+      """
+    And these are the contents of "syslog":
+      """
+      Line One
+      """
+    When I run bracken -c config.rb
+    Then I should see "Line One" on standard out
+    When another process appends "Line Two" to "syslog"
+    Then I should see "Line Two" on standard out
+
+  Scenario: Tailing and filtering an existing file
+    Given these are the contents of "config.rb":
+      """
+      file 'syslog' do
+        on 'fetchmail', /reading message/
+      end
+      """
+    And these are the contents of "syslog":
+      """
+      Sep 30 13:11:39 frodo fetchmail[19159]: skipping message bob@example.org@pop.example.org:1 (51945 octets) (oversized) flushed
+      Sep 30 13:12:08 frodo fetchmail[19159]: reading message bob@example.org@pop.example.org:1 of 1 (4697 octets) flushed
+      """
+    When I run bracken -c config.rb
+    Then I should see "Sep 30 13:12:08 frodo fetchmail[19159]: reading message bob@example.org@pop.example.org:1 of 1 (4697 octets) flushed" on standard out

data/lib/bracken.rb

@@ -0,0 +1,3 @@
+require 'bracken/application'
+require 'bracken/configuration'
+require 'bracken/logfile'

data/lib/bracken/application.rb

@@ -0,0 +1,30 @@
+module Bracken
+  class Application
+    def self.execute(arguments)
+      new.execute(arguments)
+    end
+
+    attr_reader :configuration
+
+    def initialize
+      @configuration = Configuration.new
+    end
+
+    def execute(arguments)
+      configuration.parse(arguments)
+
+      while activity = IO.select(configuration.streams)
+        streams = activity.first
+
+        streams.each do |stream|
+          line = stream.filtered_gets
+
+          if line
+            STDOUT.puts line
+            STDOUT.flush
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bracken/configuration.rb

@@ -0,0 +1,26 @@
+require 'bracken/configuration/builder'
+require 'bracken/configuration/options'
+
+module Bracken
+  class Configuration
+    attr_reader :options
+    attr_reader :builder
+    attr_reader :files
+
+    def initialize
+      @options = Options.new
+      @builder = Builder.new(self)
+      @files   = []
+    end
+
+    def parse(arguments)
+      options.parse(arguments)
+      builder.parse(options.configuration_file)
+      self
+    end
+
+    def streams
+      files.map { |file| file.stream }
+    end
+  end
+end

data/lib/bracken/configuration/builder.rb

@@ -0,0 +1,39 @@
+require 'optparse'
+
+module Bracken
+  class Configuration
+
+    class Builder
+      attr_reader :configuration
+      attr_reader :output_stream
+      attr_reader :error_stream
+
+      def initialize(configuration, output_stream = STDOUT, error_stream = STDERR)
+        @configuration = configuration
+        @output_stream = output_stream
+        @error_stream  = error_stream
+      end
+
+      def parse(pathname)
+        if File.exist?(pathname)
+          instance_eval(File.read(pathname), pathname)
+        else
+          error_stream.puts("WARNING file #{pathname} does not exist!")
+        end
+      end
+
+      def file(path, &block)
+        configuration.files << Logfile.new(path)
+
+        if block_given?
+          instance_eval(&block)
+        end
+      end
+
+      def on(*args)
+        configuration.files.last.filters << Logfile::Filter.new(*args)
+      end
+    end
+
+  end
+end

data/lib/bracken/configuration/options.rb

@@ -0,0 +1,25 @@
+require 'optparse'
+
+module Bracken
+  class Configuration
+
+    class Options
+      attr_reader :configuration_file
+
+      def initialize
+        @configuration_file = '/etc/bracken.rb'
+      end
+
+      def parse(arguments)
+        arguments.extend(::OptionParser::Arguable)
+
+        arguments.options do |opts|
+          opts.on('-c', '--config-file PATH', 'Read configuration from PATH.', '[/etc/bracken.rb]') do |path|
+            @configuration_file = path
+          end
+        end.parse!
+      end
+    end
+
+  end
+end

data/lib/bracken/logfile.rb

@@ -0,0 +1,27 @@
+require 'bracken/logfile/filter'
+require 'bracken/logfile/stream'
+require 'open4'
+
+module Bracken
+  class Logfile
+    attr_reader :filters
+    attr_reader :path
+
+    def initialize(path)
+      @filters = []
+      @path    = path
+    end
+
+    def stream
+      @stream ||= begin
+        pid, _, out, _ = Open4.popen4("tail -f #{path}")
+
+        out.extend(Stream)
+        out.logfile = self
+        out.pid     = pid
+
+        out
+      end
+    end
+  end
+end

data/lib/bracken/logfile/filter.rb

@@ -0,0 +1,24 @@
+module Bracken
+  class Logfile
+
+    class Filter < Struct.new(:service, :pattern)
+      # FIXME this is heinous
+      def match?(line)
+        if line.include?(service)
+          if pattern
+            if line.match(pattern)
+              true
+            else
+              false
+            end
+          else
+            true
+          end
+        else
+          false
+        end
+      end
+    end
+
+  end
+end

data/lib/bracken/logfile/stream.rb

@@ -0,0 +1,21 @@
+module Bracken
+  class Logfile
+
+    module Stream
+      attr_accessor :logfile
+      attr_accessor :pid
+
+      # FIXME this could use work
+      def filtered_gets
+        line = gets
+        line if logfile.filters.empty? || logfile.filters.any? { |filter| filter.match?(line) }
+      end
+
+      def kill
+        Process.kill('TERM', pid)
+        Process.wait(pid)
+      end
+    end
+
+  end
+end

data/test/configuration_builder_test.rb

@@ -0,0 +1,38 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class ConfigurationBuilderTest < Test::Unit::TestCase
+  context '#parse' do
+    should "warn on standard error when configuration file doesn't exist" do
+      error_stream  = StringIO.new('')
+
+      builder = Configuration::Builder.new(nil, nil, error_stream)
+      builder.parse('/does/not/exist')
+      error_stream.rewind
+      error_stream.read.should == "WARNING file /does/not/exist does not exist!\n"
+    end
+  end
+
+  context '#file' do
+    should 'add a new file into the configuration' do
+      configuration = Configuration.new
+
+      builder = Configuration::Builder.new(configuration)
+      builder.file('/foo/bar')
+
+      configuration.files.map { |file| file.path }.should == ['/foo/bar']
+    end
+  end
+
+  context '#on' do
+    should 'add a filter to the current file' do
+      configuration = Configuration.new
+
+      builder = Configuration::Builder.new(configuration)
+      builder.file('/foo/bar') do
+        on 'foo'
+      end
+
+      configuration.files.map { |file| file.filters }.should == [[Logfile::Filter.new('foo')]]
+    end
+  end
+end

data/test/configuration_options_test.rb

@@ -0,0 +1,22 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class ConfigurationOptionsTest < Test::Unit::TestCase
+  context 'options' do
+    setup { @options = Configuration::Options.new }
+
+    should 'default the configuration file to /etc/bracken.rb' do
+      @options.parse(%w())
+      @options.configuration_file.should == '/etc/bracken.rb'
+    end
+
+    should 'use the configuration file from -c' do
+      @options.parse(%w(-c config.rb))
+      @options.configuration_file.should == 'config.rb'
+    end
+
+    should 'use the configuration file from --config-file' do
+      @options.parse(%w(--config-file config.rb))
+      @options.configuration_file.should == 'config.rb'
+    end
+  end
+end

data/test/configuration_test.rb

@@ -0,0 +1,29 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class ConfigurationTest < Test::Unit::TestCase
+  context 'faking the filesystem' do
+    setup    { FakeFS.activate! }
+    teardown { FakeFS.deactivate! }
+
+    context '#files' do
+      should 'be empty when the configuration file specifies no files' do
+        File.open('/etc/bracken.rb', 'w') { |file| file.write('') }
+        Configuration.new.parse([]).files.should == []
+      end
+
+      should 'have the files specified in the configuration file' do
+        File.open('/etc/bracken.rb', 'w') { |file| file.write('file "/var/log/syslog"') }
+        Configuration.new.parse([]).files.map { |file| file.path }.should == ['/var/log/syslog']
+      end
+    end
+
+    context '#streams' do
+      should 'return the IO stream for each file' do
+        File.open('/etc/bracken.rb', 'w') { |file| file.write('file "/var/log/syslog"') }
+
+        configuration = Configuration.new.parse([])
+        configuration.streams.should == configuration.files.map { |file| file.stream }
+      end
+    end
+  end
+end

data/test/logfile_filter_test.rb

@@ -0,0 +1,19 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class LogfileFilterTest < Test::Unit::TestCase
+  context '#match?' do
+    setup do
+      @line = 'Sep 30 13:11:39 frodo fetchmail[19159]: skipping message bob@example.org@pop.example.org:1 (51945 octets) (oversized) flushed'
+    end
+
+    should 'match a syslog-style service name' do
+      Logfile::Filter.new('postfix').match?(@line).should == false
+      Logfile::Filter.new('fetchmail').match?(@line).should == true
+    end
+
+    should 'match a syslog-style service name and filter by pattern' do
+      Logfile::Filter.new('fetchmail', /reading message/).match?(@line).should == false
+      Logfile::Filter.new('fetchmail', /skipping message/).match?(@line).should == true
+    end
+  end
+end

data/test/logfile_test.rb

@@ -0,0 +1,21 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class LogfileTest < Test::Unit::TestCase
+  context '#stream' do
+    setup do
+      @logfile = Logfile.new(__FILE__)
+    end
+
+    should 'return a selectable, killable IO object tailing the file' do
+      reads, _, _ = IO.select([@logfile.stream], nil, nil, 0.2)
+
+      stream = reads.first
+
+      begin
+        stream.gets.should == File.readlines(__FILE__)[-10]
+      ensure
+        stream.kill
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require 'test/unit'
+
+require 'rubygems'
+require 'fakefs/safe'
+require 'matchy'
+require 'redgreen' if STDIN.tty?
+require 'shoulda'
+
+lib = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+$:.unshift(lib) unless $:.include?(lib)
+require 'bracken'
+
+class Test::Unit::TestCase
+  include Bracken
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification 
+name: bracken
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Matthew Todd
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-28 00:00:00 +03:00
+default_executable: bracken
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: open4
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: fakefs
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: jeremymcanally-matchy
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: redgreen
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: matthew.todd@gmail.com
+executables: 
+- bracken
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- Rakefile
+- README.rdoc
+- bin/bracken
+- examples/console.rb
+- features/step_definitions/bracken_steps.rb
+- features/support/env.rb
+- features/tailing.feature
+- lib/bracken/application.rb
+- lib/bracken/configuration/builder.rb
+- lib/bracken/configuration/options.rb
+- lib/bracken/configuration.rb
+- lib/bracken/logfile/filter.rb
+- lib/bracken/logfile/stream.rb
+- lib/bracken/logfile.rb
+- lib/bracken.rb
+- test/configuration_builder_test.rb
+- test/configuration_options_test.rb
+- test/configuration_test.rb
+- test/logfile_filter_test.rb
+- test/logfile_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --title
+- bracken-0.1.0
+- --inline-source
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Bracken, at present, is a glorified logfile tailer.
+test_files: []
+