cocoapods-binary-cache 0.1.1 → 0.1.7

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

@@ -4,65 +4,8 @@ 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-rome/xcodebuild_command.rb

@@ -0,0 +1,176 @@
+require_relative "xcodebuild_raw"
+
+class XcodebuildCommand
+  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 device_build_enabled?
+      build_for_sdk(device)
+      create_universal_framework
+      merge_dsym unless disable_dsym?
+      merge_swift_headers
+      merge_swift_modules
+    end
+    collect_output(Dir[target_products_dir_of(simulator) + "/*"])
+  end
+
+  private
+
+  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 "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
+    create_fat_binary(
+      simulator: "#{framework_path_of(simulator)}/#{module_name}",
+      device: "#{framework_path_of(device)}/#{module_name}"
+    )
+  end
+
+  def merge_dsym
+    simulator_dsym = framework_path_of(simulator) + ".dSYM"
+    device_dsym = framework_path_of(device) + ".dSYM"
+    return unless File.exist?(simulator_dsym) && File.exist?(device_dsym)
+
+    create_fat_binary(
+      simulator: "#{simulator_dsym}/Contents/Resources/DWARF/#{module_name}",
+      device: "#{device_dsym}/Contents/Resources/DWARF/#{module_name}"
+    )
+    collect_output(simulator_dsym)
+  end
+
+  def create_fat_binary(options)
+    cmd = ["lipo", " -create"]
+    cmd << "-output" << options[:simulator]
+    cmd << options[:simulator] << options[:device]
+    Pod::UI.puts `#{cmd.join(" ")}`
+  end
+
+  def merge_swift_headers
+    simulator_header_path = framework_path_of(simulator) + "/Headers/#{module_name}-Swift.h"
+    device_header_path = framework_path_of(device) + "/Headers/#{module_name}-Swift.h"
+    return unless File.exist?(simulator_header_path) && File.exist?(device_header_path)
+
+    merged_header = <<~HEREDOC
+      #if TARGET_OS_SIMULATOR // merged by cocoapods-binary
+      #{File.read(simulator_header_path)}
+      #else // merged by cocoapods-binary
+      #{File.read(device_header_path)}
+      #endif // merged by cocoapods-binary
+    HEREDOC
+    File.write(simulator_header_path, merged_header.strip)
+  end
+
+  def merge_swift_modules
+    simulator_swift_module_path = framework_path_of(simulator) + "/Modules/#{module_name}.swiftmodule"
+    device_swift_module_path = framework_path_of(device) + "/Modules/#{module_name}.swiftmodule"
+    return unless File.exist?(simulator_swift_module_path) && File.exist?(device_swift_module_path)
+
+    FileUtils.cp_r(
+      device_swift_module_path + "/.",
+      simulator_swift_module_path
+    )
+  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.mv(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(" ")
+
+  puts "xcodebuild command: #{cmd}"
+  log = `#{cmd}`
+
+  succeeded = $?.exitstatus.zero?
+  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
+      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,18 +7,17 @@ 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)
+      puts "Clean delta file: #{prebuild_delta_path}"
+      FileUtils.rm_rf(prebuild_delta_path)
     end
 
     def create_dir_if_needed(dir)
@@ -32,40 +31,12 @@ module PodPrebuild
         return
       end
 
-      Pod::UI.puts "Write prebuild changes to: #{delta_file_path}"
+      Pod::UI.puts "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

@@ -12,7 +12,7 @@ class SchemeEditor
       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']

data/lib/command/binary.rb

@@ -2,16 +2,35 @@ require "fileutils"
 require_relative "config"
 require_relative "fetch"
 require_relative "prebuild"
+require_relative "push"
 require_relative "visualize"
 
 module Pod
   class Command
     class Binary < Command
       self.abstract_command = true
-      self.default_subcommand = "fetch"
+      def self.options
+        [
+          ["--repo", "Cache repo (in accordance with `cache_repo` in `config_cocoapods_binary_cache`)"]
+        ]
+      end
+
+      def initialize(argv)
+        super
+        load_podfile
+        update_cli_config(:repo => argv.option("repo"))
+      end
 
       def prebuild_config
-        @prebuild_config ||= PodPrebuild::Config.new("PodBinaryCacheConfig.json")
+        @prebuild_config ||= PodPrebuild.config
+      end
+
+      def load_podfile
+        Pod::Config.instance.podfile
+      end
+
+      def update_cli_config(options)
+        PodPrebuild.config.cli_config.merge!(options)
       end
     end
   end

data/lib/command/config.rb

@@ -1,14 +1,43 @@
 require_relative "../cocoapods-binary-cache/helper/json"
 
 module PodPrebuild
+  def self.config
+    PodPrebuild::Config.instance
+  end
+
   class Config
-    attr_reader :cache_repo, :cache_path, :prebuild_path
+    attr_accessor :dsl_config, :cli_config
 
     def initialize(path)
-      @data = PodPrebuild::JSONFile.new(path)
-      @cache_repo = @data["cache_repo"] || @data["prebuilt_cache_repo"]
-      @cache_path = File.expand_path(@data["cache_path"])
-      @prebuild_path = @data["prebuild_path"] || "Pods/_Prebuild"
+      @deprecated_config = File.exist?(path) ? PodPrebuild::JSONFile.new(path).data : {}
+      @dsl_config = {}
+      @cli_config = {}
+    end
+
+    def self.instance
+      @instance ||= new("PodBinaryCacheConfig.json")
+    end
+
+    def reset!
+      @deprecated_config = {}
+      @dsl_config = {}
+      @cli_config = {}
+    end
+
+    def cache_repo
+      @cache_repo ||= cache_repo_config["remote"]
+    end
+
+    def cache_path
+      @cache_path ||= File.expand_path(cache_repo_config["local"])
+    end
+
+    def prebuild_sandbox_path
+      @dsl_config[:prebuild_sandbox_path] || @deprecated_config["prebuild_path"] || "_Prebuild"
+    end
+
+    def prebuild_delta_path
+      @dsl_config[:prebuild_delta_path] || @deprecated_config["prebuild_delta_path"] || "_Prebuild_delta/changes.json"
     end
 
     def manifest_path(in_cache: false)
@@ -16,16 +45,128 @@ module PodPrebuild
     end
 
     def root_dir(in_cache)
-      in_cache ? @cache_path : @prebuild_path
+      in_cache ? cache_path : prebuild_sandbox_path
     end
 
     def generated_frameworks_dir(in_cache: false)
       root_dir(in_cache) + "/GeneratedFrameworks"
     end
 
-    def delta_file_path
-      # TODO (thuyen): Unify this path with PodPrebuild::Output#delta_file_path
-      "Pods/_Prebuild_delta/changes.json"
+    def prebuilt_path(path: nil)
+      path.nil? ? "_Prebuilt" : "_Prebuilt/#{path}"
+    end
+
+    def validate_dsl_config
+      inapplicable_options = @dsl_config.keys - applicable_dsl_config
+      return if inapplicable_options.empty?
+
+      message = <<~HEREDOC
+        [WARNING] The following options (in `config_cocoapods_binary_cache`) are not correct: #{inapplicable_options}.
+        Available options: #{applicable_dsl_config}.
+        Check out the following doc for more details
+          https://github.com/grab/cocoapods-binary-cache/blob/master/docs/configure_cocoapods_binary_cache.md
+      HEREDOC
+
+      Pod::UI.puts message.yellow
+    end
+
+    def prebuild_config
+      @cli_config[:prebuild_config] || @dsl_config[:prebuild_config] || "Debug"
+    end
+
+    def prebuild_job?
+      @cli_config[:prebuild_job] || @dsl_config[:prebuild_job]
+    end
+
+    def prebuild_all_pods?
+      @cli_config[:prebuild_all_pods] || @dsl_config[:prebuild_all_pods]
+    end
+
+    def excluded_pods
+      @dsl_config[:excluded_pods] || Set.new
+    end
+
+    def dev_pods_enabled?
+      @dsl_config[:dev_pods_enabled]
+    end
+
+    def bitcode_enabled?
+      @dsl_config[:bitcode_enabled]
+    end
+
+    def device_build_enabled?
+      @dsl_config[:device_build_enabled]
+    end
+
+    def disable_dsym?
+      @dsl_config[:disable_dsym]
+    end
+
+    def dont_remove_source_code?
+      @dsl_config[:dont_remove_source_code]
+    end
+
+    def build_args
+      @dsl_config[:build_args]
+    end
+
+    def save_cache_validation_to
+      @dsl_config[:save_cache_validation_to]
+    end
+
+    def validate_prebuilt_settings
+      @dsl_config[:validate_prebuilt_settings]
+    end
+
+    def prebuild_code_gen
+      @dsl_config[:prebuild_code_gen]
+    end
+
+    def targets_to_prebuild_from_cli
+      @cli_config[:prebuild_targets] || []
+    end
+
+    private
+
+    def applicable_dsl_config
+      [
+        :cache_repo,
+        :prebuild_sandbox_path,
+        :prebuild_delta_path,
+        :prebuild_config,
+        :prebuild_job,
+        :prebuild_all_pods,
+        :excluded_pods,
+        :dev_pods_enabled,
+        :bitcode_enabled,
+        :device_build_enabled,
+        :disable_dsym,
+        :dont_remove_source_code,
+        :build_args,
+        :save_cache_validation_to,
+        :validate_prebuilt_settings,
+        :prebuild_code_gen
+      ]
+    end
+
+    def cache_repo_config
+      @cache_repo_config ||= begin
+        repo = @cli_config[:repo] || "default"
+        config_ = @dsl_config[:cache_repo] || {}
+        if config_[repo].nil?
+          message = <<~HEREDOC
+            [Deprecated] Configs in `PodBinaryCacheConfig.json` are deprecated.
+            Declare option `cache_repo` in `config_cocoapods_binary_cache` instead.
+            Check out the following doc for more details
+              https://github.com/grab/cocoapods-binary-cache/blob/master/docs/configure_cocoapods_binary_cache.md
+          HEREDOC
+          Pod::UI.puts message.yellow
+        end
+        config_[repo] || {
+          "remote" => @deprecated_config["cache_repo"] || @deprecated_config["prebuilt_cache_repo"],
+          "local" => @deprecated_config["cache_path"] || "~/.cocoapods-binary-cache/prebuilt-frameworks"
+        }
+      end
     end
   end
 end