tracetool 0.4.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 28053aff3e16e9baee1198e08bdbeffdefeef2f0
-  data.tar.gz: 894ac01ee7333ee6b02dc5fb422114f6269a0a72
+SHA256:
+  metadata.gz: 7b0baff5d5f633d2474acf70b639fad429dd09b5b4cc4f80333ef55f72c1e5d8
+  data.tar.gz: 2851ab0c1b575429400937ad889b0a06fdce6f9ebaf550b05956b7879166d6f6
 SHA512:
-  metadata.gz: 3fa1e1578d5c6802e508cea8b7c1af90ff2ef4f83f3574b7cf0b218afbcc48c47783706bec06273a1a6887470ebddd0ccbd15fb0448d921296033ce174b064d1
-  data.tar.gz: 338ed267bce0c0d91ecdb47cdfe6d1f8eeed36179717bc16a6c5362c84fb15d5f3099906e35ad0eaa90af7368c7e8fd2bd1c5bcb1d66b69bcb00265c4330874d
+  metadata.gz: ba21b749c8875fec7e26c70da2899dfb89ea5c0fcfed2a7fc1233b34ee222d5de43cf630fc13998cf3e95335eee152e75e7fdfea8e998867ccfbd3c581eb3a1b
+  data.tar.gz: 7f0236c1c234fa42c8fc68874cbc63e0271c773078c64cf50a5bea4e1d6951757affb02064360590c5668e559633e85b6a237d6dff7d901edfe23fbf7a522888

data/lib/tracetool/android.rb

@@ -16,6 +16,7 @@ module Tracetool
         # Find scanner which matches trace format
         @scanner = SCANNERS.map { |s| s[trace] }.compact.first
         raise(ArgumentError, "#{trace}\n not android trace?") unless @scanner
+
         @scanner.process(context)
       end
 
@@ -25,6 +26,7 @@ module Tracetool
       #   Or `nil`. If there was no scanning.
       def parser(files)
         return unless @scanner
+
         @scanner.parser(files)
       end
     end

data/lib/tracetool/android/java.rb

@@ -5,9 +5,9 @@ module Tracetool
     # Parses java stack traces
     class JavaTraceParser < Tracetool::BaseTraceParser
       # Describes java stack entry
-      STACK_ENTRY_PATTERN = /^(\s+at (?<call_description>.+))|((?<error>.+?): (?<message>.+))$/
+      STACK_ENTRY_PATTERN = /^(\s+at (?<call_description>.+))|((?<error>.+?): (?<message>.+))$/.freeze
       # Describes java method call
-      CALL_PATTERN = /(?<class>.+)\.(?<method>[^\(]+)\((((?<file>.+\.java):(?<line>\d+))|(?<location>.+))\)$/
+      CALL_PATTERN = /(?<class>.+)\.(?<method>[^\(]+)\((((?<file>.+\.java):(?<line>\d+))|(?<location>.+))\)$/.freeze
 
       def initialize(files)
         super(STACK_ENTRY_PATTERN, CALL_PATTERN, files, true)
@@ -15,8 +15,14 @@ module Tracetool
     end
     # Processes java traces
     class JavaTraceScanner
-      RX_FIRST_EXCEPTION_LINE = /^.+$/
-      RX_OTHER_EXCEPTION_LINE = /at [^(]+\(([^:]+:\d+)|(Native Method)\)$/
+      # Usually java trace starts with
+      #   com.something.SomeClass(: Some message)?
+      RX_FIRST_EXCEPTION_LINE = /^([a-zA-Z.]*)(:.*)?$/.freeze
+
+      # Rest is expanded as
+      #   at com.other.OtherClass.someMethod(OtherClass.java:42)
+      # Source marker can be just "Native Method" or "Unknown Source"
+      RX_OTHER_EXCEPTION_LINE = /((at [a-zA-Z$.]+)|(Caused by:)|(\.\.\. [0-9]* more))(.+)?$/.freeze
 
       def initialize(string)
         @trace = string
@@ -38,8 +44,6 @@ module Tracetool
         def match(string)
           # Split into lines
           first, *rest = string.split("\n")
-
-          return if rest.nil? || rest.empty?
           return unless RX_FIRST_EXCEPTION_LINE.match(first)
 
           rest.all? { |line| RX_OTHER_EXCEPTION_LINE.match(line) }

data/lib/tracetool/android/native.rb

@@ -5,10 +5,15 @@ module Tracetool
     # Android traces scanner and mapper
     class NativeTraceParser < Tracetool::BaseTraceParser
       # Describes android stack entry
+      # rubocop:disable Metrics/LineLength
       STACK_ENTRY_PATTERN =
-        %r{Stack frame #(?<frame>\d+)  (?<address>\w+ [a-f\d]+)  (?<lib>[/\w\d\.-]+)( )?(: (?<call_description>.+))?$}
+        %r{Stack frame #(?<frame>\d+)  (?<address>\w+ [a-f\d]+)  (?<lib>[/\w\d\._!=-]+)( )?(:? (?<call_description>.+))?$}.freeze
+      # rubocop:enable Metrics/LineLength
       # Describes android native method call (class::method and source file with line number)
-      CALL_PATTERN = /(Routine )?(?<method>.+) ((in)|(at)) (?<file>.+):(?<line>\d+)/
+      CALL_PATTERN = [
+        /((Routine )?(?<method>.+) ((in)|(at)) (?<file>.+):(?<line>\d+))/,
+        /(?<method>.+?) \d+/
+      ].freeze
 
       def initialize(files)
         super(STACK_ENTRY_PATTERN, CALL_PATTERN, files, true)
@@ -30,7 +35,9 @@ module Tracetool
       # @param [String] trace packed stack trace
       # @return well formed stack trace
       def unpack(trace)
-        dump_body = prepare(trace).map.with_index { |line, index| convert_line(line, index) }
+        dump_body = prepare(trace)
+                    .map
+                    .with_index { |line, index| convert_line(line, index) }
         add_header(dump_body.join("\n"))
       end
 
@@ -48,8 +55,9 @@ module Tracetool
       def convert_line(line, index)
         frame = index
         addr = line[/^(-?\d+) (.*)$/, 1]
-        lib = line[/^(-?\d+) (.*)$/, 2].strip
-        '    #%02i  pc %08x  %s'.format(frame, addr, lib)
+        lib = (line[/^(-?\d+) (.*)$/, 2] || '').strip # nil safe
+        '    #%02<frame>i  pc %08<addr>x  %<lib>s'
+          .format(frame: frame, addr: addr, lib: lib)
       end
 
       # If needed here we'll drop all unneeded leading characters from each
@@ -63,14 +71,15 @@ module Tracetool
     # Processes native traces
     class NativeTraceScanner
       # Initial sequence of asterisks which marks begining of trace body
-      TRACE_DELIMETER = '*** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***'.freeze
-      RX_INITIAL_ASTERISKS = /#{TRACE_DELIMETER.gsub('*', '\*')}/
+      TRACE_DELIMETER =
+        '*** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***'.freeze
+      RX_INITIAL_ASTERISKS = /#{TRACE_DELIMETER.gsub('*', '\*')}/.freeze
       # Contains address line like
       #
       # ```
       # pc 00000000004321ec libfoo.so
       # ```
-      RX_PC_ADDRESS = /pc \d+/
+      RX_PC_ADDRESS = /pc \d+/.freeze
 
       # Format of packed trace.
       # Consists of one or more trace blocks.
@@ -84,7 +93,7 @@ module Tracetool
       # ** symbol offset `/\d+/`
       #
       # Last two entries can be missing.
-      RX_PACKED_FORMAT = /^(<<<(\d+ [^ ]+ ([^ ]+ \d+)?;)+>>>)+$/
+      RX_PACKED_FORMAT = /^(<<<([-?\d]+ [^ ]+ (.+)?;)+>>>)+$/.freeze
 
       # @param [String] string well formed native android stack trace
       # @see https://developer.android.com/ndk/guides/ndk-stack.html
@@ -96,13 +105,7 @@ module Tracetool
       #   path to symbols dir
       # @return [String] desymbolicated stack trace
       def process(ctx)
-        symbols = File.join(ctx.symbols, 'local')
-        symbols = if ctx.arch
-                    File.join(symbols, ctx.arch)
-                  else
-                    Dir[File.join(symbols, '*')].first || symbols
-                  end
-        Pipe['ndk-stack', '-sym', symbols] << @trace
+        Pipe['ndk-stack', '-sym', ctx.symbols] << @trace
       end
 
       # Create parser for current trace format

data/lib/tracetool/ios.rb

@@ -1,3 +1,4 @@
+require_relative 'ios/atos_context'
 require_relative 'ios/scanner'
 require_relative 'ios/parser'
 

data/lib/tracetool/ios/atos_context.rb

@@ -0,0 +1,35 @@
+module Tracetool
+  module IOS
+    # Converts context to atos arguments
+    class AtosContext
+      # If no arch specified will use `arm64`
+      DEFAULT_ARCH = 'arm64'.freeze
+
+      # List of required argument names
+      REQUIRED_ARGUMENTS = %i[load_address xarchive module_name].freeze
+
+      def initialize(ctx)
+        check_arguments(ctx)
+        @load_address = ctx.load_address
+        @binary_path = module_binary(ctx.xarchive, ctx.module_name)
+        @arch = ctx.arch || 'arm64'
+      end
+
+      def to_args
+        %w[-o -l -arch].zip([@binary_path, @load_address, @arch]).flatten
+      end
+
+      private
+
+      def module_binary(xarchive, module_name)
+        File.join(xarchive, 'dSYMs', "#{module_name}.app.dSYM", 'Contents', 'Resources', 'DWARF', module_name)
+      end
+
+      def check_arguments(ctx)
+        REQUIRED_ARGUMENTS.each do |a|
+          ctx[a] || raise(ArgumentError, "Missing `#{a}` value")
+        end
+      end
+    end
+  end
+end

data/lib/tracetool/ios/parser.rb

@@ -5,10 +5,11 @@ module Tracetool
     # IOS traces scanner and source mapper
     class IOSTraceParser < Tracetool::BaseTraceParser
       # Describes IOS stack entry
-      STACK_ENTRY_PATTERN = /^(?<frame>\d+) (?<binary>[^ ]+) (?<call_description>.+)$/
+      STACK_ENTRY_PATTERN = /^(?<frame>\d+) (?<binary>[^ ]+) (?<call_description>.+)$/.freeze
       # Describes source block
       SOURCE_PATTERN =
         /^((-?\[(?<class>[^ ]+) (?<method>.+)\])|(?<method>.+)) \(in (?<module>.+)\) \((?<file>.+):(?<line>\d+)\)$/
+        .freeze
 
       def initialize(files)
         super(STACK_ENTRY_PATTERN, SOURCE_PATTERN, files, true)

data/lib/tracetool/ios/scanner.rb

@@ -1,38 +1,5 @@
 module Tracetool
   module IOS
-    # Converts context to atos arguments
-    class AtosContext
-      # If no arch specified will use `arm64`
-      DEFAULT_ARCH = 'arm64'.freeze
-
-      # List of required argument names
-      REQUIRED_ARGUMENTS = %i[load_address xarchive module_name].freeze
-
-      #
-      def initialize(ctx)
-        check_arguments(ctx)
-        @load_address = ctx.load_address
-        @binary_path = module_binary(ctx.xarchive, ctx.module_name)
-        @arch = ctx.arch || 'arm64'
-      end
-
-      def to_args
-        %w[-o -l -arch].zip([@binary_path, @load_address, @arch]).flatten
-      end
-
-      private
-
-      def module_binary(xarchive, module_name)
-        File.join(xarchive, 'dSYMs', "#{module_name}.app.dSYM", 'Contents', 'Resources', 'DWARF', module_name)
-      end
-
-      def check_arguments(ctx)
-        REQUIRED_ARGUMENTS.each do |a|
-          ctx[a] || raise(ArgumentError, "Missing `#{a}` value")
-        end
-      end
-    end
-
     # launches atos
     class IOSTraceScanner
       # Stack trace line consists of numerous whitespace separated
@@ -45,10 +12,29 @@ module Tracetool
       # @return [Array] containing (%binary_name%, %address%) pairs
       def parse(trace)
         trace.split("\n").map do |line|
-          line.split(' ')[1..2] # Fetch binary name and address
+          parse_line(line)
         end
       end
 
+      # Parse trace line from trace. Which usualy looks like this:
+      #   3   My Module Name      0x0000000102d6e9f4 My Module Name + 5859828
+      # We need to fetch two values: 'My Module Name' and '0x0000000102d6e9f4'.
+      def parse_line(line)
+        parts = line.split(' ')
+        parts.shift # Frame number, not needed
+
+        module_name = ''
+
+        until parts.first.start_with?('0x')
+          module_name += parts.shift
+          module_name += ' '
+        end
+
+        address = parts.shift
+
+        [module_name.chop, address]
+      end
+
       def process(trace, context)
         trace = parse(trace)
         desym = run_atos(context, trace.map(&:last))

data/lib/tracetool/utils/cli.rb

@@ -6,8 +6,8 @@ require_relative '../../version'
 module Tracetool
   # Tracetool cli args parser
   class ParseArgs
-    # List of supported abis
-    ARCH_LIST = %i[armeabi-v7a armeabi x86 arm64 x86_64].freeze
+    # List of supported abis. Only needed for iOS unpacking
+    ARCH_LIST = %i[arm arm64].freeze
     #
     # Return a structure describing the options.
     #
@@ -19,24 +19,25 @@ module Tracetool
       check(options)
       check_ios(options)
       options
-    rescue OptionParser::MissingArgument => x
-      io.write ["Error occurred: #{x.message}", '', opt_parser.help].join("\n")
+    rescue OptionParser::MissingArgument => e
+      io.write ["Error occurred: #{e.message}", '', opt_parser.help].join("\n")
       io.write "\n"
-      raise(x)
+      raise(e)
     end
 
     def self.check_ios(options)
       return unless options.platform == :ios
+
       {
         'address' => options.address,
-        'module' =>  options.modulename
+        'module' => options.modulename,
+        'arch' => options.arch
       }.each { |arg, check| raise(OptionParser::MissingArgument, arg) unless check }
     end
 
     def self.check(options)
       {
-        'platform' => options.platform,
-        'arch' => options.arch
+        'platform' => options.platform
       }.each { |arg, check| raise(OptionParser::MissingArgument, arg) unless check }
     end
 

data/lib/tracetool/utils/parser.rb

@@ -1,12 +1,16 @@
+require_relative 'string'
+
 module Tracetool
   # Base trace parser logic
   class BaseTraceParser
+    include StringUtils
+
     attr_reader :entry_pattern, :call_pattern
 
     def initialize(entry_pattern, call_pattern, build_files, convert_numbers = false)
       @build_files = build_files
       @entry_pattern = entry_pattern
-      @call_pattern = call_pattern
+      @call_pattern = call_pattern.is_a?(Array) ? call_pattern : [call_pattern]
       @convert_numbers = convert_numbers
     end
 
@@ -54,36 +58,63 @@ module Tracetool
     # * method
     # * file
     # * line number
-    def scan_call(e)
-      if e[:call_description]
-        call_pattern.match(e[:call_description]) do |m|
-          call = extract_groups(m)
-          # Update file entry with expanded path
-          call[:file] = find_file(call[:file]) if call[:file]
-
-          e[:call] = call
-        end
+    def scan_call(call_info)
+      call_description = call_info[:call_description]
+      # TODO: Lazy check
+      match = call_description && call_pattern.map { |p| p.match(call_description) }.compact.first
+      if match
+        call = extract_groups(match)
+        # Update file entry with expanded path
+        call[:file] = find_file(call[:file]) if call[:file]
+
+        call_info[:call] = call
       end
 
-      e
+      call_info
     end
 
     # Find file with specified file name in symbols dir
-    # Can return multiple files if name was ambigous
+    # Can return multiple files if name was ambiguous
     def find_file(file)
-      # Find all matching files
-      # remove build_dir from path
-      # remove leading '/'
-      glob = File.join('**', File.basename(file))
-      files = @build_files.select { |f| File.fnmatch(glob, f) }
+      file_name = File.basename(file)
+      # Firstly we'll drop obvious mismatches where basename of file differs
+      candidates = @build_files.select { |path| File.basename(path) == file_name }
+      # In case when got ambiguous files return all try to find closest match
+      files = find_closest_files(file, candidates)
 
       # If has only option return first
       return files.first if files.size == 1
       # Return original file if files empty
       return file if files.empty?
 
-      # If got ambiguous files return all
-      files
+      files # Return all files if many matched
+    end
+
+    # Select from candidates list such files
+    # that ends with maximum substring of file
+    # @param [String] file file path to match
+    # @param [Array<String>] candidates list of candidates path
+    # @return [Array<String>] list of files with maximum length matches
+    def find_closest_files(file, candidates)
+      candidates.inject([[], 0]) do |acc, elem|
+        # Current element score is length of longest common postfix
+        elem_score = file.longest_common_postfix(elem).length
+
+        # Unpack accumulator as (list_of_matched_files, max_score)
+        matched, score = acc
+        # Will update if only have better score
+        if elem_score >= score
+          # Current score more than last known score, so now
+          # we drop all previous results and replace them with
+          # current element
+          matched = [] if elem_score > score
+          score = elem_score
+          # Update list of matched
+          matched << elem
+        end
+
+        [matched, score]
+      end.first
     end
 
     def extract_groups(match)

data/lib/tracetool/utils/pipe.rb

@@ -1,6 +1,7 @@
 require 'open3'
+
 module Tracetool
-  # helper module for launching commands
+  # Helper module for launching commands
   module Pipe
     # Executes shell command
     class Executor
@@ -14,12 +15,10 @@ module Tracetool
       end
 
       def <<(args)
-        args = args.join("\n") if args.is_a? Array
-        IO.popen(cmd, 'r+') do |io|
-          io.write(args)
-          io.close_write
-          io.read.chomp
-        end
+        out, err, status = Open3.capture3({}, *cmd, stdin_data: args)
+        raise "#{cmd.join(' ')} (exit: #{status.exitstatus}) #{err.chomp}" unless status.success?
+
+        out.chomp
       end
     end
 

data/lib/tracetool/utils/string.rb

@@ -0,0 +1,24 @@
+module Tracetool
+  # Set of utility methods for working with strings
+  module StringUtils
+    # Extended string class
+    # rubocop:disable Style/ClassAndModuleChildren
+    class ::String
+      # Return longest common postfix
+      # @param [String] other other string to match
+      # @return [String] longest common postfix
+      def longest_common_postfix(other)
+        sidx = length - 1
+        oidx = other.length - 1
+
+        while sidx >= 0 && oidx >= 0 && (self[sidx] == other[oidx])
+          sidx -= 1
+          oidx -= 1
+        end
+
+        other[(oidx + 1)..-1]
+      end
+    end
+    # rubocop:enable Style/ClassAndModuleChildren
+  end
+end

data/lib/version.rb

@@ -1,7 +1,7 @@
 module Tracetool
   # Version constant
   module Version
-    VERSION = [0, 4, 0].freeze
+    VERSION = [0, 5, 2].freeze
 
     class << self
       # @return [String] version string

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tracetool
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.2
 platform: ruby
 authors:
 - ilya.arkhanhelsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-27 00:00:00.000000000 Z
+date: 2020-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: powerpack
@@ -37,12 +37,14 @@ files:
 - lib/tracetool/android/java.rb
 - lib/tracetool/android/native.rb
 - lib/tracetool/ios.rb
+- lib/tracetool/ios/atos_context.rb
 - lib/tracetool/ios/parser.rb
 - lib/tracetool/ios/scanner.rb
 - lib/tracetool/utils/cli.rb
 - lib/tracetool/utils/env.rb
 - lib/tracetool/utils/parser.rb
 - lib/tracetool/utils/pipe.rb
+- lib/tracetool/utils/string.rb
 - lib/tracetool_cli.rb
 - lib/version.rb
 homepage: https://github.com/vizor-games/tracetool
@@ -64,8 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Tracetool