ocrunner 0.2.5 → 0.3.0

data/README.rdoc

@@ -13,20 +13,40 @@ To run tests as files are changed (autotest-style), use:
 
   ocrunner --auto
 
+
+== Signals
+
+Control-c: kill ocrunner
+Control-\: toggle verbosity and rerun tests. This is nice for when the pretty filtered output doesn't show quite enough information to you.
+
+
+== Pretty debug logging with PRPLog()
+
+This is a little crazy, but ocrunner has support for displaying debug log messaged from your Objective-C code through the use of a custom logging macro. The messages are colored purple in order to make them easier to see in the verbose output. To use this feature, add the following macro to a header or prefix file in your Xcode project:
+  
+  #define PRPLog(format, ...) NSLog([NSString stringWithFormat: @"%s:%d:%s:\033[35m%@\033[0m", __PRETTY_FUNCTION__, __LINE__, __FILE__, format] ## __VA_ARGS__)
+
+ocrunner will display the latest version of this macro when run with --prplog-help.
+
+
 == I don't like your defaults
 
 Don't worry, you can specify the target/configuration/sdk options passed to xcodebuild. You can see all the available options by running ocrunner -h:
+          
+           --sdk, -s <s>:   SDK to build against (default: iphonesimulator3.1.3)
+        --target, -t <s>:   Target to build (default: Test)
+        --config, -c <s>:   Configuration to use (default: Debug)
+          --parallel, -p:   Use multiple processors to build multiple targets (parallelizeTargets) (default: true)
+              --auto, -a:   Watch filesystem for changes and run tests when they occur
+             --growl, -g:   Report results using Growl
+     --debug-command, -d:   Print xcodebuild command and exit
+           --verbose, -v:   Display all xcodebuild output after summary
+  --loud-compilation, -l:   Always show verbose output when a compilation or linking error occurs (default: true)
+            --prplog, -r:   Display PRPLog log messages (default: true)
+       --prplog-help, -o:   Print PRPLog code example and exit
+           --version, -e:   Print version and exit
+              --help, -h:   Show this message
 
-	      --sdk, -s <s>:   SDK to build against (default: iphonesimulator3.1.3)
-	   --target, -t <s>:   Target to build (default: Test)
-	   --config, -c <s>:   Configuration to use (default: Debug)
-	     --parallel, -p:   Use multiple processors to build multiple targets (parallelizeTargets) (default: true)
-	         --auto, -a:   Watch filesystem for changes and run tests when they occur
-	        --growl, -g:   Report results using Growl
-	--debug-command, -d:   Print xcodebuild command and exit
-	      --verbose, -v:   Display all xcodebuild output after summary
-	      --version, -e:   Print version and exit
-	         --help, -h:   Show this message
 
 == Note on Patches/Pull Requests
  

data/VERSION

@@ -1 +1 @@
-0.2.5
+0.3.0

data/lib/ocrunner.rb

@@ -1,5 +1,5 @@
-require File.dirname(__FILE__) + '/ocrunner/cli'
 require File.dirname(__FILE__) + '/ocrunner/console'
+require File.dirname(__FILE__) + '/ocrunner/cli'
 require File.dirname(__FILE__) + '/ocrunner/test_case'
 require File.dirname(__FILE__) + '/ocrunner/test_error'
 require File.dirname(__FILE__) + '/ocrunner/test_suite'

data/lib/ocrunner/cli.rb

@@ -3,6 +3,11 @@ require 'fssm'
 
 module OCRunner
   module CLI
+    
+    class << self
+      include OCRunner::Console
+    end
+    
     def self.run
       
       Kernel.trap('INT') { puts; exit }
@@ -26,9 +31,22 @@ module OCRunner
         opt :debug_command, "Print xcodebuild command and exit", :type => :boolean, :default => false
         opt :verbose, "Display all xcodebuild output after summary", :type => :boolean, :default => false
         opt :loud_compilation, "Always show verbose output when a compilation or linking error occurs", :type => :boolean, :default => true
+        opt :prplog, "Display PRPLog log messages", :type => :boolean, :default => true
+        opt :prplog_help, "Print PRPLog code example and exit", :type => :boolean, :default => false
+      end
+      
+      if opts[:prplog_help]
+        present do
+          puts indent blue "Add this to a header or prefix file in your Xcode project:"
+          puts indent '#define PRPLog(format, ...) NSLog([NSString stringWithFormat: @"%s:%d:%s:\033[35m%@\033[0m", __PRETTY_FUNCTION__, __LINE__, __FILE__, format] ## __VA_ARGS__)'
+        end
+        exit
       end
       
       execute = Proc.new{ OCRunner::TestRunner.new(opts) }
+
+      Kernel.trap('QUIT') { opts[:verbose] = !opts[:verbose]; execute.call}
+
       execute.call
       
       if opts[:auto]

data/lib/ocrunner/console.rb

@@ -1,12 +1,22 @@
-# color helpers courtesy of RSpec http://github.com/dchelimsky/rspec
+# color helpers originally courtesy of RSpec http://github.com/dchelimsky/rspec
 
 module OCRunner
   module Console
     def colorize(text, color_code)
-      "#{color_code}#{text}\033[0m"
+      "#{color_code}#{text.to_s}\033[0m"
     end
 
     def red(text); colorize(text, "\033[31m"); end
     def green(text); colorize(text, "\033[32m"); end
+    def blue(text); colorize(text, "\033[34m"); end
+    
+    def indent(text='')
+      "  " + text.to_s
+    end
+    def present(&block)
+      puts
+      yield
+      puts
+    end
   end
 end

data/lib/ocrunner/test_runner.rb

@@ -15,8 +15,8 @@ module OCRunner
       @compilation_error_occurred = false
       @output = []
       
-      setup
       build_command
+      setup
       run_tests
       summarize
       display_results
@@ -31,37 +31,39 @@ module OCRunner
       @command = "xcodebuild -target #{@options[:target]} -configuration #{@options[:config]} " +
                  "-sdk #{@options[:sdk]} #{@options[:parallel] ? '-parallelizeTargets' : ''} build"
      if @options[:debug_command]
-       puts @command
+       present do
+         puts indent @command
+       end
        exit
      end
     end
   
     def run_tests
-      IO.popen("#{@command} 2>&1") do |f| 
-        while line = f.gets do 
-          @log << line
-          process_console_output(line)
-          $stdout.flush
-        end
+      
+      puts "ocrunner started. control-c to exit, control-\\ to toggle verbosity\n\n"
+      
+      execute @command do |line|
+        @log << line
+        process_console_output(line)
+        $stdout.flush
       end
     end
   
     def summarize
       
       @suites.each do |suite|
-        suite.cases.reject {|kase| kase.passed?}.each do |kase|
-          out
+        suite.failed_cases.each do |kase|
           out '  ' + red("[#{suite.name} #{kase.name}] FAIL")
           kase.errors.each do |error|
             out '    ' + red(error.message) + " line #{error.line} of #{clean_path(error.path)}"
           end
         end
-        out
+        out if suite.failures?
       end
       
       @suites.each do |suite|
-        failed = suite.cases.reject {|kase| kase.passed?}
-        out "Suite '#{suite.name}': #{suite.cases.size - failed.size} passes and #{failed.size} failures in #{suite.time} seconds."
+        number = suite.failed_cases.size
+        out "Suite '#{suite.name}': #{suite.cases.size - number} passes and #{number} failures in #{suite.time} seconds."
       end
       
       out
@@ -74,7 +76,6 @@ module OCRunner
     end
     
     def display_results
-      puts
       puts @log if @options[:verbose] || (compilation_error_occurred && @options[:loud_compilation])
       puts @output.join("\n")
       puts
@@ -96,6 +97,28 @@ module OCRunner
     end
 
     def process_console_output(line)
+      
+      if @options[:prplog]
+        if line.include?("\033\[35m")
+          line =~ /-(\[.+\]):(\d+):(.+):/
+          out blue("#{$1} on line #{$2} of #{clean_path($3)}:")
+          out line.slice(line.index("\033\[35m")..-1)
+          @debug_output = true
+          return
+        end
+
+        if line.include?("\033[0m")
+          @debug_output = false
+          out line
+          out
+          return
+        end
+      
+        if @debug_output
+          out line
+          return
+        end 
+      end
 
       # test case started
       if line =~ /Test Case '-\[.+ (.+)\]' started/
@@ -134,9 +157,9 @@ module OCRunner
       if line =~ /The executable for the test bundle at (.+\.octest) could not be found/
         build_error("Test executable #{clean_path($1)} could not be found")
       end
-      
+
       # compilation errors
-      if line =~ /(.+\.m):(\d+): error: (.*)/
+      if !@current_case && line =~ /(.+\.m):(\d+): error: (.*)/
         compilation_error_occurred!
         build_error($&)      
       end
@@ -153,6 +176,11 @@ module OCRunner
         build_error($&)
       end
       
+      # bus error
+      if line =~ /Bus error/
+        build_error('Bus error while running tests.')        
+      end      
+      
       # segfault
       if line =~ /Segmentation fault/
         build_error('Segmentation fault while running tests.')        
@@ -170,7 +198,7 @@ module OCRunner
     end
    
     def out(line = '')
-      @output << line
+      @output << line.rstrip
     end
     
     def clean_path(path)
@@ -179,7 +207,19 @@ module OCRunner
   
     def growl(message)
       if @options[:growl]
-        `growlnotify -i "xcodeproj" -m "#{message}" `
+        execute "growlnotify -i \"xcodeproj\" -m \"#{message}\"" do |error|
+          if error =~ /command not found/
+            out red('You must have growl and growl notify installed to enable growl support. See http://growl.info.')
+          end
+        end
+      end
+    end
+  
+    def execute(cmd, &block)
+      IO.popen("#{cmd} 2>&1") do |f| 
+        while line = f.gets do 
+          yield line
+        end
       end
     end
   

data/lib/ocrunner/test_suite.rb

@@ -10,5 +10,13 @@ module OCRunner
       @name = name
       @cases = []
     end
+    
+    def failures?
+      @cases.any? {|kase| !kase.passed?}
+    end
+    
+    def failed_cases
+      @cases.reject {|kase| kase.passed?}
+    end
   end
 end

data/ocrunner.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ocrunner}
-  s.version = "0.2.5"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jim Benton"]
-  s.date = %q{2010-04-08}
+  s.date = %q{2010-04-09}
   s.default_executable = %q{ocrunner}
   s.description = %q{Provides pretty console output for running OCUnit tests with xcodebuilder from the command line}
   s.email = %q{jim@autonomousmachine.com}

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 5
-  version: 0.2.5
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Jim Benton
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-08 00:00:00 -05:00
+date: 2010-04-09 00:00:00 -05:00
 default_executable: ocrunner
 dependencies: 
 - !ruby/object:Gem::Dependency