xcodebuild-rb 0.1.0

data/lib/xcodebuild.rb

@@ -0,0 +1 @@
+require_relative 'xcode_build'

data/spec/build_task_spec.rb

@@ -0,0 +1,142 @@
+require 'spec_helper'
+require 'xcode_build/tasks/build_task'
+
+describe XcodeBuild::Tasks::BuildTask do
+  before { Rake::Task.clear }
+
+  it "defines an build task in the default namespace (xcode)" do
+    XcodeBuild::Tasks::BuildTask.new
+    Rake::Task["xcode:build"].should be_instance_of(Rake::Task)
+  end
+
+  it "defines an build task in a custom namespace" do
+    XcodeBuild::Tasks::BuildTask.new(:test)
+    Rake::Task["test:build"].should be_instance_of(Rake::Task)
+  end
+  
+  it "defines a clean task" do
+    XcodeBuild::Tasks::BuildTask.new
+    Rake::Task["xcode:clean"].should be_instance_of(Rake::Task)
+  end
+  
+  it "defines a cleanbuild" do
+    XcodeBuild::Tasks::BuildTask.new
+    Rake::Task["xcode:cleanbuild"].should be_instance_of(Rake::Task)
+  end
+
+  context "#build_opts" do
+    let(:task) { XcodeBuild::Tasks::BuildTask.new }
+
+    it "includes the project" do
+      task.project_name = "TestProject.xcproject"
+      task.build_opts.should include("-project TestProject.xcproject")
+    end
+
+    it "includes the target" do
+      task.target = "TestTarget"
+      task.build_opts.should include("-target TestTarget")
+    end
+
+    it "includes the workspace" do
+      task.workspace = "SomeWorkspace.xcworkspace"
+      task.build_opts.should include("-workspace SomeWorkspace.xcworkspace")
+    end
+
+    it "includes the scheme" do
+      task.scheme = "TestScheme"
+      task.build_opts.should include("-scheme TestScheme")
+    end
+
+    it "includes the configuration" do
+      task.configuration = "TestConfiguration"
+      task.build_opts.should include("-configuration TestConfiguration")
+    end
+
+    it "includes the arch" do
+      task.arch = "i386"
+      task.build_opts.should include("-arch i386")
+    end
+
+    it "includes the sdk" do
+      task.sdk = "iphonesimulator5.0"
+      task.build_opts.should include("-sdk iphonesimulator5.0")
+    end
+
+    it "includes the xcconfig path" do
+      task.xcconfig = "path/to/config.xcconfig"
+      task.build_opts.should include("-xcconfig path/to/config.xcconfig")
+    end
+  end
+
+  context "build task" do
+    it "runs xcodebuild with the configured build_opts" do
+      task = XcodeBuild::Tasks::BuildTask.new do |task|
+        task.project_name = "TestProject.xcproject"
+        task.configuration = "Debug"
+      end
+
+      XcodeBuild.should_receive(:run).with(task.build_opts.join(" "), anything())
+      task.run(:build)
+    end
+    
+    it "defaults to outputting the raw output to STDOUT" do
+      task = XcodeBuild::Tasks::BuildTask.new
+      XcodeBuild.should_receive(:run).with(anything(), STDOUT)
+      task.run(:build)
+    end
+    
+    it "uses a custom output buffer if specified" do
+      buffer = stub('output buffer')
+      task = XcodeBuild::Tasks::BuildTask.new do |t|
+        t.output_to = buffer
+      end
+      XcodeBuild.should_receive(:run).with(anything(), buffer)
+      task.run(:build)
+    end
+    
+    it "outputs the translator delegating to the reporter if formatter is set" do
+      formatter = stub('formatter')
+      task = XcodeBuild::Tasks::BuildTask.new do |t|
+        t.formatter = formatter
+      end
+      XcodeBuild.should_receive(:run).with(anything(),
+        output_translator_delegating_to(instance_of(XcodeBuild::Reporter)))
+      task.run(:build)
+    end
+    
+    it "changes directory if invoke_from_within is set" do
+      task = XcodeBuild::Tasks::BuildTask.new do |task|
+        task.invoke_from_within = "foo/bar"
+      end
+      
+      Dir.should_receive(:chdir).with("foo/bar").and_yield
+      XcodeBuild.should_receive(:run)
+      task.run(:build)
+    end
+  end
+  
+  context "clean task" do
+    it "runs xcodebuild with the 'clean' action" do
+      task = XcodeBuild::Tasks::BuildTask.new
+      XcodeBuild.should_receive(:run).with("clean", anything())
+      task.run(:clean)
+    end
+  end
+  
+  context "cleanbuild task" do
+    it "runs the clean task and then the build task" do
+      task = XcodeBuild::Tasks::BuildTask.new
+      XcodeBuild.should_receive(:run).with("clean", anything()) do
+        XcodeBuild.should_receive(:run).with("", anything())
+      end
+      task.run(:cleanbuild)
+    end
+  end
+  
+  RSpec::Matchers.define :output_translator_delegating_to do |expected|
+    match do |actual|
+      actual.should be_instance_of(XcodeBuild::OutputTranslator)
+      expected.should == actual.delegate
+    end
+  end
+end

data/spec/output_translator_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe XcodeBuild::OutputTranslator do
+  let(:delegate)   { mock('delegate') }
+  let(:translator) { XcodeBuild::OutputTranslator.new(delegate, ignore_global_translations: true) }
+  
+  it "notifies the delegate of each line received (to assist additional processing elsewhere)" do
+    delegate.should_receive(:beginning_translation_of_line).with("the line")
+    translator << "the line"
+  end
+  
+  it "treats :beginning_translation_of_line as an optional delegate message" do
+    delegate_should_not_respond_to(:beginning_translation_of_line)
+    delegate.should_not_receive(:beginning_translation_of_line)
+    translator << "anything"
+  end
+  
+  it "asks each translation to attempt to translate a line" do
+    translator.use_translation(FakeTranslation.dup)
+    translator.use_translation(FakeTranslation.dup)
+
+    translator << "a line"
+
+    translator.translations.each do |translation|
+      translation.should have_attempted_to_translate("a line")
+    end
+  end
+  
+  private
+  
+  module FakeTranslation
+    def attempt_to_translate(line)
+      @attempted_to_translate = line
+    end
+    
+    def has_attempted_to_translate?(line)
+      line == @attempted_to_translate
+    end
+  end
+  
+  def delegate_should_respond_to(method)
+    mock_should_respond?(delegate, method, true)
+  end
+  
+  def delegate_should_not_respond_to(method)
+    mock_should_respond?(delegate, method, false)
+  end
+  
+  def mock_should_respond?(mock, method, should_respond)
+    mock.stub(:respond_to?).with(method).and_return(should_respond)
+  end
+end

data/spec/reporting/build_reporting_spec.rb

@@ -0,0 +1,305 @@
+require 'spec_helper'
+
+describe XcodeBuild::Reporting::BuildReporting do
+  let(:reporter) { XcodeBuild::Reporter.new }
+  
+  shared_examples_for "any build" do
+    it "reports the build target" do
+      reporter.build.target.should == "ExampleProject"
+    end
+    
+    it "reports the project name" do
+      reporter.build.project_name.should == "ExampleProject"
+    end
+    
+    it "reports the build configuration" do
+      reporter.build.configuration.should == "Release"
+    end
+    
+    it "reports if the build configuration was the default" do
+      reporter.build.should be_default_configuration
+    end
+  end
+  
+  context "when receiving events" do
+    let(:delegate) { mock('reporter delegate').as_null_object }
+    
+    before do
+      reporter.delegate = delegate
+      
+      # let's assume it responds to all delegate methods
+      delegate.stub(:respond_to?).with(anything).and_return(true)
+    end
+    
+    it "notifies it's delegate that a build has started" do
+      delegate.should_receive(:build_started).with instance_of(XcodeBuild::Reporting::BuildReporting::Build)
+      
+      event({:build_started=>
+        {:target=>"ExampleProject",
+         :project=>"ExampleProject",
+         :configuration=>"Release",
+         :default=>true}})
+    end
+    
+    it "notifies it's delegate when a build step begins" do
+      assume_build_started
+      
+      delegate.should_receive(:build_step_started).with instance_of(XcodeBuild::BuildStep)
+      
+      event({:build_step=>
+        {:type=>"CpResource",
+         :arguments=>
+          ["/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS5.0.sdk/ResourceRules.plist",
+           "build/Release-iphoneos/ExampleProject.app/ResourceRules.plist"]}})
+    end
+    
+    it "notifies it's delegate when a previous build step finishes" do
+      assume_build_started
+
+      event({:build_step=>
+        {:type=>"CpResource",
+         :arguments=>
+          ["/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS5.0.sdk/ResourceRules.plist",
+           "build/Release-iphoneos/ExampleProject.app/ResourceRules.plist"]}})
+           
+      delegate.should_receive(:build_step_finished).with reporter.build.last_step
+           
+      event({:build_step=>
+        {:type=>"CpResource",
+         :arguments=>
+          ["/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS5.0.sdk/ResourceRules.plist",
+           "build/Release-iphoneos/ExampleProject.app/ResourceRules.plist"]}})
+    end
+    
+    it "notifies it's delegate when the last build step finishes and the build is successful" do
+      assume_build_started
+
+      event({:build_step=>
+        {:type=>"CpResource",
+         :arguments=>
+          ["/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS5.0.sdk/ResourceRules.plist",
+           "build/Release-iphoneos/ExampleProject.app/ResourceRules.plist"]}})
+           
+      delegate.should_receive(:build_step_finished).with reporter.build.last_step
+           
+      event({:build_succeeded=>{}})
+    end
+    
+    it "notifies it's delegate when the last build step finishes and the build fails" do
+      assume_build_started
+
+      event({:build_step=>
+        {:type=>"CpResource",
+         :arguments=>
+          ["/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS5.0.sdk/ResourceRules.plist",
+           "build/Release-iphoneos/ExampleProject.app/ResourceRules.plist"]}})
+           
+      delegate.should_receive(:build_step_finished).with reporter.build.last_step
+           
+      event({:build_succeeded=>{}})
+    end
+    
+    it "notifies it's delegate that the build has finished when it is successful" do
+      assume_build_started
+      delegate.should_receive(:build_finished).with(reporter.build)
+      event({:build_succeeded=>{}})
+    end
+    
+    it "notifies it's delegate that the build has finished when it fails" do
+      assume_build_started
+      delegate.should_receive(:build_finished).with(reporter.build)
+      event({:build_failed=>{}})
+    end
+    
+    it "tracks the time a build takes" do
+      Timecop.travel(Chronic.parse("10 seconds ago")) do
+        event({:build_started=>
+          {:target=>"ExampleProject",
+           :project=>"ExampleProject",
+           :configuration=>"Release",
+           :default=>true}})
+           
+        Timecop.travel(Chronic.parse("5 seconds from now")) do
+          event({:build_succeeded=>{}})
+        end
+      end
+      
+      reporter.build.duration.should be_within(0.01).of(5)
+    end
+  end
+  
+  context "once a build has started" do
+    before do
+      event({:build_started=>
+        {:target=>"ExampleProject",
+         :project=>"ExampleProject",
+         :configuration=>"Release",
+         :default=>true}})
+    end
+    
+    it "reports that the build is running" do
+      reporter.build.should be_running
+    end
+    
+    it "reports that the build is not finished" do
+      reporter.build.should_not be_finished
+    end
+  end
+  
+  context "once a simple, successful build has finished" do
+    before do
+      event({:build_started=>
+        {:target=>"ExampleProject",
+         :project=>"ExampleProject",
+         :configuration=>"Release",
+         :default=>true}})
+         
+      event({:build_step=>
+        {:type=>"CpResource",
+         :arguments=>
+          ["/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS5.0.sdk/ResourceRules.plist",
+           "build/Release-iphoneos/ExampleProject.app/ResourceRules.plist"]}})
+           
+      event({:build_step=>
+        {:type=>"ProcessInfoPlistFile",
+         :arguments=>
+          ["build/Release-iphoneos/ExampleProject.app/Info.plist",
+           "ExampleProject/ExampleProject-Info.plist"]}})
+           
+      event({:build_step=>
+        {:type=>"CompileC",
+         :arguments=>
+          ["build/ExampleProject.build/Release-iphoneos/ExampleProject.build/Objects-normal/armv7/AppDelegate.o",
+           "ExampleProject/AppDelegate.m",
+           "normal",
+           "armv7",
+           "objective-c",
+           "com.apple.compilers.llvm.clang.1_0.compiler"]}})
+           
+      event({:build_succeeded=>{}})
+    end
+    
+    it_behaves_like "any build"
+    
+    it "reports that the build was successful" do
+      reporter.build.should be_successful
+    end
+    
+    it "reports the total number of completed build steps" do
+      reporter.build.should have(3).steps_completed
+    end
+    
+    it "reports that the build is not running" do
+      reporter.build.should_not be_running
+    end
+    
+    it "reports that the build is finished" do
+      reporter.build.should be_finished
+    end
+  end
+  
+  context "once a simple, failed build has finished" do
+    before do
+      event({:build_started=>
+        {:target=>"ExampleProject",
+         :project=>"ExampleProject",
+         :configuration=>"Release",
+         :default=>true}})
+
+      event({:build_step=>
+        {:type=>"CompileC",
+         :arguments=>
+          ["build/ExampleProject.build/Release-iphoneos/ExampleProject.build/Objects-normal/armv7/AppDelegate.o",
+           "ExampleProject/AppDelegate.m",
+           "normal",
+           "armv7",
+           "objective-c",
+           "com.apple.compilers.llvm.clang.1_0.compiler"]}})
+           
+      event({:build_error_detected=>
+         {:file=>
+           "/Users/luke/Code/mine/xcodebuild/resources/ExampleProject/ExampleProject/main.m",
+          :line=>16,
+          :char=>42,
+          :message=>"expected ';' after expression [1]"}})
+      
+      event({:build_step=>
+        {:type=>"CompileC",
+         :arguments=>
+          ["build/ExampleProject.build/Release-iphoneos/ExampleProject.build/Objects-normal/armv7/AppDelegate.o",
+           "ExampleProject/AppDelegate.m",
+           "normal",
+           "armv7",
+           "objective-c",
+           "com.apple.compilers.llvm.clang.1_0.compiler"]}})
+           
+      event({:build_failed=>{}})
+      
+      event({:build_step_failed=>
+        {:type=>"CompileC",
+         :arguments=>
+          ["build/ExampleProject.build/Release-iphoneos/ExampleProject.build/Objects-normal/armv7/AppDelegate.o",
+           "ExampleProject/AppDelegate.m",
+           "normal",
+           "armv7",
+           "objective-c",
+           "com.apple.compilers.llvm.clang.1_0.compiler"]}})
+    end
+    
+    it_behaves_like "any build"
+    
+    it "reports that the build was a failure" do
+      reporter.build.should be_failed
+    end
+    
+    it "reports the total number of completed build steps" do
+      reporter.build.should have(2).steps_completed
+    end
+    
+    it "reports the total number of failed build steps" do
+      reporter.build.should have(1).failed_steps
+      reporter.build.failed_steps.first.tap do |step|
+        step.type.should == "CompileC"
+      end
+    end
+    
+    it "reports the errors for each failed build step" do
+      reporter.build.failed_steps.first.should have(1).errors
+      reporter.build.failed_steps.first.errors.first.tap do |error|
+        error.file.should == "/Users/luke/Code/mine/xcodebuild/resources/ExampleProject/ExampleProject/main.m"
+        error.line.should == 16
+        error.char.should == 42
+        error.message.should == "expected ';' after expression [1]"
+      end
+    end
+    
+    it "reports that the build is not running" do
+      reporter.build.should_not be_running
+    end
+    
+    it "reports that the build is finished" do
+      reporter.build.should be_finished
+    end
+  end
+  
+  private
+  
+  def event(event_data)
+    message = event_data.keys.first
+    params = event_data.values.first
+    
+    if params.any?
+      reporter.send(message, params)
+    else
+      reporter.send(message)
+    end
+  end
+  
+  def assume_build_started
+    event({:build_started=>
+      {:target=>"ExampleProject",
+       :project=>"ExampleProject",
+       :configuration=>"Release",
+       :default=>true}})
+  end
+end