xcodebuild-helper 1.0.0

data/lib/xcodebuild-helper.rb

@@ -0,0 +1,110 @@
+require 'xcode'
+require 'execute'
+
+module XCodeBuildHelper
+  @registry = {}
+  def self.[](name)
+    @registry[name]
+  end
+
+  def self.define(name, &block)
+    xcode = @registry[name]
+    if xcode == nil
+      xcode = XCodeBuildHelper::XCode.new
+    end
+    xcode.instance_eval(&block)
+    @registry[name] = xcode
+  end
+
+  def self.build(name, device = nil)
+    xcode = @registry[name]
+
+    unless xcode == nil
+      cmd = create_base_cmd(xcode)
+      if device != nil
+        cmd += parse_destination(xcode.get_device(device))
+      end
+      XCodeBuildHelper::Execute.call(cmd + "clean build | bundle exec xcpretty --color --report json-compilation-database")
+    end
+  end
+
+  def self.test_suite(name, plan, device = nil)
+    xcode = @registry[name]
+
+    unless xcode == nil
+      cmd = create_base_cmd(xcode)
+      if device != nil
+        cmd += parse_destination(xcode.get_device(device))
+      end
+      XCodeBuildHelper::Execute.call(cmd + "test | bundle exec xcpretty --color --report #{xcode.get_test_plan(plan).get_report_type}")
+    end
+  end
+
+  def self.create_base_cmd(project)
+    "xcodebuild -workspace \"#{project.get_workspace}.xcworkspace\" -scheme #{project.get_scheme} -sdk #{project.get_sdk} -config #{project.get_config} "
+  end
+
+  def self.parse_destination(device)
+    if device == nil
+      ""
+    else
+      "-destination 'platform=#{device.get_platform},name=#{device.get_name},OS=#{device.get_os}' "
+    end
+  end
+
+  def self.base_app_location(xcode)
+    unless xcode == nil
+      cmd = create_base_cmd(xcode)
+      result = XCodeBuildHelper::Execute.call(cmd + "-showBuildSettings")
+      parse_app_settings(result)
+    end
+  end
+
+  def self.parse_app_settings(settings)
+    result = /OBJROOT = ([a-zA-Z0-9\/ _\-]+)/.match(settings)
+    if result != nil
+      result[1]
+    else
+      ""
+    end
+  end
+
+  def self.app_binary_location(project)
+    Dir.glob(base_app_location(project) + "/CodeCoverage/#{project.get_scheme}/Products/#{project.get_config}-#{project.get_sdk}/#{project.get_workspace.gsub(/\s+/, '\\ ')}.app/#{project.get_workspace.gsub(/\s+/,"\\ ")}").first
+  end
+
+  def self.profdata_location(project)
+    Dir.glob(base_app_location(project) + "/CodeCoverage/#{project.get_scheme}/Coverage.profdata").first
+  end
+
+  def self.generate_coverage(name, plan)
+    xcode = @registry[name]
+    unless xcode == nil
+      coverage_plan = xcode.get_coverage_plan(plan)
+      result = XCodeBuildHelper::Execute.call("xcrun llvm-cov show -instr-profile \"#{profdata_location(xcode)}\" \"#{app_binary_location(xcode)}\" #{coverage_plan.get_source_files.first}")
+    end
+  end
+
+  def self.lint(name, plan)
+    xcode = @registry[name]
+    lint_plan = xcode.get_lint_plan(plan)
+
+    cmd = "bundle exec oclint-json-compilation-database"
+    if(lint_plan.get_ignore)
+      cmd += " -e \"#{lint_plan.get_ignore}\""
+    end
+    cmd += " --"
+    if(lint_plan.get_report_type && lint_plan.get_output)
+      cmd += " -report-type #{lint_plan.get_report_type} -o #{lint_plan.get_output}"
+    end
+
+    rules = lint_plan.get_rules
+    rules.get_attribute_list.each do |key|
+      u_key = rules.send("key_" + key.to_s)
+      value = rules.send("get_" + key.to_s)
+      cmd += " -rc #{u_key}=#{value}"
+    end
+
+    XCodeBuildHelper::Execute.call(cmd)
+  end
+end

data/spec/coverage_plan_spec.rb

@@ -0,0 +1,18 @@
+require 'coverage_plan'
+
+RSpec.describe XCodeBuildHelper::CoveragePlan do
+  context "Setter methods" do
+    before(:each) do
+      @coverage_plan = XCodeBuildHelper::CoveragePlan.new
+    end
+    it "should set the report type" do
+      @coverage_plan.report_type "REPORT_TYPE"
+      expect(@coverage_plan.get_report_type).to eq "REPORT_TYPE"
+    end
+
+    it "should set the source files" do
+      @coverage_plan.source_files ["path/tofiles/*.m"]
+      expect(@coverage_plan.get_source_files).to eq ["path/tofiles/*.m"]
+    end
+  end
+end

data/spec/device_spec.rb

@@ -0,0 +1,24 @@
+require 'device'
+
+RSpec.describe XCodeBuildHelper::Device do
+  context "Setter methods" do
+    before(:each) do
+      @device = XCodeBuildHelper::Device.new
+    end
+
+    it "should set the platform name" do
+      @device.platform "PLATFORM"
+      expect(@device.get_platform).to eq "PLATFORM"
+    end
+
+    it "should set the name" do
+      @device.name "NAME"
+      expect(@device.get_name).to eq "NAME"
+    end
+
+    it "should set the name" do
+      @device.os "9.2"
+      expect(@device.get_os).to eq "9.2"
+    end
+  end
+end

data/spec/lint_plan_spec.rb

@@ -0,0 +1,35 @@
+require 'lint_plan'
+require 'rules'
+
+RSpec.describe XCodeBuildHelper::LintPlan do
+  before(:each) do
+    @lint_plan = XCodeBuildHelper::LintPlan.new
+  end
+
+  context "Setter methods" do
+    it "should set the report type" do
+      @lint_plan.report_type "REPORT_TYPE"
+      expect(@lint_plan.get_report_type).to eq "REPORT_TYPE"
+    end
+    it "should set the output type" do
+      @lint_plan.output "OUTPUT_LOCATION"
+      expect(@lint_plan.get_output).to eq "OUTPUT_LOCATION"
+    end
+    it "should set the ignore type" do
+      @lint_plan.ignore "IGNORE"
+      expect(@lint_plan.get_ignore).to eq "IGNORE"
+    end
+    context "setting rules" do
+      before(:each) do
+        @rules = XCodeBuildHelper::Rules.new
+        @rules.long_line 120
+        @rules.short_variable_name 3
+      end
+      it "should set the rule list" do
+        @lint_plan.rules @rules
+        expect(@lint_plan.get_rules.get_long_line).to eq 120
+        expect(@lint_plan.get_rules.get_short_variable_name).to eq 3 
+      end
+    end
+  end
+end

data/spec/rule_spec.rb

@@ -0,0 +1,37 @@
+require 'rules'
+
+RSpec.describe XCodeBuildHelper::Rules do
+  before(:each) do
+    @rules = XCodeBuildHelper::Rules.new
+  end
+  context "Setter methods" do
+    it "should set the long line rule" do
+      @rules.long_line 120
+      expect(@rules.get_long_line).to eq 120
+    end
+
+    it "should set the shor variable name rule" do
+      @rules.short_variable_name 3
+      expect(@rules.get_short_variable_name).to eq 3
+    end
+  end
+
+  context "key methods" do
+    it "should return the uppercase version of the method" do
+      @rules.long_line 120
+      expect(@rules.key_long_line).to eq "LONG_LINE"
+    end
+
+    it "should return the uppercase version of the method" do
+      expect(@rules.key_long_line).to eq nil
+    end
+  end
+
+  context "get list of attributes" do
+    it "should return a list of attributes" do
+      @rules.long_line 120
+      @rules.short_variable_name 3
+      expect(@rules.get_attribute_list).to eq [:long_line, :short_variable_name]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'coveralls'
+Coveralls.wear!
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+end

data/spec/test_plan_spec.rb

@@ -0,0 +1,11 @@
+require 'test_plan'
+
+RSpec.describe XCodeBuildHelper::TestPlan do
+  context "setter methods" do
+    it "should set the report type" do
+      @test_plan = XCodeBuildHelper::TestPlan.new
+      @test_plan.report_type "REPORT_TYPE"
+      expect(@test_plan.get_report_type).to eq "REPORT_TYPE"
+    end
+  end
+end

data/spec/xcode_dsl_actions_spec.rb

@@ -0,0 +1,136 @@
+require 'xcodebuild-helper'
+
+RSpec.describe "DSL actions" do
+  context "build" do
+    before(:each) do
+      XCodeBuildHelper.define :default do
+        workspace "WORK SPACE"
+        scheme "SCHEME"
+        sdk "SDK"
+        config "CONFIG"
+        device :ipad do
+          platform "PLATFORM"
+          name "NAME"
+          os "OS"
+        end
+      end
+    end
+
+    it "should create the proper CLI to build the app" do
+      expect(XCodeBuildHelper::Execute).to receive(:call).with("xcodebuild -workspace \"WORK SPACE.xcworkspace\" -scheme SCHEME -sdk SDK -config CONFIG clean build | bundle exec xcpretty --color --report json-compilation-database")
+      XCodeBuildHelper.build(:default)
+    end
+
+    it "should create the proper CLI for the ipad" do
+      expect(XCodeBuildHelper::Execute).to receive(:call).with("xcodebuild -workspace \"WORK SPACE.xcworkspace\" -scheme SCHEME -sdk SDK -config CONFIG -destination 'platform=PLATFORM,name=NAME,OS=OS' clean build | bundle exec xcpretty --color --report json-compilation-database")
+      XCodeBuildHelper.build(:default, :ipad)
+    end
+  end
+
+  context "test_suite" do
+    before(:each) do
+      XCodeBuildHelper.define :default do
+        workspace "WORK SPACE"
+        scheme "SCHEME"
+        sdk "SDK"
+        config "CONFIG"
+
+        device :ipad do
+          platform "PLATFORM"
+          name "NAME"
+          os "OS"
+        end
+
+        test_plan :plan_a do
+          report_type 'html'
+        end
+      end
+    end
+
+    it "should create the proper CLI for testing" do
+      expect(XCodeBuildHelper::Execute).to receive(:call).with("xcodebuild -workspace \"WORK SPACE.xcworkspace\" -scheme SCHEME -sdk SDK -config CONFIG test | bundle exec xcpretty --color --report html")
+      XCodeBuildHelper.test_suite(:default, :plan_a)
+    end
+
+    it "should create the proper CLI for testing for ipad" do
+      expect(XCodeBuildHelper::Execute).to receive(:call).with("xcodebuild -workspace \"WORK SPACE.xcworkspace\" -scheme SCHEME -sdk SDK -config CONFIG -destination 'platform=PLATFORM,name=NAME,OS=OS' test | bundle exec xcpretty --color --report html")
+      XCodeBuildHelper.test_suite(:default, :plan_a, :ipad)
+    end
+  end
+
+  context "code coverage" do
+    before(:each) do
+      XCodeBuildHelper.define :default do
+        workspace "WORK SPACE"
+        scheme "SCHEME"
+        sdk "SDK"
+        config "CONFIG"
+
+        device :ipad do
+          platform "PLATFORM"
+          name "NAME"
+          os "OS"
+        end
+
+        coverage_plan :plan_a do
+          report_type "xml"
+          source_files ["path/to/files/*"]
+        end
+      end
+    end
+
+    it "will find the base app directory" do
+      expect(XCodeBuildHelper::Execute).to receive(:call).with("xcodebuild -workspace \"WORK SPACE.xcworkspace\" -scheme SCHEME -sdk SDK -config CONFIG -showBuildSettings")
+      XCodeBuildHelper.base_app_location(XCodeBuildHelper[:default])
+    end
+
+    it "will find the app binary" do
+      allow(XCodeBuildHelper).to receive(:base_app_location).and_return("/path/to/app")
+      expect(Dir).to receive(:glob).with("/path/to/app/CodeCoverage/SCHEME/Products/CONFIG-SDK/WORK\\ SPACE.app/WORK\\ SPACE").and_return([])
+      XCodeBuildHelper.app_binary_location(XCodeBuildHelper[:default])
+    end
+
+    it "will find the app profdata" do
+      allow(XCodeBuildHelper).to receive(:base_app_location).and_return("/path/to/app")
+      expect(Dir).to receive(:glob).with("/path/to/app/CodeCoverage/SCHEME/Coverage.profdata").and_return([])
+      XCodeBuildHelper.profdata_location(XCodeBuildHelper[:default])
+    end
+
+    it "will return the CLI for finding code coverage" do
+      allow(XCodeBuildHelper).to receive(:app_binary_location).and_return("/path/to/app/bin")
+      allow(XCodeBuildHelper).to receive(:profdata_location).and_return("/path/to/app/prof")
+      expect(XCodeBuildHelper::Execute).to receive(:call).with("xcrun llvm-cov show -instr-profile \"/path/to/app/prof\" \"/path/to/app/bin\" path/to/files/*")
+      XCodeBuildHelper.generate_coverage(:default, :plan_a)
+    end
+  end
+
+  context "lint" do
+    before(:each) do
+      XCodeBuildHelper.define :default do
+        workspace "WORK SPACE"
+        scheme "SCHEME"
+        sdk "SDK"
+        config "CONFIG"
+
+        device :ipad do
+          platform "PLATFORM"
+          name "NAME"
+          os "OS"
+        end
+
+        lint_plan :plan_a do
+          report_type "REPORT_TYPE"
+          output "OUTPUT"
+          ignore "IGNORE"
+          rules do
+            long_line 120
+          end
+        end
+      end
+    end
+    it "should call the correct CLI for the lint" do
+      expect(XCodeBuildHelper::Execute).to receive(:call).with("bundle exec oclint-json-compilation-database -e \"IGNORE\" -- -report-type REPORT_TYPE -o OUTPUT -rc LONG_LINE=120")
+      XCodeBuildHelper.lint(:default, :plan_a)
+    end
+  end
+end

data/spec/xcode_dsl_spec.rb

@@ -0,0 +1,176 @@
+require 'xcodebuild-helper'
+
+RSpec.describe "DSL" do
+  context "define" do
+    before(:each) do
+      XCodeBuildHelper.define :default do
+        workspace "WORK SPACE"
+        scheme "SCHEME"
+      end
+    end
+
+    it "should register the default with a workspace" do
+      expect(XCodeBuildHelper[:default].get_workspace).to eq("WORK SPACE")
+    end
+
+    it "should register the default with a scheme" do
+      expect(XCodeBuildHelper[:default].get_scheme).to eq("SCHEME")
+    end
+  end
+
+  context "registering a device" do
+    before(:each) do
+      XCodeBuildHelper.define :default do
+        workspace "WORK SPACE"
+        scheme "SCHEME"
+        device :ipad do
+          platform "PLATFORM"
+          name "NAME"
+          os "9.2"
+        end
+
+        device :iphone do
+          platform "PLATFORM_2"
+          name "NAME_2"
+          os "7.0"
+        end
+      end
+    end
+    it "should register an ipad on the project" do
+      expect(XCodeBuildHelper[:default].get_device(:ipad).get_platform).to eq "PLATFORM"
+    end
+
+    it "should register an iphone on the project" do
+      expect(XCodeBuildHelper[:default].get_device(:iphone).get_os).to eq "7.0"
+    end
+
+    it "should not overwrite the device" do
+      XCodeBuildHelper.define :default do
+        device :ipad do
+          name "IPAD"
+        end
+      end
+      expect(XCodeBuildHelper[:default].get_device(:ipad).get_platform).to eq "PLATFORM"
+      expect(XCodeBuildHelper[:default].get_device(:ipad).get_name).to eq "IPAD"
+    end
+  end
+
+  context "register a test plan" do
+    before(:each) do
+      XCodeBuildHelper.define :default do
+        workspace "WORK SPACE"
+        scheme "SCHEME"
+        test_plan :plan_a do
+          report_type 'junit'
+        end
+      end
+    end
+
+    it "should register a test plan a on the project" do
+      report_type = XCodeBuildHelper[:default].get_test_plan(:plan_a).get_report_type
+      expect(report_type).to eq 'junit'
+    end
+
+    it "should not overwrite the test plan" do
+      XCodeBuildHelper.define :default do
+        test_plan :plan_a do
+        end
+      end
+
+      report_type = XCodeBuildHelper[:default].get_test_plan(:plan_a).get_report_type
+      expect(report_type).to eq 'junit'
+    end
+  end
+
+  context "register a coverage plan" do
+    before(:each) do
+      XCodeBuildHelper.define :default do
+        workspace "WORK SPACE"
+        scheme "SCHEME"
+        coverage_plan :plan_a do
+          source_files ['/path/to/files/*.m']
+          report_type "REPORT_TYPE"
+        end
+      end
+    end
+    it "should set the source files" do
+      expect(XCodeBuildHelper[:default].get_coverage_plan(:plan_a).get_source_files).to eq ['/path/to/files/*.m']
+    end
+
+    it "should not overwrite the coverage plan" do
+      XCodeBuildHelper.define :default do
+        coverage_plan :plan_a do
+          report_type "EXPECTED"
+        end
+      end
+
+      expect(XCodeBuildHelper[:default].get_coverage_plan(:plan_a).get_report_type).to eq "EXPECTED"
+      expect(XCodeBuildHelper[:default].get_coverage_plan(:plan_a).get_source_files).to eq ['/path/to/files/*.m']
+    end
+  end
+
+  context "register a lint plan" do
+    before(:each) do
+      XCodeBuildHelper.define :default do
+        workspace "WORK SPACE"
+        lint_plan :plan_a do
+          report_type "REPORT_TYPE"
+          output "OUTPUT"
+          ignore "IGNORE"
+          rules do
+            long_line 120
+            short_variable_name 3
+          end
+        end
+      end
+
+    end
+
+    it "should set the lint plan" do
+      expect(XCodeBuildHelper[:default].get_lint_plan(:plan_a).get_report_type).to eq "REPORT_TYPE"
+    end
+
+    it "should set the rules" do
+      expect(XCodeBuildHelper[:default].get_lint_plan(:plan_a).get_rules.get_long_line).to eq 120
+    end
+
+    it "should not overwrite the lint_plan" do
+      XCodeBuildHelper.define :default do
+        lint_plan :plan_a do
+          report_type "EXPECTED"
+        end
+      end
+
+      expect(XCodeBuildHelper[:default].get_lint_plan(:plan_a).get_report_type).to eq "EXPECTED"
+      expect(XCodeBuildHelper[:default].get_lint_plan(:plan_a).get_output).to eq "OUTPUT"
+    end
+
+    it "should not overwrite previous rules" do
+      XCodeBuildHelper.define :default do
+        lint_plan :plan_a do
+          rules do
+            long_line 100
+          end
+        end
+      end
+
+      expect(XCodeBuildHelper[:default].get_lint_plan(:plan_a).get_rules.get_long_line).to eq 100
+      expect(XCodeBuildHelper[:default].get_lint_plan(:plan_a).get_rules.get_short_variable_name).to eq 3
+    end
+  end
+
+  context "edit an existing build plan" do
+    it "should overwrite the workspace but not the scheme" do
+      XCodeBuildHelper.define :default do
+        workspace "WORK SPACE"
+        scheme "SCHEME"
+      end
+
+      XCodeBuildHelper.define :default do
+        workspace "EXPECTED"
+      end
+      expect(XCodeBuildHelper[:default].get_workspace).to eq "EXPECTED"
+      expect(XCodeBuildHelper[:default].get_scheme).to eq "SCHEME"
+    end
+  end
+end