cocoapods-binary-artifactory-cache 0.0.1

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

@@ -0,0 +1,261 @@
+require_relative "xcodebuild_raw"
+
+module PodPrebuild
+  class XcodebuildCommand # rubocop:disable Metrics/ClassLength
+    def initialize(options)
+      @options = options
+      case options[:targets][0].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
+      sdks.each { |sdk| build_for_sdk(sdk) }
+
+      targets.each do |target|
+        if PodPrebuild.config.xcframework?
+          create_xcframework(target)
+        elsif sdks.count > 1
+          create_fat_framework(target)
+        else
+          collect_output(target, Dir[target_products_dir_of(target, sdks[0]) + "/*"])
+        end
+      end
+    end
+
+    private
+
+    def sdks
+      @sdks ||= begin
+        sdks_ = []
+        sdks_ << simulator if build_types.include?(:simulator)
+        sdks_ << device if build_types.include?(:device)
+        sdks_
+      end
+    end
+
+    def preferred_sdk
+      @preferred_sdk ||= sdks.include?(device) ? device : sdks[0]
+    end
+
+    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)
+      # Note: The build arguments explicitly passed from config_cocoapods_binary_cache
+      # should be preceded by the default arguments so that they could take higher priority
+      # when there are argument collisions in the xcodebuild command.
+      # For ex. `xcodebuild AN_ARG=1 AN_ARG=2` should use `AN_ARG=2` instead.
+      args_ = args.clone
+      args_[:default] ||= []
+      args_[:simulator] ||= []
+      args_[:device] ||= []
+      args_[:default].prepend("BITCODE_GENERATION_MODE=bitcode") if bitcode_enabled?
+      args_[:default].prepend("DEBUG_INFORMATION_FORMAT=dwarf") if disable_dsym?
+      args_[:simulator].prepend("ARCHS=x86_64", "ONLY_ACTIVE_ARCH=NO") if simulator == "iphonesimulator"
+      args_[:simulator] += args_[:default]
+      args_[:device].prepend("ONLY_ACTIVE_ARCH=NO")
+      args_[:device] += args_[:default]
+      args_
+    end
+
+    def build_for_sdk(sdk)
+      PodPrebuild::XcodebuildCommand.xcodebuild(
+        sandbox: sandbox,
+        scheme: scheme,
+        targets: targets.map(&:label),
+        configuration: configuration,
+        sdk: sdk,
+        deployment_target: targets.map { |t| t.platform.deployment_target }.max.to_s,
+        log_path: log_path(sdk),
+        args: sdk == simulator ? @build_args[:simulator] : @build_args[:device]
+      )
+    end
+
+    def create_xcframework(target)
+      non_framework_paths = Dir[target_products_dir_of(target, preferred_sdk) + "/*"] \
+        - [framework_path_of(target, preferred_sdk)] \
+        - dsym_paths_of(target, preferred_sdk) \
+        - bcsymbolmap_paths_of(target, preferred_sdk)
+      collect_output(target, non_framework_paths)
+
+      output = "#{output_path(target)}/#{target.product_module_name}.xcframework"
+      FileUtils.rm_rf(output)
+
+      cmd = ["xcodebuild", "-create-xcframework", "-allow-internal-distribution"]
+
+      # for each sdk, the order of params must be -framework then -debug-symbols
+      # to prevent duplicated file error when copying dSYMs
+      sdks.each do |sdk|
+        cmd << "-framework" << framework_path_of(target, sdk).shellescape
+
+        unless disable_dsym?
+          dsyms = dsym_paths_of(target, sdk)
+          cmd += dsyms.map { |dsym| "-debug-symbols #{dsym.shellescape}" }
+        end
+
+        if bitcode_enabled?
+          bcsymbolmaps = bcsymbolmap_paths_of(target, sdk)
+          cmd += bcsymbolmaps.map { |bcsymbolmap| "-debug-symbols #{bcsymbolmap.shellescape}" }
+        end
+      end
+
+      cmd << "-output" << output
+
+      Pod::UI.puts "- Create xcframework: #{target}".magenta
+      Pod::UI.puts_indented "$ #{cmd.join(' ')}" unless PodPrebuild.config.silent_build?
+
+      `#{cmd.join(" ")}`
+    end
+
+    def create_fat_framework(target)
+      # When merging contents of `simulator` & `device`, prefer contents of `device` over `simulator`
+      # https://github.com/grab/cocoapods-binary-cache/issues/25
+      collect_output(target, Dir[target_products_dir_of(target, device) + "/*"])
+
+      merge_framework_binary(target)
+      merge_framework_dsym(target)
+      merge_swift_headers(target)
+      merge_swift_modules(target)
+    end
+
+    def merge_framework_binary(target)
+      merge_contents(target, "/#{target.product_module_name}", &method(:create_fat_binary))
+    end
+
+    def merge_framework_dsym(target)
+      merge_contents(
+        target,
+        ".dSYM/Contents/Resources/DWARF/#{target.product_module_name}",
+        &method(:create_fat_binary)
+      )
+    end
+
+    def merge_swift_headers(target)
+      merge_contents(target, "/Headers/#{target.product_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(target)
+      merge_contents(target, "/Modules/#{target.product_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(target, path_suffix, &merger)
+      simulator_, device_, output_ = [
+        framework_path_of(target, simulator),
+        framework_path_of(target, device),
+        "#{output_path(target)}/#{target.product_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].shellescape << options[:device].shellescape
+      `#{cmd.join(" ")}`
+    end
+
+    def collect_output(target, paths)
+      FileUtils.mkdir_p(output_path(target))
+      paths = [paths] unless paths.is_a?(Array)
+      paths.each do |path|
+        FileUtils.rm_rf(File.join(output_path(target), File.basename(path)))
+        FileUtils.cp_r(path, output_path(target))
+      end
+    end
+
+    def target_products_dir_of(target, sdk)
+      "#{build_dir}/#{configuration}-#{sdk}/#{target.name}"
+    end
+
+    def framework_path_of(target, sdk)
+      "#{target_products_dir_of(target, sdk)}/#{target.product_module_name}.framework"
+    end
+
+    def dsym_paths_of(target, sdk)
+      Dir["#{target_products_dir_of(target, sdk)}/*.dSYM"]
+    end
+
+    def bcsymbolmap_paths_of(target, sdk)
+      Dir["#{target_products_dir_of(target, sdk)}/*.bcsymbolmap"]
+    end
+
+    def sandbox
+      @options[:sandbox]
+    end
+
+    def build_dir
+      @options[:build_dir]
+    end
+
+    def output_path(target)
+      "#{@options[:output_path]}/#{target.label}"
+    end
+
+    def scheme
+      @options[:scheme]
+    end
+
+    def targets
+      @options[:targets]
+    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
+
+    def log_path(sdk)
+      @options[:log_path].nil? ? nil : "#{@options[:log_path]}_#{sdk}"
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+require "fourflusher"
+
+module PodPrebuild
+  class XcodebuildCommand
+    PLATFORM_OF_SDK = {
+      "iphonesimulator" => "iOS",
+      "appletvsimulator" => "tvOS",
+      "watchsimulator" => "watchOS"
+    }.freeze
+
+    DESTINATION_OF_SDK = {
+      "iphoneos" => "\"generic/platform=iOS\"",
+      "iphonesimulator" => "\"generic/platform=iOS Simulator\""
+    }.freeze
+
+    def self.xcodebuild(options)
+      sdk = options[:sdk] || "iphonesimulator"
+      targets = options[:targets] || [options[:target]]
+      platform = PLATFORM_OF_SDK[sdk]
+
+      cmd = ["xcodebuild"]
+      cmd << "-project" << options[:sandbox].project_path.realdirpath.shellescape
+      targets.each { |target| cmd << "-target" << target }
+      cmd << "-configuration" << options[:configuration].shellescape
+      cmd << "-sdk" << sdk
+      if DESTINATION_OF_SDK.key?(sdk)
+        cmd << "-destination" << DESTINATION_OF_SDK[sdk]
+      else
+        unless platform.nil?
+          cmd << Fourflusher::SimControl.new.destination(:oldest, platform, options[:deployment_target])
+        end
+      end
+      cmd += options[:args] if options[:args]
+      cmd << "build"
+
+      if options[:log_path].nil?
+        cmd << "2>&1"
+      else
+        FileUtils.mkdir_p(File.dirname(options[:log_path]))
+        cmd << "> #{options[:log_path].shellescape}"
+      end
+      cmd = cmd.join(" ")
+
+      Pod::UI.puts_indented "$ #{cmd}" unless PodPrebuild.config.silent_build?
+
+      log = `#{cmd}`
+      return if $?.exitstatus.zero? # rubocop:disable Style/SpecialGlobalVars
+
+      begin
+        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
+      ensure
+        raise "Fail to build targets: #{targets}"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+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
+
+    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-artifactory-cache/prebuild_output/output.rb

@@ -0,0 +1,44 @@
+# 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 prebuild_delta_path
+      @prebuild_delta_path ||= PodPrebuild.config.prebuild_delta_path
+    end
+
+    def delta_dir
+      @delta_dir ||= File.dirname(prebuild_delta_path)
+    end
+
+    def clean_delta_file
+      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
+
+    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.message "Write prebuild changes to: #{prebuild_delta_path}"
+      create_dir_if_needed(delta_dir)
+      changes = PodPrebuild::JSONFile.new(prebuild_delta_path)
+      changes["updated"] = updated
+      changes["deleted"] = deleted
+      changes.save!
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module PodPrebuild
+  def self.state
+    @state ||= State.new
+  end
+
+  class State
+    def initialize
+      @store = {
+        :cache_validation => CacheValidationResult.new
+      }
+    end
+
+    def update(data)
+      @store.merge!(data)
+    end
+
+    def cache_validation
+      @store[:cache_validation]
+    end
+  end
+end

data/lib/cocoapods-binary-artifactory-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-binary-artifactory-cache.rb

@@ -0,0 +1,2 @@
+# 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

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-artifactory-cache/main"
+require "command/binary"

data/lib/command/binary.rb

@@ -0,0 +1,36 @@
+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
+      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
+      end
+
+      def load_podfile
+        Pod::Config.instance.podfile
+      end
+
+      def update_cli_config(options)
+        PodPrebuild.config.cli_config.merge!(options)
+      end
+    end
+  end
+end