fastlane 2.167.0 → 2.172.0

data/fastlane/lib/fastlane/actions/slack.rb

@@ -115,8 +115,8 @@ module Fastlane
                                        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,
+                                       description: "Specifies default payloads to include. Pass an empty array to suppress all the default payloads",
+                                       default_value: ['lane', 'test_result', 'git_branch', 'git_author', 'last_git_commit', 'last_git_commit_hash'],
                                        type: Array),
           FastlaneCore::ConfigItem.new(key: :attachment_properties,
                                        env_name: "FL_SLACK_ATTACHMENT_PROPERTIES",
@@ -159,8 +159,7 @@ module Fastlane
               "Build Date" => Time.new.to_s,
               "Built by" => "Jenkins",
             },
-            default_payloads: [:git_branch, :git_author], # Optional, lets you specify an allowlist of default payloads to include. Pass an empty array to suppress all the default payloads.
-                                                          # Don\'t add this key, or pass nil, if you want all the default payloads. The available default payloads are: `lane`, `test_result`, `git_branch`, `git_author`, `last_git_commit`, `last_git_commit_hash`.
+            default_payloads: [:git_branch, :git_author], # Optional, lets you specify default payloads to include. Pass an empty array to suppress all the default payloads.
             attachment_properties: { # Optional, lets you specify any other properties available for attachments in the slack API (see https://api.slack.com/docs/attachments).
                                      # This hash is deep merged with the existing properties set using the other properties above. This allows your own fields properties to be appended to the existing fields that were created using the `payload` property for instance.
               thumb_url: "http://example.com/path/to/thumb.png",
@@ -188,7 +187,7 @@ module Fastlane
 
       def self.generate_slack_attachments(options)
         color = (options[:success] ? 'good' : 'danger')
-        should_add_payload = ->(payload_name) { options[:default_payloads].nil? || options[:default_payloads].map(&:to_sym).include?(payload_name.to_sym) }
+        should_add_payload = ->(payload_name) { options[:default_payloads].map(&:to_sym).include?(payload_name.to_sym) }
 
         slack_attachment = {
           fallback: options[:message],

data/fastlane/lib/fastlane/actions/slather.rb

@@ -272,8 +272,8 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :binary_basename,
                                        env_name: "FL_SLATHER_BINARY_BASENAME",
                                        description: "Basename of the binary file, this should match the name of your bundle excluding its extension (i.e. YourApp [for YourApp.app bundle])",
-                                       is_string: false,
-                                       default_value: false),
+                                       type: Array,
+                                       optional: true),
           FastlaneCore::ConfigItem.new(key: :binary_file,
                                        env_name: "FL_SLATHER_BINARY_FILE",
                                        description: "Binary file name to be used for code coverage",

data/fastlane/lib/fastlane/actions/spm.rb

@@ -11,7 +11,7 @@ module Fastlane
         cmd << "--disable-sandbox" if params[:disable_sandbox]
         cmd << "--verbose" if params[:verbose]
         cmd << params[:command] if package_commands.include?(params[:command])
-        cmd << "--enable-code-coverage" if params[:enable_code_coverage] && params[:command] == 'generate-xcodeproj'
+        cmd << "--enable-code-coverage" if params[:enable_code_coverage] && (params[:command] == 'generate-xcodeproj' || params[:command] == 'test')
         if params[:xcconfig]
           cmd << "--xcconfig-overrides #{params[:xcconfig]}"
         end
@@ -47,7 +47,7 @@ module Fastlane
                                        end),
           FastlaneCore::ConfigItem.new(key: :enable_code_coverage,
                                        env_name: "FL_SPM_ENABLE_CODE_COVERAGE",
-                                       description: "Enables code coverage for the generated Xcode project when using the generate-xcodeproj command",
+                                       description: "Enables code coverage for the generated Xcode project when using the 'generate-xcodeproj' and the 'test' command",
                                        is_string: false,
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :build_path,

data/fastlane/lib/fastlane/actions/swiftlint.rb

@@ -139,13 +139,13 @@ module Fastlane
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :reporter,
                                        env_name: "FL_SWIFTLINT_REPORTER",
-                                       description: "Choose output reporter. Available: xcode, json, csv, checkstyle, junit, html, \
-                                                     emoji, sonarqube, markdown, github-actions-logging",
+                                       description: "Choose output reporter. Available: xcode, json, csv, checkstyle, codeclimate, \
+                                                     junit, html, emoji, sonarqube, markdown, github-actions-logging",
                                        is_string: true,
                                        optional: true,
                                        verify_block: proc do |value|
-                                         available = ['xcode', 'json', 'csv', 'checkstyle', 'junit', 'html', 'emoji', 'sonarqube', 'markdown', 'github-actions-logging']
-                                         UI.user_error!("Available values are '#{available.join("', '")}'") unless available.include?(value)
+                                         available = ['xcode', 'json', 'csv', 'checkstyle', 'codeclimate', 'junit', 'html', 'emoji', 'sonarqube', 'markdown', 'github-actions-logging']
+                                         UI.warning("Known 'reporter' values are '#{available.join("', '")}'. If you're receiving errors from swiftlint related to the reporter, make sure the reporter identifier you're using is correct and it's supported by your version of swiftlint.") unless available.include?(value)
                                        end),
           FastlaneCore::ConfigItem.new(key: :quiet,
                                        env_name: "FL_SWIFTLINT_QUIET",

data/fastlane/lib/fastlane/actions/upload_app_privacy_details_to_app_store.rb

@@ -0,0 +1,291 @@
+module Fastlane
+  module Actions
+    class UploadAppPrivacyDetailsToAppStoreAction < Action
+      DEFAULT_PATH = Fastlane::Helper.fastlane_enabled_folder_path
+      DEFAULT_FILE_NAME = "app_privacy_details.json"
+
+      def self.run(params)
+        require 'spaceship'
+
+        # Prompts select team if multiple teams and none specified
+        UI.message("Login to App Store Connect (#{params[:username]})")
+        Spaceship::ConnectAPI.login(params[:username], use_portal: false, use_tunes: true, tunes_team_id: params[:team_id], team_name: params[:team_name])
+        UI.message("Login successful")
+
+        # Get App
+        app = Spaceship::ConnectAPI::App.find(params[:app_identifier])
+        unless app
+          UI.user_error!("Could not find app with bundle identifier '#{params[:app_identifier]}' on account #{params[:username]}")
+        end
+
+        # Attempt to load JSON file
+        usages_config = load_json_file(params)
+
+        # Start interactive questions to generate and save JSON file
+        unless usages_config
+          usages_config = ask_interactive_questions_for_json
+
+          if params[:skip_json_file_saving]
+            UI.message("Skipping JSON file saving...")
+          else
+            json = JSON.pretty_generate(usages_config)
+            path = output_path(params)
+
+            UI.message("Writing file to #{path}")
+            File.write(path, json)
+          end
+        end
+
+        # Process JSON file to save app data usages to API
+        if params[:skip_upload]
+          UI.message("Skipping uploading of data... (so you can verify your JSON file)")
+        else
+          upload_app_data_usages(params, app, usages_config)
+        end
+      end
+
+      def self.load_json_file(params)
+        path = params[:json_path]
+        return nil if path.nil?
+        return JSON.parse(File.read(path))
+      end
+
+      def self.output_path(params)
+        path = params[:output_json_path]
+        return File.absolute_path(path)
+      end
+
+      def self.ask_interactive_questions_for_json(show_intro = true)
+        if show_intro
+          UI.important("You did not provide a JSON file for updating the app data usages")
+          UI.important("fastlane will now run you through interactive question to generate the JSON file")
+          UI.important("")
+          UI.important("This JSON file can be saved in source control and used in this action with the :json_file option")
+
+          unless UI.confirm("Ready to start?")
+            UI.user_error!("Cancelled")
+          end
+        end
+
+        # Fetch categories and purposes used for generating interactive questions
+        categories = Spaceship::ConnectAPI::AppDataUsageCategory.all(includes: "grouping")
+        purposes = Spaceship::ConnectAPI::AppDataUsagePurpose.all
+
+        json = []
+
+        unless UI.confirm("Are you collecting data?")
+          json << {
+            "data_protections" => [Spaceship::ConnectAPI::AppDataUsageDataProtection::ID::DATA_NOT_COLLECTED]
+          }
+
+          return json
+        end
+
+        categories.each do |category|
+          # Ask if using category
+          next unless UI.confirm("Collect data for #{category.id}?")
+
+          purpose_names = purposes.map(&:id).join(', ')
+          UI.message("How will this data be used? You'll be offered with #{purpose_names}")
+
+          # Ask purposes
+          selected_purposes = []
+          loop do
+            purposes.each do |purpose|
+              selected_purposes << purpose if UI.confirm("Used for #{purpose.id}?")
+            end
+
+            break unless selected_purposes.empty?
+            break unless UI.confirm("No purposes selected. Do you want to try again?")
+          end
+
+          # Skip asking protections if purposes were skipped
+          next if selected_purposes.empty?
+
+          # Ask protections
+          is_linked_to_user = UI.confirm("Is #{category.id} linked to the user?")
+          is_used_for_tracking = UI.confirm("Is #{category.id} used for tracking purposes?")
+
+          # Map answers to values for API requests
+          protection_id = is_linked_to_user ? Spaceship::ConnectAPI::AppDataUsageDataProtection::ID::DATA_LINKED_TO_YOU : Spaceship::ConnectAPI::AppDataUsageDataProtection::ID::DATA_NOT_LINKED_TO_YOU
+          tracking_id = is_used_for_tracking ? Spaceship::ConnectAPI::AppDataUsageDataProtection::ID::DATA_USED_TO_TRACK_YOU : nil
+
+          json << {
+            "category" => category.id,
+            "purposes" => selected_purposes.map(&:id).sort.uniq,
+            "data_protections" => [
+              protection_id, tracking_id
+            ].compact.sort.uniq
+          }
+        end
+
+        json.sort_by! { |c| c["category"] }
+
+        # Recursively call this method if no categories were selected for data collection
+        if json.empty?
+          UI.error("No categories were selected for data collection.")
+          json = ask_interactive_questions_for_json(false)
+        end
+
+        return json
+      end
+
+      def self.upload_app_data_usages(params, app, usages_config)
+        UI.message("Preparing to upload App Data Usage")
+
+        # Delete all existing usages for new ones
+        all_usages = Spaceship::ConnectAPI::AppDataUsage.all(app_id: app.id, includes: "category,grouping,purpose,dataProtection", limit: 500)
+        all_usages.each(&:delete!)
+
+        usages_config.each do |usage_config|
+          category = usage_config["category"]
+          purposes = usage_config["purposes"] || []
+          data_protections = usage_config["data_protections"] || []
+
+          # There will not be any purposes if "not collecting data"
+          # However, an AppDataUsage still needs to be created for not collecting data
+          # Creating an array with nil so that purposes can be iterated over and
+          # that AppDataUsage can be created
+          purposes = [nil] if purposes.empty?
+
+          purposes.each do |purpose|
+            data_protections.each do |data_protection|
+              if data_protection == Spaceship::ConnectAPI::AppDataUsageDataProtection::ID::DATA_NOT_COLLECTED
+                UI.message("Setting #{data_protection}")
+              else
+                UI.message("Setting #{category} and #{purpose} to #{data_protection}")
+              end
+
+              Spaceship::ConnectAPI::AppDataUsage.create(
+                app_id: app.id,
+                app_data_usage_category_id: category,
+                app_data_usage_protection_id: data_protection,
+                app_data_usage_purpose_id: purpose
+              )
+            end
+          end
+        end
+
+        # Publish
+        if params[:skip_publish]
+          UI.message("Skipping app data usage publishing... (so you can verify on App Store Connect)")
+        else
+          publish_state = Spaceship::ConnectAPI::AppDataUsagesPublishState.get(app_id: app.id)
+          if publish_state.published
+            UI.important("App data usage is already published")
+          else
+            UI.important("App data usage not published! Going to publish...")
+            publish_state.publish!
+            UI.important("App data usage is now published")
+          end
+        end
+      end
+
+      def self.description
+        "Upload App Privacy Details for an app in App Store Connect"
+      end
+
+      def self.available_options
+        user = CredentialsManager::AppfileConfig.try_fetch_value(:itunes_connect_id)
+        user ||= CredentialsManager::AppfileConfig.try_fetch_value(:apple_id)
+
+        [
+          FastlaneCore::ConfigItem.new(key: :username,
+                                       env_name: "FASTLANE_USER",
+                                       description: "Your Apple ID Username for App Store Connect",
+                                       default_value: user,
+                                       default_value_dynamic: true),
+          FastlaneCore::ConfigItem.new(key: :app_identifier,
+                                       env_name: "UPLOAD_APP_PRIVACY_DETAILS_TO_APP_STORE_APP_IDENTIFIER",
+                                       description: "The bundle identifier of your app",
+                                       code_gen_sensitive: true,
+                                       default_value: CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier),
+                                       default_value_dynamic: true),
+          FastlaneCore::ConfigItem.new(key: :team_id,
+                                       env_name: "FASTLANE_ITC_TEAM_ID",
+                                       description: "The ID of your App Store Connect team if you're in multiple teams",
+                                       optional: true,
+                                       is_string: false, # as we also allow integers, which we convert to strings anyway
+                                       code_gen_sensitive: true,
+                                       default_value: CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_id),
+                                       default_value_dynamic: true),
+          FastlaneCore::ConfigItem.new(key: :team_name,
+                                       env_name: "FASTLANE_ITC_TEAM_NAME",
+                                       description: "The name of your App Store Connect team if you're in multiple teams",
+                                       optional: true,
+                                       code_gen_sensitive: true,
+                                       default_value: CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_name),
+                                       default_value_dynamic: true),
+
+          # JSON paths
+          FastlaneCore::ConfigItem.new(key: :json_path,
+                                       env_name: "UPLOAD_APP_PRIVACY_DETAILS_TO_APP_STORE_JSON_PATH",
+                                       description: "Path to the app usage data JSON",
+                                       is_string: true,
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Could not find JSON file at path '#{File.expand_path(value)}'") unless File.exist?(value)
+                                         UI.user_error!("'#{value}' doesn't seem to be a JSON file") unless FastlaneCore::Helper.json_file?(File.expand_path(value))
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :output_json_path,
+                                       env_name: "UPLOAD_APP_PRIVACY_DETAILS_TO_APP_STORE_OUTPUT_JSON_PATH",
+                                       description: "Path to the app usage data JSON file generated by interactive questions",
+                                       conflicting_options: [:skip_json_file_saving],
+                                       default_value: File.join(DEFAULT_PATH, DEFAULT_FILE_NAME)),
+
+          # Skipping options
+          FastlaneCore::ConfigItem.new(key: :skip_json_file_saving,
+                                       env_name: "UPLOAD_APP_PRIVACY_DETAILS_TO_APP_STORE_OUTPUT_SKIP_JSON_FILE_SAVING",
+                                       description: "Whether to skip the saving of the JSON file",
+                                       conflicting_options: [:skip_output_json_path],
+                                       type: Boolean,
+                                       default_value: false),
+          FastlaneCore::ConfigItem.new(key: :skip_upload,
+                                       env_name: "UPLOAD_APP_PRIVACY_DETAILS_TO_APP_STORE_OUTPUT_SKIP_UPLOAD",
+                                       description: "Whether to skip the upload and only create the JSON file with interactive questions",
+                                       conflicting_options: [:skip_publish],
+                                       type: Boolean,
+                                       default_value: false),
+          FastlaneCore::ConfigItem.new(key: :skip_publish,
+                                       env_name: "UPLOAD_APP_PRIVACY_DETAILS_TO_APP_STORE_OUTPUT_SKIP_PUBLISH",
+                                       description: "Whether to skip the publishing",
+                                       conflicting_options: [:skip_upload],
+                                       type: Boolean,
+                                       default_value: false)
+        ]
+      end
+
+      def self.author
+        "joshdholtz"
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac, :tvos].include?(platform)
+      end
+
+      def self.details
+        "Upload App Privacy Details for an app in App Store Connect. For more detail information, view https://docs.fastlane.tools/uploading-app-privacy-details"
+      end
+
+      def self.example_code
+        [
+          'upload_app_privacy_details_to_app_store(
+            username: "your@email.com",
+            team_name: "Your Team",
+            app_identifier: "com.your.bundle"
+          )',
+          'upload_app_privacy_details_to_app_store(
+            username: "your@email.com",
+            team_name: "Your Team",
+            app_identifier: "com.your.bundle",
+            json_path: "fastlane/app_data_usages.json"
+          )'
+        ]
+      end
+
+      def self.category
+        :production
+      end
+    end
+  end
+end

data/fastlane/lib/fastlane/actions/upload_to_app_store.rb

@@ -9,9 +9,9 @@ module Fastlane
 
         begin
           config.load_configuration_file("Deliverfile")
-          config[:screenshots_path] = Actions.lane_context[SharedValues::SNAPSHOT_SCREENSHOTS_PATH] if Actions.lane_context[SharedValues::SNAPSHOT_SCREENSHOTS_PATH]
-          config[:ipa] = Actions.lane_context[SharedValues::IPA_OUTPUT_PATH] if Actions.lane_context[SharedValues::IPA_OUTPUT_PATH]
-          config[:pkg] = Actions.lane_context[SharedValues::PKG_OUTPUT_PATH] if Actions.lane_context[SharedValues::PKG_OUTPUT_PATH]
+          config[:screenshots_path] ||= Actions.lane_context[SharedValues::SNAPSHOT_SCREENSHOTS_PATH] if Actions.lane_context[SharedValues::SNAPSHOT_SCREENSHOTS_PATH]
+          config[:ipa] ||= Actions.lane_context[SharedValues::IPA_OUTPUT_PATH] if Actions.lane_context[SharedValues::IPA_OUTPUT_PATH]
+          config[:pkg] ||= Actions.lane_context[SharedValues::PKG_OUTPUT_PATH] if Actions.lane_context[SharedValues::PKG_OUTPUT_PATH]
           config[:api_key] ||= Actions.lane_context[SharedValues::APP_STORE_CONNECT_API_KEY]
 
           return config if Helper.test?

data/fastlane/lib/fastlane/actions/xcode_install.rb

@@ -17,7 +17,7 @@ module Fastlane
         if installer.installed?(params[:version])
           UI.success("Xcode #{params[:version]} is already installed ✨")
         else
-          installer.install_version(params[:version], true, true, true, true)
+          installer.install_version(params[:version], true, true, true, true, nil, true, nil, params[:download_retry_attempts])
         end
 
         xcode = installer.installed_versions.find { |x| x.version == params[:version] }
@@ -49,9 +49,7 @@ module Fastlane
         [
           FastlaneCore::ConfigItem.new(key: :version,
                                        env_name: "FL_XCODE_VERSION",
-                                       description: "The version number of the version of Xcode to install",
-                                       verify_block: proc do |value|
-                                       end),
+                                       description: "The version number of the version of Xcode to install"),
           FastlaneCore::ConfigItem.new(key: :username,
                                        short_option: "-u",
                                        env_name: "XCODE_INSTALL_USER",
@@ -65,7 +63,12 @@ module Fastlane
                                        optional: true,
                                        code_gen_sensitive: true,
                                        default_value: CredentialsManager::AppfileConfig.try_fetch_value(:team_id),
-                                       default_value_dynamic: true)
+                                       default_value_dynamic: true),
+          FastlaneCore::ConfigItem.new(key: :download_retry_attempts,
+                                       env_name: "XCODE_INSTALL_DOWNLOAD_RETRY_ATTEMPTS",
+                                       description: "Number of times the download will be retried in case of failure",
+                                       type: Integer,
+                                       default_value: 3)
         ]
       end
 

data/fastlane/lib/fastlane/cli_tools_distributor.rb

@@ -71,6 +71,9 @@ module Fastlane
         # Disabling colors if environment variable set
         require 'fastlane_core/ui/disable_colors' if FastlaneCore::Helper.colors_disabled?
 
+        # Set interactive environment variable for spaceship (which can't require fastlane_core)
+        ENV["FASTLANE_IS_INTERACTIVE"] = FastlaneCore::UI.interactive?.to_s
+
         ARGV.unshift("spaceship") if ARGV.first == "spaceauth"
         tool_name = ARGV.first ? ARGV.first.downcase : nil
 

data/fastlane/lib/fastlane/plugins/template/.rubocop.yml

@@ -122,7 +122,7 @@ Layout/SpaceAroundOperators:
   Exclude:
   - "**/spec/actions_specs/xcodebuild_spec.rb"
 AllCops:
-  TargetRubyVersion: 2.0
+  TargetRubyVersion: 2.4
   Include:
   - "*/lib/assets/*Template"
   - "*/lib/assets/*TemplateAndroid"

data/fastlane/lib/fastlane/swift_fastlane_api_generator.rb

@@ -79,6 +79,7 @@ module Fastlane
       available_external_actions = Fastlane.external_actions || []
       available_actions = []
       ActionsList.all_actions do |action|
+        next unless action.respond_to?(:action_name)
         available_actions << action.action_name unless available_external_actions.include?(action)
       end
 
@@ -108,6 +109,7 @@ module Fastlane
       # Excludes all actions that aren't pluign actions (including external actions)
       available_actions = []
       ActionsList.all_actions do |action|
+        next unless action.respond_to?(:action_name)
         available_actions << action.action_name unless available_plugins.include?(action)
       end
 
@@ -151,6 +153,7 @@ module Fastlane
 
       tool_details = []
       ActionsList.all_actions do |action|
+        next unless action.respond_to?(:action_name)
         next if self.actions_not_supported.include?(action.action_name)
 
         swift_function = process_action(action: action)