fastlane-plugin-debug_file 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95fe7394552b5dd55525ec8b8877bea26c813796dcaf766d6fc758541ba3187d
-  data.tar.gz: 821dcabcffa00f87ddbee2bc188c1f617d2783cd7c3c818de64b149a2544a781
+  metadata.gz: '079226ebaba880735af3cabaed19276177316c093b6db6d81ddaa9c89279bd81'
+  data.tar.gz: 2c8c6d1e32ca4d7cb468bd8b16339d8e91d5f2074c15efad70c1ac8475b18e10
 SHA512:
-  metadata.gz: 358f041fa3750ce46f4f2272a6568f27c02c20ee909d8f5995235a6ecf9ea6f52ac256bfea58d3a70e088d53189b5a0e71c63c682f0a024ad724d13093fcff35
-  data.tar.gz: '0280f0d169433438a4a57651a982fb3151b3175a0dc6c63a91a52f230bd10bde20259c2b42c0c3437349b3610ee0f918d87b7ac99f47041dc405eca959c5427c'
+  metadata.gz: 5375e5d39b154be40cc1e58712bed9d0dce3417f85c3ef0a6abfc0690979e8e342cd484101bc407307120f0955b5ebea87f0d01728a41d339fd6b0e064b64171
+  data.tar.gz: a5e53a19cdf77e09f4f4328a3f18c5e2f8ac8a2bc0618190c012b3b0273c914a584cfc4f9ce3b50a3d2a70df5f12796ff40ae25dfbd9c2b3b1ffe2cea981f126

data/lib/fastlane/plugin/debug_file/actions/dsym_action.rb

@@ -10,7 +10,7 @@ module Fastlane
     end
 
     class DsymAction < Action
-      ARCHIVE_PATH = File.expand_path('~/Library/Developer/Xcode/Archives')
+      ARCHIVE_PATH = ::DebugFile::Runner::ARCHIVE_PATH
       OUTPUT_PATH = '.'
 
       def self.run(params)
@@ -30,7 +30,11 @@ module Fastlane
           UI.user_error! "Not matched any archive with scheme: #{scheme}"
         end
 
-        UI.success "Selected dSYM archive path: #{File.basename(File.dirname(archive_dsym_path))}"
+        xcarchive_file = File.basename(File.dirname(archive_dsym_path))
+        xcarchive_info_file = File.join(File.expand_path('../', archive_dsym_path), 'Info.plist')
+        xcarchive_info = Helper::DebugFileHelper.xcarchive_metadata(xcarchive_info_file)
+        release_version, build_version, created_at = version_info(xcarchive_info)
+        UI.success "Selected dSYM archive: #{release_version} (#{build_version}) [#{xcarchive_file}] #{created_at}"
 
         extra_dsym = params[:extra_dsym] || []
         dsym_files = [app_dsym_filename].concat(extra_dsym).uniq
@@ -45,39 +49,43 @@ module Fastlane
         UI.success "Prepare #{dsym_files.size} dSYM file(s) compressing"
         Helper::DebugFileHelper.compress(dsym_files, output_file)
 
-        UI.success "Compressed proguard files: #{output_file}"
+        UI.success "Compressed dSYM file: #{output_file}"
         Helper::DebugFileHelper.store_shard_value SharedValues::DF_DSYM_ZIP_PATH, output_file
       end
 
       def self.last_created_dsym(scheme, archive_path)
         info_path = File.join(archive_path, '**', '*.xcarchive', 'Info.plist')
         matched_paths = []
+
+        UI.verbose "Finding #{scheme} xcarchive in #{archive_path} ..."
         Dir.glob(info_path) do |path|
-          name = get_plist_value(path, 'Name')
+          info = Helper::DebugFileHelper.xcarchive_metadata(path)
+          name = Helper::DebugFileHelper.fetch_key(info, 'Name')
           if scheme == name
+            xcarchive = File.basename(File.dirname(path))
+            release_version, build_version, created_at = version_info(info)
+            UI.verbose " => #{release_version} (#{build_version}) [#{xcarchive}] was created at #{created_at}"
+
             matched_paths << path
           end
         end
 
         return if matched_paths.empty?
 
-        UI.verbose "Found #{matched_paths.size} matched dSYM archive(s)"
+        UI.verbose "Found #{matched_paths.size} matched dSYM archive(s) of #{scheme}"
         last_created_path = matched_paths.size == 1 ? matched_paths.first : matched_paths.max_by { |p| File.stat(p).mtime }
         File.join(File.dirname(last_created_path), 'dSYMs')
       end
       private_class_method :last_created_dsym
 
-      def self.get_plist_value(file, key)
-        plist = read_plist(file)
-        plist[key.to_s]
-      end
-      private_class_method :get_plist_value
+      def self.version_info(info)
+        release_version = Helper::DebugFileHelper.fetch_key(info, 'ApplicationProperties', 'CFBundleShortVersionString')
+        build = Helper::DebugFileHelper.fetch_key(info, 'ApplicationProperties', 'CFBundleVersion')
+        created_at = Helper::DebugFileHelper.fetch_key(info, 'CreationDate')
 
-      def self.read_plist(file)
-        require 'plist'
-        Plist.parse_xml(file)
+        [release_version, build, created_at]
       end
-      private_class_method :read_plist
+      private_class_method :version_info
 
       #####################################################
       # @!group Documentation
@@ -93,7 +101,7 @@ module Fastlane
                                        env_name: 'DF_DSYM_ARCHIVE_PATH',
                                        description: 'The archive path of xcode',
                                        type: String,
-                                       default_value: Actions.lane_context[SharedValues::XCODEBUILD_ARCHIVE] || ARCHIVE_PATH,
+                                       default_value: Actions.lane_context[SharedValues::XCODEBUILD_ARCHIVE] || ::DebugFile::Runner::ARCHIVE_PATH,
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :scheme,
                                        env_name: 'DF_DSYM_SCHEME',
@@ -105,6 +113,16 @@ module Fastlane
                                        optional: true,
                                        default_value: [],
                                        type: Array),
+          FastlaneCore::ConfigItem.new(key: :release_version,
+                                       env_name: 'DF_DSYM_RELEASE_VERSION',
+                                       description: 'Use the given release version of app',
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :build,
+                                       env_name: 'DF_DSYM_BUILD',
+                                       description: 'Use the given build version of app',
+                                       optional: true,
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :output_path,
                                        env_name: 'DF_DSYM_OUTPUT_PATH',
                                        description: "The output path of compressed dSYM file",

data/lib/fastlane/plugin/debug_file/actions/list_dsym_action.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require 'fastlane/action'
+require_relative '../helper/debug_file_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      DF_DSYMS_LIST = :DF_DSYMS_LIST
+    end
+
+    class ListDsymAction < Action
+      def self.run(params)
+        archive_path = params[:archive_path]
+        scheme = params[:scheme]
+        Fastlane::UI.verbose "Finding #{scheme || 'all' } xcarchive in #{archive_path} ..."
+
+        runner = ::DebugFile::Runner.new({
+          archive_path: archive_path,
+          scheme: scheme
+        })
+
+        dsyms = runner.list_dsym
+
+        Fastlane::UI.success "Found #{dsyms.size} dSYM files"
+        dsyms.each do |dsym|
+          Fastlane::UI.success "• #{dsym[:name]} #{dsym[:release_version]} (#{dsym[:build]}) - #{dsym[:created_at]}"
+          dsym[:machos].each do |macho|
+            Fastlane::UI.message "  #{macho[:uuid]} (#{macho[:arch]})"
+          end
+        end
+
+        Helper::DebugFileHelper.store_shard_value SharedValues::DF_DSYMS_LIST, dsyms
+
+        dsyms
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Find and generate iOS/MacOS dSYM file(s) to zip file'
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :archive_path,
+                                       env_name: 'DF_DSYM_ARCHIVE_PATH',
+                                       description: 'The archive path of xcode',
+                                       type: String,
+                                       default_value: Actions.lane_context[SharedValues::XCODEBUILD_ARCHIVE] || ::DebugFile::Runner::ARCHIVE_PATH,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :scheme,
+                                       env_name: 'DF_DSYM_SCHEME',
+                                       description: 'The scheme name of app',
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :release_version,
+                                       env_name: 'DF_DSYM_RELEASE_VERSION',
+                                       description: 'Use the given release version of app',
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :build,
+                                       env_name: 'DF_DSYM_BUILD',
+                                       description: 'Use the given build version of app',
+                                       optional: true,
+                                       type: String)
+        ]
+      end
+
+      def self.example_code
+        [
+          'list_dsym',
+          'list_dsym(
+            archive_path: "~/Library/Developer/Xcode/Archives",
+            scheme: "AppName"
+          )'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+
+      def self.return_value
+        Array
+      end
+
+      def self.output
+        [
+          ['DF_DSYMS_LIST', 'the array of dSYMs metadata']
+        ]
+      end
+
+      def self.authors
+        ['icyleaf']
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/debug_file/helper/debug_file_helper.rb

@@ -35,9 +35,52 @@ module Fastlane
         end
       end
 
+      def self.macho_metadata(file)
+        require 'macho'
+
+        macho_type = MachO.open(file)
+        case macho_type
+        when ::MachO::MachOFile
+          [macho_type]
+        else
+          size = macho_type.fat_archs.each_with_object([]) do |arch, obj|
+            obj << arch.size
+          end
+
+          machos = []
+          macho_type.machos.each do |file|
+            machos << file
+          end
+          machos
+        end
+      end
+
       def self.store_shard_value(key, value)
         Actions.lane_context[key] = value
-        ENV[key.to_s] = value
+        ENV[key.to_s] = case value
+                        when String
+                          value
+                        else
+                          JSON.dump(value)
+                        end
+      end
+
+      def self.xcarchive_metadata(path)
+        file = File.directory?(path) ? File.join(path, 'Info.plist') : path
+        UI.user_error! "Can not read Info.plist in #{file}" unless File.file?(file)
+
+        require 'plist'
+        Plist.parse_xml(file)
+      end
+
+      def self.fetch_key(plist, *keys)
+        UI.crash! 'Missing keys' if keys.empty?
+
+        if keys.size == 1
+          plist[keys[0]]
+        else
+          plist.dig(*keys)
+        end
       end
     end
   end

data/lib/fastlane/plugin/debug_file/runner.rb

@@ -0,0 +1,70 @@
+module DebugFile
+  class Runner
+    ARCHIVE_PATH = File.expand_path('~/Library/Developer/Xcode/Archives')
+
+    attr_accessor :options
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    def latest_dsym(filter: :date)
+      dsyms = list_dsym
+      case filter
+      when :version
+        dsyms.max_by {|v| Gem::Version.new(v[:release_version])}
+      else
+        dsyms.max_by {|v| v[:created_at]}
+      end
+    end
+
+    def list_dsym
+      archive_path = File.expand_path(options.fetch(:archive_path, ARCHIVE_PATH))
+      search_dsym(archive_path, options[:scheme])
+    end
+
+    private
+
+    def search_dsym(path, scheme = nil)
+      info_path = File.join(path, '**', '*.xcarchive', 'Info.plist')
+      matched_paths = []
+
+      obj = []
+      Dir.glob(info_path) do |path|
+        info = Fastlane::Helper::DebugFileHelper.xcarchive_metadata(path)
+        name = Fastlane::Helper::DebugFileHelper.fetch_key(info, 'Name')
+        next unless scheme.to_s.empty? || scheme == name
+
+        release_version = Fastlane::Helper::DebugFileHelper.fetch_key(info, 'ApplicationProperties', 'CFBundleShortVersionString')
+        build = Fastlane::Helper::DebugFileHelper.fetch_key(info, 'ApplicationProperties', 'CFBundleVersion')
+        dsym_path = Dir.glob(File.join(File.dirname(path), 'dSYMs', "#{name}.app.dSYM", '**', '*', name)).first
+        created_at = Fastlane::Helper::DebugFileHelper.fetch_key(info, 'CreationDate')
+
+        machos = []
+        Fastlane::Helper::DebugFileHelper.macho_metadata(dsym_path).each do |macho|
+          machos << {
+            arch: macho.cpusubtype,
+            uuid: macho[:LC_UUID][0].uuid_string
+          }
+        end
+
+        item = {
+          root_path: File.basename(File.dirname(path)),
+          dsym_path: dsym_path,
+          machos: machos,
+          info: info,
+          name: name,
+          release_version: release_version,
+          build: build,
+          created_at: created_at,
+        }
+
+        yield item if block_given?
+
+        obj << item
+      end
+
+      obj
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module DebugFile
-    VERSION = "0.1.1"
+    VERSION = "0.2.1"
   end
 end

data/lib/fastlane/plugin/debug_file.rb

@@ -1,4 +1,5 @@
 require 'fastlane/plugin/debug_file/version'
+require 'fastlane/plugin/debug_file/runner'
 
 module Fastlane
   module DebugFile

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-debug_file
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - icyleaf
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-17 00:00:00.000000000 Z
+date: 2020-12-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-macho
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -136,7 +150,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.139.0
-description: 
+description:
 email: icyleaf.cn@gmail.com
 executables: []
 extensions: []
@@ -146,14 +160,16 @@ files:
 - README.md
 - lib/fastlane/plugin/debug_file.rb
 - lib/fastlane/plugin/debug_file/actions/dsym_action.rb
+- lib/fastlane/plugin/debug_file/actions/list_dsym_action.rb
 - lib/fastlane/plugin/debug_file/actions/proguard_action.rb
 - lib/fastlane/plugin/debug_file/helper/debug_file_helper.rb
+- lib/fastlane/plugin/debug_file/runner.rb
 - lib/fastlane/plugin/debug_file/version.rb
 homepage: https://github.com/icyleaf/fastlane-plugin-debug_file
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -168,8 +184,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Compress iOS/macApp dSYM or Android Proguard(mapping/R/AndroidManifest) to
   zip file