fastlane_hotfix 2.165.0

data/fastlane/lib/fastlane/actions/flock.rb

@@ -0,0 +1,82 @@
+module Fastlane
+  module Actions
+    class FlockAction < Action
+      BASE_URL = 'https://api.flock.co/hooks/sendMessage'.freeze
+
+      def self.run(options)
+        require 'net/http'
+        require 'uri'
+        require 'json'
+
+        notify_incoming_message_webhook(options[:base_url], options[:message], options[:token])
+      end
+
+      def self.notify_incoming_message_webhook(base_url, message, token)
+        uri = URI.join(base_url + '/', token)
+        response = Net::HTTP.start(
+          uri.host, uri.port, use_ssl: uri.scheme == 'https'
+        ) do |http|
+          request = Net::HTTP::Post.new(uri.path)
+          request.content_type = 'application/json'
+          request.body = JSON.generate("text" => message)
+          http.request(request)
+        end
+        if response.kind_of?(Net::HTTPSuccess)
+          UI.success('Message sent to Flock.')
+        else
+          UI.error("HTTP request to '#{uri}' with message '#{message}' failed with a #{response.code} response.")
+          UI.user_error!('Error sending message to Flock. Please verify the Flock webhook token.')
+        end
+      end
+
+      def self.description
+        "Send a message to a [Flock](https://flock.com/) group"
+      end
+
+      def self.details
+        "To obtain the token, create a new [incoming message webhook](https://dev.flock.co/wiki/display/FlockAPI/Incoming+Webhooks) in your Flock admin panel."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :message,
+                                       env_name: 'FL_FLOCK_MESSAGE',
+                                       description: 'Message text'),
+          FastlaneCore::ConfigItem.new(key: :token,
+                                       env_name: 'FL_FLOCK_TOKEN',
+                                       sensitive: true,
+                                       description: 'Token for the Flock incoming webhook'),
+          FastlaneCore::ConfigItem.new(key: :base_url,
+                                       env_name: 'FL_FLOCK_BASE_URL',
+                                       description: 'Base URL of the Flock incoming message webhook',
+                                       optional: true,
+                                       default_value: BASE_URL,
+                                       verify_block: proc do |value|
+                                         UI.user_error!('Invalid https URL') unless value.start_with?('https://')
+                                       end)
+        ]
+      end
+
+      def self.author
+        "Manav"
+      end
+
+      def self.example_code
+        [
+          'flock(
+            message: "Hello",
+            token: "xxx"
+          )'
+        ]
+      end
+
+      def self.category
+        :notifications
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/fastlane/lib/fastlane/actions/frame_screenshots.rb

@@ -0,0 +1,64 @@
+module Fastlane
+  module Actions
+    class FrameScreenshotsAction < Action
+      def self.run(config)
+        return if Helper.test?
+
+        require 'frameit'
+
+        UI.message("Framing screenshots at path #{config[:path]} (via frameit)")
+
+        Dir.chdir(config[:path]) do
+          Frameit.config = config
+          Frameit::Runner.new.run('.')
+        end
+      end
+
+      def self.description
+        "Adds device frames around all screenshots (via _frameit_)"
+      end
+
+      def self.details
+        [
+          "Uses [frameit](https://docs.fastlane.tools/actions/frameit/) to prepare perfect screenshots for the App Store, your website, QA or emails.",
+          "You can add background and titles to the framed screenshots as well."
+        ].join("\n")
+      end
+
+      def self.available_options
+        require "frameit"
+        require "frameit/options"
+        FastlaneCore::CommanderGenerator.new.generate(Frameit::Options.available_options) + [
+          FastlaneCore::ConfigItem.new(key: :path,
+                                       env_name: "FRAMEIT_SCREENSHOTS_PATH",
+                                       description: "The path to the directory containing the screenshots",
+                                       default_value: Actions.lane_context[SharedValues::SNAPSHOT_SCREENSHOTS_PATH] || FastlaneCore::FastlaneFolder.path,
+                                       default_value_dynamic: true)
+        ]
+      end
+
+      def self.author
+        "KrauseFx"
+      end
+
+      def self.example_code
+        [
+          'frame_screenshots',
+          'frameit # alias for "frame_screenshots"',
+          'frame_screenshots(use_platform: "ANDROID")',
+          'frame_screenshots(silver: true)',
+          'frame_screenshots(path: "/screenshots")',
+          'frame_screenshots(rose_gold: true)'
+        ]
+      end
+
+      def self.category
+        :screenshots
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac, :android].include?(platform)
+      end
+    end
+  end
+end

data/fastlane/lib/fastlane/actions/frameit.rb

@@ -0,0 +1,14 @@
+module Fastlane
+  module Actions
+    require 'fastlane/actions/frame_screenshots'
+    class FrameitAction < FrameScreenshotsAction
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Alias for the `frame_screenshots` action"
+      end
+    end
+  end
+end

data/fastlane/lib/fastlane/actions/gcovr.rb

@@ -0,0 +1,163 @@
+module Fastlane
+  module Actions
+    # --object-directory=OBJDIR      Specify the directory that contains the gcov data files.
+    # -o OUTPUT, --output=OUTPUT     Print output to this filename Keep the temporary *.gcov files generated by gcov.
+    # -k, --keep                     Keep the temporary *.gcov files generated by gcov.
+    # -d, --delete                   Delete the coverage files after they are processed.
+    # -f FILTER, --filter=FILTER     Keep only the data files that match this regular expression
+    # -e EXCLUDE, --exclude=EXCLUDE  Exclude data files that match this regular expression
+    # --gcov-filter=GCOV_FILTER      Keep only gcov data files that match this regular expression
+    # --gcov-exclude=GCOV_EXCLUDE    Exclude gcov data files that match this regular expression
+    # -r ROOT, --root=ROOT           Defines the root directory for source files.
+    # -x, --xml                      Generate XML instead of the normal tabular output.
+    # --xml-pretty                   Generate pretty XML instead of the normal dense format.
+    # --html                         Generate HTML instead of the normal tabular output.
+    # --html-details                 Generate HTML output for source file coverage.
+    # --html-absolute-paths          Set the paths in the HTML report to be absolute instead of relative
+    # -b, --branches                 Tabulate the branch coverage instead of the line coverage.
+    # -u, --sort-uncovered           Sort entries by increasing number of uncovered lines.
+    # -p, --sort-percentage          Sort entries by decreasing percentage of covered lines.
+    # --gcov-executable=GCOV_CMD     Defines the name/path to the gcov executable [defaults to the GCOV environment variable, if present; else 'gcov'].
+    # --exclude-unreachable-branches Exclude from coverage branches which are marked to be excluded by LCOV/GCOV markers or are determined to be from lines containing only compiler-generated "dead" code.
+    # -g, --use-gcov-files           Use preprocessed gcov files for analysis.
+    # -s, --print-summary            Prints a small report to stdout with line & branch percentage coverage
+
+    class GcovrAction < Action
+      ARGS_MAP = {
+        object_directory: "--object-directory",
+        output: "-o",
+        keep: "-k",
+        delete: "-d",
+        filter: "-f",
+        exclude: "-e",
+        gcov_filter: "--gcov-filter",
+        gcov_exclude: "--gcov-exclude",
+        root: "-r",
+        xml: "-x",
+        xml_pretty: "--xml-pretty",
+        html: "--html",
+        html_details: "--html-details",
+        html_absolute_paths: "--html-absolute-paths",
+        branches: "-b",
+        sort_uncovered: "-u",
+        sort_percentage: "-p",
+        gcov_executable: "--gcov-executable",
+        exclude_unreachable_branches: "--exclude-unreachable-branches",
+        use_gcov_files: "-g",
+        print_summary: "-s"
+      }
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+
+      def self.run(params)
+        unless Helper.test?
+          UI.user_error!("gcovr not installed") if `which gcovr`.length == 0
+        end
+
+        # The args we will build with
+        gcovr_args = nil
+
+        # Allows for a whole variety of configurations
+        if params.kind_of?(Hash)
+          params_hash = params
+
+          # Check if an output path was given
+          if params_hash.key?(:output)
+            create_output_dir_if_not_exists(params_hash[:output])
+          end
+
+          # Maps parameter hash to CLI args
+          gcovr_args = params_hash_to_cli_args(params_hash)
+        else
+          gcovr_args = params
+        end
+
+        # Joins args into space delimited string
+        gcovr_args = gcovr_args.join(" ")
+
+        command = "gcovr #{gcovr_args}"
+        UI.success("Generating code coverage.")
+        UI.verbose(command)
+        Actions.sh(command)
+      end
+
+      def self.create_output_dir_if_not_exists(output_path)
+        output_dir = File.dirname(output_path)
+
+        # If the output directory doesn't exist, create it
+        unless Dir.exist?(output_dir)
+          FileUtils.mkpath(output_dir)
+        end
+      end
+
+      def self.params_hash_to_cli_args(params)
+        # Remove nil value params
+        params = params.delete_if { |_, v| v.nil? }
+
+        # Maps nice developer param names to CLI arguments
+        params.map do |k, v|
+          v ||= ""
+          args = ARGS_MAP[k]
+          if args
+            value = (v != true && v.to_s.length > 0 ? "\"#{v}\"" : "")
+            "#{args} #{value}".strip
+          end
+        end.compact
+      end
+
+      def self.description
+        "Runs test coverage reports for your Xcode project"
+      end
+
+      def self.available_options
+        [
+          ['object_directory', 'Specify the directory that contains the gcov data files.'],
+          ['output', 'Print output to this filename Keep the temporary *.gcov files generated by gcov.'],
+          ['keep', 'Keep the temporary *.gcov files generated by gcov.'],
+          ['delete', 'Delete the coverage files after they are processed.'],
+          ['filter', 'Keep only the data files that match this regular expression'],
+          ['exclude', 'Exclude data files that match this regular expression'],
+          ['gcov_filter', 'Keep only gcov data files that match this regular expression'],
+          ['gcov_exclude', 'Exclude gcov data files that match this regular expression'],
+          ['root', 'Defines the root directory for source files.'],
+          ['xml', 'Generate XML instead of the normal tabular output.'],
+          ['xml_pretty', 'Generate pretty XML instead of the normal dense format.'],
+          ['html', 'Generate HTML instead of the normal tabular output.'],
+          ['html_details', 'Generate HTML output for source file coverage.'],
+          ['html_absolute_paths', 'Set the paths in the HTML report to be absolute instead of relative'],
+          ['branches', 'Tabulate the branch coverage instead of the line coverage.'],
+          ['sort_uncovered', 'Sort entries by increasing number of uncovered lines.'],
+          ['sort_percentage', 'Sort entries by decreasing percentage of covered lines.'],
+          ['gcov_executable', 'Defines the name/path to the gcov executable].'],
+          ['exclude_unreachable_branches', 'Exclude from coverage branches which are marked to be excluded by LCOV/GCOV markers'],
+          ['use_gcov_files', 'Use preprocessed gcov files for analysis.'],
+          ['print_summary', 'Prints a small report to stdout with line & branch percentage coverage']
+        ]
+      end
+
+      def self.author
+        "dtrenz"
+      end
+
+      def self.example_code
+        [
+          'gcovr(
+            html: true,
+            html_details: true,
+            output: "./code-coverage/report.html"
+          )'
+        ]
+      end
+
+      def self.details
+        "Generate summarized code coverage reports using [gcovr](http://gcovr.com/)"
+      end
+
+      def self.category
+        :testing
+      end
+    end
+  end
+end

data/fastlane/lib/fastlane/actions/get_build_number.rb

@@ -0,0 +1,106 @@
+module Fastlane
+  module Actions
+    module SharedValues
+      BUILD_NUMBER ||= :BUILD_NUMBER # originally defined in IncrementBuildNumberAction
+    end
+
+    class GetBuildNumberAction < Action
+      require 'shellwords'
+
+      def self.run(params)
+        # More information about how to set up your project and how it works:
+        # https://developer.apple.com/library/ios/qa/qa1827/_index.html
+
+        folder = params[:xcodeproj] ? File.join(params[:xcodeproj], '..') : '.'
+
+        command_prefix = [
+          'cd',
+          File.expand_path(folder).shellescape,
+          '&&'
+        ].join(' ')
+
+        command = [
+          command_prefix,
+          'agvtool',
+          'what-version',
+          '-terse'
+        ].join(' ')
+
+        if Helper.test?
+          Actions.lane_context[SharedValues::BUILD_NUMBER] = command
+        else
+          build_number = Actions.sh(command).split("\n").last.strip
+
+          # Store the number in the shared hash
+          Actions.lane_context[SharedValues::BUILD_NUMBER] = build_number
+        end
+        return build_number
+      rescue => ex
+        return false if params[:hide_error_when_versioning_disabled]
+        UI.error('Before being able to increment and read the version number from your Xcode project, you first need to setup your project properly. Please follow the guide at https://developer.apple.com/library/content/qa/qa1827/_index.html')
+        raise ex
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Get the build number of your project"
+      end
+
+      def self.details
+        [
+          "This action will return the current build number set on your project.",
+          "You first have to set up your Xcode project, if you haven't done it already: [https://developer.apple.com/library/ios/qa/qa1827/_index.html](https://developer.apple.com/library/ios/qa/qa1827/_index.html)."
+        ].join("\n")
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :xcodeproj,
+                             env_name: "FL_BUILD_NUMBER_PROJECT",
+                             description: "optional, you must specify the path to your main Xcode project if it is not in the project root directory",
+                             optional: true,
+                             verify_block: proc do |value|
+                               UI.user_error!("Please pass the path to the project, not the workspace") if value.end_with?(".xcworkspace")
+                               UI.user_error!("Could not find Xcode project") if !File.exist?(value) && !Helper.test?
+                             end),
+          FastlaneCore::ConfigItem.new(key: :hide_error_when_versioning_disabled,
+                             env_name: "FL_BUILD_NUMBER_HIDE_ERROR_WHEN_VERSIONING_DISABLED",
+                             description: "Used during `fastlane init` to hide the error message",
+                             default_value: false,
+                             type: Boolean)
+        ]
+      end
+
+      def self.output
+        [
+          ['BUILD_NUMBER', 'The build number']
+        ]
+      end
+
+      def self.authors
+        ["Liquidsoul"]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+
+      def self.example_code
+        [
+          'build_number = get_build_number(xcodeproj: "Project.xcodeproj")'
+        ]
+      end
+
+      def self.return_type
+        :string
+      end
+
+      def self.category
+        :project
+      end
+    end
+  end
+end

data/fastlane/lib/fastlane/actions/get_build_number_repository.rb

@@ -0,0 +1,120 @@
+module Fastlane
+  module Actions
+    module SharedValues
+      BUILD_NUMBER_REPOSITORY = :BUILD_NUMBER_REPOSITORY
+    end
+
+    class GetBuildNumberRepositoryAction < Action
+      def self.is_svn?
+        Actions.sh('svn info')
+        return true
+      rescue
+        return false
+      end
+
+      def self.is_git?
+        Actions.sh('git rev-parse HEAD')
+        return true
+      rescue
+        return false
+      end
+
+      def self.is_git_svn?
+        Actions.sh('git svn info')
+        return true
+      rescue
+        return false
+      end
+
+      def self.is_hg?
+        Actions.sh('hg status')
+        return true
+      rescue
+        return false
+      end
+
+      def self.command(use_hg_revision_number)
+        if is_svn?
+          UI.message("Detected repo: svn")
+          return 'svn info | grep Revision | egrep -o "[0-9]+"'
+        elsif is_git_svn?
+          UI.message("Detected repo: git-svn")
+          return 'git svn info | grep Revision | egrep -o "[0-9]+"'
+        elsif is_git?
+          UI.message("Detected repo: git")
+          return 'git rev-parse --short HEAD'
+        elsif is_hg?
+          UI.message("Detected repo: hg")
+          if use_hg_revision_number
+            return 'hg parent --template {rev}'
+          else
+            return 'hg parent --template "{node|short}"'
+          end
+        else
+          UI.user_error!("No repository detected")
+        end
+      end
+
+      def self.run(params)
+        build_number = Action.sh(command(params[:use_hg_revision_number])).strip
+        Actions.lane_context[SharedValues::BUILD_NUMBER_REPOSITORY] = build_number
+        return build_number
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Get the build number from the current repository"
+      end
+
+      def self.details
+        [
+          "This action will get the **build number** according to what the SCM HEAD reports.",
+          "Currently supported SCMs are svn (uses root revision), git-svn (uses svn revision), git (uses short hash) and mercurial (uses short hash or revision number).",
+          "There is an option, `:use_hg_revision_number`, which allows to use mercurial revision number instead of hash."
+        ].join("\n")
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :use_hg_revision_number,
+                                       env_name: "USE_HG_REVISION_NUMBER",
+                                       description: "Use hg revision number instead of hash (ignored for non-hg repos)",
+                                       optional: true,
+                                       is_string: false,
+                                       default_value: false)
+        ]
+      end
+
+      def self.output
+        [
+          ['BUILD_NUMBER_REPOSITORY', 'The build number from the current repository']
+        ]
+      end
+
+      def self.return_value
+        "The build number from the current repository"
+      end
+
+      def self.authors
+        ["bartoszj", "pbrooks", "armadsen"]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+
+      def self.example_code
+        [
+          'get_build_number_repository'
+        ]
+      end
+
+      def self.category
+        :source_control
+      end
+    end
+  end
+end