fastlane_iac_publish 0.1.0

data/sigh/lib/sigh.rb

@@ -0,0 +1,4 @@
+require_relative 'sigh/resign'
+require_relative 'sigh/manager'
+require_relative 'sigh/options'
+require_relative 'sigh/local_manage'

data/sigh/lib/sigh/commands_generator.rb

@@ -0,0 +1,153 @@
+require 'commander'
+require 'fastlane/version'
+
+require_relative 'options'
+require_relative 'resign'
+require_relative 'local_manage'
+require_relative 'manager'
+
+HighLine.track_eof = false
+
+module Sigh
+  class CommandsGenerator
+    include Commander::Methods
+
+    def self.start
+      self.new.run
+    end
+
+    def run
+      program :name, 'sigh'
+      program :version, Fastlane::VERSION
+      program :description, 'CLI for \'sigh\' - Because you would rather spend your time building stuff than fighting provisioning'
+      program :help, 'Author', 'Felix Krause <sigh@krausefx.com>'
+      program :help, 'Website', 'https://fastlane.tools'
+      program :help, 'Documentation', 'https://docs.fastlane.tools/actions/sigh/'
+      program :help_formatter, :compact
+
+      global_option('--verbose') { FastlaneCore::Globals.verbose = true }
+
+      command :renew do |c|
+        c.syntax = 'fastlane sigh renew'
+        c.description = 'Renews the certificate (in case it expired) and outputs the path to the generated file'
+
+        FastlaneCore::CommanderGenerator.new.generate(Sigh::Options.available_options, command: c)
+
+        c.action do |args, options|
+          user_input = options.__hash__
+
+          # The user might run sigh using
+          #
+          #   sigh development
+          #
+          #   sigh adhoc -u user@krausefx.com
+          #
+          # When the user runs this, it will use :development
+          #
+          #   sigh development --adhoc
+          #
+          case args.first
+          when "development"
+            user_input[:development] = true
+            user_input.delete(:adhoc)
+          when "adhoc"
+            user_input[:adhoc] = true
+            user_input.delete(:development)
+          end
+
+          Sigh.config = FastlaneCore::Configuration.create(Sigh::Options.available_options, user_input)
+
+          Sigh::Manager.start
+        end
+      end
+
+      command :download_all do |c|
+        c.syntax = 'fastlane sigh download_all'
+        c.description = 'Downloads all valid provisioning profiles'
+
+        c.option('--download_xcode_profiles', 'Only works with `fastlane sigh download_all` command: Also download Xcode managed provisioning profiles')
+
+        FastlaneCore::CommanderGenerator.new.generate(Sigh::Options.available_options, command: c)
+
+        c.action do |args, options|
+          # Below is some custom code to get an extra flag that's only available
+          # for the `fastlane sigh download_all` command and not for the `sigh` action
+          user_hash = options.__hash__
+          download_xcode_profiles = options.download_xcode_profiles
+
+          if download_xcode_profiles == true
+            user_hash.delete(:download_xcode_profiles)
+          end
+          Sigh.config = FastlaneCore::Configuration.create(Sigh::Options.available_options, user_hash)
+          Sigh::Manager.download_all(download_xcode_profiles: download_xcode_profiles)
+        end
+      end
+
+      command :repair do |c|
+        c.syntax = 'fastlane sigh repair'
+        c.description = 'Repairs all expired or invalid provisioning profiles'
+
+        FastlaneCore::CommanderGenerator.new.generate(Sigh::Options.available_options, command: c)
+
+        c.action do |args, options|
+          Sigh.config = FastlaneCore::Configuration.create(Sigh::Options.available_options, options.__hash__)
+          require 'sigh/repair'
+          Sigh::Repair.new.repair_all
+        end
+      end
+
+      command :resign do |c|
+        c.syntax = 'fastlane sigh resign'
+        c.description = 'Resigns an existing ipa file with the given provisioning profile'
+        c.option('-i', '--signing_identity STRING', String, 'The signing identity to use. Must match the one defined in the provisioning profile.')
+        c.option('-x', '--version_number STRING', String, 'Version number to force binary and all nested binaries to use. Changes both CFBundleShortVersionString and CFBundleVersion.')
+        c.option('-p', '--provisioning_profile PATH', String, '(or BUNDLE_ID=PATH) The path to the provisioning profile which should be used. '\
+                 'Can be provided multiple times if the application contains nested applications and app extensions, which need their own provisioning profile. '\
+                 'The path may be prefixed with a identifier in order to determine which provisioning profile should be used on which app.',
+                 &multiple_values_option_proc(c, "provisioning_profile", &proc { |value| value.split('=', 2) }))
+        c.option('-d', '--display_name STRING', String, 'Display name to use')
+        c.option('-e', '--entitlements PATH', String, 'The path to the entitlements file to use.')
+        c.option('--short_version STRING', String, 'Short version string to force binary and all nested binaries to use (CFBundleShortVersionString).')
+        c.option('--bundle_version STRING', String, 'Bundle version to force binary and all nested binaries to use (CFBundleVersion).')
+        c.option('--use_app_entitlements', 'Extract app bundle codesigning entitlements and combine with entitlements from new provisionin profile.')
+        c.option('-g', '--new_bundle_id STRING', String, 'New application bundle ID (CFBundleIdentifier)')
+        c.option('--keychain_path STRING', String, 'Path to the keychain that /usr/bin/codesign should use')
+
+        c.action do |args, options|
+          Sigh::Resign.new.run(options, args)
+        end
+      end
+
+      command :manage do |c|
+        c.syntax = 'fastlane sigh manage'
+        c.description = 'Manage installed provisioning profiles on your system.'
+
+        c.option('-f', '--force', 'Force remove all expired provisioning profiles. Required on CI.')
+        c.option('-e', '--clean_expired', 'Remove all expired provisioning profiles.')
+
+        c.option('-p', '--clean_pattern STRING', String, 'Remove any provisioning profiles that matches the regular expression.')
+        c.example('Remove all "iOS Team Provisioning" provisioning profiles', 'fastlane sigh manage -p "iOS\ ?Team Provisioning Profile"')
+
+        c.action do |args, options|
+          Sigh::LocalManage.start(options, args)
+        end
+      end
+
+      default_command(:renew)
+
+      run!
+    end
+
+    def multiple_values_option_proc(command, name)
+      proc do |value|
+        value = yield(value) if block_given?
+        option = command.proxy_options.find { |opt| opt[0] == name } || []
+        values = option[1] || []
+        values << value
+
+        command.proxy_options.delete(option)
+        command.proxy_options << [name, values]
+      end
+    end
+  end
+end

data/sigh/lib/sigh/download_all.rb

@@ -0,0 +1,45 @@
+require 'spaceship'
+
+require_relative 'manager'
+require_relative 'module'
+
+module Sigh
+  class DownloadAll
+    # Download all valid provisioning profiles
+    def download_all(download_xcode_profiles: false)
+      UI.message("Starting login with user '#{Sigh.config[:username]}'")
+      Spaceship.login(Sigh.config[:username], nil)
+      Spaceship.select_team
+      UI.message("Successfully logged in")
+
+      Spaceship.provisioning_profile.all(xcode: download_xcode_profiles).each do |profile|
+        if profile.valid?
+          UI.message("Downloading profile '#{profile.name}'...")
+          download_profile(profile)
+        else
+          UI.important("Skipping invalid/expired profile '#{profile.name}'")
+        end
+      end
+
+      if download_xcode_profiles
+        UI.message("This run also included all Xcode managed provisioning profiles, as you used the `--download_xcode_profiles` flag")
+      else
+        UI.message("All Xcode managed provisioning profiles were ignored on this, to include them use the `--download_xcode_profiles` flag")
+      end
+    end
+
+    def download_profile(profile)
+      FileUtils.mkdir_p(Sigh.config[:output_path])
+
+      type_name = profile.class.pretty_type
+      profile_name = "#{type_name}_#{profile.uuid}_#{profile.app.bundle_id}.mobileprovision" # default name
+
+      output_path = File.join(Sigh.config[:output_path], profile_name)
+      File.open(output_path, "wb") do |f|
+        f.write(profile.download)
+      end
+
+      Manager.install_profile(output_path) unless Sigh.config[:skip_install]
+    end
+  end
+end

data/sigh/lib/sigh/local_manage.rb

@@ -0,0 +1,145 @@
+require 'plist'
+require 'fastlane_core/globals'
+
+require_relative 'module'
+
+module Sigh
+  class LocalManage
+    LIST = "list"
+    CLEANUP = "cleanup"
+
+    def self.start(options, args)
+      command, clean_expired, clean_pattern, force = get_inputs(options, args)
+      if command == LIST
+        list_profiles
+      elsif command == CLEANUP
+        cleanup_profiles(clean_expired, clean_pattern, force)
+      end
+    end
+
+    def self.install_profile(profile)
+      UI.message("Installing provisioning profile...")
+      profile_path = File.expand_path("~") + "/Library/MobileDevice/Provisioning Profiles/"
+      uuid = ENV["SIGH_UUID"] || ENV["SIGH_UDID"]
+      profile_filename = uuid + ".mobileprovision"
+      destination = profile_path + profile_filename
+
+      # If the directory doesn't exist, make it first
+      unless File.directory?(profile_path)
+        FileUtils.mkdir_p(profile_path)
+      end
+
+      # copy to Xcode provisioning profile directory
+      FileUtils.copy(profile, destination)
+
+      if File.exist?(destination)
+        UI.success("Profile installed at \"#{destination}\"")
+      else
+        UI.user_error!("Failed installation of provisioning profile at location: #{destination}")
+      end
+    end
+
+    def self.get_inputs(options, _args)
+      clean_expired = options.clean_expired
+      clean_pattern = /#{options.clean_pattern}/ if options.clean_pattern
+      force = options.force
+      command = (!clean_expired.nil? || !clean_pattern.nil?) ? CLEANUP : LIST
+      return command, clean_expired, clean_pattern, force
+    end
+
+    def self.list_profiles
+      profiles = load_profiles
+
+      now = DateTime.now
+      soon = (Date.today + 30).to_datetime
+
+      profiles_valid = profiles.select { |profile| profile["ExpirationDate"] > now && profile["ExpirationDate"] > soon }
+      if profiles_valid.count > 0
+        UI.message("Provisioning profiles installed")
+        UI.message("Valid:")
+        profiles_valid.each do |profile|
+          UI.message(profile_info(profile).green)
+        end
+      end
+
+      profiles_soon = profiles.select { |profile| profile["ExpirationDate"] > now && profile["ExpirationDate"] < soon }
+      if profiles_soon.count > 0
+        UI.message("")
+        UI.message("Expiring within 30 days:")
+        profiles_soon.each do |profile|
+          UI.message(profile_info(profile).yellow)
+        end
+      end
+
+      profiles_expired = profiles.select { |profile| profile["ExpirationDate"] < now }
+      if profiles_expired.count > 0
+        UI.message("")
+        UI.message("Expired:")
+        profiles_expired.each do |profile|
+          UI.message(profile_info(profile).red)
+        end
+      end
+
+      UI.message("")
+      UI.message("Summary")
+      UI.message("#{profiles.count} installed profiles")
+      UI.message("#{profiles_expired.count} are expired".red) if profiles_expired.count > 0
+      UI.message("#{profiles_soon.count} are valid but will expire within 30 days".yellow)
+      UI.message("#{profiles_valid.count} are valid".green)
+
+      UI.message("You can remove all expired profiles using `fastlane sigh manage -e`") if profiles_expired.count > 0
+    end
+
+    def self.profile_info(profile)
+      if FastlaneCore::Globals.verbose?
+        "#{profile['Name']} - #{File.basename(profile['Path'])}"
+      else
+        profile['Name']
+      end
+    end
+
+    def self.cleanup_profiles(expired = false, pattern = nil, force = nil)
+      now = DateTime.now
+
+      profiles = load_profiles.select { |profile| (expired && profile["ExpirationDate"] < now) || (!pattern.nil? && profile["Name"] =~ pattern) }
+
+      UI.message("The following provisioning profiles are either expired or matches your pattern:")
+      profiles.each do |profile|
+        UI.message(profile["Name"].red)
+      end
+
+      delete = force
+      unless delete
+        if Helper.ci?
+          UI.user_error!("On a CI server, cleanup cannot be used without the --force option")
+        else
+          delete = UI.confirm("Delete these provisioning profiles #{profiles.length}?")
+        end
+      end
+
+      if delete
+        profiles.each do |profile|
+          File.delete(profile["Path"])
+        end
+        UI.success("\n\nDeleted #{profiles.length} profiles")
+      end
+    end
+
+    def self.load_profiles
+      UI.message("Loading Provisioning profiles from ~/Library/MobileDevice/Provisioning Profiles/")
+      profiles_path = File.expand_path("~") + "/Library/MobileDevice/Provisioning Profiles/*.mobileprovision"
+      profile_paths = Dir[profiles_path]
+
+      profiles = []
+      profile_paths.each do |profile_path|
+        profile = Plist.parse_xml(`security cms -D -i '#{profile_path}' 2> /dev/null`) # /dev/null: https://github.com/fastlane/fastlane/issues/6387
+        profile['Path'] = profile_path
+        profiles << profile
+      end
+
+      profiles = profiles.sort_by { |profile| profile["Name"].downcase }
+
+      return profiles
+    end
+  end
+end

data/sigh/lib/sigh/manager.rb

@@ -0,0 +1,47 @@
+require 'fastlane_core/provisioning_profile'
+
+require_relative 'runner'
+
+module Sigh
+  class Manager
+    def self.start
+      path = Sigh::Runner.new.run
+
+      return nil unless path
+
+      if Sigh.config[:filename]
+        file_name = Sigh.config[:filename]
+      else
+        file_name = File.basename(path)
+      end
+
+      FileUtils.mkdir_p(Sigh.config[:output_path])
+      output = File.join(File.expand_path(Sigh.config[:output_path]), file_name)
+      begin
+        FileUtils.mv(path, output)
+      rescue
+        # in case it already exists
+      end
+
+      install_profile(output) unless Sigh.config[:skip_install]
+
+      puts(output.green)
+
+      return File.expand_path(output)
+    end
+
+    def self.download_all(download_xcode_profiles: false)
+      require 'sigh/download_all'
+      DownloadAll.new.download_all(download_xcode_profiles: download_xcode_profiles)
+    end
+
+    def self.install_profile(profile)
+      uuid = FastlaneCore::ProvisioningProfile.uuid(profile)
+      name = FastlaneCore::ProvisioningProfile.name(profile)
+      ENV["SIGH_UDID"] = ENV["SIGH_UUID"] = uuid if uuid
+      ENV["SIGH_NAME"] = name if name
+
+      FastlaneCore::ProvisioningProfile.install(profile)
+    end
+  end
+end

data/sigh/lib/sigh/module.rb

@@ -0,0 +1,16 @@
+require 'fastlane_core/ui/ui'
+require 'fastlane_core/helper'
+
+module Sigh
+  # Use this to just setup the configuration attribute and set it later somewhere else
+  class << self
+    attr_accessor :config
+  end
+
+  Helper = FastlaneCore::Helper # you gotta love Ruby: Helper.* should use the Helper class contained in FastlaneCore
+  UI = FastlaneCore::UI
+  ROOT = Pathname.new(File.expand_path('../../..', __FILE__))
+
+  ENV['FASTLANE_TEAM_ID'] ||= ENV["SIGH_TEAM_ID"]
+  ENV['DELIVER_USER'] ||= ENV["SIGH_USERNAME"]
+end

data/sigh/lib/sigh/options.rb

@@ -0,0 +1,160 @@
+require 'fastlane_core/configuration/configuration'
+require 'credentials_manager/appfile_config'
+require_relative 'module'
+
+module Sigh
+  class Options
+    def self.available_options
+      user = CredentialsManager::AppfileConfig.try_fetch_value(:apple_dev_portal_id)
+      user ||= CredentialsManager::AppfileConfig.try_fetch_value(:apple_id)
+
+      [
+        FastlaneCore::ConfigItem.new(key: :adhoc,
+                                     env_name: "SIGH_AD_HOC",
+                                     description: "Setting this flag will generate AdHoc profiles instead of App Store Profiles",
+                                     is_string: false,
+                                     default_value: false,
+                                     conflicting_options: [:developer_id, :development],
+                                     conflict_block: proc do |option|
+                                       UI.user_error!("You can't enable both :#{option.key} and :adhoc")
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :developer_id,
+                                     env_name: "SIGH_DEVELOPER_ID",
+                                     description: "Setting this flag will generate Developer ID profiles instead of App Store Profiles",
+                                     is_string: false,
+                                     default_value: false,
+                                     conflicting_options: [:adhoc, :development],
+                                     conflict_block: proc do |option|
+                                       UI.user_error!("You can't enable both :#{option.key} and :developer_id")
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :development,
+                                     env_name: "SIGH_DEVELOPMENT",
+                                     description: "Renew the development certificate instead of the production one",
+                                     is_string: false,
+                                     default_value: false,
+                                     conflicting_options: [:adhoc, :developer_id],
+                                     conflict_block: proc do |option|
+                                       UI.user_error!("You can't enable both :#{option.key} and :development")
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :skip_install,
+                                     env_name: "SIGH_SKIP_INSTALL",
+                                     description: "By default, the certificate will be added to your local machine. Setting this flag will skip this action",
+                                     is_string: false,
+                                     default_value: false),
+        FastlaneCore::ConfigItem.new(key: :force,
+                                     env_name: "SIGH_FORCE",
+                                     description: "Renew provisioning profiles regardless of its state - to automatically add all devices for ad hoc profiles",
+                                     is_string: false,
+                                     short_option: "-f",
+                                     default_value: false),
+        FastlaneCore::ConfigItem.new(key: :app_identifier,
+                                     short_option: "-a",
+                                     env_name: "SIGH_APP_IDENTIFIER",
+                                     description: "The bundle identifier of your app",
+                                     code_gen_sensitive: true,
+                                     default_value: CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier),
+                                     default_value_dynamic: true),
+        FastlaneCore::ConfigItem.new(key: :username,
+                                     short_option: "-u",
+                                     env_name: "SIGH_USERNAME",
+                                     description: "Your Apple ID Username",
+                                     default_value: user,
+                                     default_value_dynamic: true),
+        FastlaneCore::ConfigItem.new(key: :team_id,
+                                     short_option: "-b",
+                                     env_name: "SIGH_TEAM_ID",
+                                     description: "The ID of your Developer Portal team if you're in multiple teams",
+                                     optional: true,
+                                     code_gen_sensitive: true,
+                                     default_value: CredentialsManager::AppfileConfig.try_fetch_value(:team_id),
+                                     default_value_dynamic: true,
+                                     verify_block: proc do |value|
+                                       ENV["FASTLANE_TEAM_ID"] = value.to_s
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :team_name,
+                                     short_option: "-l",
+                                     env_name: "SIGH_TEAM_NAME",
+                                     description: "The name of your Developer Portal team if you're in multiple teams",
+                                     optional: true,
+                                     code_gen_sensitive: true,
+                                     default_value: CredentialsManager::AppfileConfig.try_fetch_value(:team_name),
+                                     default_value_dynamic: true,
+                                     verify_block: proc do |value|
+                                       ENV["FASTLANE_TEAM_NAME"] = value.to_s
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :provisioning_name,
+                                     short_option: "-n",
+                                     env_name: "SIGH_PROVISIONING_PROFILE_NAME",
+                                     description: "The name of the profile that is used on the Apple Developer Portal",
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :ignore_profiles_with_different_name,
+                                     env_name: "SIGH_IGNORE_PROFILES_WITH_DIFFERENT_NAME",
+                                     description: "Use in combination with :provisioning_name - when true only profiles matching this exact name will be downloaded",
+                                     optional: true,
+                                     is_string: false,
+                                     default_value: false),
+        FastlaneCore::ConfigItem.new(key: :output_path,
+                                     short_option: "-o",
+                                     env_name: "SIGH_OUTPUT_PATH",
+                                     description: "Directory in which the profile should be stored",
+                                     default_value: "."),
+        FastlaneCore::ConfigItem.new(key: :cert_id,
+                                     short_option: "-i",
+                                     env_name: "SIGH_CERTIFICATE_ID",
+                                     description: "The ID of the code signing certificate to use (e.g. 78ADL6LVAA) ",
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :cert_owner_name,
+                                     short_option: "-c",
+                                     env_name: "SIGH_CERTIFICATE",
+                                     description: "The certificate name to use for new profiles, or to renew with. (e.g. \"Felix Krause\")",
+                                     optional: true),
+        FastlaneCore::ConfigItem.new(key: :filename,
+                                     short_option: "-q",
+                                     env_name: "SIGH_PROFILE_FILE_NAME",
+                                     optional: true,
+                                     description: "Filename to use for the generated provisioning profile (must include .mobileprovision)",
+                                     verify_block: proc do |value|
+                                       UI.user_error!("The output name must end with .mobileprovision") unless value.end_with?(".mobileprovision")
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :skip_fetch_profiles,
+                                     env_name: "SIGH_SKIP_FETCH_PROFILES",
+                                     description: "Skips the verification of existing profiles which is useful if you have thousands of profiles",
+                                     is_string: false,
+                                     default_value: false,
+                                     short_option: "-w"),
+        FastlaneCore::ConfigItem.new(key: :skip_certificate_verification,
+                                     short_option: '-z',
+                                     env_name: "SIGH_SKIP_CERTIFICATE_VERIFICATION",
+                                     description: "Skips the verification of the certificates for every existing profiles. This will make sure the provisioning profile can be used on the local machine",
+                                     is_string: false,
+                                     default_value: false),
+        FastlaneCore::ConfigItem.new(key: :platform,
+                                     short_option: '-p',
+                                     env_name: "SIGH_PLATFORM",
+                                     description: "Set the provisioning profile's platform (i.e. ios, tvos)",
+                                     is_string: false,
+                                     default_value: "ios",
+                                     verify_block: proc do |value|
+                                       value = value.to_s
+                                       pt = %w(macos tvos ios)
+                                       UI.user_error!("Unsupported platform, must be: #{pt}") unless pt.include?(value)
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :readonly,
+                                     env_name: "SIGH_READONLY",
+                                     description: "Only fetch existing profile, don't generate new ones",
+                                     optional: true,
+                                     is_string: false,
+                                     default_value: false,
+                                     conflicting_options: [:force],
+                                     conflict_block: proc do |value|
+                                       UI.user_error!("You can't enable both :force and :readonly")
+                                     end),
+        FastlaneCore::ConfigItem.new(key: :template_name,
+                                     env_name: "SIGH_PROVISIONING_PROFILE_TEMPLATE_NAME",
+                                     description: "The name of provisioning profile template. If the developer account has provisioning profile templates (aka: custom entitlements), the template name can be found by inspecting the Entitlements drop-down while creating/editing a provisioning profile (e.g. \"Apple Pay Pass Suppression Development\")",
+                                     optional: true,
+                                     default_value: nil)
+      ]
+    end
+  end
+end