carthage_remote_cache 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d396754d9d36f42ce94e959a2a79060edcd08e62
-  data.tar.gz: 16d69bfae6cd53c5465a7e92e398c7243acfbf33
+  metadata.gz: 99a24b3d5f791bcaeb20e54585407e069cef1315
+  data.tar.gz: f2142c1579c0be86a434b7145d6d0598724bb29d
 SHA512:
-  metadata.gz: 0b3972b131d66bd5bd9bf6be8be8ebc037b72ee59dba515761db2d3c088851199deeeb9ef01a5e927af5d676879318a55ee2e322d9282a17e77f839966862a29
-  data.tar.gz: bb6bc109ba2c95587e585d4577ac3bcb030a6a2d84b1b4d078a276c23da664277e97205d7a87a95f6a96c16465f9471c0371f64dab15ec4ee2c3bbbbc88a55af
+  metadata.gz: 959084abe1f980e686068760c818f4b138e03075cc88667fc47ea875dab38ab7eb21c5e5a94bb775654e2558a2aa98ed07126e89c4cbadfbb02b456d604494fb
+  data.tar.gz: 4469e11a247c273fc956ed1afac2d6f76a3404d6ee7a24ab387c9d2a1c0145868255b5af2c68f9417b0b1f1c222e5ebe27bfe65704133f118bd2cc48d0561052

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    carthage_remote_cache (0.0.2)
+    carthage_remote_cache (0.0.3)
       concurrent-ruby (~> 1.0.5)
       rack (~> 2.0.4)
       rest-client (~> 2.0.2)
@@ -47,7 +47,7 @@ GEM
     tilt (2.0.8)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.4)
+    unf_ext (0.0.7.5)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,13 +1,105 @@
 # CarthageRemoteCache
 
+Centralized cache to serve Carthage frameworks. Useful for distributed CI setup with several build machines. It's aware of your `xcodebuild` and `swift` versions and builds on top of Carthage's `.xyz.version` file mechanism.
+
 ## Installation
 
 The gem is published at [rubygems.org](https://rubygems.org/gems/carthage_remote_cache), installation is as easy as:
 
     $ gem install carthage_remote_cache
 
+## Quickstart
+
+1. Run `carthagerc server` to start the cache on a remote server
+2. `cd` to your project's root folder
+3. Run `carthagerc init` to create `Cartrcfile` and point the server property to your  running server URL
+4. Assuming your `Carthage` directory is already built, run `carthagerc upload` to populate remote cache
+5. Push your `Cartrcfile` and from a different machine run `cartrcfile download` to fetch frameworks into `Carthage/Build/` folder
+6. Build your app without having to wait for `carthage bootstrap`
+
 ## Usage
 
+### Init
+
+Before running any other commands, it's required to initialize `carthagerc` in your project directory by running:
+
+    $ carthagerc init
+
+Which produces a `Cartrcfile`. Configuration is done via plain `ruby` code, so it is as simple as:
+
+    Configuration.setup do |c|
+        c.server = "http://localhost:9292/"
+    end
+
+`Cartrcfile` is supposed to be version controlled (e.g. included in git repository), so that it lives along your code and all consumers of the repository have access to same configuration.
+
+### Upload Workflow
+
+Make sure that all your framework binaries have been built with `carthage`, otherwise there is nothing to upload.
+
+    $ carthage bootstrap
+
+Start the upload with:
+
+    $ carthagerc upload
+
+After couple of seconds you should be able to see confirmation in terminal:
+
+    Uploaded 53 archives, skipped 0.
+
+#### Overwriting Existing Cache
+
+Attempting to run `carthagerc upload` again will not upload any framework binaries, since all of them are already present on the cache server:
+
+    Uploaded 53 archives, skipped 53.
+
+If your cache happen to be tainted by invalid framework binaries, you can overwrite existing cache with
+
+    $ carthagerc upload --force
+
+#### Upgrading Xcode or Swift
+
+It is recommended to always perform the upload workflow after upgrading Xcode and Swift versions since `carthagerc` cached frameworks are not only bound to framework versions, but also to your build environment.
+
+### Download Workflow
+
+Once cache server has been populated with framework binaries, it's time to fetch frameworks from a different machine. Make sure to pull in `Cartrcfile` from respository before executing:
+
+    $ carthagerc download
+
+You should expect to see following output on a machine with empty `Carthage` folder:
+
+    Downloaded and extracted 53 archives, skipped 0 archives.
+
+Your project should be ready for building.
+
+#### Overwriting Local Carthage Folder
+
+In case you happen to change a file in `Carthage/Build` by accident, it's possible to force download all frameworks again with:
+
+    $ carthagerc download --force
+
+
+### Config
+
+To get a quick overview on Xcode / Swift / Framework versions, execute
+
+    $ carthagerc config
+
+Which will print similar information:
+
+    Xcodebuild: 9C40b
+    ---
+    Swift: 4.0.3
+    ---
+    Server: http://localhost:9292/
+    ---
+    Cartfile.resolved:
+    github "kayak/attributions" "0.3"
+    ---
+    Local Build Frameworks:
+    Attributions 0.3 [:iOS]
+
 ### Cache Server
 
 Start the server with
@@ -16,6 +108,8 @@ Start the server with
 
 and browse to [localhost:9292](http://localhost:9292/) where you should be able to see the default _Welcome_ message.
 
+Framework binaries will be stored in `~/.carthagerc_server` folder.
+
 Server is bound to port 9292 by default. If you need to use different port, specify the port number via `-pPORT` or `--port=PORT` command line arguments, e.g.:
 
     $ carthage server -p9000
@@ -23,28 +117,49 @@ Server is bound to port 9292 by default. If you need to use different port, spec
 
 Don't forget to change port number in your version controlled `Cartrcfile`.
 
-### Carthage Preparation
+#### Launch Agent
 
-### Init
+You can also run the cache server as a launch agent. Copy the template [com.kayak.carthagerc.server.plist](https://github.com/kayak/carthage_remote_cache/blob/master/com.kayak.carthagerc.server.plist) file to `~/Library/LaunchAgents`, change log
+paths to include your username and run:
 
-    $ carthagerc init
+    $ launchctl load -w ~/Library/LaunchAgents/com.kayak.carthagerc.server.plist
 
-Example `Cartrcfile`:
+If you want to stop the agent, run:
 
-    Configuration.setup do |c|
-        c.server = "http://localhost:9292/"
-    end
+    $ launchctl unload ~/Library/LaunchAgents/com.kayak.carthagerc.server.plist
 
-### Artifact Upload
-    $ carthagerc upload
-
-### Artifact Download
-    $ carthagerc download
+Check out official documentation on [Launch Agents](https://developer.apple.com/library/content/documentation/MacOSX/Conceptual/BPSystemStartup/Chapters/CreatingLaunchdJobs.html) for more info. 
 
 ### Help
 
 Documentation is also available when running `carthagerc` or `carthagerc --help`. Both commands print list of available commands with brief description.
 
+    carthagerc COMMAND [OPTIONS]
+
+    ...
+
+    COMMANDS
+        config
+            prints environment information and Cartrcfile configuration
+
+        download [-f|--force] [-v|--verbose]
+            fetch missing frameworks into Carthage/Build
+
+        init
+            create initial Cartrcfile in current directory
+
+        upload [-f|--force] [-v|--verbose]
+            archive frameworks in Carthage/Build and upload them to the server
+
+        server [-pPORT|--port=PORT]
+            start cache server
+
+    OPTIONS
+        -f, --force                      Force upload/download of framework archives even if local and server .version files match
+        -h, --help                       Show help
+        -p, --port=PORT                  Server application port used when starting server, default port is 9292
+        -v, --verbose                    Show extra runtime information
+
 ## Development
 
 After checking out the repo, run `dev/setup` to install dependencies. You can also run `dev/console` for an interactive prompt that will allow you to experiment.
@@ -57,25 +172,17 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ### Example Folder
 
-Repository is bundled with an example Carthage setup – open the `example` folder, where  you should be able to see following files, which are preconfigured to bring in a couple of frameworks:
+Repository is bundled with an example Carthage setup for your experiments. Open the [example](https://github.com/kayak/carthage_remote_cache/blob/master/example) folder, where you should be able to see following files, which are preconfigured to bring in a couple of frameworks:
 - Cartfile
 - Cartfile.resolved
 - Cartrcfile
 
-#### Upload
-
-First of all, build Carthage dependencies:
+Make sure to build these dependencies with `carthage bootstrap` before attempting to upload them.
 
-    $ carthage update --no-build && carthage bootstrap
-
-After the `Carthage/Build` folder gets populated, execute:
+Try out a few commands:
 
+    $ carthagerc config
     $ carthagerc upload
-
-You should be able to observe the `~/.carthage_remote_cache` folder filling.
-
-#### Download
-
     $ carthagerc download
 
 ## License

data/bin/carthagerc

@@ -21,10 +21,10 @@ opt_parser = OptionParser.new do |opt|
     opt.separator "QUICKSTART"
     opt.separator "    1. Run `carthagerc server` to start the cache on a remote server"
     opt.separator "    2. `cd` to your project's root folder"
-    opt.separator "    3. Run `carthagerc init` to create #{CARTRCFILE} and point the server property to your running server URL"
-    opt.separator "    4. Assuming your #{CARTHAGE_DIR} directory is already built, run `carthagerc upload` to populate remote cache"
-    opt.separator "    5. Push your `CARTRCFILE` and from a different machine run `cartrcfile download` to fetch frameworks into #{CARTHAGE_BUILD_DIR} folder"
-    opt.separator "    6. Profit"
+    opt.separator "    3. Run `carthagerc init` to create `Cartrcfile` and point the server property to your running server URL"
+    opt.separator "    4. Assuming your `Carthage` directory is already built, run `carthagerc upload` to populate remote cache"
+    opt.separator "    5. Push your `Cartrcfile` and from a different machine run `cartrcfile download` to fetch frameworks into `Carthage/Build/` folder"
+    opt.separator "    6. Build your app without having to wait for `carthage bootstrap`"
     opt.separator ""
     opt.separator "COMMANDS"
     opt.separator "    config"
@@ -80,6 +80,6 @@ begin
     else
         bail("Unsupported command #{command}, run with --help to show available commands")
     end
-rescue => e
+rescue AppError => e
     bail(e.message)
 end

data/carthage_remote_cache.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "carthage_remote_cache"
-  spec.version       = "0.0.2"
+  spec.version       = "0.0.3"
 
   spec.summary       = %q{Centralized cache to serve carthage frameworks. Useful for distributed CI setup with several build machines.}
   spec.description   = spec.summary

data/com.kayak.carthagerc.server.plist

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+    <dict>
+        <key>Label</key>
+        <string>com.kayak.carthagerc.server</string>
+        <key>ProgramArguments</key>
+        <array>
+            <string>/usr/local/bin/carthagerc</string>
+            <string>server</string>
+            <string>--port=9292</string>
+        </array>
+        <key>KeepAlive</key>
+        <true/>
+        <key>StandardOutPath</key>
+        <string>/Users/MY_USER/Library/Logs/carthagerc.server.stdout.log</string>
+        <key>StandardErrorPath</key>
+        <string>/Users/MY_USER/Library/Logs/carthagerc.server.stderr.log</string>
+    </dict>
+</plist>

data/lib/carthage_archive.rb

@@ -3,7 +3,7 @@ class CarthageArchive
     attr_reader :archive_filename, :archive_path
 
     def initialize(framework_name, platform)
-        raise "Platform #{platform.inspect} needs to be a symbol" unless platform.kind_of?(Symbol)
+        raise AppError.new, "Platform #{platform.inspect} needs to be a symbol" unless platform.kind_of?(Symbol)
 
         @framework_name = framework_name
         @platform = platform
@@ -21,13 +21,13 @@ class CarthageArchive
 
         platform_path = File.join(CARTHAGE_BUILD_DIR, platform_to_carthage_dir_string(@platform))
         framework_path = File.join(platform_path, "#{@framework_name}.framework")
-        raise "Archive can't be created, no framework directory at #{framework_path}" unless Dir.exist?(framework_path)
+        raise AppError.new, "Archive can't be created, no framework directory at #{framework_path}" unless Dir.exist?(framework_path)
 
         dsym_path = File.join(platform_path, "#{@framework_name}.framework.dSYM")
-        raise "DSYM File #{dsym_path} is missing" unless File.exist?(dsym_path)
+        raise AppError.new, "DSYM File #{dsym_path} is missing" unless File.exist?(dsym_path)
 
         binary_path = File.join(framework_path, @framework_name)
-        raise "Binary #{binary_path} is missing, failed to read .bcsymbolmap files" unless File.exist?(binary_path)
+        raise AppError.new, "Binary #{binary_path} is missing, failed to read .bcsymbolmap files" unless File.exist?(binary_path)
 
         bcsymbolmap_paths = find_bcsymbolmap_paths(platform_path, binary_path)
 
@@ -41,7 +41,7 @@ class CarthageArchive
     end
 
     def unpack_archive
-        raise "Archive #{@archive_path} is missing" unless File.exist?(@archive_path)
+        raise AppError.new, "Archive #{@archive_path} is missing" unless File.exist?(@archive_path)
         $LOG.debug("Unpacking #{@archive_path}, file size: #{formatted_archive_size}")
         sh("unzip -o #{quote @archive_path}")
     end

data/lib/carthage_dependency.rb

@@ -30,7 +30,7 @@ class CarthageDependency
         when "github"
             repository.split("/").last
         else
-            raise "Determining version_filename from #{@type} dependency is not yet supported"
+            raise AppError.new, "Determining version_filename from #{@type} dependency is not yet supported"
         end
     end
 

data/lib/commands/download_command.rb

@@ -52,12 +52,12 @@ class DownloadCommand
         end
 
         version_file = @networking.download_version_file(carthage_dependency)
-        raise "Version file #{carthage_dependency.version_filename} is not present on the server, please run `carthagerc upload` first" if version_file.nil?
+        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 do
                 archive = @api.download_and_unpack_archive(carthage_dependency, framework_name, platform)
-                raise "Failed to download framework #{carthage_dependency} – #{framework_name} (#{platform}). Please `upload` the framework first." if archive.nil?
+                raise AppError.new, "Failed to download framework #{carthage_dependency} – #{framework_name} (#{platform}). Please `upload` the framework first." if archive.nil?
                 @number_of_downloaded_archives += 1
             end
         end

data/lib/commands/init_command.rb

@@ -7,7 +7,7 @@ class InitCommand
     def run
         path = File.join(Dir.pwd, CARTRCFILE)
         if File.exist?(path)
-            raise "File #{path} already exists"
+            raise AppError.new, "File #{path} already exists"
         else
             File.write(path, file_contents)
         end

data/lib/configuration.rb

@@ -44,34 +44,35 @@ class Configuration
     def initialize_env
         xcodebuild_raw_version = sh("xcodebuild -version")
         @xcodebuild_version = xcodebuild_raw_version[/Build version (.*)$/, 1]
-        raise "Could not parse build version from '#{xcodebuild_raw_version}'" if @xcodebuild_version.nil?
+        raise AppError.new, "Could not parse build version from '#{xcodebuild_raw_version}'" if @xcodebuild_version.nil?
 
         swift_raw_version = sh("swift -version")
         @swift_version = swift_raw_version[/Apple Swift version (.*) \(/, 1]
-        raise "Could not parse swift version from '#{raw_swift_version}'" if @swift_version.nil?
+        raise AppError.new, "Could not parse swift version from '#{raw_swift_version}'" if @swift_version.nil?
 
-        raise "Misssing #{CARTFILE_RESOLVED}" unless File.exist?(CARTFILE_RESOLVED)
+        raise AppError.new, "Misssing #{CARTFILE_RESOLVED}" unless File.exist?(CARTFILE_RESOLVED)
         @carthage_dependencies = File.readlines(CARTFILE_RESOLVED)
             .map { |line| CarthageDependency.parse_cartfile_resolved_line(line) }
             .compact
     end
 
     def initialize_cartrcfile
-        raise "Configuration file #{CARTRCFILE} was not found, consider creating one by running `carthagerc init`" unless File.exist?(CARTRCFILE)
+        raise AppError.new, "Configuration file #{CARTRCFILE} was not found, consider creating one by running `carthagerc init`" unless File.exist?(CARTRCFILE)
 
         # Populate class variable @@user_config.
         load File.join(Dir.pwd, CARTRCFILE)
 
-        raise "Missing 'server' configuration in #{CARTRCFILE}" if @@user_config.server.nil? || @@user_config.server.empty?
+        raise AppError.new, "Missing 'server' configuration in #{CARTRCFILE}" if @@user_config.server.nil? || @@user_config.server.empty?
         @server_uri = URI.parse(@@user_config.server)
     end
 
     def framework_names_with_platforms
-        version_files.flat_map do |vf|
+        lines = version_files.flat_map do |vf|
             vf.platforms_by_framework.flat_map do |framework_name, platforms|
                 "#{framework_name} #{vf.version} #{platforms}"
             end
         end
+        lines.sort
     end
 
     def version_files

data/lib/constants.rb

@@ -5,4 +5,4 @@ CARTRCFILE =  'Cartrcfile'
 THREAD_POOL_SIZE = 8
 
 SERVER_DEFAULT_PORT = 9292
-SERVER_CACHE_DIR = File.join(Dir.home, '.carthage-remote-cache')
+SERVER_CACHE_DIR = File.join(Dir.home, '.carthagerc_server')

data/lib/errors.rb

@@ -1,4 +1,7 @@
-class MultipleErrorsError < StandardError
+# Common type for all carthage_remote_cache Errors.
+class AppError < StandardError; end
+
+class MultipleErrorsError < AppError
 
     def initialize(errors)
         @errors = errors
@@ -10,4 +13,4 @@ class MultipleErrorsError < StandardError
 
 end
 
-class OutdatedFrameworkBuildError < StandardError; end
+class OutdatedFrameworkBuildError < AppError; end

data/lib/server/server_app.rb

@@ -40,19 +40,6 @@ post versions_path do
     status(200)
 end
 
-# Check whether framework archive is already cached.
-head frameworks_path do
-    dirname = params_to_framework_dir(params)
-    archive = CarthageArchive.new(params[:framework_name], params[:platform].to_sym)
-    filename = File.join(dirname, archive.archive_filename)
-
-    if File.exist?(filename)
-        status(200)
-    else
-        status(404)
-    end
-end
-
 # Retrieve .zip framework archive.
 get frameworks_path do
     dirname = params_to_framework_dir(params)

data/lib/utils.rb

@@ -27,7 +27,7 @@ def quote(input)
             .select { |e| !e.empty? }
             .join(' ')
     else
-        raise "Unsupported type #{input}"
+        raise AppError.new, "Unsupported type #{input}"
     end
 end
 
@@ -42,7 +42,7 @@ def platform_to_api_string(platform)
     when :watchOS
         'watchOS'
     else
-        raise "Unrecognized platform #{platform.inspect}"
+        raise AppError.new, "Unrecognized platform #{platform.inspect}"
     end
 end
 
@@ -57,6 +57,6 @@ def platform_to_carthage_dir_string(platform)
     when :watchOS
         'watchOS'
     else
-        raise "Unrecognized platform #{platform.inspect}"
+        raise AppError.new, "Unrecognized platform #{platform.inspect}"
     end
 end

data/lib/version_file.rb

@@ -63,13 +63,13 @@ class VersionFile
     private
 
     def parse
-        raise "File #{path} doesn't exist, has carthage been bootstrapped?" unless File.exist?(@path)
+        raise AppError.new, "File #{path} doesn't exist, has carthage been bootstrapped?" unless File.exist?(@path)
 
         file = File.read(@path)
         json = JSON.parse(file)
 
         @version = json['commitish']
-        raise "Version is missing in #{@path}" if @version.nil? || @version.empty?
+        raise AppError.new, "Version is missing in #{@path}" if @version.nil? || @version.empty?
 
         @frameworks_by_platform = {
             :iOS => parse_platform_array(json['iOS']),

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: carthage_remote_cache
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Juraj Blahunka
@@ -125,6 +125,7 @@ files:
 - Rakefile
 - bin/carthagerc
 - carthage_remote_cache.gemspec
+- com.kayak.carthagerc.server.plist
 - dev/console
 - dev/setup
 - dev/start_server