fastlane_iac_publish 0.1.0

data/fastlane/lib/fastlane/actions/update_fastlane.rb

@@ -0,0 +1,177 @@
+require 'rubygems/spec_fetcher'
+require 'rubygems/command_manager'
+
+module Fastlane
+  module Actions
+    # Makes sure fastlane tools are up-to-date when running fastlane
+    class UpdateFastlaneAction < Action
+      ALL_TOOLS = ["fastlane"]
+
+      def self.run(options)
+        return if options[:no_update] # this is used to update itself
+
+        tools_to_update = options[:tools].split(',') unless options[:tools].nil?
+        tools_to_update ||= all_installed_tools
+
+        if tools_to_update.count == 0
+          UI.error("No tools specified or couldn't find any installed fastlane.tools")
+          return
+        end
+
+        UI.message("Looking for updates for #{tools_to_update.join(', ')}...")
+
+        updater = Gem::CommandManager.instance[:update]
+        updater.options[:prerelease] = true if options[:nightly]
+        cleaner = Gem::CommandManager.instance[:cleanup]
+
+        gem_dir = ENV['GEM_HOME'] || Gem.dir
+        sudo_needed = !File.writable?(gem_dir)
+
+        if sudo_needed
+          UI.important("It seems that your Gem directory is not writable by your current user.")
+          UI.important("fastlane would need sudo rights to update itself, however, running 'sudo fastlane' is not recommended.")
+          UI.important("If you still want to use this action, please read the documentation on how to set this up:")
+          UI.important("https://docs.fastlane.tools/actions/#update_fastlane")
+          return
+        end
+
+        unless updater.respond_to?(:highest_installed_gems)
+          UI.important("The update_fastlane action requires rubygems version 2.1.0 or greater.")
+          UI.important("Please update your version of ruby gems before proceeding.")
+          UI.command "gem install rubygems-update"
+          UI.command "update_rubygems"
+          UI.command "gem update --system"
+          return
+        end
+
+        highest_versions = updater.highest_installed_gems.keep_if { |key| tools_to_update.include?(key) }
+        update_needed = updater.which_to_update(highest_versions, tools_to_update)
+
+        if update_needed.count == 0
+          UI.success("Nothing to update ✅")
+          show_information_about_nightly_builds unless options[:nightly]
+          return
+        end
+
+        # suppress updater output - very noisy
+        Gem::DefaultUserInteraction.ui = Gem::SilentUI.new
+
+        update_needed.each do |tool_info|
+          tool = tool_info[0]
+          gem_version = tool_info[1]
+          local_version = Gem::Version.new(highest_versions[tool].version)
+          latest_official_version = FastlaneCore::UpdateChecker.fetch_latest(tool)
+
+          if options[:nightly]
+            UI.message("Updating #{tool} from #{local_version.to_s.yellow} to nightly build #{gem_version.to_s.yellow}... (last official release #{latest_official_version.to_s.yellow}) 🚀")
+          else
+            UI.message("Updating #{tool} from #{local_version.to_s.yellow} to #{latest_official_version.to_s.yellow}... 🚀")
+          end
+
+          # Approximate_recommendation will create a string like "~> 0.10" from a version 0.10.0, e.g. one that is valid for versions >= 0.10 and <1.0
+          requirement_version = options[:nightly] ? gem_version : local_version.approximate_recommendation
+          updater.update_gem(tool, Gem::Requirement.new(requirement_version))
+
+          UI.success("Finished updating #{tool}")
+        end
+
+        UI.message("Cleaning up old versions...")
+        cleaner.options[:args] = tools_to_update
+        cleaner.execute
+
+        if options[:nightly]
+          UI.success("Thanks for using fastlane's nightly builds! This makes it easier for everyone to detect regressions earlier.")
+          UI.success("Please submit an issue on GitHub if anything behaves differently than it should 🍪")
+        else
+          show_information_about_nightly_builds
+        end
+
+        UI.message("fastlane.tools successfully updated! I will now restart myself... 😴")
+
+        # Set no_update to true so we don't try to update again
+        exec("FL_NO_UPDATE=true #{$PROGRAM_NAME} #{ARGV.join(' ')}")
+      end
+
+      def self.show_information_about_nightly_builds
+        UI.message("")
+        UI.message("Please help us test early releases of fastlane by opting into nightly builds 🌃")
+        UI.message("Just replace your `update_fastlane` call with")
+        UI.message("")
+        UI.command_output("update_fastlane(nightly: true)")
+        UI.message("")
+        UI.message("Nightly builds are reviewed and tested just like the public releases 🚂")
+        UI.message("")
+      end
+
+      def self.all_installed_tools
+        Gem::Specification.select { |s| ALL_TOOLS.include?(s.name) }.map(&:name).uniq
+      end
+
+      def self.description
+        "Makes sure fastlane-tools are up-to-date when running fastlane"
+      end
+
+      def self.details
+        sample = <<-SAMPLE.markdown_sample
+          ```bash
+          export GEM_HOME=~/.gems
+          export PATH=$PATH:~/.gems/bin
+          ```
+        SAMPLE
+
+        [
+          "This action will update fastlane to the most recent version - major version updates will not be performed automatically, as they might include breaking changes. If an update was performed, fastlane will be restarted before the run continues.",
+          "",
+          "If you are using rbenv or rvm, everything should be good to go. However, if you are using the system's default ruby, some additional setup is needed for this action to work correctly. In short, fastlane needs to be able to access your gem library without running in `sudo` mode.",
+          "",
+          "The simplest possible fix for this is putting the following lines into your `~/.bashrc` or `~/.zshrc` file:".markdown_preserve_newlines,
+          sample,
+          "After the above changes, restart your terminal, then run `mkdir $GEM_HOME` to create the new gem directory. After this, you're good to go!",
+          "",
+          "Recommended usage of the `update_fastlane` action is at the top inside of the `before_all` block, before running any other action."
+        ].join("\n")
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :nightly,
+                                       env_name: "FL_UPDATE_FASTLANE_NIGHTLY",
+                                       description: "Opt-in to install and use nightly fastlane builds",
+                                       is_string: false,
+                                       default_value: false),
+          FastlaneCore::ConfigItem.new(key: :no_update,
+                                       env_name: "FL_NO_UPDATE",
+                                       description: "Don't update during this run. This is used internally",
+                                       is_string: false,
+                                       default_value: false),
+          FastlaneCore::ConfigItem.new(key: :tools,
+                                       env_name: "FL_TOOLS_TO_UPDATE",
+                                       description: "Comma separated list of fastlane tools to update (e.g. `fastlane,deliver,sigh`)",
+                                       deprecated: true,
+                                       optional: true)
+        ]
+      end
+
+      def self.authors
+        ["milch", "KrauseFx"]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.example_code
+        [
+          'before_all do
+            update_fastlane
+            # ...
+          end'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+    end
+  end
+end

data/fastlane/lib/fastlane/actions/update_icloud_container_identifiers.rb

@@ -0,0 +1,99 @@
+module Fastlane
+  module Actions
+    module SharedValues
+      UPDATE_ICLOUD_CONTAINER_IDENTIFIERS = :UPDATE_ICLOUD_CONTAINER_IDENTIFIERS
+    end
+
+    class UpdateIcloudContainerIdentifiersAction < Action
+      require 'plist'
+
+      def self.run(params)
+        entitlements_file = params[:entitlements_file]
+        UI.message("Entitlements File: #{entitlements_file}")
+
+        # parse entitlements
+        result = Plist.parse_xml(entitlements_file)
+        UI.error("Entitlements file at '#{entitlements_file}' cannot be parsed.") unless result
+
+        # get iCloud container field
+        icloud_container_key = 'com.apple.developer.icloud-container-identifiers'
+        icloud_container_value = result[icloud_container_key]
+        UI.error("No existing iCloud container field specified. Please specify an iCloud container in the entitlements file.") unless icloud_container_value
+
+        # get uniquity container field
+        ubiquity_container_key = 'com.apple.developer.ubiquity-container-identifiers'
+        ubiquity_container_value = result[ubiquity_container_key]
+        UI.error("No existing ubiquity container field specified. Please specify an ubiquity container in the entitlements file.") unless ubiquity_container_value
+
+        # set iCloud container identifiers
+        result[icloud_container_key] = params[:icloud_container_identifiers]
+        result[ubiquity_container_key] = params[:icloud_container_identifiers]
+
+        # save entitlements file
+        result.save_plist(entitlements_file)
+
+        UI.message("Old iCloud Container Identifiers: #{icloud_container_value}")
+        UI.message("Old Ubiquity Container Identifiers: #{ubiquity_container_value}")
+
+        UI.success("New iCloud Container Identifiers set: #{result[icloud_container_key]}")
+        UI.success("New Ubiquity Container Identifiers set: #{result[ubiquity_container_key]}")
+
+        Actions.lane_context[SharedValues::UPDATE_ICLOUD_CONTAINER_IDENTIFIERS] = result[icloud_container_key]
+      end
+
+      def self.description
+        "This action changes the iCloud container identifiers in the entitlements file"
+      end
+
+      def self.details
+        "Updates the iCloud Container Identifiers in the given Entitlements file, so you can use different iCloud containers for different builds like Adhoc, App Store, etc."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :entitlements_file,
+                                       env_name: "FL_UPDATE_ICLOUD_CONTAINER_IDENTIFIERS_ENTITLEMENTS_FILE_PATH",
+                                       description: "The path to the entitlement file which contains the iCloud container identifiers",
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Please pass a path to an entitlements file. ") unless value.include?(".entitlements")
+                                         UI.user_error!("Could not find entitlements file") if !File.exist?(value) && !Helper.test?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :icloud_container_identifiers,
+                                       env_name: "FL_UPDATE_ICLOUD_CONTAINER_IDENTIFIERS_IDENTIFIERS",
+                                       description: "An Array of unique identifiers for the iCloud containers. Eg. ['iCloud.com.test.testapp']",
+                                       is_string: false,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("The parameter icloud_container_identifiers needs to be an Array.") unless value.kind_of?(Array)
+                                       end)
+        ]
+      end
+
+      def self.output
+        [
+          ['UPDATE_ICLOUD_CONTAINER_IDENTIFIERS', 'The new iCloud Container Identifiers']
+        ]
+      end
+
+      def self.authors
+        ["JamesKuang"]
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+
+      def self.example_code
+        [
+          'update_icloud_container_identifiers(
+            entitlements_file: "/path/to/entitlements_file.entitlements",
+            icloud_container_identifiers: ["iCloud.com.companyname.appname"]
+          )'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+    end
+  end
+end

data/fastlane/lib/fastlane/actions/update_info_plist.rb

@@ -0,0 +1,143 @@
+module Fastlane
+  module Actions
+    module SharedValues
+    end
+
+    class UpdateInfoPlistAction < Action
+      def self.run(params)
+        # Check if parameters are set
+        if params[:app_identifier] || params[:display_name] || params[:block]
+          if (params[:app_identifier] || params[:display_name]) && params[:block]
+            UI.important("block parameter can not be specified with app_identifier or display_name")
+            return false
+          end
+
+          # Assign folder from parameter or search for xcodeproj file
+          folder = params[:xcodeproj] || Dir["*.xcodeproj"].first
+          UI.user_error!("Could not figure out your xcodeproj path. Please specify it using the `xcodeproj` parameter") if folder.nil?
+
+          if params[:scheme]
+            project = Xcodeproj::Project.open(folder)
+            scheme = project.native_targets.detect { |target| target.name == params[:scheme] }
+            UI.user_error!("Couldn't find scheme named '#{params[:scheme]}'") unless scheme
+
+            params[:plist_path] = scheme.build_configurations.first.build_settings["INFOPLIST_FILE"]
+            UI.user_error!("Scheme named '#{params[:scheme]}' doesn't have a plist file") unless params[:plist_path]
+            params[:plist_path] = params[:plist_path].gsub("$(SRCROOT)", ".")
+          end
+
+          if params[:plist_path].nil?
+            UI.user_error!("You must specify either a plist path or a scheme")
+          end
+
+          # Read existing plist file
+          info_plist_path = File.join(folder, "..", params[:plist_path])
+          UI.user_error!("Couldn't find info plist file at path '#{info_plist_path}'") unless File.exist?(info_plist_path)
+
+          UpdatePlistAction.run(
+            plist_path: info_plist_path,
+            block: proc do |plist|
+              plist['CFBundleIdentifier'] = params[:app_identifier] if params[:app_identifier]
+              plist['CFBundleDisplayName'] = params[:display_name] if params[:display_name]
+              params[:block].call(plist) if params[:block]
+            end
+          )
+        else
+          UI.important("You haven't specified any parameters to update your plist.")
+          false
+        end
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.is_supported?(platform)
+        [:ios].include?(platform)
+      end
+
+      def self.description
+        'Update a Info.plist file with bundle identifier and display name'
+      end
+
+      def self.details
+        "This action allows you to modify your `Info.plist` file before building. This may be useful if you want a separate build for alpha, beta or nightly builds, but don't want a separate target."
+      end
+
+      def self.available_options
+        [
+
+          FastlaneCore::ConfigItem.new(key: :xcodeproj,
+                                       env_name: "FL_UPDATE_PLIST_PROJECT_PATH",
+                                       description: "Path to your Xcode project",
+                                       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: :plist_path,
+                                       env_name: "FL_UPDATE_PLIST_PATH",
+                                       description: "Path to info plist",
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Invalid plist file") unless value[-6..-1].casecmp(".plist").zero?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :scheme,
+                                       env_name: "FL_UPDATE_PLIST_APP_SCHEME",
+                                       description: "Scheme of info plist",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :app_identifier,
+                                       env_name: 'FL_UPDATE_PLIST_APP_IDENTIFIER',
+                                       description: 'The App Identifier of your app',
+                                       code_gen_sensitive: true,
+                                       default_value: ENV['PRODUCE_APP_IDENTIFIER'],
+                                       default_value_dynamic: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :display_name,
+                                       env_name: 'FL_UPDATE_PLIST_DISPLAY_NAME',
+                                       description: 'The Display Name of your app',
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :block,
+                                       is_string: false,
+                                       description: 'A block to process plist with custom logic',
+                                       optional: true)
+
+        ]
+      end
+
+      def self.author
+        'tobiasstrebitzer'
+      end
+
+      def self.example_code
+        [
+          'update_info_plist( # update app identifier string
+            plist_path: "path/to/Info.plist",
+            app_identifier: "com.example.newappidentifier"
+          )',
+          'update_info_plist( # Change the Display Name of your app
+            plist_path: "path/to/Info.plist",
+            display_name: "MyApp-Beta"
+          )',
+          'update_info_plist( # Target a specific `xcodeproj` rather than finding the first available one
+            xcodeproj: "path/to/Example.proj",
+            plist_path: "path/to/Info.plist",
+            display_name: "MyApp-Beta"
+          )',
+          'update_info_plist( # Advanced processing: find URL scheme for particular key and replace value
+            xcodeproj: "path/to/Example.proj",
+            plist_path: "path/to/Info.plist",
+            block: proc do |plist|
+              urlScheme = plist["CFBundleURLTypes"].find{|scheme| scheme["CFBundleURLName"] == "com.acme.default-url-handler"}
+              urlScheme[:CFBundleURLSchemes] = ["acme-production"]
+            end
+          )'
+        ]
+      end
+
+      def self.category
+        :project
+      end
+    end
+  end
+end

data/fastlane/lib/fastlane/actions/update_plist.rb

@@ -0,0 +1,80 @@
+module Fastlane
+  module Actions
+    module SharedValues
+    end
+
+    class UpdatePlistAction < Action
+      def self.run(params)
+        require 'xcodeproj'
+
+        if params[:plist_path].nil?
+          UI.user_error!("You must specify a plist path")
+        end
+
+        # Read existing plist file
+        plist_path = params[:plist_path]
+
+        UI.user_error!("Couldn't find plist file at path '#{plist_path}'") unless File.exist?(plist_path)
+        plist = Xcodeproj::Plist.read_from_path(plist_path)
+
+        params[:block].call(plist) if params[:block]
+
+        # Write changes to file
+        Xcodeproj::Plist.write_to_path(plist, plist_path)
+
+        UI.success("Updated #{params[:plist_path]} 💾.")
+        File.read(plist_path)
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.is_supported?(platform)
+        [:ios].include?(platform)
+      end
+
+      def self.description
+        'Update a plist file'
+      end
+
+      def self.details
+        "This action allows you to modify any `plist` file."
+      end
+
+      def self.available_options
+        [
+
+          FastlaneCore::ConfigItem.new(key: :plist_path,
+                                       env_name: "FL_UPDATE_PLIST_PATH",
+                                       description: "Path to plist file",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :block,
+                                       is_string: false,
+                                       description: 'A block to process plist with custom logic')
+
+        ]
+      end
+
+      def self.author
+        'rishabhtayal'
+      end
+
+      def self.example_code
+        [
+          'update_plist( # Advanced processing: find URL scheme for particular key and replace value
+            plist_path: "path/to/Info.plist",
+            block: proc do |plist|
+              urlScheme = plist["CFBundleURLTypes"].find{|scheme| scheme["CFBundleURLName"] == "com.acme.default-url-handler"}
+              urlScheme[:CFBundleURLSchemes] = ["acme-production"]
+            end
+          )'
+        ]
+      end
+
+      def self.category
+        :project
+      end
+    end
+  end
+end