fastlane-plugin-build_cache 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b340bae99f72196dfefb748a59afcc6428f13b0b
+  data.tar.gz: 22bcc41493691de2b611ab8b2c16c6c27d311821
+SHA512:
+  metadata.gz: 61acecde35e545d6a5daba795721b35e826eeb15c4ecac2a78574fca90273d237a31e5f07ebc92dda65095bccb3e52827c37accb8fccdd4752397f93195ed3c0
+  data.tar.gz: c9fef9d851367775aa54d23f8c0ffea0c2a9439e7cf73910dbce73252f94ec4120100b64e2e816ee8e9e24da7e3f2ca4d73ca43726e73ea0b7911fe3c9152a1d

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Fernando Saragoca <fsaragoca@me.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# build_cache plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-build_cache)
+[![Twitter: @fsaragoca](https://img.shields.io/badge/contact-@fsaragoca-blue.svg?style=flat)](https://twitter.com/fsaragoca)
+
+[![CircleCI](https://circleci.com/gh/fsaragoca/fastlane-plugin-build_cache.svg?style=svg)](https://circleci.com/gh/fsaragoca/fastlane-plugin-build_cache)
+
+## Getting Started
+
+This project is a [fastlane](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-build_cache`, add it to your project by running:
+
+```bash
+fastlane add_plugin build_cache
+```
+
+## About build_cache
+
+Helper for caching builds when using Xcode 8 features 'build for testing' & 'test without building'
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using `fastlane` Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About `fastlane`
+
+`fastlane` is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/build_cache.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/build_cache/version'
+
+module Fastlane
+  module BuildCache
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::BuildCache.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/build_cache/actions/archive_derived_data_action.rb

@@ -0,0 +1,66 @@
+module Fastlane
+  module Actions
+    class ArchiveDerivedDataAction < Action
+      def self.run(params)
+        build_identifier = params[:build_identifier]
+        workspace_path = params[:workspace_path]
+        Helper::BuildCacheHelper.ensure_workspace_folder_exists(workspace_path)
+
+        derived_data_path = params[:derived_data_path]
+        derived_data_path_components = derived_data_path.split('/')
+        derived_data_folder_name = derived_data_path_components.pop
+
+        zip_tmp_path = File.join(derived_data_path_components.join('/'), build_identifier)
+        zip_final_path = File.join(workspace_path, build_identifier)
+
+        files_to_delete = [File.join(derived_data_path, 'ModuleCache'),
+                           File.join(derived_data_path, 'Logs')]
+        files_to_delete << zip_tmp_path
+        files_to_delete << zip_final_path
+
+        files_to_delete.each do |file|
+          Actions.sh("rm -rf #{file}", log: $verbose)
+        end
+
+        Actions.sh("cd #{derived_data_path} && cd ../ && zip -r #{build_identifier} #{derived_data_folder_name}", log: $verbose)
+        Actions.sh("mv #{zip_tmp_path} #{zip_final_path}", log: $verbose)
+
+        zip_final_path
+      end
+
+      def self.description
+        "Archives derived data folder in a zip file for later use"
+      end
+
+      def self.authors
+        ["Fernando Saragoca"]
+      end
+
+      def self.return_value
+        "Returns path for archived zip file"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :derived_data_path,
+                                  env_name: "BUILD_CACHE_DERIVED_DATA_PATH",
+                               description: "Path to derived data folder",
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :workspace_path,
+                                  env_name: "BUILD_CACHE_WORKSPACE_PATH",
+                               description: "Build cache workspace",
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :build_identifier,
+                                  env_name: "BUILD_CACHE_BUILD_IDENTIFIER",
+                               description: "Identifier for current build",
+                             default_value: Helper::BuildCacheHelper.build_identifier,
+                                      type: String)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/build_cache/actions/check_build_cache_workspace_action.rb

@@ -0,0 +1,42 @@
+module Fastlane
+  module Actions
+    class CheckBuildCacheWorkspaceAction < Action
+      def self.run(params)
+        workspace_path = params[:workspace_path]
+        build_identifier = params[:build_identifier]
+        full_path = File.join(workspace_path, build_identifier)
+        File.file?(full_path)
+      end
+
+      def self.description
+        "Check if cache for current build is avaiable"
+      end
+
+      def self.authors
+        ["Fernando Saragoca"]
+      end
+
+      def self.return_value
+        "Boolean indicating if cache for current build is available"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :workspace_path,
+                                  env_name: "BUILD_CACHE_WORKSPACE_PATH",
+                               description: "Build cache workspace",
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :build_identifier,
+                                  env_name: "BUILD_CACHE_BUILD_IDENTIFIER",
+                               description: "Identifier for current build",
+                             default_value: Helper::BuildCacheHelper.build_identifier,
+                                      type: String)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/build_cache/actions/clean_build_cache_workspace_action.rb

@@ -0,0 +1,46 @@
+module Fastlane
+  module Actions
+    class CleanBuildCacheWorkspaceAction < Action
+      def self.run(params)
+        workspace_path = params[:workspace_path]
+        max_build_count = params[:max_build_count]
+
+        files = Dir[workspace_path + '/*.zip']
+        number_of_files_to_delete = files.count - max_build_count
+        if number_of_files_to_delete > 0
+          # `File.atime` returns the last access time for the named file as a Time object.
+          sorted_files = files.sort_by { |filename| File.atime(filename) }
+          sorted_files.take(number_of_files_to_delete).each do |file|
+            Actions.sh("rm -rf #{file}", log: $verbose)
+          end
+        end
+      end
+
+      def self.description
+        "Cleans workspace by removing old builds, using last access time for comparison"
+      end
+
+      def self.authors
+        ["Fernando Saragoca"]
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :workspace_path,
+                                  env_name: "BUILD_CACHE_WORKSPACE_PATH",
+                               description: "Build cache workspace",
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :max_build_count,
+                                  env_name: "BUILD_CACHE_MAX_BUILD_COUNT",
+                               description: "Number of archives to keep in workspace",
+                             default_value: 10,
+                                      type: Integer)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/build_cache/actions/unarchive_derived_data_action.rb

@@ -0,0 +1,55 @@
+module Fastlane
+  module Actions
+    class UnarchiveDerivedDataAction < Action
+      def self.run(params)
+        build_identifier = params[:build_identifier]
+        workspace_path = params[:workspace_path]
+        Helper::BuildCacheHelper.ensure_workspace_folder_exists(workspace_path)
+
+        derived_data_path = params[:derived_data_path]
+        derived_data_path_components = derived_data_path.split('/')
+        derived_data_path_components.pop
+
+        derived_data_root_folder_path = derived_data_path_components.join('/')
+        zip_path = File.join(workspace_path, build_identifier)
+
+        if File.exist?(zip_path)
+          Actions.sh("unzip #{zip_path} -d #{derived_data_root_folder_path}", log: $verbose)
+        else
+          UI.user_error! "Unable to find cache for build '#{build_identifier}' 🚫"
+        end
+      end
+
+      def self.description
+        "Unarchives derived data folder from a zip file"
+      end
+
+      def self.authors
+        ["Fernando Saragoca"]
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :derived_data_path,
+                                  env_name: "BUILD_CACHE_DERIVED_DATA_PATH",
+                               description: "Path to derived data folder",
+                             default_value: ENV['DERIVED_DATA_PATH'],
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :workspace_path,
+                                  env_name: "BUILD_CACHE_WORKSPACE_PATH",
+                               description: "Build cache workspace",
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :build_identifier,
+                                  env_name: "BUILD_CACHE_BUILD_IDENTIFIER",
+                               description: "Identifier for current build",
+                             default_value: Helper::BuildCacheHelper.build_identifier,
+                                      type: String)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/build_cache/helper/build_cache_helper.rb

@@ -0,0 +1,18 @@
+module Fastlane
+  module Helper
+    class BuildCacheHelper
+      # class methods that you define here become available in your action
+      # as `Helper::BuildCacheHelper.your_method`
+      #
+      def self.build_identifier
+        commits = Actions.sh('git rev-list HEAD', log: $verbose).chomp
+        identifier = Digest::SHA256.hexdigest(commits)
+        identifier + '.zip'
+      end
+
+      def self.ensure_workspace_folder_exists(workspace_path)
+        `mkdir #{workspace_path}` unless File.exist?(workspace_path)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/build_cache/version.rb

@@ -0,0 +1,5 @@
+module Fastlane
+  module BuildCache
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-build_cache
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fernando Saragoca
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+description: 
+email: fsaragoca@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/build_cache.rb
+- lib/fastlane/plugin/build_cache/actions/archive_derived_data_action.rb
+- lib/fastlane/plugin/build_cache/actions/check_build_cache_workspace_action.rb
+- lib/fastlane/plugin/build_cache/actions/clean_build_cache_workspace_action.rb
+- lib/fastlane/plugin/build_cache/actions/unarchive_derived_data_action.rb
+- lib/fastlane/plugin/build_cache/helper/build_cache_helper.rb
+- lib/fastlane/plugin/build_cache/version.rb
+homepage: https://github.com/fsaragoca/fastlane-plugin-build_cache
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Helper for caching builds when using 'build for testing' & 'test without
+  building'
+test_files: []