uispecrunner 0.2.1

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Blake Watters
+
+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,37 @@
+# UISpecRunner
+### By Blake Watters <blake@twotoasters.com>
+### [http://github.com/twotoasters/UISpecRunner]()
+
+A flexible CLI test runner for use with the UISpec iOS BDD framework.
+
+Install the gem and run: `uispec -h` for details.
+
+## Requirements
+To utilize the uispec utility, you must add the UISpecRunner category
+to your project. This category provides support for running specs by
+Protocol and provides a general environment variable based runner. The
+category header and implementation file as well as a main.m are available
+in the src/ directory with this gem. Use `gem edit uispecrunner` or pull
+them from Github.
+
+## Provides support for:
+- Running all specs
+- Running all specs in a class
+- Running a specific spec class and method
+- Switches for targeting different iOS SDK versions, project files, 
+  configurations and targets
+- Starting securityd daemon to allow interaction with the keychain
+- Support for reading configuration settings from
+- A Ruby API for configuring your own spec runners
+- Will read common arguments from uispec.opts file for easy per project configuration
+
+## TODO
+- Auto-detect SDK versions available
+- Rake file template
+- Support for running specific files
+- Support for running non-headless (either via AppleScript or iphonesim)
+- Generate a Kicker script
+
+## Copyright
+
+Copyright (c) 2010 Blake Watters. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "uispecrunner"
+    gem.summary = %Q{Flexible spec runner for UISpec on iOS}
+    gem.description = %Q{Provides a simple Ruby interface for running UISpec iPhone tests}
+    gem.email = "blake@twotoasters.com"
+    gem.homepage = "http://github.com/twotoasters/UISpecRunner"
+    gem.authors = ["Blake Watters"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "UISpecRunner #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.1

data/bin/uispec

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'uispecrunner/application'
+exit UISpecRunner::Application.run!(*ARGV)

data/lib/uispecrunner/application.rb

@@ -0,0 +1,31 @@
+require 'uispecrunner'
+require 'uispecrunner/options'
+
+class UISpecRunner
+  class Application
+    def self.run!(*arguments)
+      options = UISpecRunner::Options.new(arguments)
+      
+      if options[:invalid_argument]
+        $stderr.puts options[:invalid_argument]
+        options[:show_help] = true
+      end
+
+      if options[:show_help]
+        $stderr.puts options.opts
+        return 1
+      end
+      
+      # Read standard arguments from uispec.opts
+      options_file = 'uispec.opts'
+      if File.exists?(options_file)
+        option_file_args = File.readlines(options_file).map {|l| l.chomp.split " "}.flatten
+        options = options.merge(UISpecRunner::Options.new(option_file_args))
+      end
+      
+      runner = UISpecRunner.new(options)
+      runner.run!
+      return 0
+    end
+  end
+end

data/lib/uispecrunner/options.rb

@@ -0,0 +1,101 @@
+class UISpecRunner
+  class Options < Hash
+    attr_reader :opts, :orig_args
+    
+    def initialize(args)
+      super()
+      
+      @orig_args = args.clone
+      
+      # Configure default settings
+      self[:run_mode] = :all
+      self[:target] = 'UISpec'
+      self[:configuration] = 'Debug'
+      self[:build_dir] = './build'
+      self[:verbose] = false
+      self[:sdk_version] = '3.0'
+      
+      require 'optparse'
+      @opts = OptionParser.new do |o|
+        o.banner = "Usage: #{File.basename($0)} [options]\ne.g. #{File.basename($0)}"                
+        
+        o.separator ""
+        o.separator "Run Modes:"
+        
+        o.on('-s', '--spec [CLASS]', 'Run the specified UISpec class') do |spec|
+          self[:spec] = spec
+          self[:run_mode] = :spec
+        end
+        
+        o.on('-e', '--example [METHOD]', 'Run the specified example method (requires --spec)') do |example|
+          self[:example] = example
+          self[:run_mode] = :example
+          # TODO: Need to raise exception if method is specified without class
+        end
+        
+        o.on('-p', '--protocol [PROTOCOL]', 'Run all UISpec classes implementing the Objective-C protocol') do |protocol|
+          self[:protocol] = protocol
+          self[:run_mode] = :protocol
+        end
+        
+        o.separator ""
+        o.separator "Environment options:"
+        
+        o.on('--project [PROJECT_FILE]',
+             'Run the UISpec target in specified project',
+             'Default: auto-detect project in current directory') do |project|
+          self[:project] = project
+        end
+        
+        o.on('--sdk [VERSION]',
+             'Run the UISpec target against the iPhone SDK version',
+             'Default: 3.0') do |sdk_version|
+          self[:sdk_version] = sdk_version
+        end                
+        
+        o.on('-c', '--configuration [CONFIGURATION]',
+             'Build with specified XCode configuration.',
+             'Default: Debug') do |configuration|
+          self[:configuration] = configuration
+        end
+        
+        o.on('-t', '--target [TARGET]',
+             'Run the specified XCode target.',
+             'Default: UISpec') do |target|
+          self[:target] = target
+        end
+        
+        o.on('--builddir [BUILD_DIR]',
+             'Run app in the build directory.',
+             'Default: ./build') do |build_dir|
+          self[:build_dir] = build_dir
+        end
+        
+        o.on('--securityd',
+             'Start the securityd daemon before running specs. This allow interaction with the keychain.') do |securityd|
+          self[:securityd] = securityd
+        end
+        
+        o.on('-v', '--[no-]verbose', "Run verbosely") do |v|
+          self[:verbose] = v
+        end
+        
+        o.on_tail('-h', '--help', 'display this help and exit') do
+          self[:show_help] = true
+        end
+      end
+      
+      begin
+        @opts.parse!(args)
+        # TODO: Support running specific files
+        #self[:project_name] = args.shift
+      rescue OptionParser::InvalidOption => e
+        self[:invalid_argument] = e.message
+      end
+    end
+    
+    def merge(other)
+      self.class.new(@orig_args + other.orig_args)
+    end
+  end
+end

data/lib/uispecrunner.rb

@@ -0,0 +1,129 @@
+# UISpec Runner
+# By: Blake Watters <blake@twotoasters.com>
+# Portions borrowed from Eloy Duran's Kicker script (http://github.com/alloy/UISpec)
+
+require 'tmpdir'
+
+class UISpecRunner
+  attr_accessor :project, :target, :configuration, :sdk_version, :build_dir, :verbose, :securityd
+  
+  # private
+  attr_accessor :run_mode, :spec, :example, :protocol
+  
+  def initialize(options = {})
+    options.each { |k,v| self.send("#{k}=", v) }
+    self.target ||= 'UISpec'
+    self.configuration ||= 'Debug'
+    self.build_dir ||= './build'
+    self.run_mode ||= :all
+  end    
+  
+  def run!
+    case run_mode
+    when :all
+      run_all!
+    when :spec
+      run_spec!(self.spec)
+    when :example
+      run_spec_example!(self.spec, self.example)
+    when :protocol
+      run_protocol!(self.protocol_name)
+    else
+      raise ArgumentError, "Unknown run mode: #{run_mode}"
+    end    
+  end
+  
+  def run_all!
+    run_specs
+  end
+  
+  def run_protocol!(protocol_name)
+    run_specs('UISPEC_PROTOCOL' => protocol_name)
+  end
+  
+  def run_spec!(spec_name)
+    run_specs('UISPEC_SPEC' => spec_name)
+  end
+  
+  def run_spec_example!(spec_name, example_name)
+    run_specs('UISPEC_SPEC' => spec_name, 'UISPEC_EXAMPLE' => example_name)
+  end
+  
+  def verbose?
+    self.verbose
+  end
+  
+  private
+    def run_command(command)
+      puts "Executing: #{command}" if verbose?
+      system(command)
+    end
+    
+    def path_to_securityd
+      "#{sdk_dir}/usr/libexec/securityd"
+    end
+    
+    def start_securityd
+      run_command("launchctl submit -l UISpecRunnerDaemons -- #{path_to_securityd}")
+      @securityd_running = true
+      Signal.trap("INT") { stop_securityd }
+      Signal.trap("TERM") { stop_securityd }
+      Signal.trap("EXIT") { stop_securityd }
+    end
+    
+    def stop_securityd
+      run_command("launchctl remove UISpecRunnerDaemons") if @securityd_running
+      @securityd_running = false
+    end
+    
+    def run_specs(env = {})
+     if build_project!
+       env.merge!('DYLD_ROOT_PATH' => sdk_dir, 'IPHONE_SIMULATOR_ROOT' => sdk_dir, 'CFFIXED_USER_HOME' => tmpdir)
+       puts "Setting environment variables: #{env.inspect}" if verbose?
+       with_env(env) do
+         start_securityd if securityd
+         command = "#{build_dir}/#{configuration}-iphonesimulator/#{target}.app/#{target} -RegisterForSystemEvents"
+         puts "Executing: #{command}" if verbose?
+         output = `#{command}`
+         exit_code = $?
+         unless exit_code == 0
+           puts "[!] Failed to run UISpec target: #{output}"
+           exit 1
+         end
+       end
+     else
+       puts "[!] Failed to build UISpecs.app"
+       exit 1
+     end
+    end
+    
+    def sdk_dir
+      "/Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator#{sdk_version}.sdk"
+    end
+    
+    def tmpdir
+      Dir.tmpdir
+    end
+    
+    def project_switch
+      "-project #{project}" if project
+    end
+    
+    def sdk_switch
+      "-sdk #{sdk_dir}" if sdk_version
+    end
+    
+    def build_project!
+      command = "xcodebuild #{project_switch} -target #{target} -configuration #{configuration} #{sdk_switch} > /dev/null"
+      puts "Building project with: #{command}" if verbose?
+      system(command)
+    end
+    
+    def with_env(env)
+      before = env.inject({}) { |h, (k, _)| h[k] = ENV[k]; h }
+      env.each { |k, v| ENV[k] = v }
+      yield
+    ensure
+      before.each { |k, v| ENV[k] = v }
+    end
+end

data/spec/options_spec.rb

@@ -0,0 +1,8 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe UISpecRunner::Options do
+  it "should set the command to run_protocol" do
+    options = UISpecRunner::Options.new('-p UISpecIntegration')
+    options[:command].should == :run_protocol
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'UISpecRunner'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/uispecrunner_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "UISpecRunner" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/src/UISpec+UISpecRunner.h

@@ -0,0 +1,27 @@
+//
+//  UISpec+UISpecRunner.h
+//  UISpecRunner
+//
+//  Created by Blake Watters on 7/15/10.
+//  Copyright 2010 Two Toasters. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+#import "UISpec.h"
+
+@interface UISpec (UISpecRunner)
+
+/**
+ * Run all UISpec classes conforming to a given protocol
+ */
++(void)runSpecsConformingToProtocol:(Protocol *)protocol afterDelay:(NSTimeInterval)delay;
+
+/**
+ * Infers which set of UISpec classes to run from the following environment variables:
+ * UISPEC_PROTOCOL - Specifies a protocol to run
+ * UISPEC_SPEC - Specifies a spec class to run
+ * UISPEC_METHOD - Specifies an example to run (requires UISPEC_SPEC to be set)
+ */
++(void)runSpecsFromEnvironmentAfterDelay:(int)seconds;
+
+@end

data/src/UISpec+UISpecRunner.m

@@ -0,0 +1,68 @@
+//
+//  UISpec+UISpecRunner.m
+//  UISpecRunner
+//
+//  Created by Blake Watters on 7/15/10.
+//  Copyright 2010 Two Toasters. All rights reserved.
+//
+
+#import "UISpec+UISpecRunner.h"
+
+@implementation UISpec (UISpecRunner)
+
++(BOOL)class:(Class)class conformsToProtocol:(Protocol *)protocol {
+	while (class) {
+		if (class_conformsToProtocol(class, protocol)) {
+			return YES;
+		}
+		class = class_getSuperclass(class);
+	}
+	return NO;
+}
+
++(NSArray*)specClassesConformingToProtocol:(Protocol *)protocol {
+	NSMutableArray *array = [NSMutableArray array];
+    int numClasses = objc_getClassList(NULL, 0);
+    if (numClasses > 0) {
+        Class *classes = malloc(sizeof(Class) * numClasses);
+        (void) objc_getClassList (classes, numClasses);
+        int i;
+        for (i = 0; i < numClasses; i++) {
+            Class c = classes[i];
+			if ([self isASpec:c] && [self class:c conformsToProtocol:protocol]) {
+				[array addObject:c];
+			}
+        }
+        free(classes);
+    }
+	return array;
+}
+
++(void)runSpecsConformingToProtocol:(Protocol *)protocol afterDelay:(NSTimeInterval)delay {
+	NSArray* specClasses = [self specClassesConformingToProtocol:protocol];
+	[self performSelector:@selector(runSpecClasses:) withObject:specClasses afterDelay:delay];
+}
+
++(void)runSpecsFromEnvironmentAfterDelay:(int)seconds {
+	char* protocolName = getenv("UISPEC_PROTOCOL");
+	char* specName = getenv("UISPEC_SPEC");
+	char* exampleName = getenv("UISPEC_EXAMPLE");
+	if (protocolName) {
+		Protocol* protocol = NSProtocolFromString([NSString stringWithUTF8String:protocolName]);
+		NSLog(@"[UISpecRunner] Running Specs conforming to Protocol: %@", [NSString stringWithUTF8String:protocolName]);
+		[UISpec runSpecsConformingToProtocol:protocol afterDelay:seconds];
+	} else if (exampleName) {
+		if (nil == specName) {
+			[NSException raise:nil format:@"UISPEC_EXAMPLE cannot be specified without providing UISPEC_SPEC"];
+		}
+		NSLog(@"[UISpecRunner] Running Examples %s on Spec %s", exampleName, specName);
+		[UISpec runSpec:[NSString stringWithUTF8String:specName] example:[NSString stringWithUTF8String:exampleName] afterDelay:seconds];
+	} else if (specName) {
+		NSLog(@"[UISpecRunner] Running Spec %s", specName);
+		[UISpec runSpec:[NSString stringWithUTF8String:specName] afterDelay:seconds];
+	} else {
+		[UISpec runSpecsAfterDelay:seconds];
+	}	
+}
+
+@end

data/src/main.m

@@ -0,0 +1,23 @@
+//
+//  main.m
+//  UISpecRunner
+//
+//  Created by Blake Watters on 4/20/10.
+//  Copyright 2010 Two Toasters. All rights reserved.
+//
+
+#import <UIKit/UIKit.h>
+#import <UISpec.h>
+#import "UISpec+UISpecRunner.h"
+
+int main(int argc, char *argv[]) {
+    
+	NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
+	
+	// Run the specs
+	[UISpec runSpecsFromEnvironmentAfterDelay:0.5];
+	
+    int retVal = UIApplicationMain(argc, argv, nil, nil);
+    [pool release];
+    return retVal;
+}

data/uispecrunner.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{uispecrunner}
+  s.version = "0.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Blake Watters"]
+  s.date = %q{2010-07-15}
+  s.default_executable = %q{uispec}
+  s.description = %q{Provides a simple Ruby interface for running UISpec iPhone tests}
+  s.email = %q{blake@twotoasters.com}
+  s.executables = ["uispec"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "bin/uispec",
+     "lib/uispecrunner.rb",
+     "lib/uispecrunner/application.rb",
+     "lib/uispecrunner/options.rb",
+     "spec/options_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/uispecrunner_spec.rb",
+     "src/UISpec+UISpecRunner.h",
+     "src/UISpec+UISpecRunner.m",
+     "src/main.m",
+     "uispecrunner.gemspec"
+  ]
+  s.homepage = %q{http://github.com/twotoasters/UISpecRunner}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Flexible spec runner for UISpec on iOS}
+  s.test_files = [
+    "spec/options_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/uispecrunner_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: uispecrunner
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 1
+  version: 0.2.1
+platform: ruby
+authors: 
+- Blake Watters
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-15 00:00:00 -04:00
+default_executable: uispec
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: Provides a simple Ruby interface for running UISpec iPhone tests
+email: blake@twotoasters.com
+executables: 
+- uispec
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- bin/uispec
+- lib/uispecrunner.rb
+- lib/uispecrunner/application.rb
+- lib/uispecrunner/options.rb
+- spec/options_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/uispecrunner_spec.rb
+- src/UISpec+UISpecRunner.h
+- src/UISpec+UISpecRunner.m
+- src/main.m
+- uispecrunner.gemspec
+has_rdoc: true
+homepage: http://github.com/twotoasters/UISpecRunner
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Flexible spec runner for UISpec on iOS
+test_files: 
+- spec/options_spec.rb
+- spec/spec_helper.rb
+- spec/uispecrunner_spec.rb