fastlane_iac_publish 0.1.0

data/fastlane/lib/fastlane/actions/upload_symbols_to_crashlytics.rb

@@ -0,0 +1,244 @@
+require 'thread'
+
+module Fastlane
+  module Actions
+    class UploadSymbolsToCrashlyticsAction < Action
+      def self.run(params)
+        require 'tmpdir'
+
+        find_binary_path(params)
+        find_gsp_path(params)
+        find_api_token(params)
+
+        if !params[:api_token] && !params[:gsp_path]
+          UI.user_error!('Either Fabric API key or path to Firebase Crashlytics GoogleService-Info.plist must be given.')
+        end
+
+        dsym_paths = []
+        dsym_paths << params[:dsym_path] if params[:dsym_path]
+        dsym_paths += Actions.lane_context[SharedValues::DSYM_PATHS] if Actions.lane_context[SharedValues::DSYM_PATHS]
+
+        # Allows adding of additional multiple dsym_paths since :dsym_path can be autoset by other actions
+        dsym_paths += params[:dsym_paths] if params[:dsym_paths]
+
+        if dsym_paths.count == 0
+          UI.error("Couldn't find any dSYMs, please pass them using the dsym_path option")
+          return nil
+        end
+
+        # Get rid of duplicates (which might occur when both passed and detected)
+        dsym_paths = dsym_paths.collect { |a| File.expand_path(a) }
+        dsym_paths.uniq!
+
+        max_worker_threads = params[:dsym_worker_threads]
+        if max_worker_threads > 1
+          UI.message("Using #{max_worker_threads} threads for Crashlytics dSYM upload 🏎")
+        end
+
+        dsym_paths.each do |current_path|
+          handle_dsym(params, current_path, max_worker_threads)
+        end
+
+        UI.success("Successfully uploaded dSYM files to Crashlytics 💯")
+      end
+
+      # @param current_path this is a path to either a dSYM or a zipped dSYM
+      #   this might also be either nested or not, we're flexible
+      def self.handle_dsym(params, current_path, max_worker_threads)
+        if current_path.end_with?(".dSYM")
+          upload_dsym(params, current_path)
+        elsif current_path.end_with?(".zip")
+          UI.message("Extracting '#{current_path}'...")
+
+          current_path = File.expand_path(current_path)
+          Dir.mktmpdir do |dir|
+            Dir.chdir(dir) do
+              Actions.sh("unzip -qo #{current_path.shellescape}")
+              work_q = Queue.new
+              Dir["*.dSYM"].each do |sub|
+                work_q.push(sub)
+              end
+              execute_uploads(params, max_worker_threads, work_q)
+            end
+          end
+        else
+          UI.error("Don't know how to handle '#{current_path}'")
+        end
+      end
+
+      def self.execute_uploads(params, max_worker_threads, work_q)
+        number_of_threads = [max_worker_threads, work_q.size].min
+        workers = (0...number_of_threads).map do
+          Thread.new do
+            begin
+              while work_q.size > 0
+                current_path = work_q.pop(true)
+                upload_dsym(params, current_path)
+              end
+            rescue => ex
+              UI.error(ex.to_s)
+            end
+          end
+        end
+        workers.map(&:join)
+      end
+
+      def self.upload_dsym(params, path)
+        UI.message("Uploading '#{path}'...")
+        command = []
+        command << File.expand_path(params[:binary_path]).shellescape
+        if params[:gsp_path]
+          command << "-gsp #{params[:gsp_path].shellescape}"
+        elsif params[:api_token]
+          command << "-a #{params[:api_token]}"
+        end
+        command << "-p #{params[:platform] == 'appletvos' ? 'tvos' : params[:platform]}"
+        command << File.expand_path(path).shellescape
+        begin
+          command_to_execute = command.join(" ")
+          UI.verbose("upload_dsym using command: #{command_to_execute}")
+          Actions.sh(command_to_execute, log: false)
+        rescue => ex
+          UI.error(ex.to_s) # it fails, however we don't want to fail everything just for this
+        end
+      end
+
+      def self.find_api_token(params)
+        return if params[:gsp_path]
+        unless params[:api_token].to_s.length > 0
+          Dir["./**/Info.plist"].each do |current|
+            result = Actions::GetInfoPlistValueAction.run(path: current, key: "Fabric")
+            next unless result
+            next unless result.kind_of?(Hash)
+            params[:api_token] ||= result["APIKey"]
+            UI.verbose("found an APIKey in #{current}")
+          end
+        end
+      end
+
+      def self.find_gsp_path(params)
+        return if params[:api_token]
+
+        if params[:gsp_path].to_s.length > 0
+          params[:gsp_path] = File.expand_path(params[:gsp_path])
+        else
+          gsp_path = Dir["./**/GoogleService-Info.plist"].first
+          params[:gsp_path] = File.expand_path(gsp_path) unless gsp_path.nil?
+        end
+      end
+
+      def self.find_binary_path(params)
+        params[:binary_path] ||= (Dir["/Applications/Fabric.app/**/upload-symbols"] + Dir["./Pods/**/upload-symbols"]).last
+        UI.user_error!("Failed to find Fabric's upload_symbols binary at /Applications/Fabric.app/**/upload-symbols or ./Pods/**/upload-symbols. Please specify the location of the binary explicitly by using the binary_path option") unless params[:binary_path]
+
+        params[:binary_path] = File.expand_path(params[:binary_path])
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Upload dSYM symbolication files to Crashlytics"
+      end
+
+      def self.details
+        "This action allows you to upload symbolication files to Crashlytics. It's extra useful if you use it to download the latest dSYM files from Apple when you use Bitcode. This action will not fail the build if one of the uploads failed. The reason for that is that sometimes some of dSYM files are invalid, and we don't want them to fail the complete build."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :dsym_path,
+                                       env_name: "FL_UPLOAD_SYMBOLS_TO_CRASHLYTICS_DSYM_PATH",
+                                       description: "Path to the DSYM file or zip to upload",
+                                       default_value: ENV[SharedValues::DSYM_OUTPUT_PATH.to_s] || (Dir["./**/*.dSYM"] + Dir["./**/*.dSYM.zip"]).sort_by { |f| File.mtime(f) }.last,
+                                       default_value_dynamic: true,
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Couldn't find file at path '#{File.expand_path(value)}'") unless File.exist?(value)
+                                         UI.user_error!("Symbolication file needs to be dSYM or zip") unless value.end_with?(".zip", ".dSYM")
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :dsym_paths,
+                                       env_name: "FL_UPLOAD_SYMBOLS_TO_CRASHLYTICS_DSYM_PATHS",
+                                       description: "Paths to the DSYM files or zips to upload",
+                                       optional: true,
+                                       type: Array,
+                                       verify_block: proc do |values|
+                                         values.each do |value|
+                                           UI.user_error!("Couldn't find file at path '#{File.expand_path(value)}'") unless File.exist?(value)
+                                           UI.user_error!("Symbolication file needs to be dSYM or zip") unless value.end_with?(".zip", ".dSYM")
+                                         end
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :api_token,
+                                       env_name: "CRASHLYTICS_API_TOKEN",
+                                       sensitive: true,
+                                       optional: true,
+                                       description: "Crashlytics API Key",
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No API token for Crashlytics given, pass using `api_token: 'token'`") if value.to_s.length == 0
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :gsp_path,
+                                       env_name: "GOOGLE_SERVICES_INFO_PLIST_PATH",
+                                       code_gen_sensitive: true,
+                                       optional: true,
+                                       description: "Path to GoogleService-Info.plist",
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Couldn't find file at path '#{File.expand_path(value)}'") unless File.exist?(value)
+                                         UI.user_error!("No Path to GoogleService-Info.plist for Firebase Crashlytics given, pass using `gsp_path: 'path'`") if value.to_s.length == 0
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :binary_path,
+                                       env_name: "FL_UPLOAD_SYMBOLS_TO_CRASHLYTICS_BINARY_PATH",
+                                       description: "The path to the upload-symbols file of the Fabric app",
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Couldn't find file at path '#{value}'") unless File.exist?(value)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :platform,
+                                       env_name: "FL_UPLOAD_SYMBOLS_TO_CRASHLYTICS_PLATFORM",
+                                       description: "The platform of the app (ios, appletvos, mac)",
+                                       default_value: "ios",
+                                       verify_block: proc do |value|
+                                         available = ['ios', 'appletvos', 'mac']
+                                         UI.user_error!("Invalid platform '#{value}', must be #{available.join(', ')}") unless available.include?(value)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :dsym_worker_threads,
+                                       env_name: "FL_UPLOAD_SYMBOLS_TO_CRASHLYTICS_DSYM_WORKER_THREADS",
+                                       type: Integer,
+                                       default_value: 1,
+                                       optional: true,
+                                       description: "The number of threads to use for simultaneous dSYM upload",
+                                       verify_block: proc do |value|
+                                         min_threads = 1
+                                         UI.user_error!("Too few threads (#{value}) minimum number of threads: #{min_threads}") unless value >= min_threads
+                                       end)
+        ]
+      end
+
+      def self.output
+        nil
+      end
+
+      def self.return_value
+        nil
+      end
+
+      def self.authors
+        ["KrauseFx"]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :appletvos].include?(platform)
+      end
+
+      def self.example_code
+        [
+          'upload_symbols_to_crashlytics(dsym_path: "./App.dSYM.zip")'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+    end
+  end
+end

data/fastlane/lib/fastlane/actions/upload_symbols_to_sentry.rb

@@ -0,0 +1,165 @@
+module Fastlane
+  module Actions
+    class UploadSymbolsToSentryAction < Action
+      def self.run(params)
+        # Warning about usinging new plugin
+        UI.important("It's recommended to use the official Sentry Fastlane plugin")
+        UI.important("GitHub: https://github.com/getsentry/fastlane-plugin-sentry")
+        UI.important("Installation: fastlane add_plugin sentry")
+
+        Actions.verify_gem!('rest-client')
+        require 'rest-client'
+
+        # Params - API
+        host = params[:api_host]
+        api_key = params[:api_key]
+        auth_token = params[:auth_token]
+        org = params[:org_slug]
+        project = params[:project_slug]
+
+        # Params - dSYM
+        dsym_path = params[:dsym_path]
+        dsym_paths = params[:dsym_paths] || []
+
+        has_api_key = !api_key.to_s.empty?
+        has_auth_token = !auth_token.to_s.empty?
+
+        # Will fail if none or both authentication methods are provided
+        if !has_api_key && !has_auth_token
+          UI.user_error!("No API key or authentication token found for SentryAction given, pass using `api_key: 'key'` or `auth_token: 'token'`")
+        elsif has_api_key && has_auth_token
+          UI.user_error!("Both API key and authentication token found for SentryAction given, please only give one")
+        end
+
+        # Url to post dSYMs to
+        url = "#{host}/projects/#{org}/#{project}/files/dsyms/"
+
+        if has_api_key
+          resource = RestClient::Resource.new(url, api_key, '')
+        else
+          resource = RestClient::Resource.new(url, headers: { Authorization: "Bearer #{auth_token}" })
+        end
+
+        UI.message("Will upload dSYM(s) to #{url}")
+
+        # Upload dsym(s)
+        dsym_paths += [dsym_path]
+        uploaded_paths = dsym_paths.compact.map do |dsym|
+          upload_dsym(resource, dsym)
+        end
+
+        # Return uplaoded dSYM paths
+        uploaded_paths
+      end
+
+      def self.upload_dsym(resource, dsym)
+        UI.message("Uploading... #{dsym}")
+        resource.post(file: File.new(dsym, 'rb')) unless Helper.test?
+        UI.success('dSYM successfully uploaded to Sentry!')
+
+        dsym
+      rescue
+        UI.user_error!('Error while trying to upload dSYM to Sentry')
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Upload dSYM symbolication files to Sentry"
+      end
+
+      def self.details
+        "This action allows you to upload symbolication files to Sentry. It's extra useful if you use it to download the latest dSYM files from Apple when you use Bitcode."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :api_host,
+                                       env_name: "SENTRY_HOST",
+                                       description: "API host url for Sentry",
+                                       is_string: true,
+                                       default_value: "https://app.getsentry.com/api/0",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :api_key,
+                                       env_name: "SENTRY_API_KEY",
+                                       description: "API key for Sentry",
+                                       sensitive: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :auth_token,
+                                       env_name: "SENTRY_AUTH_TOKEN",
+                                       description: "Authentication token for Sentry",
+                                       sensitive: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :org_slug,
+                                       env_name: "SENTRY_ORG_SLUG",
+                                       description: "Organization slug for Sentry project",
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No organization slug for SentryAction given, pass using `org_slug: 'org'`") unless value && !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :project_slug,
+                                       env_name: "SENTRY_PROJECT_SLUG",
+                                       description: "Project slug for Sentry",
+                                       verify_block: proc do |value|
+                                         UI.user_error!("No project slug for SentryAction given, pass using `project_slug: 'project'`") unless value && !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :dsym_path,
+                                       env_name: "SENTRY_DSYM_PATH",
+                                       description: "Path to your symbols file. For iOS and Mac provide path to app.dSYM.zip",
+                                       default_value: Actions.lane_context[SharedValues::DSYM_OUTPUT_PATH],
+                                       default_value_dynamic: true,
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         # validation is done in the action
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :dsym_paths,
+                                       env_name: "SENTRY_DSYM_PATHS",
+                                       description: "Path to an array of your symbols file. For iOS and Mac provide path to app.dSYM.zip",
+                                       default_value: Actions.lane_context[SharedValues::DSYM_PATHS],
+                                       default_value_dynamic: true,
+                                       is_string: false,
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         # validation is done in the action
+                                       end)
+        ]
+      end
+
+      def self.return_value
+        "The uploaded dSYM path(s)"
+      end
+
+      def self.authors
+        ["joshdholtz"]
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+
+      def self.example_code
+        [
+          'upload_symbols_to_sentry(
+            auth_token: "...",
+            org_slug: "...",
+            project_slug: "...",
+            dsym_path: "./App.dSYM.zip"
+          )'
+        ]
+      end
+
+      def self.category
+        :deprecated
+      end
+
+      def self.deprecated_notes
+        [
+          "Please use the `sentry` plugin instead.",
+          "Install using `fastlane add_plugin sentry`.",
+          "Replace `upload_symbols_to_sentry(...)` with `sentry_upload_dsym(...)`."
+        ].join("\n")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+module Fastlane
+  module Actions
+    module SharedValues
+    end
+
+    class UploadToAppStoreAction < Action
+      def self.run(config)
+        require 'deliver'
+
+        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]
+
+          return config if Helper.test?
+          Deliver::Runner.new(config).run
+        end
+      end
+
+      def self.description
+        "Upload metadata and binary to App Store Connect (via _deliver_)"
+      end
+
+      def self.details
+        [
+          "Using _upload_to_app_store_ after _build_app_ and _capture_screenshots_ will automatically upload the latest ipa and screenshots with no other configuration.",
+          "",
+          "If you don't want a PDF report for App Store builds, use the `:force` option.",
+          "This is useful when running _fastlane_ on your Continuous Integration server:",
+          "`_upload_to_app_store_(force: true)`",
+          "If your account is on multiple teams and you need to tell the `iTMSTransporter` which 'provider' to use, you can set the `:itc_provider` option to pass this info."
+        ].join("\n")
+      end
+
+      def self.available_options
+        require "deliver"
+        require "deliver/options"
+        FastlaneCore::CommanderGenerator.new.generate(Deliver::Options.available_options)
+      end
+
+      def self.author
+        "KrauseFx"
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+
+      def self.example_code
+        [
+          'upload_to_app_store(
+            force: true, # Set to true to skip PDF verification
+            itc_provider: "abcde12345" # pass a specific value to the iTMSTransporter -itc_provider option
+          )',
+          'deliver   # alias for "upload_to_app_store"',
+          'appstore  # alias for "upload_to_app_store"'
+        ]
+      end
+
+      def self.category
+        :production
+      end
+    end
+  end
+end