fastlane_iac_publish 0.1.0

data/fastlane/lib/fastlane/actions/gradle.rb

@@ -0,0 +1,249 @@
+require 'pathname'
+require 'shellwords'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      GRADLE_APK_OUTPUT_PATH = :GRADLE_APK_OUTPUT_PATH
+      GRADLE_ALL_APK_OUTPUT_PATHS = :GRADLE_ALL_APK_OUTPUT_PATHS
+      GRADLE_AAB_OUTPUT_PATH = :GRADLE_AAB_OUTPUT_PATH
+      GRADLE_ALL_AAB_OUTPUT_PATHS = :GRADLE_ALL_AAB_OUTPUT_PATHS
+      GRADLE_FLAVOR = :GRADLE_FLAVOR
+      GRADLE_BUILD_TYPE = :GRADLE_BUILD_TYPE
+    end
+
+    class GradleAction < Action
+      def self.run(params)
+        task = params[:task]
+        flavor = params[:flavor]
+        build_type = params[:build_type]
+
+        gradle_task = [task, flavor, build_type].join
+
+        project_dir = params[:project_dir]
+
+        gradle_path_param = params[:gradle_path] || './gradlew'
+
+        # Get the path to gradle, if it's an absolute path we take it as is, if it's relative we assume it's relative to the project_dir
+        gradle_path = if Pathname.new(gradle_path_param).absolute?
+                        File.expand_path(gradle_path_param)
+                      else
+                        File.expand_path(File.join(project_dir, gradle_path_param))
+                      end
+
+        # Ensure we ended up with a valid path to gradle
+        UI.user_error!("Couldn't find gradlew at path '#{File.expand_path(gradle_path)}'") unless File.exist?(gradle_path)
+
+        # Construct our flags
+        flags = []
+        flags << "-p #{project_dir.shellescape}"
+        flags << params[:properties].map { |k, v| "-P#{k.to_s.shellescape}=#{v.to_s.shellescape}" }.join(' ') unless params[:properties].nil?
+        flags << params[:system_properties].map { |k, v| "-D#{k.to_s.shellescape}=#{v.to_s.shellescape}" }.join(' ') unless params[:system_properties].nil?
+        flags << params[:flags] unless params[:flags].nil?
+
+        # Run the actual gradle task
+        gradle = Helper::GradleHelper.new(gradle_path: gradle_path)
+
+        # If these were set as properties, then we expose them back out as they might be useful to others
+        Actions.lane_context[SharedValues::GRADLE_BUILD_TYPE] = build_type if build_type
+        Actions.lane_context[SharedValues::GRADLE_FLAVOR] = flavor if flavor
+
+        # We run the actual gradle task
+        result = gradle.trigger(task: gradle_task,
+                                serial: params[:serial],
+                                flags: flags.join(' '),
+                                print_command: params[:print_command],
+                                print_command_output: params[:print_command_output])
+
+        # If we didn't build, then we return now, as it makes no sense to search for apk's in a non-`assemble` or non-`build` scenario
+        return result unless task =~ /\b(assemble)/ || task =~ /\b(bundle)/
+
+        apk_search_path = File.join(project_dir, '**', 'build', 'outputs', 'apk', '**', '*.apk')
+        aab_search_path = File.join(project_dir, '**', 'build', 'outputs', 'bundle', '**', '*.aab')
+
+        # Our apk/aab is now built, but there might actually be multiple ones that were built if a flavor was not specified in a multi-flavor project (e.g. `assembleRelease`)
+        # However, we're not interested in unaligned apk's...
+        new_apks = Dir[apk_search_path].reject { |path| path =~ /^.*-unaligned.apk$/i }
+        new_apks = new_apks.map { |path| File.expand_path(path) }
+        new_aabs = Dir[aab_search_path]
+        new_aabs = new_aabs.map { |path| File.expand_path(path) }
+
+        # We expose all of these new apks and aabs
+        Actions.lane_context[SharedValues::GRADLE_ALL_APK_OUTPUT_PATHS] = new_apks
+        Actions.lane_context[SharedValues::GRADLE_ALL_AAB_OUTPUT_PATHS] = new_aabs
+
+        # We also take the most recent apk and aab to return as SharedValues::GRADLE_APK_OUTPUT_PATH and SharedValues::GRADLE_AAB_OUTPUT_PATH
+        # This is the one that will be relevant for most projects that just build a single build variant (flavor + build type combo).
+        # In multi build variants this value is undefined
+        last_apk_path = new_apks.sort_by(&File.method(:mtime)).last
+        last_aab_path = new_aabs.sort_by(&File.method(:mtime)).last
+        Actions.lane_context[SharedValues::GRADLE_APK_OUTPUT_PATH] = File.expand_path(last_apk_path) if last_apk_path
+        Actions.lane_context[SharedValues::GRADLE_AAB_OUTPUT_PATH] = File.expand_path(last_aab_path) if last_aab_path
+
+        # Give a helpful message in case there were no new apks or aabs. Remember we're only running this code when assembling, in which case we certainly expect there to be an apk or aab
+        UI.message('Couldn\'t find any new signed apk files...') if new_apks.empty? && new_aabs.empty?
+
+        return result
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'All gradle related actions, including building and testing your Android app'
+      end
+
+      def self.details
+        'Run `./gradlew tasks` to get a list of all available gradle tasks for your project'
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :task,
+                                       env_name: 'FL_GRADLE_TASK',
+                                       description: 'The gradle task you want to execute, e.g. `assemble` or `test`. For tasks such as `assembleMyFlavorRelease` you should use gradle(task: \'assemble\', flavor: \'Myflavor\', build_type: \'Release\')',
+                                       optional: false,
+                                       is_string: true),
+          FastlaneCore::ConfigItem.new(key: :flavor,
+                                       env_name: 'FL_GRADLE_FLAVOR',
+                                       description: 'The flavor that you want the task for, e.g. `MyFlavor`. If you are running the `assemble` task in a multi-flavor project, and you rely on Actions.lane_context[SharedValues::GRADLE_APK_OUTPUT_PATH] then you must specify a flavor here or else this value will be undefined',
+                                       optional: true,
+                                       is_string: true),
+          FastlaneCore::ConfigItem.new(key: :build_type,
+                                       env_name: 'FL_GRADLE_BUILD_TYPE',
+                                       description: 'The build type that you want the task for, e.g. `Release`. Useful for some tasks such as `assemble`',
+                                       optional: true,
+                                       is_string: true),
+          FastlaneCore::ConfigItem.new(key: :flags,
+                                       env_name: 'FL_GRADLE_FLAGS',
+                                       description: 'All parameter flags you want to pass to the gradle command, e.g. `--exitcode --xml file.xml`',
+                                       optional: true,
+                                       is_string: true),
+          FastlaneCore::ConfigItem.new(key: :project_dir,
+                                       env_name: 'FL_GRADLE_PROJECT_DIR',
+                                       description: 'The root directory of the gradle project',
+                                       default_value: '.',
+                                       is_string: true),
+          FastlaneCore::ConfigItem.new(key: :gradle_path,
+                                       env_name: 'FL_GRADLE_PATH',
+                                       description: 'The path to your `gradlew`. If you specify a relative path, it is assumed to be relative to the `project_dir`',
+                                       optional: true,
+                                       is_string: true),
+          FastlaneCore::ConfigItem.new(key: :properties,
+                                       env_name: 'FL_GRADLE_PROPERTIES',
+                                       description: 'Gradle properties to be exposed to the gradle script',
+                                       optional: true,
+                                       is_string: false),
+          FastlaneCore::ConfigItem.new(key: :system_properties,
+                                       env_name: 'FL_GRADLE_SYSTEM_PROPERTIES',
+                                       description: 'Gradle system properties to be exposed to the gradle script',
+                                       optional: true,
+                                       is_string: false),
+          FastlaneCore::ConfigItem.new(key: :serial,
+                                       env_name: 'FL_ANDROID_SERIAL',
+                                       description: 'Android serial, which device should be used for this command',
+                                       is_string: true,
+                                       default_value: ''),
+          FastlaneCore::ConfigItem.new(key: :print_command,
+                                       env_name: 'FL_GRADLE_PRINT_COMMAND',
+                                       description: 'Control whether the generated Gradle command is printed as output before running it (true/false)',
+                                       is_string: false,
+                                       default_value: true),
+          FastlaneCore::ConfigItem.new(key: :print_command_output,
+                                       env_name: 'FL_GRADLE_PRINT_COMMAND_OUTPUT',
+                                       description: 'Control whether the output produced by given Gradle command is printed while running (true/false)',
+                                       is_string: false,
+                                       default_value: true)
+        ]
+      end
+
+      def self.output
+        [
+          ['GRADLE_APK_OUTPUT_PATH', 'The path to the newly generated apk file. Undefined in a multi-variant assemble scenario'],
+          ['GRADLE_ALL_APK_OUTPUT_PATHS', 'When running a multi-variant `assemble`, the array of signed apk\'s that were generated'],
+          ['GRADLE_FLAVOR', 'The flavor, e.g. `MyFlavor`'],
+          ['GRADLE_BUILD_TYPE', 'The build type, e.g. `Release`'],
+          ['GRADLE_AAB_OUTPUT_PATH', 'The path to the most recent Android app bundle'],
+          ['GRADLE_ALL_AAB_OUTPUT_PATHS', 'The paths to the most recent Android app bundles']
+        ]
+      end
+
+      def self.return_value
+        'The output of running the gradle task'
+      end
+
+      def self.authors
+        ['KrauseFx', 'lmirosevic']
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :android].include?(platform) # we support iOS as cross platforms apps might want to call `gradle` also
+      end
+
+      def self.example_code
+        [
+          'gradle(
+            task: "assemble",
+            flavor: "WorldDomination",
+            build_type: "Release"
+          )',
+          'gradle(
+            # ...
+
+            properties: {
+              "versionCode" => 100,
+              "versionName" => "1.0.0",
+              # ...
+            }
+          )
+          ```
+
+          You can use this to automatically [sign and zipalign](https://developer.android.com/studio/publish/app-signing.html) your app:
+          ```ruby
+          gradle(
+            task: "assemble",
+            build_type: "Release",
+            print_command: false,
+            properties: {
+              "android.injected.signing.store.file" => "keystore.jks",
+              "android.injected.signing.store.password" => "store_password",
+              "android.injected.signing.key.alias" => "key_alias",
+              "android.injected.signing.key.password" => "key_password",
+            }
+          )',
+          '# If you need to pass sensitive information through the `gradle` action, and don\'t want the generated command to be printed before it is run, you can suppress that:
+          gradle(
+            # ...
+            print_command: false
+          )
+          ```
+
+          You can also suppress printing the output generated by running the generated Gradle command:
+          ```ruby
+          gradle(
+            # ...
+            print_command_output: false
+          )
+          ```
+
+          To pass any other CLI flags to gradle use:
+          ```ruby
+          gradle(
+            # ...
+
+            flags: "--exitcode --xml file.xml"
+          )',
+          '# Delete the build directory and generated APKs
+          gradle(
+            task: "clean"
+          )'
+        ]
+      end
+
+      def self.category
+        :building
+      end
+    end
+  end
+end

data/fastlane/lib/fastlane/actions/gym.rb

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

data/fastlane/lib/fastlane/actions/hg_add_tag.rb

@@ -0,0 +1,48 @@
+module Fastlane
+  module Actions
+    # Adds a hg tag to the current commit
+    class HgAddTagAction < Action
+      def self.run(options)
+        tag = options[:tag]
+
+        UI.message("Adding mercurial tag '#{tag}' 🎯.")
+
+        command = "hg tag \"#{tag}\""
+        return command if Helper.test?
+
+        Actions.sh(command)
+      end
+
+      def self.description
+        "This will add a hg tag to the current branch"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :tag,
+                                       env_name: "FL_HG_TAG_TAG",
+                                       description: "Tag to create")
+        ]
+      end
+
+      def self.author
+        # credits to lmirosevic for original git version
+        "sjrmanning"
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.example_code
+        [
+          'hg_add_tag(tag: "1.3")'
+        ]
+      end
+
+      def self.category
+        :source_control
+      end
+    end
+  end
+end

data/fastlane/lib/fastlane/actions/hg_commit_version_bump.rb

@@ -0,0 +1,183 @@
+module Fastlane
+  module Actions
+    # Commits version bump.
+    class HgCommitVersionBumpAction < Action
+      def self.run(params)
+        require 'xcodeproj'
+        require 'pathname'
+        require 'set'
+        require 'shellwords'
+
+        xcodeproj_path = params[:xcodeproj] ? File.expand_path(File.join('.', params[:xcodeproj])) : nil
+
+        if Helper.test?
+          xcodeproj_path = "/tmp/Test.xcodeproj"
+        end
+
+        # get the repo root path
+        repo_path = Helper.test? ? '/tmp/repo' : Actions.sh('hg root').strip
+        repo_pathname = Pathname.new(repo_path)
+
+        if xcodeproj_path
+          # ensure that the xcodeproj passed in was OK
+          unless Helper.test?
+            UI.user_error!("Could not find the specified xcodeproj: #{xcodeproj_path}") unless File.directory?(xcodeproj_path)
+          end
+        else
+          # find an xcodeproj (ignoring dependencies)
+          xcodeproj_paths = Fastlane::Helper::XcodeprojHelper.find(repo_path)
+
+          # no projects found: error
+          UI.user_error!('Could not find a .xcodeproj in the current repository\'s working directory.') if xcodeproj_paths.count == 0
+
+          # too many projects found: error
+          if xcodeproj_paths.count > 1
+            relative_projects = xcodeproj_paths.map { |e| Pathname.new(e).relative_path_from(repo_pathname).to_s }.join("\n")
+            UI.user_error!("Found multiple .xcodeproj projects in the current repository's working directory. Please specify your app's main project: \n#{relative_projects}")
+          end
+
+          # one project found: great
+          xcodeproj_path = xcodeproj_paths.first
+        end
+
+        # find the pbxproj path, relative to hg directory
+        if Helper.test?
+          hg_dirty_files = params[:test_dirty_files].split(",")
+          expected_changed_files = params[:test_expected_files].split(",")
+        else
+          pbxproj_pathname = Pathname.new(File.join(xcodeproj_path, 'project.pbxproj'))
+          pbxproj_path = pbxproj_pathname.relative_path_from(repo_pathname).to_s
+
+          # find the info_plist files
+          project = Xcodeproj::Project.open(xcodeproj_path)
+          info_plist_files = project.objects.select do |object|
+            object.isa == 'XCBuildConfiguration'
+          end.map(&:to_hash).map do |object_hash|
+            object_hash['buildSettings']
+          end.select do |build_settings|
+            build_settings.key?('INFOPLIST_FILE')
+          end.map do |build_settings|
+            build_settings['INFOPLIST_FILE']
+          end.uniq.map do |info_plist_path|
+            Pathname.new(File.expand_path(File.join(xcodeproj_path, '..', info_plist_path))).relative_path_from(repo_pathname).to_s
+          end
+
+          # create our list of files that we expect to have changed, they should all be relative to the project root, which should be equal to the hg workdir root
+          expected_changed_files = []
+          expected_changed_files << pbxproj_path
+          expected_changed_files << info_plist_files
+          expected_changed_files.flatten!.uniq!
+
+          # get the list of files that have actually changed in our hg workdir
+          hg_dirty_files = Actions.sh('hg status -n').split("\n")
+        end
+
+        # little user hint
+        UI.user_error!("No file changes picked up. Make sure you run the `increment_build_number` action first.") if hg_dirty_files.empty?
+
+        # check if the files changed are the ones we expected to change (these should be only the files that have version info in them)
+        dirty_set = Set.new(hg_dirty_files.map(&:downcase))
+        expected_set = Set.new(expected_changed_files.map(&:downcase))
+        changed_files_as_expected = dirty_set.subset?(expected_set)
+        unless changed_files_as_expected
+          unless params[:force]
+            str = ["Found unexpected uncommitted changes in the working directory. Expected these files to have changed:",
+                   "#{expected_changed_files.join("\n")}.",
+                   "But found these actual changes: \n#{hg_dirty_files.join("\n")}.",
+                   "Make sure you have cleaned up the build artifacts and are only left with the changed version files at this",
+                   "stage in your lane, and don't touch the working directory while your lane is running. You can also use the :force option to ",
+                   "bypass this check, and always commit a version bump regardless of the state of the working directory."].join("\n")
+            UI.user_error!(str)
+          end
+        end
+
+        # create a commit with a message
+        command = "hg commit -m '#{params[:message]}'"
+        return command if Helper.test?
+        begin
+          Actions.sh(command)
+
+          UI.success("Committed \"#{params[:message]}\" 💾.")
+        rescue => ex
+          UI.error(ex)
+          UI.important("Didn't commit any changes. 😐")
+        end
+      end
+
+      def self.description
+        "This will commit a version bump to the hg repo"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :message,
+                                       env_name: "FL_COMMIT_BUMP_MESSAGE",
+                                       description: "The commit message when committing the version bump",
+                                       default_value: "Version Bump"),
+          FastlaneCore::ConfigItem.new(key: :xcodeproj,
+                                       env_name: "FL_BUILD_NUMBER_PROJECT",
+                                       description: "The path to your project file (Not the workspace). If you have only one, this is optional",
+                                       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") unless File.exist?(value)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :force,
+                                       env_name: "FL_FORCE_COMMIT",
+                                       description: "Forces the commit, even if other files than the ones containing the version number have been modified",
+                                       optional: true,
+                                       default_value: false,
+                                       is_string: false),
+          FastlaneCore::ConfigItem.new(key: :test_dirty_files,
+                                       env_name: "FL_HG_COMMIT_TEST_DIRTY_FILES",
+                                       description: "A list of dirty files passed in for testing",
+                                       optional: true,
+                                       default_value: "file1, file2"),
+          FastlaneCore::ConfigItem.new(key: :test_expected_files,
+                                       env_name: "FL_HG_COMMIT_TEST_EXP_FILES",
+                                       description: "A list of expected changed files passed in for testing",
+                                       optional: true,
+                                       default_value: "file1, file2")
+        ]
+      end
+
+      def self.author
+        # credits to lmirosevic for original git version
+        "sjrmanning"
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.details
+        list = <<-LIST.markdown_list
+          All `.plist` files
+          The `.xcodeproj/project.pbxproj` file
+        LIST
+        [
+          "The mercurial equivalent of the [commit_version_bump](https://docs.fastlane.tools/actions/commit_version_bump/) git action. Like the git version, it is useful in conjunction with [`increment_build_number`](https://docs.fastlane.tools/actions/increment_build_number/).",
+          "It checks the repo to make sure that only the relevant files have changed, these are the files that `increment_build_number` (`agvtool`) touches:".markdown_preserve_newlines,
+          list,
+          "Then commits those files to the repo.",
+          "Customize the message with the `:message` option, defaults to 'Version Bump'",
+          "If you have other uncommitted changes in your repo, this action will fail. If you started off in a clean repo, and used the _ipa_ and or _sigh_ actions, then you can use the [clean_build_artifacts](https://docs.fastlane.tools/actions/clean_build_artifacts/) action to clean those temporary files up before running this action."
+        ].join("\n")
+      end
+
+      def self.example_code
+        [
+          'hg_commit_version_bump',
+          'hg_commit_version_bump(
+            message: "Version Bump",                 # create a commit with a custom message
+            xcodeproj: "./path/MyProject.xcodeproj", # optional, if you have multiple Xcode project files, you must specify your main project here
+          )'
+        ]
+      end
+
+      def self.category
+        :source_control
+      end
+    end
+  end
+end