fastlane-plugin-fastci 0.0.1

data/lib/fastlane/plugin/fastci/actions/package_action.rb

@@ -0,0 +1,262 @@
+require 'gym'
+require 'fastlane_core'
+require 'fastlane/action'
+include Fastlane::Helper
+
+module Fastlane
+  module Actions
+    # 打包
+    class PackageAction < Action
+      def self.run(params)
+
+        # 入参配置
+        configuration = params[:configuration] || "Debug"
+        export_method = params[:export_method] || "development"
+        build = params[:build] || nil
+        is_analyze_swiftlint = params[:is_analyze_swiftlint] || false
+        is_detect_duplicity_code = params[:is_detect_duplicity_code] || false
+        is_detect_unused_code = params[:is_detect_unused_code] || false
+        is_detect_unused_image = params[:is_detect_unused_image] || false
+        if export_method == "app-store"
+          configuration = "Release"
+        end
+
+        # 清理上一次的打包缓存
+        FileUtils.rm_rf(Dir.glob("#{Constants.BUILD_LOG_DIR}/*"))
+        FileUtils.rm_rf(Dir.glob("#{Constants.IPA_OUTPUT_DIR}/*"))
+        
+        # 安装证书
+        InstallCertificateAction.run({})
+        # 安装 provisioningProfile
+        InstallProfileAction.run({})
+
+        scheme = Environment.scheme
+        # 更改项目build号
+        UpdateBuildNumberAction.run(
+          build: build
+        )
+        time = Time.new.strftime("%Y%m%d%H%M")
+        version = Actions::GetVersionNumberAction.run(target: "#{Environment.target}")
+        build = Actions::GetBuildNumberAction.run({})
+        # 生成ipa包的名字格式
+        ipaName = "#{Environment.scheme}_#{export_method}_#{version}_#{build}.ipa"
+        
+        # 获取 Extension 的 Bundle ID（可能有多个，用逗号分隔）
+        extension_bundle_ids = Environment.extension_bundle_ids
+        extension_profile_names = []
+        # profile 名字
+        profile_name = ""
+
+        case export_method
+        when "development"
+          profile_name = Environment.provisioningProfiles_development
+          extension_profile_names = Environment.extension_profiles_development
+        when "ad-hoc"
+          profile_name = Environment.provisioningProfiles_adhoc
+          extension_profile_names = Environment.extension_profiles_adhoc
+        when "app-store"
+          profile_name = Environment.provisioningProfiles_appstore
+          extension_profile_names = Environment.extension_profiles_appstore
+        else
+          raise "Unsupported export method: #{export_method}"
+        end
+
+        # 组装 provisioningProfiles 
+        provisioningProfiles_map = {
+          "#{Environment.bundleID}" => "#{profile_name}"
+        }
+        extension_bundle_ids.each_with_index do |ext_bundle_id, idx|
+          provisioningProfiles_map[ext_bundle_id.strip] = extension_profile_names[idx]&.strip
+        end
+
+        UI.message("*************| 开始打包 |*************")
+
+        options = {
+          clean: true,
+          silent: true,
+          workspace: Environment.workspace,
+          scheme: scheme,
+          configuration: configuration,
+          buildlog_path: Constants.BUILD_LOG_DIR,
+          output_name: ipaName,
+          output_directory: Constants.IPA_OUTPUT_DIR,
+          export_options: {
+            method: export_method,
+            provisioningProfiles: provisioningProfiles_map
+          }
+        }
+        config = FastlaneCore::Configuration.create(Gym::Options.available_options, options)
+        Gym::Manager.new.work(config)
+
+        UI.message("*************| 打包完成 |*************")
+
+        UI.message("*************| 复制打包产物 |*************")
+        # 定义桌面路径
+        desktop_path = File.expand_path("~/Desktop")
+        output_path = File.join(desktop_path, "BuildOutput_#{scheme}")
+        target_path = File.join(output_path, "#{build}")
+        FileUtils.mkdir_p(target_path)
+        # 构建复制到桌面
+        Dir.glob("#{Constants.IPA_OUTPUT_DIR}/*").each do |file|
+          UI.message("准备复制文件：#{file} 到 #{target_path}")
+          FileUtils.cp_r(file, target_path)
+        end
+
+        # UI.message("*************| 重置 Git 仓库 |*************")
+        # 重置 Git 仓库
+        # system("git reset --hard")
+
+        ipa_path = "#{Constants.IPA_OUTPUT_DIR}/#{ipaName}"
+
+        if export_method == "app-store"
+          notiText = "🚀🚀🚀🚀🚀🚀\n\n#{scheme}-iOS-打包完成\n\n#{version}_#{build}_#{export_method}\n\n🚀🚀🚀🚀🚀🚀"
+          NotiDingdingAction.run(notiText: notiText)
+
+          if CommonHelper.is_validate_string(Environment.connect_key_id) && CommonHelper.is_validate_string(Environment.connect_issuer_id)
+
+            UploadStoreAction.run({})
+            notiText = "🚀🚀🚀🚀🚀🚀\n\n#{scheme}-iOS-上传完成\n\n#{version}_#{build}_#{export_method}\n\n🚀🚀🚀🚀🚀🚀"
+            NotiDingdingAction.run(notiText: notiText)
+          end
+        else
+          # 上传蒲公英
+          pgy_upload_info = UploadPgyAction.run(
+            "ipa_path": ipa_path
+          )
+          qrCode = pgy_upload_info["buildQRCodeURL"]
+
+          # 钉钉通知
+          notiText = "🚀🚀🚀🚀🚀🚀\n\n#{scheme}-iOS-打包完成\n\n#{version}_#{build}_#{export_method}\n\n🚀🚀🚀🚀🚀🚀"
+          if CommonHelper.is_validate_string(qrCode)
+            notiText << "\n\n⬇️⬇️⬇️ 扫码安装 ⬇️⬇️⬇️\n\n![screenshot](#{qrCode})"
+          end
+          NotiDingdingAction.run(notiText: notiText)
+        end
+
+        # 代码分析
+        if is_analyze_swiftlint && export_method != "app-store"
+          analyze_swiftlint(is_from_package: true, configuration: configuration)
+          # 结果复制到桌面
+          FileUtils.cp(SWIFTLINT_HTML_FILE, target_path)
+          FileUtils.cp(SWIFTLINT_ANALYZE_HTML_FILE, target_path)
+          UI.message("*************| 代码分析完成 |*************")
+        else
+          UI.message("*************| 跳过代码分析 |*************")
+        end
+
+        # 重复代码检查
+        if is_detect_duplicity_code && export_method != "app-store"
+          detect_code_duplicity(is_all: true)
+          # 结果复制到桌面
+          FileUtils.cp(DUPLICITY_CODE_HTML_FILE, target_path)
+          UI.message("*************| 重复代码检查完成 |*************")
+        else
+          UI.message("*************| 跳过重复代码检查 |*************")
+        end
+
+        # 无用代码检查
+        if is_detect_unused_code && export_method != "app-store"
+          DetectUnusedCodeAction.run(
+            is_from_package: true,
+            configuration: configuration
+          )
+          # 结果复制到桌面
+          FileUtils.cp(Constants.UNUSED_CODE_HTML_FILE, target_path)
+          UI.message("*************| 无用代码检查完成 |*************")
+        else
+          UI.message("*************| 跳过无用代码检查 |*************")
+        end
+
+        # 无用图片检查
+        if is_detect_unused_image && export_method != "app-store"
+          DetectUnusedImageAction.run({})
+          # 结果复制到桌面
+          FileUtils.cp(Constants.UNUSED_IMAGE_HTML_FILE, target_path)
+          UI.message("*************| 无用图片检查完成 |*************")
+        else
+          UI.message("*************| 跳过未使用图片检查 |*************")
+        end
+
+        if is_swiftlint ||
+          is_detect_duplicity_code ||
+          is_detect_unused_code ||
+          is_detect_unused_image
+          # 钉钉通知
+          notiText = "🚀🚀🚀🚀🚀🚀\n\n#{scheme}-iOS-代码检查完成\n\n#{version}_#{build}_#{export_method}\n\n🚀🚀🚀🚀🚀🚀"
+          NotiDingdingAction.run(notiText: notiText)
+        else
+          UI.message("*************| 跳过代码检查 |*************")
+        end
+
+        UI.message("*************| 脚本完成 |*************")
+      end
+
+      def self.description
+        "打包"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :configuration,
+            description: "编译环境 Release or Debug",
+            optional: true,
+            default_value: "Release",
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :export_method,
+            description: "打包方式 ad-hoc, enterprise, app-store, development",
+            optional: true,
+            default_value: "development",
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :build,
+            description: "不采取自动更新，自定义 build 号",
+            optional: true,
+            default_value: nil,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :is_analyze_code,
+            description: "是否代码分析",
+            optional: true,
+            default_value: false,
+            type: Boolean
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :is_detect_code_duplicity,
+            description: "是否检查重复代码",
+            optional: true,
+            default_value: false,
+            type: Boolean
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :is_detect_unused_code,
+            description: "是否检查无用代码",
+            optional: true,
+            default_value: false,
+            type: Boolean
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :is_detect_unused_image,
+            description: "是否检查无用图片",
+            optional: true,
+            default_value: false,
+            type: Boolean
+          ),
+        ]
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+
+      def self.category
+        :building
+      end
+
+    end
+  end
+end

data/lib/fastlane/plugin/fastci/actions/update_build_number_action.rb

@@ -0,0 +1,65 @@
+require 'fastlane/action'
+include Fastlane::Helper
+
+module Fastlane
+  module Actions
+    # 更新 build 号
+    class UpdateBuildNumberAction < Action
+      def self.run(params)
+
+        build = params[:build] || nil
+        unless CommonHelper.is_validate_string(build)
+          currentTime = Time.new.strftime("%Y%m%d")
+          build = CommonHelper.get_cached_build_number
+
+          if build.include?("#{currentTime}.")
+            # 当天版本 计算迭代版本号
+            lastStr = build.split('.').last
+            lastNum = lastStr.to_i
+            lastNum += 1
+            lastStr = lastNum.to_s.rjust(2, '0')
+            build = "#{currentTime}.#{lastStr}"
+          else
+            # 非当天版本 build 重置
+            build = "#{currentTime}.01"
+          end
+
+          # 缓存新的 build 号
+          CommonHelper.write_cached_txt(Constants.BUILD_NUMBER_FILE, build)
+        end
+
+        UI.message("*************| 更新 build #{build} |*************")
+        # 更改项目 build 号
+        Actions::IncrementBuildNumberAction.run(
+          build_number: build
+        )
+        
+      end
+
+      def self.description
+        "更新 build 号"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :build,
+            description: "不采取自动更新，自定义 build 号",
+            optional: true,
+            default_value: nil,
+            type: String
+          ),
+        ]
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+
+      def self.category
+        :building
+      end
+
+    end
+  end
+end

data/lib/fastlane/plugin/fastci/actions/upload_pgy_action.rb

@@ -0,0 +1,47 @@
+require 'fastlane/action'
+require 'fastlane/plugin/pgyer'
+include Fastlane::Helper
+
+module Fastlane
+  module Actions
+    # 上传蒲公英
+    class UploadPgyAction < Action
+      def self.run(params)
+        UI.message("*************| 开始上传蒲公英 |*************")
+
+        unless CommonHelper.is_validate_string(Environment.pgy_api_key)
+          UI.message("*************| 没有配置 pgy_api_key |*************")
+          return
+        end
+
+        ipa_path = params[:ipa_path] || ""
+
+        pgyinfo = PgyerAction.run(
+          ipa: ipa_path,
+          api_key: Environment.pgy_api_key,
+          password: Environment.pgy_password,
+          install_type: "2"
+        )
+
+        return pgyinfo
+      end
+
+      def self.description
+        "上传蒲公英"
+      end
+
+      def self.available_options
+        []
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+
+      def self.category
+        :building
+      end
+
+    end
+  end
+end

data/lib/fastlane/plugin/fastci/actions/upload_store_action.rb

@@ -0,0 +1,50 @@
+require 'fastlane/action'
+include Fastlane::Helper
+
+module Fastlane
+  module Actions
+    # 上传 AppStore
+    class UploadStoreAction < Action
+      def self.run(params)
+        UI.message("*************| 开始上传 AppStore |*************")
+
+        other_action.app_store_connect_api_key(
+          key_id: Environment.connect_key_id,
+          issuer_id: Environment.connect_issuer_id,
+          key_filepath: File.expand_path("./AuthKey_#{Environment.connect_key_id}.p8"),
+          duration: 1200, # optional (maximum 1200)
+          in_house: false # optional but may be required if using match/sigh
+        )
+        other_action.upload_to_app_store(
+          skip_metadata: false,
+          skip_screenshots: true,
+          force: true,
+          submit_for_review: false,
+          automatic_release: false,
+          release_notes: params[:release_notes]
+        )
+        
+      end
+
+      def self.description
+        "上传 AppStore"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :release_notes,
+            description: "更新文案, 格式为 { "zh-Hans" => "修复问题", "en-US" => "bugfix"} ",
+            optional: false,
+            type: Hash
+          )
+        ]
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+
+    end
+  end
+end

data/lib/fastlane/plugin/fastci/helper/common_helper.rb

@@ -0,0 +1,108 @@
+require 'fastlane_core/ui/ui'
+require 'fileutils'
+
+module Fastlane
+  module Helper
+    class CommonHelper
+
+      def self.read_cached_txt(file_name)
+        if File.exist?(file_name)
+          File.read(file_name).strip
+        else
+          nil
+        end
+      end
+
+      def self.write_cached_txt(file_name, content)
+        dir_name = File.dirname(file_name)
+        FileUtils.mkdir_p(dir_name) unless Dir.exist?(dir_name)
+
+        File.open(file_name, "w") { |file| file.write(content) }
+      end
+
+      def self.get_cached_build_number
+        cached_build = read_cached_txt(Constants.BUILD_NUMBER_FILE)
+        currentTime = Time.new.strftime("%Y%m%d")
+        
+        if cached_build.nil? || cached_build.empty?
+          # 初始化 build
+          return "#{currentTime}.00"
+        else
+          return cached_build
+        end
+      end
+
+      # 判断字段是否有值
+      def self.is_validate_string(variable)
+        if variable.nil? || variable.empty?
+          return false
+        end
+        return true
+      end
+
+      # 获取当前 commit_hash 到最新 commit 下所有变更的 swift 文件
+      def self.get_git_modified_swift_files(commit_hash)
+        modified_files = sh("git diff --name-only --diff-filter=d #{commit_hash}..origin/develop").split("\n")
+        swift_files = modified_files.select { |file| file.end_with?('.swift') }
+        return swift_files
+      end
+
+      # 缓存最新 git
+      def self.cache_git_commit 
+        latest_commit = sh("git rev-parse HEAD").strip
+        write_cached_txt(COMMIT_HASH_FILE, latest_commit)
+      end
+
+      # 从构建日志中提取 index store 路径的辅助方法
+      def self.extract_index_store_path(log_file)
+        begin
+          log_content = File.read(log_file)
+
+          # 在日志中查找 DerivedData 路径
+          derived_data_match = log_content.match(/DerivedData\/([^\/]+)-([^\/]+)/)
+          if derived_data_match
+            project_name = derived_data_match[1]
+            hash_suffix = derived_data_match[2]
+            
+            # 构建可能的 index store 路径
+            derived_data_base = File.expand_path("~/Library/Developer/Xcode/DerivedData")
+            project_dir = "#{derived_data_base}/#{project_name}-#{hash_suffix}"
+            
+            # Xcode 14+ 使用 Index.noindex
+            index_paths = [
+              "#{project_dir}/Index.noindex/DataStore",
+              "#{project_dir}/Index/DataStore"
+            ]
+            
+            # 返回第一个存在的路径
+            index_paths.each do |path|
+              if File.exist?(path)
+                puts "*************| 找到 index store: #{path} |*************"
+                return path
+              end
+            end
+          end
+          
+          puts "*************| 在构建日志中未找到有效的 index store 路径 |*************"
+          return nil
+        rescue => e
+          puts "*************| 解析构建日志失败: #{e.message} |*************"
+          return nil
+        end
+      end
+
+      # 生成并打开 html
+      def self.generate_and_open_html(title, python_file, origin_file, html_file)
+        python_path = File.expand_path("../../python/#{python_file}", __dir__)
+        origin_file_path = File.expand_path(origin_file)
+        html_file_path = File.expand_path(html_file)
+
+        system("python3 \"#{python_path}\" \"#{title}\" \"#{origin_file_path}\" \"#{html_file_path}\"")
+        system("open \"#{html_file_path}\"")
+
+        File.delete(origin_file_path)
+      end
+
+    end
+  end
+end

data/lib/fastlane/plugin/fastci/helper/constants.rb

@@ -0,0 +1,48 @@
+module Fastlane
+  module Helper
+    module Constants
+      # cache 文件
+      def self.BUILD_NUMBER_FILE
+        "fastlane_cache/build_cache.txt"
+      end
+      def self.COMMIT_HASH_FILE
+        "fastlane_cache/commit_cache.txt"
+      end
+      def self.SWIFTLINT_ANALYZE_FILE
+        "fastlane_cache/temp/swiftlint_analyze_result.txt"
+      end
+      def self.SWIFTLINT_ANALYZE_HTML_FILE
+        "fastlane_cache/html/analyze_lint_report.html"
+      end
+      def self.DUPLICITY_CODE_MODIFIED_FILE
+        "fastlane_cache/temp/duplicity_code_modified_files.txt"
+      end
+      def self.DUPLICITY_CODE_FILE
+        "fastlane_cache/temp/duplicity_code_result.xml"
+      end
+      def self.DUPLICITY_CODE_HTML_FILE
+        "fastlane_cache/html/duplicity_code_report.html"
+      end
+      def self.UNUSED_CODE_FILE
+        "fastlane_cache/temp/unused_code_result.txt"
+      end
+      def self.UNUSED_CODE_HTML_FILE
+        "fastlane_cache/html/unused_code_report.html"
+      end
+      def self.UNUSED_IMAGE_FILE
+        "fastlane_cache/temp/unused_image_result.txt"
+      end
+      def self.UNUSED_IMAGE_HTML_FILE
+        "fastlane_cache/html/unused_image_report.html"
+      end
+
+      # bulid 产物
+      def self.BUILD_LOG_DIR
+        "fastlane_cache/build_logs"
+      end
+      def self.IPA_OUTPUT_DIR
+        "fastlane_cache/build_products"
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/fastci/helper/environment.rb

@@ -0,0 +1,86 @@
+module Fastlane
+  module Helper
+    module Environment
+      # 苹果密钥配置
+      def self.connect_key_id
+        ENV['CONNECT_KEY_ID']
+      end
+      def self.connect_issuer_id
+        ENV['CONNECT_ISSUER_ID']
+      end
+
+      # 项目配置
+      def self.scheme
+        ENV['SCHEME_NAME']
+      end
+      def self.target
+        ENV['TARGET_NAME']
+      end
+      def self.workspace
+        ENV['WORKSPACE']
+      end
+      def self.bundleID
+        ENV['BUNDLE_ID']
+      end
+      def self.extension_bundle_ids
+        ENV['EXTENSION_BUNDLE_IDS']&.split(",") || []
+      end
+      def self.schemes
+        ENV['SCHEMES_NAME']&.split(",") || []
+      end
+
+      # 描述文件配置
+      def self.provisioningProfile_folder_name
+        ENV['PROFILE_FOLDER_NAME']
+      end
+      def self.provisioningProfiles_development
+        ENV['PROFILE_DEVELOPMENT']
+      end
+      def self.provisioningProfiles_adhoc
+        ENV['PROFILE_ADHOC']
+      end
+      def self.provisioningProfiles_appstore
+        ENV['PROFILE_APPSTORE']
+      end
+      def self.extension_profiles_development
+        ENV['EXTENSION_PROFILES_DEVELOPMENT']&.split(",") || []
+      end
+      def self.extension_profiles_adhoc
+        ENV['EXTENSION_PROFILES_ADHOC']&.split(",") || []
+      end
+      def self.extension_profiles_appstore
+        ENV['EXTENSION_PROFILES_APPSTORE']&.split(",") || []
+      end
+
+      # p12 证书配置
+      def self.certificate_folder_name
+        ENV['PROFILE_FOLDER_NAME']
+      end
+      def self.certificate_development
+        ENV['CERTIFICATE_DEVELOPMENT']
+      end
+      def self.certificate_distribution
+        ENV['CERTIFICATE_DISTRIBUTION']
+      end
+      def self.certificate_password
+        ENV['CERTIFICATE_PASSWORD']
+      end
+      def self.keychain_password
+        ENV['KEYCHAIN_PASSWORD']
+      end
+
+      # 蒲公英配置
+      def self.pgy_api_key
+        ENV['PGY_API_KEY']
+      end
+      def self.pgy_password
+        ENV['PGY_PASSWORD']
+      end
+
+      # 钉钉配置
+      def self.dingdingToken
+        ENV['DINGDING_TOKEN']
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/fastci/version.rb

@@ -0,0 +1,5 @@
+module Fastlane
+  module Fastci
+    VERSION = "0.0.1"
+  end
+end

data/lib/fastlane/plugin/fastci.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/fastci/version'
+
+module Fastlane
+  module Fastci
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::Fastci.all_classes.each do |current|
+  require current
+end