cocoapods-binary-cache 0.1.1

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

@@ -0,0 +1,49 @@
+# 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 'json'
+require 'cocoapods'
+require_relative "helper/checksum"
+
+class PodCacheValidator
+
+  # Cache miss/hit checking for development pods
+  # Return 2 Hashes for cache miss and cache hit libraries
+  def self.verify_devpod_checksum(sandbox_root, generated_framework_path, lock_file)
+    devpod_path = "#{sandbox_root}/devpod/"
+    target_path = generated_framework_path
+    Pod::UI.puts "verify_devpod_checksum: #{devpod_path}"
+    external_sources = lock_file.to_hash["EXTERNAL SOURCES"]
+    unless File.directory?(target_path)
+      FileUtils.mkdir_p(target_path)
+    end
+    missing_pods_dic = Hash[]
+    dev_pods_count = 0
+    cachehit_pods_dic = Hash[]
+    if !external_sources
+      Pod::UI.puts 'No development pods!'
+      return missing_pods_dic, cachehit_pods
+    end
+    external_sources.each do |name, attribs|
+      if attribs.class == Hash
+        path = attribs[:path]
+        if path
+          hash = FolderChecksum.checksum(path)
+          dev_pods_count += 1
+          cached_path = "#{devpod_path}#{name}_#{hash}"
+          if !Dir.exists?(cached_path)
+            missing_pods_dic[name] = hash
+          else
+            cachehit_pods_dic[name] = hash
+            target_dir = "#{target_path}/#{name}"
+            FileUtils.rm_r(target_dir, :force => true)
+            FileUtils.cp_r(cached_path, target_dir)
+          end
+        end
+      else
+        Pod::UI.puts "Error, wrong type: #{attribs}"
+      end
+    end
+    return missing_pods_dic, cachehit_pods_dic
+  end
+end

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

@@ -0,0 +1,47 @@
+module PodPrebuild
+  class Metadata < JSONFile
+    def self.in_dir(dir)
+      PodPrebuild::Metadata.new(dir + "metadata.json")
+    end
+
+    def resources
+      @data["resources"] || []
+    end
+
+    def resources=(value)
+      @data["resources"] = value
+    end
+
+    def framework_name
+      @data["framework_name"]
+    end
+
+    def framework_name=(value)
+      @data["framework_name"] = value
+    end
+
+    def static_framework?
+      @data["static_framework"] || false
+    end
+
+    def static_framework=(value)
+      @data["static_framework"] = value
+    end
+
+    def resource_bundles
+      @data["resource_bundles"] || []
+    end
+
+    def resource_bundles=(value)
+      @data["resource_bundles"] = value
+    end
+
+    def build_settings
+      @data["build_settings"] || {}
+    end
+
+    def build_settings=(value)
+      @data["build_settings"] = value
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+# 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
+
+module PodPrebuild
+  class Output
+    def initialize(prebuild_sandbox)
+      @sandbox = prebuild_sandbox
+    end
+
+    def delta_dir
+      @delta_dir ||= File.expand_path("#{@sandbox.root}/../_Prebuild_delta")
+    end
+
+    def delta_file_path
+      # TODO (thuyen): Unify this path with PodPrebuild::Config#delta_file_path
+      "#{delta_dir}/changes.json"
+    end
+
+    def clean_delta_file
+      puts "Clean delta file: #{delta_file_path}"
+      FileUtils.rm_rf(delta_file_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)
+      if updated.empty? && deleted.empty?
+        Pod::UI.puts "No changes in prebuild"
+        return
+      end
+
+      Pod::UI.puts "Write prebuild changes to: #{delta_file_path}"
+      create_dir_if_needed(delta_dir)
+      changes = PodPrebuild::JSONFile.new(delta_file_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

@@ -0,0 +1,35 @@
+# 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'
+
+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}"
+    scheme_files = Dir["#{pod_proj_path}/**/*.xcscheme"]
+    scheme_files.each do |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}"
+
+      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']
+      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) }
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module PodPrebuild
+  class StateStore
+    @excluded_pods = Set.new
+    @cache_validation = CacheValidationResult.new
+
+    class << self
+      attr_accessor :excluded_pods
+      attr_accessor :cache_validation
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Pod
+  module UI
+    class << self
+      def step(message)
+        section("❯❯❯ Step: #{message}".magenta) { yield if block_given? }
+      end
+    end
+  end
+end

data/lib/cocoapods_plugin.rb

@@ -0,0 +1,5 @@
+# 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 "cocoapods-binary-cache/main"
+require "command/binary"

data/lib/command/binary.rb

@@ -0,0 +1,18 @@
+require "fileutils"
+require_relative "config"
+require_relative "fetch"
+require_relative "prebuild"
+require_relative "visualize"
+
+module Pod
+  class Command
+    class Binary < Command
+      self.abstract_command = true
+      self.default_subcommand = "fetch"
+
+      def prebuild_config
+        @prebuild_config ||= PodPrebuild::Config.new("PodBinaryCacheConfig.json")
+      end
+    end
+  end
+end

data/lib/command/config.rb

@@ -0,0 +1,31 @@
+require_relative "../cocoapods-binary-cache/helper/json"
+
+module PodPrebuild
+  class Config
+    attr_reader :cache_repo, :cache_path, :prebuild_path
+
+    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"
+    end
+
+    def manifest_path(in_cache: false)
+      root_dir(in_cache) + "/Manifest.lock"
+    end
+
+    def root_dir(in_cache)
+      in_cache ? @cache_path : @prebuild_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"
+    end
+  end
+end

data/lib/command/executor/base.rb

@@ -0,0 +1,20 @@
+module PodPrebuild
+  class CommandExecutor
+    def initialize(options)
+      @config = options[:config]
+    end
+
+    def git(cmd, options = {})
+      comps = ["git"]
+      comps << "-C" << @config.cache_path unless options[:cache_repo] == false
+      comps << cmd
+      comps << "&> /dev/null" if options[:ignore_output]
+      comps << "|| true" if options[:can_fail]
+      `#{comps.join(" ")}`
+    end
+
+    def git_clone(cmd, options = {})
+      git("clone #{cmd}", options.merge(:cache_repo => false))
+    end
+  end
+end

data/lib/command/executor/fetcher.rb

@@ -0,0 +1,44 @@
+require_relative "base"
+require_relative "../helper/zip"
+
+module PodPrebuild
+  class CacheFetcher < CommandExecutor
+    def initialize(options)
+      super(options)
+      @cache_branch = options[:cache_branch]
+    end
+
+    def run
+      Pod::UI.step("Fetching cache") do
+        fetch_cache(@config.cache_repo, @cache_branch, @config.cache_path)
+        unzip_cache
+      end
+    end
+
+    private
+
+    def fetch_cache(repo, branch, dest_dir)
+      Pod::UI.puts "Fetching cache from #{repo} (branch: #{branch})".green
+      if Dir.exist?(dest_dir + "/.git")
+        git("fetch origin #{branch}")
+        git("checkout -f FETCH_HEAD", ignore_output: true)
+        git("branch -D #{branch} || true", ignore_output: true, can_fail: true)
+        git("checkout -b #{branch}")
+      else
+        FileUtils.rm_rf(dest_dir)
+        git_clone("--depth=1 --branch=#{branch} #{repo} #{dest_dir}")
+      end
+    end
+
+    def unzip_cache
+      Pod::UI.puts "Unzipping cache: #{@config.cache_path} -> #{@config.prebuild_path}".green
+      FileUtils.rm_rf(@config.prebuild_path)
+      FileUtils.mkdir_p(@config.prebuild_path)
+
+      FileUtils.cp(@config.manifest_path(in_cache: true), @config.manifest_path)
+      Dir[@config.generated_frameworks_dir(in_cache: true) + "/*.zip"].each do |path|
+        ZipUtils.unzip(path, to_dir: @config.generated_frameworks_dir)
+      end
+    end
+  end
+end

data/lib/command/executor/prebuilder.rb

@@ -0,0 +1,58 @@
+require_relative "base"
+require_relative "fetcher"
+require_relative "pusher"
+
+module PodPrebuild
+  class CachePrebuilder < CommandExecutor
+    def initialize(options)
+      super(options)
+      @cache_branch = options[:cache_branch]
+      @push_cache = options[:push_cache]
+      @fetcher = PodPrebuild::CacheFetcher.new(options)
+      @pusher = PodPrebuild::CachePusher.new(options)
+    end
+
+    def run
+      @fetcher.run
+      prebuild
+      changes = PodPrebuild::JSONFile.new(@config.delta_file_path)
+      return if changes.empty?
+
+      sync_cache(changes)
+      @pusher.run if @push_cache
+    end
+
+    private
+
+    def prebuild
+      Pod::UI.step("Installation") do
+        Pod::Command::Install.new(CLAide::ARGV.new([])).run
+      end
+    end
+
+    def sync_cache(changes)
+      Pod::UI.step("Syncing cache") do
+        FileUtils.cp(@config.manifest_path, @config.manifest_path(in_cache: true))
+        clean_cache(changes["deleted"])
+        zip_to_cache(changes["updated"])
+      end
+    end
+
+    def zip_to_cache(pods_to_update)
+      pods_to_update.each do |pod|
+        Pod::UI.puts "- Update cache: #{pod}"
+        ZipUtils.zip(
+          "#{@config.generated_frameworks_dir}/#{pod}",
+          to_dir: @config.generated_frameworks_dir(in_cache: true)
+        )
+      end
+    end
+
+    def clean_cache(pods_to_delete)
+      pods_to_delete.each do |pod|
+        Pod::UI.puts "- Clean up cache: #{pod}"
+        FileUtils.rm_rf("#{@config.generated_frameworks_dir(in_cache: true)}/#{pod}.zip")
+      end
+    end
+  end
+end

data/lib/command/executor/pusher.rb

@@ -0,0 +1,19 @@
+require_relative "base"
+
+module PodPrebuild
+  class CachePusher < CommandExecutor
+    def initialize(options)
+      super(options)
+      @cache_branch = options[:cache_branch]
+    end
+
+    def run
+      Pod::UI.step("Pushing cache") do
+        commit_message = "Update prebuilt cache".shellescape
+        git("add .")
+        git("commit -m '#{commit_message}'")
+        git("push origin head")
+      end
+    end
+  end
+end

data/lib/command/executor/visualizer.rb

@@ -0,0 +1,20 @@
+require_relative "base"
+require_relative "../../cocoapods-binary-cache/dependencies_graph/dependencies_graph"
+
+module PodPrebuild
+  class Visualizer < CommandExecutor
+    def initialize(options)
+      super(options)
+      @lockfile = options[:lockfile]
+      @open = options[:open]
+      @output_dir = options[:output_dir]
+    end
+
+    def run
+      FileUtils.mkdir_p(@output_dir)
+      graph = DependenciesGraph.new(@lockfile)
+      graph.write_graphic_file("png", "#{@output_dir}/graph", Set.new)
+      `open #{@output_dir}/graph.png` if @open
+    end
+  end
+end