fastlane 0.11.0 → 0.12.0

data/lib/fastlane/actions/notify.rb

@@ -12,7 +12,7 @@ module Fastlane
         "Shows a Mac OS X notification"
       end
 
-      def author
+      def self.author
         "champo"
       end
 

data/lib/fastlane/actions/pem.rb

@@ -13,7 +13,7 @@ module Fastlane
         values = params.first
 
         begin
-          FastlaneCore::UpdateChecker.start_looking_for_update('pem')
+          FastlaneCore::UpdateChecker.start_looking_for_update('pem') unless Helper.is_test?
 
           success_block = values[:new_profile]
           values.delete(:new_profile) # as it's not in the configs

data/lib/fastlane/actions/produce.rb

@@ -8,16 +8,15 @@ module Fastlane
       def self.run(params)
         require 'produce'
 
-        hash = params.first || {}
-        raise 'Parameter of produce must be a hash'.red unless hash.is_a?(Hash)
+        raise 'Parameter of produce must be a hash'.red unless params.is_a?(Hash)
 
-        hash.each do |key, value|
+        params.each do |key, value|
           ENV[key.to_s.upcase] = value.to_s
         end
 
         return if Helper.test?
 
-        FastlaneCore::UpdateChecker.start_looking_for_update('produce')
+        FastlaneCore::UpdateChecker.start_looking_for_update('produce') unless Helper.is_test?
 
         begin
           Dir.chdir(FastlaneFolder.path || Dir.pwd) do

data/lib/fastlane/actions/push_to_git_remote.rb

@@ -3,29 +3,26 @@ module Fastlane
     # Adds a git tag to the current commit
     class PushToGitRemoteAction < Action
       def self.run(params)
-        options = params.first
-
-        remote        = (options && options[:remote]) || 'origin'
-        force         = (options && options[:force]) || false
-        local_branch  = (options && (options[:local_branch] || options[:branch])) || Actions.git_branch.gsub(/#{remote}\//, '') || 'master'
-        remote_branch = (options && options[:remote_branch]) || local_branch
+        local_branch  = params[:local_branch] || (Actions.git_branch.gsub(/#{params[:remote]}\//, '') rescue nil) || 'master'
+        remote_branch = params[:remote_branch] || local_branch
 
         # construct our command as an array of components
         command = [
           'git',
           'push',
-          remote,
+          params[:remote],
           "#{local_branch}:#{remote_branch}",
           '--tags'
         ]
 
         # optionally add the force component
-        command << '--force' if force
+        command << '--force' if params[:force]
 
         # execute our command
-        puts Actions.sh('pwd')
-        Actions.sh(command.join(' '))
+        Actions.sh('pwd')
+        return command.join(' ') if Helper.is_test?
 
+        Actions.sh(command.join(' '))
         Helper.log.info 'Sucesfully pushed to remote.'
       end
 
@@ -35,10 +32,23 @@ module Fastlane
 
       def self.available_options
         [
-          ['remote', 'The remote to push to. Defaults to `origin`'],
-          ['branch', 'The local branch to push from. Defaults to the current branch'],
-          ['branch', 'The remote branch to push to. Defaults to the local branch'],
-          ['force', 'Force push to remote. Defaults to false']
+          FastlaneCore::ConfigItem.new(key: :local_branch,
+                                       env_name: "FL_GIT_PUSH_LOCAL_BRANCH",
+                                       description: "The local branch to push from. Defaults to the current branch",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :remote_branch,
+                                       env_name: "FL_GIT_PUSH_REMOTE_BRANCH",
+                                       description: "The remote branch to push to. Defaults to the local branch",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :force,
+                                       env_name: "FL_PUSH_GIT_FORCE",
+                                       description: "Force push to remote. Defaults to false",
+                                       is_string: false,
+                                       default_value: false),
+          FastlaneCore::ConfigItem.new(key: :remote,
+                                       env_name: "FL_GIT_PUSH_REMOTE",
+                                       description: "The remote to push to. Defaults to `origin`",
+                                       default_value: 'origin')
         ]
       end
 

data/lib/fastlane/actions/register_devices.rb

@@ -1,3 +1,5 @@
+require 'credentials_manager'
+
 module Fastlane
   module Actions
     class RegisterDevicesAction < Action
@@ -9,17 +11,12 @@ module Fastlane
 
       def self.run(params)
         require 'cupertino/provisioning_portal'
-        require 'credentials_manager'
         require 'csv'
 
-        params = params.first
-
-        raise 'You must pass valid params to the register_devices action. Please check the readme.'.red if (params.nil? || params.empty?)
-
         devices       = params[:devices]
         devices_file  = params[:devices_file]
-        team_id       = params[:team_id] || ENV['CUPERTINO_TEAM_ID'] || ENV['FASTLANE_TEAM_ID']
-        username      = params[:username] || ENV['CUPERTINO_USERNAME']
+        team_id       = params[:team_id]
+        username      = params[:username]
 
         if devices
           device_objs = devices.map do |k, v|
@@ -69,10 +66,25 @@ module Fastlane
 
       def self.available_options
         [
-          ['devices', 'A hash of devices, with the name as key and the UDID as value'],
-          ['device_file', 'Instead, you can proide a path containing all UDIDs'],
-          ['team_id', 'optional: Your team ID'],
-          ['username', 'optional: Your Apple ID']
+          FastlaneCore::ConfigItem.new(key: :devices,
+                                       env_name: "FL_REGISTER_DEVICES_DEVICES",
+                                       description: "A hash of devices, with the name as key and the UDID as value",
+                                       is_string: false),
+          FastlaneCore::ConfigItem.new(key: :devices_file,
+                                       env_name: "FL_REGISTER_DEVICES_FILE",
+                                       description: "Provide a path to the devices to register",
+                                       optional: true,
+                                       verify_block: Proc.new do |value|
+                                        raise "Could not find file '#{value}'".red unless File.exists?(value)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :team_id,
+                                       env_name: "FASTLANE_TEAM_ID",
+                                       description: "optional: Your team ",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :username,
+                                       env_name: "CUPERTINO_USERNAME",
+                                       description: "optional: Your Apple ID ",
+                                       default_value: CredentialsManager::AppfileConfig.try_fetch_value(:apple_id)),
         ]
       end
 

data/lib/fastlane/actions/reset_git_repo.rb

@@ -3,9 +3,8 @@ module Fastlane
     # Does a hard reset and clean on the repo
     class ResetGitRepoAction < Action
       def self.run(params)
-        hash = params.first
-        if params.include?(:force) || hash[:force] || Actions.lane_context[SharedValues::GIT_REPO_WAS_CLEAN_ON_START]
-          paths = (hash[:files] rescue nil)
+        if params[:force] || params[:force] || Actions.lane_context[SharedValues::GIT_REPO_WAS_CLEAN_ON_START]
+          paths = (params[:files] rescue nil)
 
           if (paths || []).count == 0
             Actions.sh('git reset --hard HEAD')
@@ -37,8 +36,17 @@ module Fastlane
 
       def self.available_options
         [
-          ['files', 'Array of files the changes should be discarded from. If not given, all files will be discarded'],
-          ['force', 'Skip verifying of previously clean state of repo. Only recommended in combination with `files` option']
+          FastlaneCore::ConfigItem.new(key: :files,
+                                       env_name: "FL_RESET_GIT_FILES",
+                                       description: "Array of files the changes should be discarded from. If not given, all files will be discarded",
+                                       verify_block: Proc.new do |value|
+                                        raise "Please pass an array only" unless value.kind_of?Array
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :force,
+                                       env_name: "FL_RESET_GIT_FORCE",
+                                       description: "Skip verifying of previously clean state of repo. Only recommended in combination with `files` option",
+                                       is_string: false,
+                                       default_value: false),
         ]
       end
 

data/lib/fastlane/actions/resign.rb

@@ -5,20 +5,9 @@ module Fastlane
       def self.run(params)
         require 'sigh'
 
-        params = params.first
-
-        raise 'You must pass valid params to the resign action. Please check the README.md'.red if (params.nil? || params.empty?)
-
-        ipa                   = params[:ipa] || Actions.lane_context[SharedValues::IPA_OUTPUT_PATH]
-        signing_identity      = params[:signing_identity]
-        provisioning_profile  = params[:provisioning_profile] || Actions.lane_context[SharedValues::SIGH_PROFILE_PATH]
-
-        raise 'Please pass a valid ipa which should be a path to an ipa on disk'.red unless ipa
-        raise 'Please pass a valid signing_identity'.red unless signing_identity
-        raise 'Please pass a valid provisioning_profile which should be a path to a profile on disk.'.red unless provisioning_profile
 
         # try to resign the ipa
-        if Sigh::Resign.resign(ipa, signing_identity, provisioning_profile)
+        if Sigh::Resign.resign(params[:ipa], params[:signing_identity], params[:provisioning_profile])
           Helper.log.info 'Successfully re-signed .ipa 🔏.'.green
         else
           raise 'Failed to re-sign .ipa'.red
@@ -26,14 +15,28 @@ module Fastlane
       end
 
       def self.description
-        "Code sign an existing ipa file"
+        "Codesign an existing ipa file"
       end
 
       def self.available_options
         [
-          ['ipa', 'Path to the ipa file to resign. Optional if you use the `ipa` or `xcodebuild` action'],
-          ['signing_identity', 'Code signing identity to use. e.g. "iPhone Distribution: Luka Mirosevic (0123456789)"'],
-          ['provisioning_profile', 'Path to your provisioning_profile. Optional if you use `sigh`']
+          FastlaneCore::ConfigItem.new(key: :ipa,
+                                       env_name: "FL_RESIGN_IPA",
+                                       description: "Path to the ipa file to resign. Optional if you use the `ipa` or `xcodebuild` action",
+                                       default_value: Actions.lane_context[SharedValues::IPA_OUTPUT_PATH],
+                                       verify_block: Proc.new do |value|
+                                        raise "No IPA file given or found, pass using `ipa_path: 'path/app.ipa'`".red unless File.exists?(value)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :signing_identity,
+                                       env_name: "FL_RESIGN_SIGNING_IDENTITY",
+                                       description: "Code signing identity to use. e.g. \"iPhone Distribution: Luka Mirosevic (0123456789)\""),
+          FastlaneCore::ConfigItem.new(key: :provisioning_profile,
+                                       env_name: "FL_RESIGN_PROVISIONING_PROFILE",
+                                       description: "Path to your provisioning_profile. Optional if you use `sigh`",
+                                       default_value: Actions.lane_context[SharedValues::SIGH_PROFILE_PATH],
+                                       verify_block: Proc.new do |value|
+                                        raise "No provisioning_profile file given or found, pass using `provisioning_profile: 'path/app.mobileprovision'`".red unless File.exists?(value)
+                                       end)
         ]
       end
 

data/lib/fastlane/actions/s3.rb

@@ -12,18 +12,6 @@ module Fastlane
       S3_HTML_OUTPUT_PATH = :S3_HTML_OUTPUT_PATH
     end
 
-    # -f, --file FILE      .ipa file for the build 
-    # -d, --dsym FILE      zipped .dsym package for the build 
-    # -a, --access-key-id ACCESS_KEY_ID AWS Access Key ID 
-    # -s, --secret-access-key SECRET_ACCESS_KEY AWS Secret Access Key 
-    # -b, --bucket BUCKET  S3 bucket 
-    # --[no-]create        Create bucket if it doesn't already exist 
-    # -r, --region REGION  Optional AWS region (for bucket creation) 
-    # --acl ACL            Uploaded object permissions e.g public_read (default), private, public_read_write, authenticated_read 
-    # --source-dir SOURCE  Optional source directory e.g. ./build 
-    # -P, --path PATH      S3 'path'. Values from Info.plist will be substituded for keys wrapped in {}  
-    #              eg. "/path/to/folder/{CFBundleVersion}/" could be evaluated as "/path/to/folder/1.0.0/" 
-
     S3_ARGS_MAP = {
       ipa: '-f',
       dsym: '-d',
@@ -37,23 +25,19 @@ module Fastlane
     }
 
     class S3Action < Action
-      def self.run(params)
-        
-        params[0] ||= {}
-        unless params.first.is_a?Hash
-          raise "Please pass the required information to the s3 action." 
-        end
-
-        # Other things that we need
-        params = params.first
-
-        params[:access_key] ||= ENV['S3_ACCESS_KEY'] || ENV['AWS_ACCESS_KEY_ID']
-        params[:secret_access_key] ||= ENV['S3_SECRET_ACCESS_KEY'] || ENV['AWS_SECRET_ACCESS_KEY']
-        params[:bucket] ||= ENV['S3_BUCKET'] || ENV['AWS_BUCKET_NAME']
-        params[:region] ||= ENV['S3_REGION'] || ENV['AWS_REGION']
-        params[:ipa] ||= Actions.lane_context[SharedValues::IPA_OUTPUT_PATH]
-        params[:dsym] ||= Actions.lane_context[SharedValues::DSYM_OUTPUT_PATH]
-        params[:path] ||= 'v{CFBundleShortVersionString}_b{CFBundleVersion}/'
+      def self.run(config)
+
+        # Calling fetch on config so that default values will be used
+        params = {}
+        params[:ipa] = config[:ipa]
+        params[:dsym] = config[:dsym]
+        params[:access_key] = config[:access_key]
+        params[:secret_access_key] = config[:secret_access_key]
+        params[:bucket] = config[:bucket]
+        params[:region] = config[:region]
+        params[:acl] = config[:acl]
+        params[:source] = config[:source]
+        params[:path] = config[:path]
 
         # Maps nice developer build parameters to Shenzhen args
         build_args = params_to_build_args(params)
@@ -247,14 +231,49 @@ module Fastlane
 
       def self.available_options
         [
-          ['access_key', 'AWS S3 Access Key', 'S3_ACCESS_KEY'],
-          ['secret_access_key', 'AWS S3 Secret Key', 'S3_SECRET_ACCESS_KEY'],
-          ['bucket', 'The bucket to store the ipa and plist in', 'S3_BUCKET'],
-          ['region', 'The region of your S3 server', 'S3_REGION'],
-          ['file', 'Path the ipa file to upload'],
-          ['dsym', 'Path to your dsym file'],
-          ['path', 'The path how it\'s used on S3']
-          # TODO: there are more options
+          FastlaneCore::ConfigItem.new(key: :ipa,
+                                       env_name: "",
+                                       description: ".ipa file for the build ",
+                                       optional: true,
+                                       default_value: Actions.lane_context[SharedValues::IPA_OUTPUT_PATH]),
+          FastlaneCore::ConfigItem.new(key: :dsym,
+                                       env_name: "",
+                                       description: "zipped .dsym package for the build ",
+                                       optional: true,
+                                       default_value: Actions.lane_context[SharedValues::DSYM_OUTPUT_PATH]),
+          FastlaneCore::ConfigItem.new(key: :access_key,
+                                       env_name: "S3_ACCESS_KEY",
+                                       description: "AWS Access Key ID ",
+                                       optional: true,
+                                       default_value: ENV['AWS_ACCESS_KEY_ID']),
+          FastlaneCore::ConfigItem.new(key: :secret_access_key,
+                                       env_name: "S3_SECRET_ACCESS_KEY",
+                                       description: "AWS Secret Access Key ",
+                                       optional: true,
+                                       default_value: ENV['AWS_SECRET_ACCESS_KEY']),
+          FastlaneCore::ConfigItem.new(key: :bucket,
+                                       env_name: "S3_BUCKET",
+                                       description: "AWS bucket name",
+                                       optional: true,
+                                       default_value: ENV['AWS_BUCKET_NAME']),
+          FastlaneCore::ConfigItem.new(key: :region,
+                                       env_name: "S3_REGION",
+                                       description: "AWS region (for bucket creation) ",
+                                       optional: true,
+                                       default_value: ENV['AWS_REGION']),
+          FastlaneCore::ConfigItem.new(key: :path,
+                                       env_name: "S3_PATH",
+                                       description: "S3 'path'. Values from Info.plist will be substituded for keys wrapped in {}  ",
+                                       optional: true,
+                                       default_value: 'v{CFBundleShortVersionString}_b{CFBundleVersion}/'),
+          FastlaneCore::ConfigItem.new(key: :source,
+                                       env_name: "S3_SOURCE",
+                                       description: "Optional source directory e.g. ./build ",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :acl,
+                                       env_name: "S3_ACL",
+                                       description: "Uploaded object permissions e.g public_read (default), private, public_read_write, authenticated_read ",
+                                       optional: true,),
         ]
       end
 

data/lib/fastlane/actions/sigh.rb

@@ -23,7 +23,7 @@ module Fastlane
         end
 
         begin
-          FastlaneCore::UpdateChecker.start_looking_for_update('sigh')
+          FastlaneCore::UpdateChecker.start_looking_for_update('sigh') unless Helper.is_test?
 
           Sigh.config = FastlaneCore::Configuration.create(Sigh::Options.available_options, (values || {}))
           

data/lib/fastlane/actions/slack.rb

@@ -30,17 +30,10 @@ module Fastlane
         message
       end
 
-      def self.run(params)
-        options = { message: '',
-                    success: true,
-                    channel: nil,
-                    payload: {}
-                  }.merge(params.first || {})
-
+      def self.run(options)
         require 'slack-notifier'
 
         options[:message] = self.trim_message(options[:message].to_s || '')
-
         options[:message] = Slack::Notifier::LinkFormatter.format(options[:message])
 
         url = ENV['SLACK_URL']
@@ -79,11 +72,36 @@ module Fastlane
 
       def self.available_options
         [
-          ['message', 'The message that should be displayed on Slack. This supports the standard Slack markup language'],
-          ['channel', '#channel or @username'],
-          ['success', 'Success or error?'],
-          ['payload', 'Add additional information to this post. payload must be a hash containg any key with any value'],
-          ['default_payloads', 'Remove some of the default payloads. More information about the available payloads GitHub']
+          FastlaneCore::ConfigItem.new(key: :message,
+                                       env_name: "FL_SLACK_MESSAGE",
+                                       description: "The message that should be displayed on Slack. This supports the standard Slack markup language",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :channel,
+                                       env_name: "FL_SLACK_CHANNEL",
+                                       description: "#channel or @username",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :slack_url,
+                                       env_name: "SLACK_URL",
+                                       description: "Create an Incoming WebHook for your Slack group",
+                                       verify_block: Proc.new do |value|
+                                        raise "Invalid URL, must start with https://" unless value.start_with?"https://"
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :payload,
+                                       env_name: "FL_SLACK_PAYLOAD",
+                                       description: "Add additional information to this post. payload must be a hash containg any key with any value",
+                                       default_value: {},
+                                       is_string: false),
+          FastlaneCore::ConfigItem.new(key: :default_payloads,
+                                       env_name: "FL_SLACK_DEFAULT_PAYLOADS",
+                                       description: "Remove some of the default payloads. More information about the available payloads on GitHub",
+                                       optional: true,
+                                       is_string: false),
+          FastlaneCore::ConfigItem.new(key: :success,
+                                       env_name: "FL_SLACK_SUCCESS",
+                                       description: "Was this build successful? (true/false)",
+                                       optional: true,
+                                       default_value: true,
+                                       is_string: false),
         ]
       end
 

data/lib/fastlane/actions/snapshot.rb

@@ -6,9 +6,8 @@ module Fastlane
 
     class SnapshotAction < Action
       def self.run(params)
-        clean = true
-        clean = false if params.include?(:noclean)
-        $verbose = true if params.include?(:verbose)
+        $verbose = true if params[:verbose]
+        clean = !params[:noclean]
 
         if Helper.test?
           Actions.lane_context[SharedValues::SNAPSHOT_SCREENSHOTS_PATH] = Dir.pwd
@@ -17,7 +16,7 @@ module Fastlane
 
         require 'snapshot'
 
-        FastlaneCore::UpdateChecker.start_looking_for_update('snapshot')
+        FastlaneCore::UpdateChecker.start_looking_for_update('snapshot') unless Helper.is_test?
 
         begin
           Dir.chdir(FastlaneFolder.path) do
@@ -39,8 +38,16 @@ module Fastlane
 
       def self.available_options
         [
-          ['noclean', 'Skips the clean process when building the app'],
-          ['verbose', 'Print out the UI Automation output']
+          FastlaneCore::ConfigItem.new(key: :noclean,
+                                       env_name: "FL_SNAPSHOT_NO_CLEAN",
+                                       description: "Skips the clean process when building the app",
+                                       is_string: false,
+                                       default_value: false),
+          FastlaneCore::ConfigItem.new(key: :verbose,
+                                       env_name: "FL_SNAPSHOT_VERBOSE",
+                                       description: "Print out the UI Automation output",
+                                       is_string: false,
+                                       default_value: false)
         ]
       end