fastlane-plugin-wpmreleasetoolkit 1.0.0

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/configure/configure_update_action.rb

@@ -0,0 +1,139 @@
+require 'fastlane/action'
+require 'fastlane_core/ui/ui'
+
+require_relative '../../helper/filesystem_helper'
+require_relative '../../helper/configure_helper'
+
+module Fastlane
+  module Actions
+    class ConfigureUpdateAction < Action
+      def self.run(params = {})
+        prompt_to_switch_branches
+
+        if repo_is_ahead_of_remote
+          UI.user_error!("The local secrets store has changes that the remote repository doesn't.\
+            Please fix this issue before continuing")
+        end
+
+        prompt_to_update_to_most_recent_version if repo_is_behind_remote
+
+        if configure_file_is_behind_repo
+          prompt_to_update_configure_file_to_most_recent_hash
+        else
+          # Update configure file even if already update to date
+          # This ensures the file format is up to date
+          update_configure_file
+        end
+
+        # If there is no encryption key for the project, generate one
+        if Fastlane::Helper::ConfigureHelper.project_encryption_key.nil?
+          # If the user chose not to update the repo but there is no encryption key, throw an error
+          UI.user_error!('The local secrets behind the remote but it is missing a keys.json entry for this project. Please update it to the latest commit.') if repo_is_behind_remote
+          Fastlane::Helper::ConfigureHelper.update_project_encryption_key
+          # Update the configure file to the new hash
+          update_configure_file
+        end
+
+        Fastlane::Helper::ConfigureHelper.files_to_copy.each do |file_reference|
+          file_reference.update
+        end
+
+        UI.success "Configuration Secrets are up to date – don't forget to commit your changes to `.configure`."
+
+        # Apply the changes that are now in the .configure file
+        other_action.configure_apply
+      end
+
+      def self.prompt_to_switch_branches
+        branch_name_to_display = current_branch.nil? ? current_hash : current_branch
+        if UI.confirm("The current branch is `#{branch_name_to_display}`. Would you like to switch branches?")
+          new_branch = UI.select("Select the branch you'd like to switch to: ", get_branches)
+          checkout_branch(new_branch)
+          update_configure_file
+        else
+          UI.user_error!('The local secrets store is in a deatched HEAD state.  Please check out a branch and try again.') if current_branch.nil?
+        end
+      end
+
+      def self.prompt_to_update_to_most_recent_version
+        if UI.confirm("The current branch is #{repo_commits_behind_remote} commit(s) behind. Would you like to update it?")
+          update_branch
+          update_configure_file
+        end
+      end
+
+      def self.prompt_to_update_configure_file_to_most_recent_hash
+        update_configure_file if UI.confirm("The `.configure` file is #{configure_file_commits_behind_repo} commit hash(es) behind the repo. Would you like to update it?")
+      end
+
+      def self.current_branch
+        Fastlane::Helper::ConfigureHelper.repo_branch_name
+      end
+
+      def self.current_hash
+        Fastlane::Helper::ConfigureHelper.repo_commit_hash
+      end
+
+      def self.update_configure_file
+        Fastlane::Helper::ConfigureHelper.update_configure_file_from_repository
+      end
+
+      def self.repo_is_ahead_of_remote
+        Fastlane::Helper::ConfigureHelper.repo_is_ahead_of_remote
+      end
+
+      def self.repo_commits_behind_remote
+        Fastlane::Helper::ConfigureHelper.repo_commits_behind_remote
+      end
+
+      def self.repo_is_behind_remote
+        Fastlane::Helper::ConfigureHelper.repo_is_behind_remote
+      end
+
+      def self.configure_file_is_behind_repo
+        Fastlane::Helper::ConfigureHelper.configure_file_is_behind_local
+      end
+
+      def self.configure_file_commits_behind_repo
+        Fastlane::Helper::ConfigureHelper.configure_file_commits_behind_repo
+      end
+
+      def self.get_branches
+        branches = sh("cd #{absolute_secret_store_path} && git branch -r")
+        branches.split("\n")
+                .map { |s| s.strip!.split('/')[1] }
+                .reject { |s| s.include? 'HEAD' }
+      end
+
+      ### Switch to the given branch, but don't ensure that it's up-to-date – that's for another step
+      def self.checkout_branch(branch_name)
+        sh("cd '#{absolute_secret_store_path}' && git checkout '#{branch_name}'")
+      end
+
+      ### Ensure that the local secrets respository is up to date
+      def self.update_branch
+        sh("cd '#{absolute_secret_store_path}' && git pull")
+      end
+
+      def self.absolute_secret_store_path
+        Fastlane::Helper::FilesystemHelper.secret_store_dir
+      end
+
+      def self.description
+        'Ensure that the local secrets repository is up to date.'
+      end
+
+      def self.authors
+        ['Jeremy Massel']
+      end
+
+      def self.details
+        'Ensure that the local secrets repository is up to date, and lets you test alternative branches.'
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/configure/configure_validate_action.rb

@@ -0,0 +1,134 @@
+require 'fastlane/action'
+require 'fastlane_core/ui/ui'
+
+require_relative '../../helper/filesystem_helper'
+require_relative '../../helper/configure_helper'
+
+module Fastlane
+  module Actions
+    class ConfigureValidateAction < Action
+      def self.run(params = {})
+        # Start by ensuring that we've set up the project for configuration
+        validate_that_configure_file_exists
+
+        # Check that the secrets repo is locally clean _before_ downloading the latest version,
+        # otherwise, the error messaging isn't as helpful.
+        validate_that_secrets_repo_is_clean
+
+        # Update the repository to get the latest version of the configuration secrets – that's
+        # how we'll know if we're behind in subsequent validations
+        ConfigureDownloadAction.run
+
+        validate_that_branches_match
+
+        validate_that_hashes_match
+
+        validate_that_no_dependent_files_have_changed
+
+        validate_that_all_copied_files_match
+
+        UI.success 'Configuration is valid'
+      end
+
+      ###
+      #         VALIDATION RULES
+      ###
+
+      ### Validate that the branch specified in .configure matches the branch
+      ### checked out in ~/.mobile-secrets.
+      def self.validate_that_branches_match
+        repo_branch_name = Fastlane::Helper::ConfigureHelper.repo_branch_name
+        file_branch_name = Fastlane::Helper::ConfigureHelper.configure_file_branch_name
+
+        unless repo_branch_name == file_branch_name
+
+          UI.user_error!([
+            'The branch specified in `.configure` is not the currently checked out branch in the secrets repository.',
+            "To fix this issue, switch back to the `#{file_branch_name}` branch in the mobile secrets repository.",
+          ].join("\n"))
+        end
+      end
+
+      ### Validate that the pinned hash specified in .configure matches
+      ### the current hash of ~/.mobile-secrets
+      def self.validate_that_hashes_match
+        repo_hash = Fastlane::Helper::ConfigureHelper.repo_commit_hash
+        file_hash = Fastlane::Helper::ConfigureHelper.configure_file_commit_hash
+
+        unless repo_hash == file_hash
+
+          UI.user_error!([
+            'The pinned_hash specified in `.configure` is not the currently checked out hash in the secrets repository.',
+            "To fix this issue, check out the `#{file_hash}` hash in the mobile secrets repository.",
+          ].join("\n"))
+        end
+      end
+
+      ### Validate that based on the commit hash in the .configure file, no files have changed
+      ### that affect this project.
+      def self.validate_that_no_dependent_files_have_changed
+        repo_hash = Fastlane::Helper::ConfigureHelper.repo_commit_hash
+        file_hash = Fastlane::Helper::ConfigureHelper.configure_file_commit_hash
+
+        changed_files = Fastlane::Helper::ConfigureHelper.files_changed_between(file_hash, repo_hash)
+        dependencies = Fastlane::Helper::ConfigureHelper.file_dependencies
+        new_files = Fastlane::Helper::ConfigureHelper.new_files_in(changed_files)
+
+        changed_dependencies = changed_files & dependencies # calculate array intersection
+
+        UI.user_error!("The following files are out of date. Please run `bundle exec fastlane run configure_update` before continuing:\n\n#{changed_dependencies}") unless changed_dependencies.empty?
+
+        UI.user_error!("The following files are in the secrets repository, but aren't available for your project. Please run `bundle exec fastlane run configure_update` before continuing:\n\n#{new_files}") unless new_files.empty?
+      end
+
+      ### Validate that the secrets repo doesn't have any local changes
+      def self.validate_that_secrets_repo_is_clean
+        UI.user_error!('The secrets repository has uncommitted changes. Please commit or discard them before continuing.') unless Fastlane::Helper::ConfigureHelper.repo_has_changes
+      end
+
+      def self.validate_that_all_copied_files_match
+        Fastlane::Helper::ConfigureHelper.files_to_copy.each do |x|
+          source = absolute_secret_store_path(x.file)
+          destination = absolute_project_path(x.destination)
+
+          sourceHash = file_hash(source)
+          destinationHash = file_hash(destination)
+
+          UI.user_error!("`#{x.destination} doesn't match the file in the secrets repository (#{x.file}) – unable to continue") unless sourceHash == destinationHash
+        end
+      end
+
+      def self.validate_that_configure_file_exists
+        UI.user_error!("Couldn't find `.configure` file. Please set up this project for `configure` by running `bundle exec fastlane run configure_setup`") unless Fastlane::Helper::ConfigureHelper.configuration_path_exists
+      end
+
+      def self.absolute_project_path(relative_path)
+        Fastlane::Helper::FilesystemHelper.absolute_project_path(relative_path)
+      end
+
+      def self.absolute_secret_store_path(relative_path)
+        Fastlane::Helper::FilesystemHelper.absolute_secret_store_path(relative_path)
+      end
+
+      def self.file_hash(absolute_path)
+        Fastlane::Helper::FilesystemHelper.file_hash(absolute_path)
+      end
+
+      def self.description
+        'Ensure that the configuration is valid'
+      end
+
+      def self.authors
+        ['Jeremy Massel']
+      end
+
+      def self.details
+        'Ensure that the configuration is valid'
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/add_development_certificates_to_provisioning_profiles.rb

@@ -0,0 +1,77 @@
+module Fastlane
+  module Actions
+    class AddDevelopmentCertificatesToProvisioningProfilesAction < Action
+      def self.run(params)
+        require 'spaceship'
+
+        Spaceship.login
+        Spaceship.select_team(team_id: params[:team_id])
+
+        all_certificates = Spaceship.certificate.all(mac: false).select do |certificate|
+          certificate.owner_type == 'teamMember'
+        end
+
+        params[:app_identifier].each do |identifier|
+          Spaceship.provisioning_profile.find_by_bundle_id(bundle_id: identifier)
+                   .select do |profile|
+            profile.is_a? Spaceship::Portal::ProvisioningProfile::Development
+          end
+                   .tap do |profiles|
+            UI.important "Warning: Unable to find any profiles associated with #{identifier}" unless profiles.length > 0
+          end
+                   .each do |profile|
+            profile.certificates = all_certificates
+            profile.update!
+            UI.success "Applied #{all_certificates.length} certificates to #{profile.name}"
+          end
+        end
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Add dev certificates to provisioning profiles'
+      end
+
+      def self.details
+        "Add all team member's development certificates to profiles associated with the provided bundle identifiers"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :app_identifier,
+                                       description: 'List of App Identifiers that should contain the new device identifier',
+                                       is_string: false,
+                                       verify_block: proc do |value|
+                                                       UI.user_error!('You must provide an array of bundle identifiers in `app_identifier`') if value.empty?
+                                                     end),
+          FastlaneCore::ConfigItem.new(key: :team_id,
+                                       description: 'The team_id for the provisioning profiles',
+                                       is_string: true,
+                                       verify_block: proc do |value|
+                                                       UI.user_error!('You must provide a team ID in `team_id`') unless value && (!value.empty?)
+                                                     end),
+        ]
+      end
+
+      def self.output
+        # This lane doesn't provide variables that other lanes can consume.
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.authors
+        # So no one will ever forget your contribution to fastlane :) You are awesome btw!
+        ['jkmassel']
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/add_devices_to_provisioning_profiles.rb

@@ -0,0 +1,79 @@
+module Fastlane
+  module Actions
+    class AddAllDevicesToProvisioningProfilesAction < Action
+      def self.run(params)
+        require 'spaceship'
+
+        Spaceship.login
+        Spaceship.select_team(team_id: params[:team_id])
+
+        devices = Spaceship.device.all_ios_profile_devices
+
+        params[:app_identifier].each do |identifier|
+          Spaceship.provisioning_profile.find_by_bundle_id(bundle_id: identifier)
+                   .select do |profile|
+            profile.is_a? Spaceship::Portal::ProvisioningProfile::Development
+          end
+                   .tap do |profiles|
+            UI.important "Warning: Unable to find any profiles associated with #{identifier}" unless profiles.length > 0
+          end
+                   .each do |profile|
+            profile.devices = devices
+            profile.update!
+            UI.success "Applied #{devices.length} devices to #{profile.name}"
+          end
+        end
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Add devices to provisioning profiles'
+      end
+
+      def self.details
+        'Add all iOS devices to any profiles associated with the provided bundle identifiers'
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :app_identifier,
+            description: 'List of App Identifiers that should contain the new device identifier',
+            is_string: false,
+            verify_block: proc do |value|
+              UI.user_error!('You must provide an array of bundle identifiers in `app_identifier`') if value.empty?
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :team_id,
+            description: 'The team_id for the provisioning profiles',
+            is_string: true,
+            verify_block: proc do |value|
+              UI.user_error!('You must provide a team ID in `team_id`') unless value && (!value.empty?)
+            end
+          ),
+        ]
+      end
+
+      def self.output
+        # This lane doesn't provide variables that other lanes can consume.
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.authors
+        # So no one will ever forget your contribution to fastlane :) You are awesome btw!
+        ['jkmassel']
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_betabuild_prechecks.rb

@@ -0,0 +1,92 @@
+module Fastlane
+  module Actions
+    class IosBetabuildPrechecksAction < Action
+      def self.run(params)
+        UI.message "Skip confirm: #{params[:skip_confirm]}"
+        UI.message "Work on version: #{params[:base_version]}" unless params[:base_version].nil?
+
+        require_relative '../../helper/ios/ios_version_helper.rb'
+        require_relative '../../helper/ios/ios_git_helper.rb'
+
+        # Checkout develop and update
+        Fastlane::Helper::GitHelper.checkout_and_pull('develop')
+
+        # Check versions
+        build_version = Fastlane::Helper::Ios::VersionHelper.get_build_version
+        message = "The following current version has been detected: #{build_version}\n"
+
+        # Check branch
+        app_version = Fastlane::Helper::Ios::VersionHelper.get_public_version
+        UI.user_error!("#{message}Release branch for version #{app_version} doesn't exist. Abort.") unless !params[:base_version].nil? || Fastlane::Helper::GitHelper.checkout_and_pull(release: app_version)
+
+        # Check user overwrite
+        build_version = get_user_build_version(params[:base_version], message) unless params[:base_version].nil?
+        next_version = Fastlane::Helper::Ios::VersionHelper.calc_next_build_version(build_version)
+
+        # Verify
+        message << "Updating branch to version: #{next_version}.\n"
+        if !params[:skip_confirm]
+          UI.user_error!('Aborted by user request') unless UI.confirm("#{message}Do you want to continue?")
+        else
+          UI.message(message)
+        end
+
+        # Check local repo status
+        other_action.ensure_git_status_clean()
+
+        # Return the current version
+        build_version
+      end
+
+      def self.get_user_build_version(version, message)
+        UI.user_error!("Release branch for version #{version} doesn't exist. Abort.") unless Fastlane::Helper::GitHelper.checkout_and_pull(release: version)
+        build_version = Fastlane::Helper::Ios::VersionHelper.get_build_version
+        message << "Looking at branch release/#{version} as requested by user. Detected version: #{build_version}.\n"
+        build_version
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Runs some prechecks before preparing for a new test build'
+      end
+
+      def self.details
+        'Updates the relevant release branch, checks the app version and ensure the branch is clean'
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :base_version,
+                                       env_name: 'FL_IOS_BETABUILD_PRECHECKS_BASE_VERSION',
+                                       description: 'The version to work on', # a short description of this parameter
+                                       is_string: true,
+                                       optional: true), # true: verifies the input is a string, false: every kind of value),
+          FastlaneCore::ConfigItem.new(key: :skip_confirm,
+                                       env_name: 'FL_IOS_BETABUILD_PRECHECKS_SKIPCONFIRM',
+                                       description: 'Skips confirmation',
+                                       is_string: false, # true: verifies the input is a string, false: every kind of value
+                                       default_value: false), # the default value if the user didn't provide one
+        ]
+      end
+
+      def self.output
+      end
+
+      def self.return_value
+        # If you method provides a return value, you can describe here what it does
+      end
+
+      def self.authors
+        # So no one will ever forget your contribution to fastlane :) You are awesome btw!
+        ['loremattei']
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+    end
+  end
+end