cocoapods-binary-cache 0.1.2 → 0.1.8

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

@@ -0,0 +1,32 @@
+module PodPrebuild
+  class Env
+    @stage_idx = 0
+
+    class << self
+      def reset!
+        @stage_idx = 0
+        @stages = nil
+      end
+
+      def next_stage!
+        @stage_idx += 1 if @stage_idx < stages.count - 1
+      end
+
+      def stages
+        @stages ||= PodPrebuild.config.prebuild_job? ? [:prebuild, :integration] : [:integration]
+      end
+
+      def current_stage
+        stages[@stage_idx]
+      end
+
+      def prebuild_stage?
+        current_stage == :prebuild
+      end
+
+      def integration_stage?
+        current_stage == :integration
+      end
+    end
+  end
+end

data/lib/cocoapods-binary-cache/helper/checksum.rb

@@ -4,9 +4,15 @@
 require "digest/md5"
 
 class FolderChecksum
-  def self.checksum(dir)
-    files = Dir["#{dir}/**/*"].reject { |f| File.directory?(f) }
-    content = files.map { |f| File.read(f) }.join
-    Digest::MD5.hexdigest(content).to_s
+  def self.git_checksum(dir)
+    checksum_of_files(`git ls-files #{dir}`.split("\n"))
+  rescue => e
+    Pod::UI.warn "Cannot get checksum of tracked files under #{dir}: #{e}"
+    checksum_of_files(Dir["#{dir}/**/*"].reject { |f| File.directory?(f) })
+  end
+
+  def self.checksum_of_files(files)
+    checksums = files.sort.map { |f| Digest::MD5.hexdigest(File.read(f)) }
+    Digest::MD5.hexdigest(checksums.join)
   end
 end

data/lib/cocoapods-binary-cache/helper/lockfile.rb

@@ -1,3 +1,5 @@
+require_relative "checksum"
+
 module PodPrebuild
   class Lockfile
     attr_reader :lockfile, :data
@@ -15,6 +17,10 @@ module PodPrebuild
       @data["EXTERNAL SOURCES"] || {}
     end
 
+    def dev_pod_sources
+      @dev_pod_sources ||= external_sources.select { |_, attributes| attributes.key?(:path) } || {}
+    end
+
     def dev_pod_names
       # There are 2 types of external sources:
       # - Development pods: declared with `:path` option in Podfile, corresponding to `:path` in the Lockfile
@@ -27,7 +33,7 @@ module PodPrebuild
       #     :git: git@remote_url
       #     :commit: abc1234
       # --------------------
-      @dev_pod_names ||= external_sources.select { |_, attributes| attributes.key?(:path) }.keys.to_set
+      @dev_pod_names ||= dev_pod_sources.keys.to_set
     end
 
     def dev_pods
@@ -40,13 +46,30 @@ module PodPrebuild
       @non_dev_pods ||= pods.reject { |name, _| dev_pod_names_.include?(name) }
     end
 
+    def subspec_vendor_pods
+      dev_pod_names_ = dev_pod_names
+      @subspec_vendor_pods ||= subspec_pods.reject { |name, _| dev_pod_names_.include?(name) }
+    end
+
+    # Return content hash (Hash the directory at source path) of a dev_pod
+    # Return nil if it's not a dev_pod
+    def dev_pod_hash(pod_name)
+      dev_pod_hashes_map[pod_name]
+    end
+
+    private
+
     def subspec_pods
-      pods.keys
+      @subspec_pods ||= pods.keys
         .select { |k| k.include?("/") }
         .group_by { |k| k.split("/")[0] }
     end
 
-    private
+    # Generate a map between a dev_pod and it source hash
+    def dev_pod_hashes_map
+      @dev_pod_hashes_map ||=
+        dev_pod_sources.map { |name, attribs| [name, FolderChecksum.git_checksum(attribs[:path])] }.to_h
+    end
 
     # Parse an item under `PODS` section of a Lockfile
     # @param hash_or_string: an item under `PODS` section, could be a Hash (if having dependencies) or a String

data/lib/cocoapods-binary-cache/helper/podspec.rb

@@ -1,7 +1,11 @@
 module Pod
   class Specification
     def empty_source_files?
-      return subspecs.all?(&:empty_source_files?) unless subspecs.empty?
+
+      unless subspecs.empty?
+        # return early if there are some files in subpec(s) but process the spec itself
+        return false unless subspecs.all?(&:empty_source_files?)
+      end
 
       check = lambda do |patterns|
         patterns = [patterns] if patterns.is_a?(String)

data/lib/cocoapods-binary-cache/helper/prebuild_order.rb

@@ -0,0 +1,12 @@
+module PodPrebuild
+  module BuildOrder
+    def self.order_targets(targets)
+      # It's more efficient to build frameworks that have more dependencies first
+      # so that the build parallelism is ultilized
+      # >> --- MyFramework ----------------------------------|
+      #        >> --- ADependency ---|
+      #          >> --- AnotherADependency ---|
+      targets.sort_by { |t| -t.recursive_dependent_targets.count }
+    end
+  end
+end

data/lib/cocoapods-binary-cache/hooks/post_install.rb

@@ -5,12 +5,30 @@ module PodPrebuild
     end
 
     def run
-      return unless Pod::Podfile::DSL.dev_pods_enabled && @installer_context.sandbox.instance_of?(Pod::PrebuildSandbox)
+      edit_scheme_for_code_coverage if PodPrebuild::Env.prebuild_stage?
+      diagnose if PodPrebuild::Env.integration_stage?
+    end
+
+    private
+
+    def diagnose
+      Pod::UI.title("Diagnosing cocoapods-binary-cache") do
+        PodPrebuild::Diagnosis.new(
+          cache_validation: PodPrebuild.state.cache_validation,
+          standard_sandbox: @installer_context.sandbox,
+          specs: @installer_context.umbrella_targets.map(&:specs).flatten
+        ).run
+      end
+    end
+
+    def edit_scheme_for_code_coverage
+      return unless PodPrebuild.config.dev_pods_enabled?
+      return unless @installer_context.sandbox.instance_of?(Pod::PrebuildSandbox)
 
       # Modify pods scheme to support code coverage
       # If we don't prebuild dev pod -> no need to care about this in Pod project
       # because we setup in the main project (ex. DriverCI scheme)
-      SchemeEditor.edit_to_support_code_coverage(@installer_context.sandbox) if Pod.is_prebuild_stage
+      SchemeEditor.edit_to_support_code_coverage(@installer_context.sandbox)
     end
   end
 end

data/lib/cocoapods-binary-cache/hooks/pre_install.rb

@@ -13,18 +13,17 @@ module PodPrebuild
     end
 
     def run
-      require_relative "../pod-binary/helper/feature_switches"
-      return if Pod.is_prebuild_stage
+      return if @installer_context.sandbox.is_a?(Pod::PrebuildSandbox)
 
       log_section "🚀  Prebuild frameworks"
       ensure_valid_podfile
       save_installation_states
-      prepare_environment
       create_prebuild_sandbox
-      Pod::UI.section("Detect implicit dependencies") { detect_implicit_dependencies }
-      Pod::UI.section("Validate prebuilt cache") { validate_cache }
-      prebuild! if Pod::Podfile::DSL.prebuild_job?
-      reset_environment
+      Pod::UI.title("Detect implicit dependencies") { detect_implicit_dependencies }
+      Pod::UI.title("Validate prebuilt cache") { validate_cache }
+      prebuild! if PodPrebuild.config.prebuild_job?
+
+      PodPrebuild::Env.next_stage!
       log_section "🤖  Resume pod installation"
       require_relative "../pod-binary/integration"
     end
@@ -33,7 +32,6 @@ module PodPrebuild
 
     def save_installation_states
       save_pod_install_options
-      save_states_from_dsl
     end
 
     def save_pod_install_options
@@ -52,36 +50,10 @@ module PodPrebuild
       end
     end
 
-    def prepare_environment
-      Pod::UI.puts "Prepare environment"
-      Pod.is_prebuild_stage = true
-      Pod::Podfile::DSL.enable_prebuild_patch true  # enable sikpping for prebuild targets
-      Pod::Installer.force_disable_integration true # don't integrate targets
-      Pod::Config.force_disable_write_lockfile true # disbale write lock file for perbuild podfile
-      Pod::Installer.disable_install_complete_message true # disable install complete message
-    end
-
-    def reset_environment
-      Pod::UI.puts "Reset environment"
-      Pod.is_prebuild_stage = false
-      Pod::Installer.force_disable_integration false
-      Pod::Podfile::DSL.enable_prebuild_patch false
-      Pod::Config.force_disable_write_lockfile false
-      Pod::Installer.disable_install_complete_message false
-      Pod::UserInterface.warnings = [] # clean the warning in the prebuild step, it's duplicated.
-    end
-
-    def save_states_from_dsl
-      # Note: DSL is reloaded when creating an installer (Pod::Installer.new).
-      # Any mutation to DSL is highly discouraged
-      # --> Rather, perform mutation on PodPrebuild::StateStore instead
-      PodPrebuild::StateStore.excluded_pods += Pod::Podfile::DSL.excluded_pods
-    end
-
     def create_prebuild_sandbox
       standard_sandbox = installer_context.sandbox
       @prebuild_sandbox = Pod::PrebuildSandbox.from_standard_sandbox(standard_sandbox)
-      Pod::UI.puts "Create prebuild sandbox at #{@prebuild_sandbox.root}"
+      Pod::UI.message "Create prebuild sandbox at #{@prebuild_sandbox.root}"
     end
 
     def detect_implicit_dependencies
@@ -91,11 +63,9 @@ module PodPrebuild
         .group_by { |spec| spec.name.split("/")[0] }
         .select { |_, specs| specs.all?(&:empty_source_files?) }
         .keys
-
-      PodPrebuild::StateStore.excluded_pods += pods_with_empty_source_files
+      PodPrebuild.config.update_detected_excluded_pods!(pods_with_empty_source_files)
+      PodPrebuild.config.update_detected_prebuilt_pod_names!(@original_installer.prebuilt_pod_names)
       Pod::UI.puts "Exclude pods with empty source files: #{pods_with_empty_source_files.to_a}"
-
-      # TODO (thuyen): Detect dependencies of a prebuilt pod and treat them as prebuilt pods as well
     end
 
     def validate_cache
@@ -104,16 +74,16 @@ module PodPrebuild
         podfile: podfile,
         pod_lockfile: installer_context.lockfile,
         prebuilt_lockfile: prebuilt_lockfile,
-        validate_prebuilt_settings: Pod::Podfile::DSL.validate_prebuilt_settings,
+        validate_prebuilt_settings: PodPrebuild.config.validate_prebuilt_settings,
         generated_framework_path: prebuild_sandbox.generate_framework_path,
         sandbox_root: prebuild_sandbox.root,
-        ignored_pods: PodPrebuild::StateStore.excluded_pods,
-        prebuilt_pod_names: @original_installer.prebuilt_pod_names
+        ignored_pods: PodPrebuild.config.excluded_pods,
+        prebuilt_pod_names: PodPrebuild.config.prebuilt_pod_names
       ).validate
-      path_to_save_cache_validation = Pod::Podfile::DSL.save_cache_validation_to
+      path_to_save_cache_validation = PodPrebuild.config.save_cache_validation_to
       @cache_validation.update_to(path_to_save_cache_validation) unless path_to_save_cache_validation.nil?
       cache_validation.print_summary
-      PodPrebuild::StateStore.cache_validation = cache_validation
+      PodPrebuild.state.update(:cache_validation => cache_validation)
     end
 
     def prebuild!

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

@@ -9,13 +9,14 @@ require_relative "helper/json"
 require_relative "helper/lockfile"
 require_relative "helper/path_utils"
 require_relative "helper/podspec"
+require_relative "env"
 require_relative "state_store"
 require_relative "hooks/post_install"
 require_relative "hooks/pre_install"
 require_relative "pod-binary/prebuild_dsl"
 require_relative "pod-binary/prebuild_hook"
 require_relative "pod-binary/prebuild"
-require_relative "prebuild_cache"
 require_relative "prebuild_output/metadata"
 require_relative "prebuild_output/output"
 require_relative "scheme_editor"
+require_relative "diagnosis/diagnosis"

data/lib/cocoapods-binary-cache/pod-binary/helper/build.rb

@@ -0,0 +1,40 @@
+require_relative "../../pod-rome/xcodebuild_raw"
+require_relative "../../pod-rome/xcodebuild_command"
+
+module Pod
+  class Prebuild
+    def self.build(options)
+      target = options[:target]
+      return if target.nil?
+
+      Pod::UI.puts "Building target: #{target}...".magenta
+      options[:sandbox] = Pod::Sandbox.new(Pathname(options[:sandbox])) unless options[:sandbox].is_a?(Pod::Sandbox)
+      options[:build_dir] = build_dir(options[:sandbox].root)
+
+      case target.platform.name
+      when :ios, :tvos, :watchos
+        XcodebuildCommand.new(options).run
+      when :osx
+        xcodebuild(
+          sandbox: options[:sandbox],
+          target: target.label,
+          configuration: options[:configuration],
+          sdk: "macosx",
+          args: options[:args]
+        )
+      else
+        raise "Unsupported platform for '#{target.name}': '#{target.platform.name}'"
+      end
+      raise "The build directory was not found in the expected location" unless options[:build_dir].directory?
+    end
+
+    def self.remove_build_dir(sandbox_root)
+      path = build_dir(sandbox_root)
+      path.rmtree if path.exist?
+    end
+
+    def self.build_dir(sandbox_root)
+      sandbox_root.parent + "build"
+    end
+  end
+end

data/lib/cocoapods-binary-cache/pod-binary/helper/detected_prebuilt_pods/installer.rb

@@ -3,7 +3,7 @@ module Pod
     # Returns the names of pod targets detected as prebuilt, including
     # those declared in Podfile and their dependencies
     def prebuilt_pod_names
-      prebuilt_pod_targets.map(&:name)
+      prebuilt_pod_targets.map(&:name).to_set
     end
 
     # Returns the pod targets detected as prebuilt, including
@@ -17,7 +17,7 @@ module Pod
         targets = pod_targets.select { |target| explicit_prebuilt_pod_names.include?(target.pod_name) }
         dependencies = targets.flat_map(&:recursive_dependent_targets) # Treat dependencies as prebuilt pods
         all = (targets + dependencies).uniq
-        all = all.reject { |target| sandbox.local?(target.pod_name) } unless Podfile::DSL.dev_pods_enabled?
+        all = all.reject { |target| sandbox.local?(target.pod_name) } unless PodPrebuild.config.dev_pods_enabled?
         all
       end
     end

data/lib/cocoapods-binary-cache/pod-binary/helper/detected_prebuilt_pods/target_definition.rb

@@ -3,20 +3,13 @@ module Pod
     class TargetDefinition
       def detect_prebuilt_pod(name, requirements)
         @explicit_prebuilt_pod_names ||= []
-        options = requirements.last
-        if Pod::Podfile::DSL.prebuild_all?
-          @explicit_prebuilt_pod_names << Specification.root_name(name)
-        elsif options.is_a?(Hash) && options[:binary]
-          @explicit_prebuilt_pod_names << Specification.root_name(name)
-        end
+        options = requirements.last || {}
+        @explicit_prebuilt_pod_names << Specification.root_name(name) if options.is_a?(Hash) && options[:binary]
         options.delete(:binary) if options.is_a?(Hash)
         requirements.pop if options.empty?
       end
 
-      # Returns the names of pod targets explicitly declared as prebuilt in Podfile
-      # using `:binary => true`.
-      # In case `prebuild_all` is ON via `config_cocoapods_binary_cache`, returns the
-      # name of all pod targets
+      # Returns the names of pod targets explicitly declared as prebuilt in Podfile using `:binary => true`.
       def explicit_prebuilt_pod_names
         names = @explicit_prebuilt_pod_names || []
         names += parent.explicit_prebuilt_pod_names if !parent.nil? && parent.is_a?(TargetDefinition)

data/lib/cocoapods-binary-cache/pod-binary/helper/names.rb

@@ -18,19 +18,10 @@
 module Pod
   def self.fast_get_targets_for_pod_name(pod_name, targets, cache)
     pod_name = pod_name.split("/")[0] # Look for parent spec instead of subspecs
-    pod_name_to_targets_hash = nil
     if cache.empty?
-      pod_name_to_targets_hash = targets.reduce({}) do |sum, target|
-        array = sum[target.pod_name] || []
-        array << target
-        sum[target.pod_name] = array
-        sum
-      end
-      cache << pod_name_to_targets_hash
+      targets.select { |target| target.name == pod_name }
     else
-      pod_name_to_targets_hash = cache.first
+      cache.first[pod_name] || []
     end
-
-    pod_name_to_targets_hash[pod_name] || []
   end
 end

data/lib/cocoapods-binary-cache/pod-binary/helper/prebuild_sandbox.rb

@@ -2,46 +2,46 @@ require_relative "names"
 
 module Pod
   class PrebuildSandbox < Sandbox
-
     # [String] standard_sandbox_path
     def self.from_standard_sanbox_path(path)
-      prebuild_sandbox_path = Pathname.new(path).realpath + "_Prebuild"
-      self.new(prebuild_sandbox_path)
+      prebuild_sandbox_path = Pathname.new(path).realpath + ".." + PodPrebuild.config.prebuild_sandbox_path
+      new(prebuild_sandbox_path)
     end
 
     def self.from_standard_sandbox(sandbox)
-      self.from_standard_sanbox_path(sandbox.root)
+      from_standard_sanbox_path(sandbox.root)
     end
 
     def standard_sanbox_path
-      self.root.parent
+      root.parent
     end
 
     def generate_framework_path
-      self.root + "GeneratedFrameworks"
+      root + "GeneratedFrameworks"
     end
 
     # @param name [String] pass the target.name (may containing platform suffix)
     # @return [Pathname] the folder containing the framework file.
     def framework_folder_path_for_target_name(name)
-      self.generate_framework_path + name
+      generate_framework_path + name
     end
 
     def exsited_framework_target_names
-      exsited_framework_name_pairs.map { |pair| pair[0] }.uniq
+      existed_framework_name_pairs.map { |pair| pair[0] }.uniq
     end
 
     def exsited_framework_pod_names
-      exsited_framework_name_pairs.map { |pair| pair[1] }.uniq
+      existed_framework_name_pairs.map { |pair| pair[1] }.uniq
     end
 
     def existed_target_names_for_pod_name(pod_name)
-      exsited_framework_name_pairs.select { |pair| pair[1] == pod_name }.map { |pair| pair[0] }
+      existed_framework_name_pairs.select { |pair| pair[1] == pod_name }.map { |pair| pair[0] }
     end
 
     def save_pod_name_for_target(target)
       folder = framework_folder_path_for_target_name(target.name)
       return unless folder.exist?
+
       flag_file_path = folder + "#{target.pod_name}.pod_name"
       File.write(flag_file_path.to_s, "")
     end
@@ -54,16 +54,16 @@ module Pod
       end
       name = name.basename(".pod_name").to_s unless name.nil?
       name ||= Pathname.new(target_folder_path).basename.to_s # for compatibility with older version
+      name
     end
 
     # Array<[target_name, pod_name]>
-    def exsited_framework_name_pairs
+    def existed_framework_name_pairs
       return [] unless generate_framework_path.exist?
-      generate_framework_path.children().map do |framework_path|
-        if framework_path.directory? && (not framework_path.children.empty?)
+
+      generate_framework_path.children.map do |framework_path|
+        if framework_path.directory? && !framework_path.children.empty?
           [framework_path.basename.to_s, pod_name_for_target_folder(framework_path)]
-        else
-          nil
         end
       end.reject(&:nil?).uniq
     end