tracetool 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 28053aff3e16e9baee1198e08bdbeffdefeef2f0
-  data.tar.gz: 894ac01ee7333ee6b02dc5fb422114f6269a0a72
+SHA256:
+  metadata.gz: ebe6ba1b66d5457e530be1544b059cf42da169d948a651766ad57fd3c6dac99e
+  data.tar.gz: 7b1a2cdefc535a9bb851dc212b69eaa34d89720d051936ab7d34442384db150f
 SHA512:
-  metadata.gz: 3fa1e1578d5c6802e508cea8b7c1af90ff2ef4f83f3574b7cf0b218afbcc48c47783706bec06273a1a6887470ebddd0ccbd15fb0448d921296033ce174b064d1
-  data.tar.gz: 338ed267bce0c0d91ecdb47cdfe6d1f8eeed36179717bc16a6c5362c84fb15d5f3099906e35ad0eaa90af7368c7e8fd2bd1c5bcb1d66b69bcb00265c4330874d
+  metadata.gz: d7a9e46d22089eb1b2517edc7664e3bf26ae04e6f82e4b55aaad3e87d9119b293a9d1fdde0a8d072ebadf2ac619487c24ddf099a0184a968e638b90ba34008b3
+  data.tar.gz: 4a187b23b271f395919265da64dc8d328b7a1b4fa4bcaf8383d33ed8e07d6c8c5dd5253e044db2d70a3efa6e6c604271b49439f7f4d01f163a5fab04761b8c9c

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

@@ -6,9 +6,13 @@ module Tracetool
     class NativeTraceParser < Tracetool::BaseTraceParser
       # Describes android stack entry
       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
       # 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 +34,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 +54,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 +70,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 +92,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

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

@@ -8,7 +8,6 @@ module Tracetool
       # 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

data/lib/tracetool/utils/cli.rb

@@ -27,9 +27,10 @@ module Tracetool
 
     def self.check_ios(options)
       return unless options.platform == :ios
+
       {
         'address' => options.address,
-        'module' =>  options.modulename
+        'module' => options.modulename
       }.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/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, 4, 1].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.4.1
 platform: ruby
 authors:
 - ilya.arkhanhelsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-27 00:00:00.000000000 Z
+date: 2019-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: powerpack
@@ -43,6 +43,7 @@ files:
 - 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
@@ -65,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: Tracetool