carthage_remote_cache 0.0.5 → 0.0.10

data/lib/api.rb

@@ -1,15 +1,45 @@
 class API
-  def initialize(shell, networking, options)
+  def initialize(shell, config, networking, options)
     @shell = shell
+    @config = config
     @networking = networking
     @options = options
+    @unpack_mutex = Mutex.new
   end
 
-  def version_file_matches_server?(carthage_dependency, version_file)
+  def verify_server_version
+    server_version = @networking.get_server_version
+    unless server_version == VERSION
+      raise ServerVersionMismatchError.new, version_mismatch_message(server_version)
+    end
+  end
+
+  def verify_build_dir_matches_cartfile_resolved
+    errors = []
+    for carthage_dependency in @config.carthage_resolved_dependencies
+      begin
+        version_file = carthage_dependency.new_version_file
+        carthage_dependency.verify_version_in_version_file(version_file)
+      rescue VersionFileDoesNotExistError => e
+        errors << OutdatedFrameworkBuildError.new(
+          carthage_dependency.guessed_framework_basename,
+          "-",
+          carthage_dependency.version
+        )
+      rescue OutdatedFrameworkBuildError => e
+        errors << e
+      end
+    end
+    if errors.count > 0
+      raise FrameworkValidationError.new(errors)
+    end
+  end
+
+  def version_file_matches_server?(carthage_dependency, version_file, platforms)
     if @options[:force]
       false
     else
-      server_version_file = @networking.download_version_file(carthage_dependency)
+      server_version_file = @networking.download_version_file(carthage_dependency, platforms)
       result = version_file.same_content?(server_version_file)
       server_version_file.remove unless server_version_file.nil?
       result
@@ -19,7 +49,7 @@ class API
   # @return zip archive size in Bytes
   def create_and_upload_archive(carthage_dependency, framework_name, platform)
     archive = CarthageArchive.new(framework_name, platform)
-    archive.create_archive(@shell, carthage_dependency.should_include_dsym)
+    archive.create_archive(@shell)
     archive_size = archive.archive_size
     begin
       checksum = crc32(archive.archive_path)
@@ -49,7 +79,10 @@ class API
     archive_size = archive.archive_size
     begin
       $LOG.debug("Downloaded #{archive.archive_path}")
-      archive.unpack_archive(@shell)
+      # Can't unpack multiple archives concurrently.
+      @unpack_mutex.synchronize do
+        archive.unpack_archive(@shell)
+      end
     ensure
       archive.delete_archive
     end
@@ -58,6 +91,17 @@ class API
 
   private
 
+  def version_mismatch_message(server_version)
+    <<~EOS
+      Version mismatch:
+        Cache server version: #{server_version}
+        Client version:       #{VERSION}
+
+      Please use the same version as cache server by running:
+      $ gem install carthage_remote_cache -v #{server_version}
+    EOS
+  end
+
   def checksum_error_message(path, remote, local)
     <<~EOS
       Checksums for '#{path}' do not match:

data/lib/carthage_archive.rb

@@ -1,3 +1,5 @@
+require "fileutils"
+
 class CarthageArchive
   attr_reader :archive_filename, :archive_path
 
@@ -15,7 +17,7 @@ class CarthageArchive
   # - Carthage/Build/iOS/Alamofire.framework/Alamofire
   # - Carthage/Build/iOS/618BEB79-4C7F-3692-B140-131FB983AC5E.bcsymbolmap
   # into Alamofire-iOS.zip
-  def create_archive(shell, should_include_dsym, carthage_build_dir = CARTHAGE_BUILD_DIR)
+  def create_archive(shell, carthage_build_dir = CARTHAGE_BUILD_DIR)
     $LOG.debug("Archiving #{@framework_name} for #{@platform}")
 
     platform_path = File.join(carthage_build_dir, platform_to_carthage_dir_string(@platform))
@@ -25,12 +27,8 @@ class CarthageArchive
     # It's very likely, that binary releases don't contain DSYMs.
     dsym_path = File.join(platform_path, "#{@framework_name}.framework.dSYM")
     unless File.exist?(dsym_path)
-      if should_include_dsym
-        raise AppError.new, "DSYM File #{dsym_path} not found"
-      else
-        $LOG.error("DSYM File #{dsym_path} not found, continuing")
-        dsym_path = nil
-      end
+      $LOG.error("DSYM File #{dsym_path} not found, continuing")
+      dsym_path = nil
     end
 
     binary_path = File.join(framework_path, @framework_name)
@@ -50,8 +48,11 @@ class CarthageArchive
     $LOG.debug("Created #{@archive_path} archive, file size: #{formatted_archive_size}")
   end
 
-  def unpack_archive(shell)
+  def unpack_archive(shell, carthage_build_dir = CARTHAGE_BUILD_DIR)
     raise AppError.new, "Archive #{@archive_path} is missing" unless File.exist?(@archive_path)
+
+    delete_existing_build_framework_if_exists(carthage_build_dir)
+
     $LOG.debug("Unpacking #{@archive_path}, file size: #{formatted_archive_size}")
     shell.unpack(@archive_path)
   end
@@ -85,4 +86,13 @@ class CarthageArchive
   def formatted_archive_size
     format_file_size(archive_size)
   end
+
+  def delete_existing_build_framework_if_exists(carthage_build_dir)
+    platform_path = File.join(carthage_build_dir, platform_to_carthage_dir_string(@platform))
+    framework_path = File.join(platform_path, "#{@framework_name}.framework")
+    if File.exist?(framework_path)
+      $LOG.debug("Deleting #{framework_path}")
+      FileUtils.rm_rf(framework_path)
+    end
+  end
 end

data/lib/carthage_dependency.rb

@@ -27,6 +27,10 @@ class CarthageDependency
     @version = args[:version]
   end
 
+  def new_version_file
+    VersionFile.new(version_filepath)
+  end
+
   # Since one Cartfile.resolved entry may produce multiple differently named frameworks,
   # this is an entry point to identifying a framework name.
   def guessed_framework_basename
@@ -52,38 +56,13 @@ class CarthageDependency
     File.join(CARTHAGE_BUILD_DIR, version_filename)
   end
 
-  def should_include_dsym
-    case @origin
-    when :github
-      true
-    when :git
-      true
-    when :binary
-      false
-    else
-      raise AppError.new, "Unrecognized origin '#{@origin}'"
-    end
-  end
-
-  def validate_version_file(version_file)
+  def verify_version_in_version_file(version_file)
     if @version != version_file.version
-      raise OutdatedFrameworkBuildError.new, version_validation_message(version_file)
+      raise OutdatedFrameworkBuildError.new(guessed_framework_basename, version_file.version, @version)
     end
   end
 
   def to_s
     "#{@origin.to_s} \"#{@source}\" \"#{@version}\""
   end
-
-  private
-
-  def version_validation_message(version_file)
-    <<~EOS
-      Outdated version of '#{guessed_framework_basename}' framework detected:
-        Expected version '#{@version}'
-        Found version '#{version_file.version}'
-
-      Please run `carthage bootstrap` to build frameworks.
-    EOS
-  end
 end

data/lib/carthage_remote_cache.rb

@@ -1,16 +1,17 @@
 lib = File.expand_path("..", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-require 'api'
-require 'carthage_archive'
-require 'carthage_dependency'
-require 'constants'
-require 'configuration'
-require 'crc32'
-require 'errors'
-require 'log'
-require 'networking'
-require 'shell_wrapper'
-require 'utils'
-require 'version'
-require 'version_file'
+require "api"
+require "carthage_archive"
+require "carthage_dependency"
+require "constants"
+require "configuration"
+require "crc32"
+require "errors"
+require "log"
+require "networking"
+require "shell_wrapper"
+require "table"
+require "utils"
+require "version"
+require "version_file"

data/lib/commands.rb

@@ -1,7 +1,8 @@
 lib = File.expand_path("..", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-require 'commands/download_command'
-require 'commands/init_command'
-require 'commands/server_command'
-require 'commands/upload_command'
+require "commands/download_command"
+require "commands/init_command"
+require "commands/server_command"
+require "commands/upload_command"
+require "commands/verify_command"

data/lib/commands/download_command.rb

@@ -1,16 +1,17 @@
-require 'concurrent'
+require "concurrent"
 
 class DownloadCommand
   def self.new_with_defaults(options)
     shell = ShellWrapper.new
     config = Configuration.new(shell)
-    networking = Networking.new(config)
-    api = API.new(shell, networking, options)
+    networking = Networking.new(config, options[:is_retry_enabled])
+    api = API.new(shell, config, networking, options)
 
     DownloadCommand.new(
       config: config,
       networking: networking,
       api: api,
+      platforms: options[:platforms],
     )
   end
 
@@ -18,17 +19,22 @@ class DownloadCommand
     @config = args[:config]
     @networking = args[:networking]
     @api = args[:api]
+    @platforms = args[:platforms]
   end
 
   def run
+    @config.ensure_shell_commands
+    @api.verify_server_version
+
     pool = Concurrent::FixedThreadPool.new(THREAD_POOL_SIZE)
 
+    @mutex = Mutex.new
     @number_of_downloaded_archives = 0
     @number_of_skipped_archives = 0
     @total_archive_size = 0
     errors = Concurrent::Array.new
 
-    for carthage_dependency in @config.carthage_dependencies
+    for carthage_dependency in @config.carthage_resolved_dependencies
       pool.post(carthage_dependency) do |carthage_dependency|
         begin
           download(carthage_dependency)
@@ -53,27 +59,30 @@ class DownloadCommand
   private
 
   def download(carthage_dependency)
-    local_version_file =
-      if File.exist?(carthage_dependency.version_filepath)
-        VersionFile.new(carthage_dependency.version_filepath)
+    local_version_file = if File.exist?(carthage_dependency.version_filepath)
+        carthage_dependency.new_version_file
       else
         nil
       end
 
-    if !local_version_file.nil? && @api.version_file_matches_server?(carthage_dependency, local_version_file)
+    if !local_version_file.nil? && @api.version_file_matches_server?(carthage_dependency, local_version_file, @platforms)
       $LOG.debug("Version file #{local_version_file.path} matches server version, skipping download")
-      @number_of_skipped_archives += local_version_file.number_of_frameworks
+      @mutex.synchronize do
+        @number_of_skipped_archives += local_version_file.number_of_frameworks
+      end
       return
     end
 
-    version_file = @networking.download_version_file(carthage_dependency)
+    version_file = @networking.download_version_file(carthage_dependency, @platforms)
     raise AppError.new, "Version file #{carthage_dependency.version_filename} is not present on the server, please run `carthagerc upload` first" if version_file.nil?
 
     version_file.frameworks_by_platform.each do |platform, framework_names|
       for framework_name in framework_names
         archive_size = @api.download_and_unpack_archive(carthage_dependency, framework_name, platform)
-        @number_of_downloaded_archives += 1
-        @total_archive_size += archive_size
+        @mutex.synchronize do
+          @number_of_downloaded_archives += 1
+          @total_archive_size += archive_size
+        end
       end
     end
     version_file.move_to_build_dir

data/lib/commands/server_command.rb

@@ -4,8 +4,8 @@ class ServerCommand
   end
 
   def run
-    ENV['RACK_ENV'] = 'production'
-    require 'server/server_app'
+    ENV["RACK_ENV"] = "production"
+    require "server/server_app"
     Rack::Handler::WEBrick.run(
       Sinatra::Application,
       :Port => @options[:server_port],

data/lib/commands/upload_command.rb

@@ -1,11 +1,11 @@
-require 'concurrent'
+require "concurrent"
 
 class UploadCommand
   def self.new_with_defaults(options)
     shell = ShellWrapper.new
     config = Configuration.new(shell)
-    networking = Networking.new(config)
-    api = API.new(shell, networking, options)
+    networking = Networking.new(config, options[:is_retry_enabled])
+    api = API.new(shell, config, networking, options)
 
     UploadCommand.new(
       config: config,
@@ -21,16 +21,21 @@ class UploadCommand
   end
 
   def run
+    @config.ensure_shell_commands
+    @api.verify_server_version
+    @api.verify_build_dir_matches_cartfile_resolved
+
     pool = Concurrent::FixedThreadPool.new(THREAD_POOL_SIZE)
 
     $LOG.debug("Will upload frameworks: #{@config.all_framework_names}")
 
+    @mutex = Mutex.new
     @number_of_uploaded_archives = 0
     @number_of_skipped_archives = 0
     @total_archive_size = 0
     errors = Concurrent::Array.new
 
-    for carthage_dependency in @config.carthage_dependencies
+    for carthage_dependency in @config.carthage_resolved_dependencies
       pool.post(carthage_dependency) do |carthage_dependency|
         begin
           upload(carthage_dependency)
@@ -55,13 +60,13 @@ class UploadCommand
   private
 
   def upload(carthage_dependency)
-    version_file = VersionFile.new(carthage_dependency.version_filepath)
-
-    carthage_dependency.validate_version_file(version_file)
+    version_file = carthage_dependency.new_version_file
 
-    if @api.version_file_matches_server?(carthage_dependency, version_file)
+    if @api.version_file_matches_server?(carthage_dependency, version_file, nil)
       $LOG.debug("Version file #{version_file.path} matches server version, skipping upload")
-      @number_of_skipped_archives += version_file.number_of_frameworks
+      @mutex.synchronize do
+        @number_of_skipped_archives += version_file.number_of_frameworks
+      end
       return
     end
 
@@ -70,8 +75,10 @@ class UploadCommand
     version_file.frameworks_by_platform.each do |platform, framework_names|
       for framework_name in framework_names
         archive_size = @api.create_and_upload_archive(carthage_dependency, framework_name, platform)
-        @number_of_uploaded_archives += 1
-        @total_archive_size += archive_size
+        @mutex.synchronize do
+          @number_of_uploaded_archives += 1
+          @total_archive_size += archive_size
+        end
       end
     end
   end

data/lib/commands/verify_command.rb

@@ -0,0 +1,18 @@
+class VerifyCommand
+  def self.new_with_defaults(options)
+    shell = ShellWrapper.new
+    config = Configuration.new(shell)
+    networking = Networking.new(config, options[:is_retry_enabled])
+    api = API.new(shell, config, networking, options)
+
+    VerifyCommand.new(api: api)
+  end
+
+  def initialize(args)
+    @api = args[:api]
+  end
+
+  def run
+    @api.verify_build_dir_matches_cartfile_resolved
+  end
+end

data/lib/configuration.rb

@@ -1,4 +1,4 @@
-require 'uri'
+require "uri"
 
 class Configuration
   class UserConfig
@@ -11,14 +11,15 @@ class Configuration
     yield(@@user_config)
   end
 
-  attr_reader :xcodebuild_version, :swift_version, :carthage_dependencies, :server_uri
+  attr_reader :carthage_resolved_dependencies, :server_uri
 
   def self.new_with_defaults
     Configuration.new(ShellWrapper.new)
   end
 
   def initialize(shell)
-    initialize_env(shell)
+    @shell = shell
+    initialize_cartfile_resolved
     initialize_cartrcfile
   end
 
@@ -26,16 +27,40 @@ class Configuration
     version_files.flat_map { |vf| vf.framework_names }.uniq.sort
   end
 
+  # Ensure, that these lazy properties are loaded before kicking off async code.
+  def ensure_shell_commands
+    xcodebuild_version
+    swift_version
+  end
+
+  def xcodebuild_version
+    if @xcodebuild_version.nil?
+      xcodebuild_raw_version = @shell.xcodebuild_version
+      @xcodebuild_version = xcodebuild_raw_version[/Build version (.*)$/, 1]
+      raise AppError.new, "Could not parse build version from '#{xcodebuild_raw_version}'" if @xcodebuild_version.nil?
+    end
+    @xcodebuild_version
+  end
+
+  def swift_version
+    if @swift_version.nil?
+      swift_raw_version = @shell.swift_version
+      @swift_version = swift_raw_version[/Apple Swift version (.*) \(/, 1]
+      raise AppError.new, "Could not parse swift version from '#{raw_swift_version}'" if @swift_version.nil?
+    end
+    @swift_version
+  end
+
   def to_s
     <<~EOS
-      Xcodebuild: #{@xcodebuild_version}
+      Xcodebuild: #{xcodebuild_version}
       ---
-      Swift: #{@swift_version}
+      Swift: #{swift_version}
       ---
       Server: #{@server_uri.to_s}
       ---
       Cartfile.resolved:
-      #{@carthage_dependencies.join("\n")}
+      #{@carthage_resolved_dependencies.join("\n")}
       ---
       Local Build Frameworks:
       #{framework_names_with_platforms.join("\n")}
@@ -44,17 +69,9 @@ class Configuration
 
   private
 
-  def initialize_env(shell)
-    xcodebuild_raw_version = shell.xcodebuild_version
-    @xcodebuild_version = xcodebuild_raw_version[/Build version (.*)$/, 1]
-    raise AppError.new, "Could not parse build version from '#{xcodebuild_raw_version}'" if @xcodebuild_version.nil?
-
-    swift_raw_version = shell.swift_version
-    @swift_version = swift_raw_version[/Apple Swift version (.*) \(/, 1]
-    raise AppError.new, "Could not parse swift version from '#{raw_swift_version}'" if @swift_version.nil?
-
+  def initialize_cartfile_resolved
     raise AppError.new, "Misssing #{CARTFILE_RESOLVED}" unless File.exist?(CARTFILE_RESOLVED)
-    @carthage_dependencies = File.readlines(CARTFILE_RESOLVED)
+    @carthage_resolved_dependencies = File.readlines(CARTFILE_RESOLVED)
       .map { |line| CarthageDependency.parse_cartfile_resolved_line(line) }
       .compact
   end
@@ -79,6 +96,6 @@ class Configuration
   end
 
   def version_files
-    @carthage_dependencies.map { |d| VersionFile.new(d.version_filepath) }
+    @carthage_resolved_dependencies.map { |d| d.new_version_file }
   end
 end