cocoapods-binary-cache 0.1.2 → 0.1.8

data/lib/cocoapods-binary-cache/pod-binary/prebuild_dsl.rb

@@ -1,68 +1,9 @@
-require_relative "tool/tool"
-
 module Pod
   class Podfile
     module DSL
       def config_cocoapods_binary_cache(options)
-        apply_config = lambda do |config|
-          DSL.send("#{config}=", options[config]) unless options[config].nil?
-        end
-
-        apply_config.call(:prebuild_config)
-        apply_config.call(:prebuild_job)
-        apply_config.call(:prebuild_all) # TODO (thuyen): Revise this option
-        apply_config.call(:prebuild_all_vendor_pods)
-        apply_config.call(:excluded_pods)
-        apply_config.call(:dev_pods_enabled)
-        apply_config.call(:bitcode_enabled)
-        apply_config.call(:dont_remove_source_code)
-        apply_config.call(:custom_device_build_options)
-        apply_config.call(:custom_simulator_build_options)
-        apply_config.call(:save_cache_validation_to)
-        apply_config.call(:validate_prebuilt_settings)
-      end
-
-      @prebuild_config = "Debug"
-      @prebuild_job = false
-      @prebuild_all = false
-      @prebuild_all_vendor_pods = false
-      @excluded_pods = Set.new
-      @dev_pods_enabled = false
-      @bitcode_enabled = false
-      @dont_remove_source_code = false
-      @custom_device_build_options = []
-      @custom_simulator_build_options = []
-      @save_cache_validation_to = nil
-      # A proc to validate the provided build settings (per target) with the build settings of the prebuilt frameworks
-      # For example, in Podfile:
-      # -----------------------------------------------
-      #   validate_prebuilt_settings do |target|
-      #     settings = {}
-      #     settings["MACH_O_TYPE"] == "staticlib"
-      #     settings["SWIFT_VERSION"] == swift_version_of(target)
-      #     settings
-      #   end
-      # -----------------------------------------------
-      @validate_prebuilt_settings = nil
-
-      class << self
-        attr_accessor :prebuild_config
-        attr_accessor :prebuild_job
-        attr_accessor :prebuild_all
-        attr_accessor :prebuild_all_vendor_pods
-        attr_accessor :excluded_pods
-        attr_accessor :dev_pods_enabled
-        attr_accessor :bitcode_enabled
-        attr_accessor :dont_remove_source_code
-        attr_accessor :custom_device_build_options
-        attr_accessor :custom_simulator_build_options
-        attr_accessor :save_cache_validation_to
-        attr_accessor :validate_prebuilt_settings
-
-        alias prebuild_job? prebuild_job
-        alias prebuild_all? prebuild_all
-        alias prebuild_all_vendor_pods? prebuild_all_vendor_pods
-        alias dev_pods_enabled? dev_pods_enabled
+        PodPrebuild.config.dsl_config = options
+        PodPrebuild.config.validate_dsl_config
       end
     end
   end

data/lib/cocoapods-binary-cache/pod-binary/prebuild_hook.rb

@@ -1,4 +1,3 @@
-require_relative "helper/passer"
 require_relative "helper/podfile_options"
 require_relative "helper/prebuild_sandbox"
 

data/lib/cocoapods-binary-cache/pod-rome/xcodebuild_command.rb

@@ -0,0 +1,192 @@
+require_relative "xcodebuild_raw"
+
+class XcodebuildCommand # rubocop:disable Metrics/ClassLength
+  def initialize(options)
+    @options = options
+    case options[:target].platform.name
+    when :ios
+      @options[:device] = "iphoneos"
+      @options[:simulator] = "iphonesimulator"
+    when :tvos
+      @options[:device] = "appletvos"
+      @options[:simulator] = "appletvsimulator"
+    when :watchos
+      @options[:device] = "watchos"
+      @options[:simulator] = "watchsimulator"
+    end
+    @build_args = make_up_build_args(options[:args] || {})
+  end
+
+  def run
+    build_for_sdk(simulator) if build_types.include?(:simulator)
+    build_for_sdk(device) if build_types.include?(:device)
+
+    case build_types
+    when [:simulator]
+      collect_output(Dir[target_products_dir_of(simulator) + "/*"])
+    when [:device]
+      collect_output(Dir[target_products_dir_of(device) + "/*"])
+    else
+      # When merging contents of `simulator` & `device`, prefer contents of `device` over `simulator`
+      # https://github.com/grab/cocoapods-binary-cache/issues/25
+      collect_output(Dir[target_products_dir_of(device) + "/*"])
+      create_universal_framework
+    end
+  end
+
+  private
+
+  def build_types
+    @build_types ||= begin
+      # TODO (thuyen): Add DSL options `build_for_types` to specify build types
+      types = [:simulator]
+      types << :device if device_build_enabled?
+      types
+    end
+  end
+
+  def make_up_build_args(args)
+    args_ = args.clone
+    args_[:default] ||= []
+    args_[:simulator] ||= []
+    args_[:device] ||= []
+    args_[:default] += ["BITCODE_GENERATION_MODE=bitcode"] if bitcode_enabled?
+    args_[:default] += ["DEBUG_INFORMATION_FORMAT=dwarf"] if disable_dsym?
+    args_[:simulator] += ["ARCHS=x86_64", "ONLY_ACTIVE_ARCH=NO"] if simulator == "iphonesimulator"
+    args_[:simulator] += args_[:default]
+    args_[:device] += args_[:default]
+    args_
+  end
+
+  def build_for_sdk(sdk)
+    framework_path = framework_path_of(sdk)
+    if Dir.exist?(framework_path)
+      Pod::UI.puts_indented "--> Framework already exists at: #{framework_path}"
+      return
+    end
+
+    succeeded, = xcodebuild(
+      sandbox: sandbox,
+      target: target.label,
+      configuration: configuration,
+      sdk: sdk,
+      deployment_target: target.platform.deployment_target.to_s,
+      args: sdk == simulator ? @build_args[:simulator] : @build_args[:device]
+    )
+    raise "Build framework failed: #{target.label}" unless succeeded
+  end
+
+  def create_universal_framework
+    merge_framework_binary
+    merge_framework_dsym
+    merge_swift_headers
+    merge_swift_modules
+  end
+
+  def merge_framework_binary
+    merge_contents("/#{module_name}", &method(:create_fat_binary))
+  end
+
+  def merge_framework_dsym
+    merge_contents(".dSYM/Contents/Resources/DWARF/#{module_name}", &method(:create_fat_binary))
+  end
+
+  def merge_swift_headers
+    merge_contents("/Headers/#{module_name}-Swift.h") do |options|
+      merged_header = <<~HEREDOC
+        #if TARGET_OS_SIMULATOR // merged by cocoapods-binary
+        #{File.read(options[:simulator])}
+        #else // merged by cocoapods-binary
+        #{File.read(options[:device])}
+        #endif // merged by cocoapods-binary
+      HEREDOC
+      File.write(options[:output], merged_header.strip)
+    end
+  end
+
+  def merge_swift_modules
+    merge_contents("/Modules/#{module_name}.swiftmodule") do |options|
+      # Note: swiftmodules of `device` were copied beforehand,
+      # here, we only need to copy swiftmodules of `simulator`
+      FileUtils.cp_r(options[:simulator] + "/.", options[:output])
+    end
+  end
+
+  def merge_contents(path_suffix, &merger)
+    simulator_, device_, output_ = [
+      framework_path_of(simulator),
+      framework_path_of(device),
+      "#{output_path}/#{module_name}.framework"
+    ].map { |p| p + path_suffix }
+    return unless File.exist?(simulator_) && File.exist?(device_)
+
+    merger.call(simulator: simulator_, device: device_, output: output_)
+  end
+
+  def create_fat_binary(options)
+    cmd = ["lipo", " -create"]
+    cmd << "-output" << options[:output]
+    cmd << options[:simulator] << options[:device]
+    Pod::UI.puts `#{cmd.join(" ")}`
+  end
+
+  def collect_output(paths)
+    paths = [paths] unless paths.is_a?(Array)
+    paths.each do |path|
+      FileUtils.rm_rf(File.join(output_path, File.basename(path)))
+      FileUtils.cp_r(path, output_path)
+    end
+  end
+
+  def target_products_dir_of(sdk)
+    "#{build_dir}/#{configuration}-#{sdk}/#{target.name}"
+  end
+
+  def framework_path_of(sdk)
+    "#{target_products_dir_of(sdk)}/#{module_name}.framework"
+  end
+
+  def module_name
+    target.product_module_name
+  end
+
+  def sandbox
+    @options[:sandbox]
+  end
+
+  def build_dir
+    @options[:build_dir]
+  end
+
+  def output_path
+    @options[:output_path]
+  end
+
+  def target
+    @options[:target]
+  end
+
+  def configuration
+    @options[:configuration]
+  end
+
+  def bitcode_enabled?
+    @options[:bitcode_enabled]
+  end
+
+  def device_build_enabled?
+    @options[:device_build_enabled]
+  end
+
+  def device
+    @options[:device] || "iphoneos"
+  end
+
+  def simulator
+    @options[:simulator] || "iphonesimulator"
+  end
+
+  def disable_dsym?
+    @options[:disable_dsym]
+  end
+end

data/lib/cocoapods-binary-cache/pod-rome/xcodebuild_raw.rb

@@ -0,0 +1,43 @@
+require "fourflusher"
+
+PLATFORM_OF_SDK = {
+  "iphonesimulator" => "iOS",
+  "appletvsimulator" => "tvOS",
+  "watchsimulator" => "watchOS"
+}.freeze
+
+def xcodebuild(options)
+  sdk = options[:sdk] || "iphonesimulator"
+  platform = PLATFORM_OF_SDK[sdk]
+
+  cmd = ["xcodebuild"]
+  cmd << "-project" << options[:sandbox].project_path.realdirpath
+  cmd << "-scheme" << options[:target]
+  cmd << "-configuration" << options[:configuration]
+  cmd << "-sdk" << sdk
+  cmd << Fourflusher::SimControl.new.destination(:oldest, platform, options[:deployment_target]) unless platform.nil?
+  cmd += options[:args] if options[:args]
+  cmd << "2>&1"
+  cmd = cmd.join(" ")
+
+  Pod::UI.puts_indented "$ #{cmd}"
+  log = `#{cmd}`
+
+  succeeded = $?.exitstatus.zero? # rubocop:disable Style/SpecialGlobalVars
+  unless succeeded
+    begin
+      raise "Unexpected error" unless log.include?("** BUILD FAILED **")
+
+      require "xcpretty" # TODO (thuyen): Revise this dependency
+      # use xcpretty to print build log
+      # 64 represent command invalid. http://www.manpagez.com/man/3/sysexits/
+      printer = XCPretty::Printer.new({:formatter => XCPretty::Simple, :colorize => "auto"})
+      log.each_line do |line|
+        printer.pretty_print(line)
+      end
+    rescue
+      Pod::UI.puts log.red
+    end
+  end
+  [succeeded, log]
+end

data/lib/cocoapods-binary-cache/prebuild_output/metadata.rb

@@ -43,5 +43,21 @@ module PodPrebuild
     def build_settings=(value)
       @data["build_settings"] = value
     end
+
+    def source_hash
+      @data["source_hash"] || {}
+    end
+
+    def source_hash=(value)
+      @data["source_hash"] = value
+    end
+
+    def project_root
+      @data["project_root"]
+    end
+
+    def project_root=(value)
+      @data["project_root"] = value
+    end
   end
 end

data/lib/cocoapods-binary-cache/prebuild_output/output.rb

@@ -7,65 +7,38 @@ module PodPrebuild
       @sandbox = prebuild_sandbox
     end
 
-    def delta_dir
-      @delta_dir ||= File.expand_path("#{@sandbox.root}/../_Prebuild_delta")
+    def prebuild_delta_path
+      @prebuild_delta_path ||= PodPrebuild.config.prebuild_delta_path
     end
 
-    def delta_file_path
-      # TODO (thuyen): Unify this path with PodPrebuild::Config#delta_file_path
-      "#{delta_dir}/changes.json"
+    def delta_dir
+      @delta_dir ||= File.dirname(prebuild_delta_path)
     end
 
     def clean_delta_file
-      puts "Clean delta file: #{delta_file_path}"
-      FileUtils.rm_rf(delta_file_path)
+      Pod::UI.message "Clean delta file: #{prebuild_delta_path}"
+      FileUtils.rm_rf(prebuild_delta_path)
     end
 
     def create_dir_if_needed(dir)
       FileUtils.mkdir_p dir unless File.directory?(dir)
     end
 
-    # Input 2 arrays of library names
-    def write_delta_file(updated, deleted)
+    def write_delta_file(options)
+      updated = options[:updated]
+      deleted = options[:deleted]
+
       if updated.empty? && deleted.empty?
         Pod::UI.puts "No changes in prebuild"
         return
       end
 
-      Pod::UI.puts "Write prebuild changes to: #{delta_file_path}"
+      Pod::UI.message "Write prebuild changes to: #{prebuild_delta_path}"
       create_dir_if_needed(delta_dir)
-      changes = PodPrebuild::JSONFile.new(delta_file_path)
+      changes = PodPrebuild::JSONFile.new(prebuild_delta_path)
       changes["updated"] = updated
       changes["deleted"] = deleted
       changes.save!
     end
-
-    def process_prebuilt_dev_pods
-      devpod_output_path = "#{delta_dir}/devpod_prebuild_output/"
-      create_dir_if_needed(devpod_output_path)
-      Pod::UI.puts "Copy prebuilt devpod frameworks to output dir: #{devpod_output_path}"
-
-      # Inject project path (where the framework is built) to support generating code coverage later
-      project_root = PathUtils.remove_last_path_component(@sandbox.standard_sanbox_path.to_s)
-      template_file_path = devpod_output_path + "prebuilt_map"
-      File.open(template_file_path, "w") do |file|
-        file.write(project_root)
-      end
-
-      # FIXME (thuyen): Revise usage of cache_miss_dev_pods_dic
-      # The behavior of processing outputs of dev pods and non-dev pods should be very SIMILAR
-      cache_miss_dev_pods_dic = {}
-
-      cache_miss_dev_pods_dic.each do |name, hash|
-        Pod::UI.puts "Output dev pod lib: #{name} hash: #{hash}"
-        built_lib_path = @sandbox.framework_folder_path_for_target_name(name)
-        next unless File.directory?(built_lib_path)
-
-        FileUtils.cp(template_file_path, "#{built_lib_path}/#{name}.framework")
-        target_dir = "#{devpod_output_path}#{name}_#{hash}"
-        Pod::UI.puts "From: #{built_lib_path} -> #{target_dir}"
-        FileUtils.cp_r(built_lib_path, target_dir)
-      end
-    end
   end
 end

data/lib/cocoapods-binary-cache/scheme_editor.rb

@@ -1,35 +1,36 @@
 # Copyright 2019 Grabtaxi Holdings PTE LTE (GRAB), All rights reserved.
 # Use of this source code is governed by an MIT-style license that can be found in the LICENSE file
 
-require 'rexml/document'
+require "rexml/document"
 
 class SchemeEditor
   def self.edit_to_support_code_coverage(sandbox)
     pod_proj_path = sandbox.project_path
-    puts "Modify schemes of pod project to support code coverage of prebuilt local pod: #{pod_proj_path}"
+    Pod::UI.message "Modify schemes of pod project to support code coverage of prebuilt local pod: #{pod_proj_path}"
     scheme_files = Dir["#{pod_proj_path}/**/*.xcscheme"]
     scheme_files.each do |file_path|
-      scheme_name = File.basename(file_path, '.*')
+      scheme_name = File.basename(file_path, ".*")
       next unless sandbox.local?(scheme_name)
 
-      puts "Modify scheme to enable coverage symbol when prebuild: #{scheme_name}"
+      Pod::UI.message "Modify scheme to enable coverage symbol when prebuild: #{scheme_name}"
 
-      doc = File.open(file_path, 'r') { |f| REXML::Document.new(f) }
-      scheme = doc.elements['Scheme']
-      test_action = scheme.elements['TestAction']
-      next if test_action.attributes['codeCoverageEnabled'] == 'YES'
+      doc = File.open(file_path, "r") { |f| REXML::Document.new(f) }
+      scheme = doc.elements["Scheme"]
+      test_action = scheme.elements["TestAction"]
+      next if test_action.attributes["codeCoverageEnabled"] == "YES"
 
-      test_action.add_attribute('codeCoverageEnabled', 'YES')
-      test_action.add_attribute('onlyGenerateCoverageForSpecifiedTargets', 'YES')
-      coverage_targets = REXML::Element.new('CodeCoverageTargets')
-      buildable_ref = scheme.elements['BuildAction'] \
-                            .elements['BuildActionEntries'] \
-                            .elements['BuildActionEntry'] \
-                            .elements['BuildableReference']
+      test_action.add_attribute("codeCoverageEnabled", "YES")
+      test_action.add_attribute("onlyGenerateCoverageForSpecifiedTargets", "YES")
+      coverage_targets = REXML::Element.new("CodeCoverageTargets")
+      buildable_ref = scheme
+        .elements["BuildAction"]
+        .elements["BuildActionEntries"]
+        .elements["BuildActionEntry"]
+        .elements["BuildableReference"]
       new_buildable_ref = buildable_ref.clone # Need to clone, otherwise the original one will be move to new place
       coverage_targets.add_element(new_buildable_ref)
       test_action.add_element(coverage_targets)
-      File.open(file_path, 'w') { |f| doc.write(f) }
+      File.open(file_path, "w") { |f| doc.write(f) }
     end
   end
 end