xcodebuild-rb 0.1.0

data/spec/reporting/clean_reporting_spec.rb

@@ -0,0 +1,276 @@
+require 'spec_helper'
+
+describe XcodeBuild::Reporting::CleanReporting do
+  let(:reporter) { XcodeBuild::Reporter.new }
+  
+  shared_examples_for "any clean" do
+    it "reports the clean target" do
+      reporter.clean.target.should == "ExampleProject"
+    end
+    
+    it "reports the project name" do
+      reporter.clean.project_name.should == "ExampleProject"
+    end
+    
+    it "reports the clean configuration" do
+      reporter.clean.configuration.should == "Release"
+    end
+    
+    it "reports if the clean configuration was the default" do
+      reporter.clean.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 clean has started" do
+      delegate.should_receive(:clean_started).with instance_of(XcodeBuild::Reporting::CleanReporting::Clean)
+      
+      event({:clean_started=>
+        {:target=>"ExampleProject",
+         :project=>"ExampleProject",
+         :configuration=>"Release",
+         :default=>true}})
+    end
+    
+    it "notifies it's delegate when a clean step begins" do
+      assume_clean_started
+      
+      delegate.should_receive(:clean_step_started).with instance_of(XcodeBuild::BuildStep)
+      
+      event({:clean_step=>
+        {:type=>"Clean.Remove",
+         :arguments=>
+          ["clean",
+           "build/Release-iphoneos/ExampleProject.app"]}})
+    end
+    
+    it "notifies it's delegate when a previous clean step finishes" do
+      assume_clean_started
+
+      event({:clean_step=>
+        {:type=>"Clean.Remove",
+         :arguments=>
+          ["clean",
+           "build/Release-iphoneos/ExampleProject.app"]}})
+           
+      delegate.should_receive(:clean_step_finished).with reporter.clean.last_step
+           
+      event({:clean_step=>
+        {:type=>"Clean.Remove",
+         :arguments=>
+          ["clean",
+           "build/Release-iphoneos/ExampleProject.app"]}})
+    end
+    
+    it "notifies it's delegate when the last clean step finishes and the clean is successful" do
+      assume_clean_started
+
+      event({:clean_step=>
+        {:type=>"Clean.Remove",
+         :arguments=>
+          ["clean",
+           "build/Release-iphoneos/ExampleProject.app"]}})
+           
+      delegate.should_receive(:clean_step_finished).with reporter.clean.last_step
+           
+      event({:clean_succeeded=>{}})
+    end
+    
+    it "notifies it's delegate when the last clean step finishes and the clean fails" do
+      assume_clean_started
+
+      event({:clean_step=>
+        {:type=>"Clean.Remove",
+         :arguments=>
+          ["clean",
+           "build/Release-iphoneos/ExampleProject.app"]}})
+           
+      delegate.should_receive(:clean_step_finished).with reporter.clean.last_step
+           
+      event({:clean_failed=>{}})
+    end
+    
+    it "notifies it's delegate that the clean has finished when it is successful" do
+      assume_clean_started
+      delegate.should_receive(:clean_finished).with(reporter.clean)
+      event({:clean_succeeded=>{}})
+    end
+    
+    it "notifies it's delegate that the clean has finished when it fails" do
+      assume_clean_started
+      delegate.should_receive(:clean_finished).with(reporter.clean)
+      event({:clean_failed=>{}})
+    end
+    
+    it "tracks the time a clean takes" do
+      Timecop.travel(Chronic.parse("10 seconds ago")) do
+        event({:clean_started=>
+          {:target=>"ExampleProject",
+           :project=>"ExampleProject",
+           :configuration=>"Release",
+           :default=>true}})
+           
+        Timecop.travel(Chronic.parse("5 seconds from now")) do
+          event({:clean_succeeded=>{}})
+        end
+      end
+      
+      reporter.clean.duration.should be_within(0.01).of(5)
+    end
+  end
+  
+  context "once a clean has started" do
+    before do
+      event({:clean_started=>
+        {:target=>"ExampleProject",
+         :project=>"ExampleProject",
+         :configuration=>"Release",
+         :default=>true}})
+    end
+    
+    it "reports that the clean is running" do
+      reporter.clean.should be_running
+    end
+    
+    it "reports that the clean is not finished" do
+      reporter.clean.should_not be_finished
+    end
+  end
+  
+  context "once a simple, successful clean has finished" do
+    before do
+      event({:clean_started=>
+        {:target=>"ExampleProject",
+         :project=>"ExampleProject",
+         :configuration=>"Release",
+         :default=>true}})
+         
+      event({:clean_step=>
+         {:type=>"Clean.Remove",
+          :arguments=>
+           ["clean",
+            "build/Release-iphoneos/FileOne"]}})
+           
+      event({:clean_step=>
+        {:type=>"Clean.Remove",
+         :arguments=>
+          ["clean",
+           "build/Release-iphoneos/FileTwo"]}})
+           
+      event({:clean_succeeded=>{}})
+    end
+    
+    it_behaves_like "any clean"
+    
+    it "reports that the clean was successful" do
+      reporter.clean.should be_successful
+    end
+    
+    it "reports the total number of completed clean steps" do
+      reporter.clean.should have(2).steps_completed
+    end
+    
+    it "reports that the clean is not running" do
+      reporter.clean.should_not be_running
+    end
+    
+    it "reports that the clean is finished" do
+      reporter.clean.should be_finished
+    end
+  end
+  
+  context "once a simple, failed build has finished" do
+    before do
+      event({:clean_started=>
+        {:target=>"ExampleProject",
+         :project=>"ExampleProject",
+         :configuration=>"Release",
+         :default=>true}})
+         
+      event({:clean_step=>
+         {:type=>"Clean.Remove",
+          :arguments=>
+           ["clean",
+            "build/Release-iphoneos/FileOne"]}})
+            
+      event({:clean_error_detected=>
+         {:message=>"Error Domain=NSCocoaErrorDomain Code=513 ExampleProject couldn't be removed"}})
+           
+      event({:clean_step=>
+        {:type=>"Clean.Remove",
+         :arguments=>
+          ["clean",
+           "build/Release-iphoneos/FileTwo"]}})
+           
+      event({:clean_failed=>{}})
+      
+      event({:clean_step_failed=>
+        {:type=>"Clean.Remove",
+          :arguments=>
+           ["clean",
+            "build/Release-iphoneos/FileOne"]}})
+    end
+    
+    it_behaves_like "any clean"
+    
+    it "reports that the clean was a failure" do
+      reporter.clean.should be_failed
+    end
+    
+    it "reports the total number of completed clean steps" do
+      reporter.clean.should have(2).steps_completed
+    end
+    
+    it "reports the total number of failed clean steps" do
+      reporter.clean.should have(1).failed_steps
+      reporter.clean.failed_steps.first.tap do |step|
+        step.type.should == "Clean.Remove"
+      end
+    end
+    
+    it "reports the errors for each failed clean step" do
+      reporter.clean.failed_steps.first.should have(1).errors
+      reporter.clean.failed_steps.first.errors.first.tap do |error|
+        error.message.should == "Error Domain=NSCocoaErrorDomain Code=513 ExampleProject couldn't be removed"
+      end
+    end
+    
+    it "reports that the clean is not running" do
+      reporter.clean.should_not be_running
+    end
+    
+    it "reports that the clean is finished" do
+      reporter.clean.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_clean_started
+    event({:clean_started=>
+      {:target=>"ExampleProject",
+       :project=>"ExampleProject",
+       :configuration=>"Release",
+       :default=>true}})
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+ENV["LC_CTYPE"] = "en_US.UTF-8"
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end
+
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'xcodebuild'
+require 'chronic'
+require 'timecop'
+
+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

data/spec/translations/building_translations_spec.rb

@@ -0,0 +1,167 @@
+require 'spec_helper'
+
+describe XcodeBuild::Translations::Building do
+  let(:delegate)    { mock('delegate', :respond_to? => true) }
+  let(:translator)  { XcodeBuild::OutputTranslator.new(delegate, ignore_global_translations: true) }
+  let(:translation) { translator.translations[0] }
+  
+  before do
+    translator.use_translation XcodeBuild::Translations::Building
+    
+    delegate_should_respond_to(:beginning_translation_of_line)
+    delegate.stub(:beginning_translation_of_line).and_return(true)
+    
+    translator.should have(1).translations
+  end
+  
+  context "before it detects that a build has started" do
+    it "reports that it is not building" do
+      translation.should_not be_building
+    end
+    
+    it "notifies the delegate of the start of a build with the default configuration" do
+      delegate.stub(:beginning_translation_of_line)
+      delegate.should_receive(:build_started).with(
+                target: "ExampleProject",
+               project: "ExampleProject",
+         configuration: "Release",
+               default: true
+      )
+      translator << "=== BUILD NATIVE TARGET ExampleProject OF PROJECT ExampleProject WITH THE DEFAULT CONFIGURATION (Release) ==="
+    end
+    
+    it "notifies the delegate of the start of a build with a non-default configuration" do
+      delegate.stub(:beginning_translation_of_line)
+      delegate.should_receive(:build_started).with(
+                target: "ExampleProject",
+               project: "ExampleProject",
+         configuration: "Debug",
+               default: false
+      )
+      translator << "=== BUILD NATIVE TARGET ExampleProject OF PROJECT ExampleProject WITH THE CONFIGURATION Debug ==="
+    end
+
+    it "treats :build_started as a required delegate message and raise if it doesn't respond" do
+      delegate_should_not_respond_to(:build_started)
+      -> { 
+        translator << "=== BUILD NATIVE TARGET ExampleProject OF PROJECT ExampleProject WITH THE CONFIGURATION Debug ==="
+
+      }.should raise_error(XcodeBuild::OutputTranslator::MissingDelegateMethodError)
+    end
+  end
+  
+  context "once a build start has been detected" do
+    before do
+      translation.stub(:building?).and_return(true)
+    end
+    
+    it "notifies the delegate of a single build step" do
+      delegate.stub(:beginning_translation_of_line)
+      delegate.should_receive(:build_step).with(
+             type: "CodeSign", 
+        arguments: ["build/Debug-iphoneos/ExampleProject.app"]
+      )
+      translator << "\n"
+      translator << "CodeSign build/Debug-iphoneos/ExampleProject.app"
+    end
+
+    it "treats :beginning_translation_of_line as an optional delegate message" do
+      delegate_should_not_respond_to(:build_step)
+      delegate.should_not_receive(:build_step)
+      translator << "\n"
+      translator << "CodeSign build/Debug-iphoneos/ExampleProject.app"
+    end
+
+    it "notifies the delegate when the build failed" do
+      delegate.stub(:beginning_translation_of_line)
+      delegate.should_receive(:build_failed)
+      translator << "\n\n\n"
+      translator << "** BUILD FAILED **"
+    end
+
+    it "treats :build_failed as a required delegate message and raise if it doesn't respond" do
+      delegate_should_not_respond_to(:build_failed)
+      -> { 
+        translator << "** BUILD FAILED **"
+
+      }.should raise_error(XcodeBuild::OutputTranslator::MissingDelegateMethodError)
+    end
+
+    it "notifies the delegate when the build succeeded" do
+      delegate.stub(:beginning_translation_of_line)
+      delegate.should_receive(:build_succeeded)
+      translator << "\n\n\n"
+      translator << "** BUILD SUCCEEDED **"
+    end
+
+    it "treats :build_succeeded as a required delegate message and raise if it doesn't respond" do
+      delegate_should_not_respond_to(:build_succeeded)
+      -> { 
+        translator << "** BUILD SUCCEEDED **"
+
+      }.should raise_error(XcodeBuild::OutputTranslator::MissingDelegateMethodError)
+    end
+
+    it "notifies the delegate of build step failures" do
+      delegate.should_receive(:build_step_failed).with(
+             type: "CodeSign", 
+        arguments: ["build/Debug-iphoneos/ExampleProject.app"]
+      )
+      translator << "The following build commands failed:"
+      translator << "\tCodeSign build/Debug-iphoneos/ExampleProject.app"
+      translator << "(2 failures)"
+    end
+
+    it "treats :build_step_failed as an optional delegate message" do
+      delegate_should_not_respond_to(:build_step_failed)
+      delegate.should_not_receive(:build_step_failed)
+      translator << "The following build commands failed:"
+      translator << "\tCodeSign build/Debug-iphoneos/ExampleProject.app"
+    end
+
+    it "notifies the delegate of errors that occur throughout the build" do
+      delegate.should_receive(:build_error_detected).with(
+             file: "/ExampleProject/main.m", 
+             line: 16,
+             char: 42,
+          message: "expected ';' after expression [1]"
+      )
+      translator << "/ExampleProject/main.m:16:42: error: expected ';' after expression [1]"
+    end
+
+    it "notifies the delegate of errors for different build steps" do
+      delegate.should_receive(:build_error_detected).with(
+             file: "/ExampleProject/main.m", 
+             line: 16,
+             char: 42,
+          message: "expected ';' after expression [1]"
+      )
+
+      translator << "CompileC ExampleProject/main.m normal"
+      translator << "/ExampleProject/main.m:16:42: error: expected ';' after expression [1]"
+      translator << "1 error generated."
+    end
+
+    it "notifies the delegate of multiple errors for the same build step" do
+      delegate.should_receive(:build_error_detected).with(
+             file: "/ExampleProject/main.m", 
+             line: 16,
+             char: 42,
+          message: "expected ';' after expression [1]"
+      ).twice
+
+      translator << "CompileC ExampleProject/main.m normal"
+      translator << "/ExampleProject/main.m:16:42: error: expected ';' after expression [1]"
+      translator << ""
+      translator << "/ExampleProject/main.m:16:42: error: expected ';' after expression [1]"
+      translator << ""
+      translator << "2 errors generated."
+    end
+
+    it "treats :build_error_detected as an optional delegate message" do
+      delegate_should_not_respond_to(:build_error_detected)
+      delegate.should_not_receive(:build_error_detected)
+      translator << "/ExampleProject/main.m:16:42: error: expected ';' after expression [1]"
+    end
+  end
+end