appmap 0.22.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e4bb797e4a52228da17a1d2bea86cc7b39c0e77f868794282a4a506bc118c1b
-  data.tar.gz: 17c42a6dbab64ded9e0c0735df3e1a6b4ffb871f5368c134038fa4574f18a140
+  metadata.gz: 2ba1394503aa1c8f498901ed3c7b903af4bcf5b60b16fe48eee08d9c64f66d67
+  data.tar.gz: 665c48d0d450b2500277b2bdcb54dc356e0b31d442c1f7d9fcb47d0c5c054de6
 SHA512:
-  metadata.gz: ce536f9473bc5c13127c7f9e327e011123a0b56291197c1c3f91db68c7ec2fa64438382cc08f002e2634cf7a1877b630f43849989197ca0285da72e79a93767d
-  data.tar.gz: 5a457dbc9afa127d6ca284bf47ee549b3e7a0cb579e1edf2313783ced314e87134ac9a2c4b06e1035402e5619876d7d990b0f65268e12a991480641b5574bc0e
+  metadata.gz: 279932323e5ca1ba95eb42a7bc4410e795fb308b2861c1b3ee2bb29ece31e54664983731648967e82ce4367813eb67557791c21bab16cfc67192d743b34d7568
+  data.tar.gz: 0141f02617969b168a2dd0c158e8fbfd5b85caa5bc3fa23691c049ae37adefa269d8e76c3c37b4f08f139bc20071b53bf7b31056b2df1c5dfafef44123a7136b

data/.travis.yml

@@ -0,0 +1,38 @@
+language: ruby
+
+services:
+- docker
+
+# We expect RAILS_ENV to start off unset, then adjust its value as
+# necessary.
+before_script:
+  - unset RAILS_ENV
+  
+jobs:
+  include:
+  - stage: minitest
+    script:
+    - mkdir tmp
+    - bundle exec rake minitest
+    
+  - stage: base
+    script:
+    - bundle exec rake build:base:2.5
+  - stage: base
+    script:
+    - bundle exec rake build:base:2.6
+      
+  - stage: fixtures
+    script:
+    - bundle exec rake build:fixtures:2.5:all
+  - stage: fixtures
+    script:
+    - bundle exec rake build:fixtures:2.6:all
+
+  - stage: spec
+    script:
+    - bundle exec rake spec:2.5
+  - stage: spec
+    script:
+    - bundle exec rake spec:2.6
+    

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v0.23.0
+
+* **appmap stats** command added.
+
 # v0.22.0
 
 * **RSpec** recorder generates an "inventory" (AppMap with classMap, without events) named `Inventory.appmap.json`.

data/README.md

@@ -171,5 +171,5 @@ Batch Id: a116f1df-ee57-4bde-8eef-851af0f3d7bc
 ```
 
 # Build status
+[![Build Status](https://travis-ci.org/applandinc/appmap-ruby.svg?branch=master)](https://travis-ci.org/applandinc/appmap-ruby)
 
-![Build status](https://travis-ci.org/applandinc/appmap-ruby.svg?branch=master)

data/Rakefile

@@ -4,6 +4,8 @@ GEM_VERSION = AppMap::VERSION
 require 'rake/testtask'
 require 'rdoc/task'
 
+require 'open3'
+
 namespace 'gem' do
   require 'bundler/gem_tasks'
 end
@@ -11,20 +13,32 @@ end
 RUBY_VERSIONS=%w[2.5 2.6]
 FIXTURE_APPS=%w[rack_users_app rails_users_app rails4_users_app]
 
+def run_cmd(*cmd)
+  $stderr.puts "Running: #{cmd}"
+  out,s = Open3.capture2e(*cmd)
+  unless s.success?
+    $stderr.puts <<-END
+      Command failed:
+      <<< Output:
+      #{out}
+      >>> End of output
+    END
+    raise 'Docker build failed'
+  end
+end
+  
 def build_base_image(ruby_version)
-  system "docker build" \
+  run_cmd "docker build" \
          " --build-arg RUBY_VERSION=#{ruby_version} --build-arg GEM_VERSION=#{GEM_VERSION}" \
-         " -t appmap:#{GEM_VERSION} -f Dockerfile.appmap ." \
-  or raise 'Docker build failed'
+         " -t appmap:#{GEM_VERSION} -f Dockerfile.appmap ."
 end
   
 def build_app_image(app, ruby_version)
   Dir.chdir "spec/fixtures/#{app}" do
-    system "env RUBY_VERSION=#{ruby_version} GEM_VERSION=#{GEM_VERSION}" \
-           " docker-compose build" \
-           " --build-arg RUBY_VERSION=#{ruby_version}" \
-           " --build-arg GEM_VERSION=#{GEM_VERSION}" \
-    or raise 'docker-compose build failed'
+    run_cmd( {"RUBY_VERSION" => ruby_version, "GEM_VERSION" => GEM_VERSION},
+      " docker-compose build" \
+      " --build-arg RUBY_VERSION=#{ruby_version}" \
+      " --build-arg GEM_VERSION=#{GEM_VERSION}")
   end
 end
 
@@ -76,8 +90,7 @@ def run_specs(ruby_version, task_args)
       # cause it to be ignored. Setting it to '' or +nil+ causes an
       # empty argument to get passed to rspec, which confuses it.
       task.pattern = 'never match this'
-      task.rspec_opts = '-f doc '
-      task.rspec_opts += args.to_a.join(' ')
+      task.rspec_opts = args.to_a.join(' ')
     end
   end
   
@@ -112,6 +125,8 @@ Rake::TestTask.new(:minitest) do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
 
+task spec: "spec:all"
+
 task test: %i[spec:all minitest]
 
 task default: :test

data/exe/appmap

@@ -85,6 +85,57 @@ module AppMap
       end
     end
 
+    desc 'Calculate and print statistics of scenario files.'
+    arg_name 'filename'
+    command :stats do |c|
+      output_file_flag(c, default_value: '-')
+
+      c.desc 'Display format for the result (text | json)'
+      c.default_value 'text'
+      c.flag %i[f format]
+
+      c.desc 'Maximum number of lines to display for each stat'
+      c.flag %i[l limit]
+
+      c.action do |_, options, args|
+        require 'appmap/command/stats'
+
+        limit = options[:limit].to_i if options[:limit]
+
+        # Name of the file to analyze. GLI will ensure that it's present.
+        filenames = args
+        help_now!("'filename' argument is required") if filenames.empty?
+
+        require 'appmap/algorithm/stats'
+        result = filenames.inject(::AppMap::Algorithm::Stats::Result.new([], [])) do |stats_result, filename|
+          appmap = begin
+            JSON.parse(File.read(filename))
+          rescue JSON::ParserError
+            STDERR.puts "#{filename} is not valid JSON : #{$!}"
+            nil
+          end
+          stats_result.tap do
+            if appmap
+              limit = options[:limit].to_i if options[:limit]
+              stats_for_file = AppMap::Command::Stats.new(appmap).perform(limit: limit)
+              stats_result.merge!(stats_for_file)
+            end
+          end
+        end
+
+        result.sort!
+        result.limit!(limit) if limit
+
+        display = case options[:format]
+        when 'json'
+          JSON.pretty_generate(result.as_json)
+        else
+          result.as_text
+        end
+        @output_file.write display
+      end
+    end
+
     desc 'Upload a scenario file to AppLand.'
     arg_name 'filename'
     command :upload do |c|

data/lib/appmap/algorithm/prune_class_map.rb

@@ -14,7 +14,7 @@ module AppMap
         @logger = ->(msg) {}
       end
 
-      def prune
+      def perform
         # This proc counts the number of objects in the class map whose type is 'k'
         count = proc do |k, e|
           n = 0

data/lib/appmap/algorithm/stats.rb

@@ -0,0 +1,88 @@
+module AppMap
+  module Algorithm
+    StatsStruct = Struct.new(:appmap)
+
+    # Compute AppMap statistics.
+    class Stats < StatsStruct
+      Result = Struct.new(:class_frequency, :method_frequency) do
+        def merge!(other)
+          merge = lambda do |freq, other_freq|
+            freq_by_name = freq.inject({}) do |table, entry|
+              table.tap do
+                table[entry.name] = entry
+              end
+            end
+            other_freq.each do |other_entry|
+              entry = freq_by_name[other_entry.name]
+              if entry
+                entry.count += other_entry.count
+              else
+                freq << other_entry
+              end
+            end
+          end
+          merge.call(class_frequency, other.class_frequency)
+          merge.call(method_frequency, other.method_frequency)
+
+          self
+        end
+
+        def sort!
+          comparator = ->(a,b) { b.count <=> a.count }
+          class_frequency.sort!(&comparator)
+          method_frequency.sort!(&comparator)
+          
+          self
+        end
+
+        def limit!(limit)
+          self.class_frequency = class_frequency[0...limit]
+          self.method_frequency = method_frequency[0...limit]
+
+          self
+        end
+
+        def as_text
+          lines = [
+            "Class frequency:",
+            "----------------",
+          ] + class_frequency.map(&:to_a).map(&:reverse).map { |line | line.join("\t") } + [
+            "",
+            "Method frequency:",
+            "----------------",
+          ] + method_frequency.map(&:to_a).map(&:reverse).map { |line | line.join("\t") }
+          lines.join("\n")
+        end
+      end
+      Frequency = Struct.new(:name, :count)
+      
+      def perform(limit: nil)
+        events = appmap['events'] || []
+        frequency_calc = lambda do |key_func|
+          events_by_key = events.inject(Hash.new(0))  do |memo, event|
+            key = key_func.call(event)
+            memo.tap do
+              memo[key] += 1 if key
+            end
+          end
+          events_by_key.map do |key, count|
+            Frequency.new(key, count)
+          end
+        end
+
+        class_name_func = ->(event) { event['defined_class'] }
+        full_name_func = lambda do |event|
+          class_name = event['defined_class']
+          static = event['static']
+          function_name = event['method_id']
+          [ class_name, static ? '.' : '#', function_name ].join if class_name && !static.nil? && function_name
+        end
+
+        class_frequency = frequency_calc.call(class_name_func)
+        method_frequency = frequency_calc.call(full_name_func)
+
+        Result.new(class_frequency, method_frequency)
+      end
+    end
+  end
+end

data/lib/appmap/command/stats.rb

@@ -0,0 +1,12 @@
+module AppMap
+  module Command
+    StatsStruct = Struct.new(:appmap)
+
+    class Stats < StatsStruct
+      def perform(limit: nil)
+        require 'appmap/algorithm/stats'
+        AppMap::Algorithm::Stats.new(appmap).perform(limit: limit)
+      end
+    end
+  end
+end

data/lib/appmap/command/upload.rb

@@ -92,7 +92,7 @@ module AppMap
         Algorithm::PruneClassMap.new(class_map).tap do |alg|
           alg.events = events if events
           alg.logger = ->(msg) { warn msg } if debug?
-        end.prune
+        end.perform
       end
     end
   end

data/lib/appmap/version.rb

@@ -3,7 +3,7 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.22.0'
+  VERSION = '0.23.0'
 
   APPMAP_FORMAT_VERSION = '1.2'
 end

data/spec/abstract_controller4_base_spec.rb

@@ -8,7 +8,7 @@ describe 'AbstractControllerBase' do
     FileUtils.rm_rf tmpdir
     FileUtils.mkdir_p tmpdir
     cmd = "docker-compose run --rm -e APPMAP=true -v #{File.absolute_path tmpdir}:/app/tmp app ./bin/rspec spec/controllers/users_controller_api_spec.rb:8"
-    system cmd, chdir: @fixture_dir or raise 'Failed to run rails_users_app container'
+    run_cmd cmd, chdir: @fixture_dir
 
     example.run
   end

data/spec/abstract_controller_base_spec.rb

@@ -8,7 +8,7 @@ describe 'AbstractControllerBase' do
     FileUtils.rm_rf tmpdir
     FileUtils.mkdir_p tmpdir
     cmd = "docker-compose run --rm -e APPMAP=true -v #{File.absolute_path tmpdir}:/app/tmp app ./bin/rspec spec/controllers/users_controller_api_spec.rb:8"
-    system cmd, chdir: @fixture_dir or raise 'Failed to run rails_users_app container'
+    run_cmd cmd, chdir: @fixture_dir
 
     example.run
   end

data/spec/fixtures/rails_users_app/create_app

@@ -1,11 +1,26 @@
 #!/usr/bin/env bash
 
+# Just checking for a healthy container isn't enough, apparently. If
+# we don't wait here, sometimes the database is inaccessible.
+for i in {1..10}; do
+  psql -h pg -U postgres postgres -c 'select 1' >/dev/null 2>&1 && break
+  printf ' .'
+  sleep 1
+done
+echo
+out="$(psql -h pg -U postgres postgres -c 'select 1' 2>&1)"
+if [[ $? != 0 ]]; then
+   echo "Postgres didn't start in time:"
+   echo "$out"
+   exit 1
+fi
+
 psql -h pg -U postgres -c "create database app_development"
 psql -h pg -U postgres -c "create database app_test"
 
 set -e
 
-./bin/rake db:migrate
+RAILS_ENV=development ./bin/rake db:migrate
 RAILS_ENV=test ./bin/rake db:migrate
 
 echo "INSERT INTO users ( login ) VALUES ( 'admin' )  " | psql -h pg -U postgres app_development

data/spec/rails_spec_helper.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'open3'
 
 def wait_for_container(app_name)
   start_time = Time.now
@@ -11,24 +12,38 @@ def wait_for_container(app_name)
   end
 end
 
+def run_cmd(*cmd)
+  out,s = Open3.capture2e(*cmd)
+  unless s.success?
+    $stderr.puts <<~END
+      Command failed:
+      #{cmd}
+      <<< Output:
+      #{out}
+      >>> End of output
+    END
+    raise 'Command failed'
+  end
+end
+
 shared_context 'Rails app pg database' do
   before(:all) do
     raise "you must set @fixure_dir" unless @fixture_dir
     
     Dir.chdir @fixture_dir do 
       cmd = 'docker-compose up -d pg'
-      system cmd or raise "Command failed: #{cmd}"
+      run_cmd cmd
       wait_for_container 'pg'
 
       cmd = 'docker-compose run --rm app ./create_app'
-      system cmd or raise "Command failed: #{cmd}"
+      run_cmd cmd
     end
   end
 
   after(:all) do
     if ENV['NOKILL'] != 'true'
       cmd = 'docker-compose down -v'
-      system cmd, chdir: @fixture_dir or raise "Command failed: #{cmd}"
+      run_cmd cmd, chdir: @fixture_dir
     end
   end
 end

data/spec/railtie_spec.rb

@@ -9,12 +9,21 @@ describe 'AppMap tracer via Railtie' do
   let(:cmd) { %(docker-compose run --rm -e RAILS_ENV -e APPMAP app ./bin/rails r "puts Rails.configuration.appmap.enabled.inspect") }
   let(:command_capture2) do
     require 'open3'
-    Open3.capture2(env, cmd, chdir: @fixture_dir).tap do |result|
-      raise 'Failed to run rails_users_app container' unless result[1] == 0
+    Open3.capture3(env, cmd, chdir: @fixture_dir).tap do |result|
+      unless result[2] == 0
+        $stderr.puts <<~END
+          Failed to run rails_users_app container
+          <<< Output:
+          #{result[0]}
+          #{result[1]}
+          >>> End of output
+        END
+        raise 'Failed to run rails_users_app container'
+      end
     end
   end
   let(:command_output) { command_capture2[0].strip }
-  let(:command_result) { command_capture2[1] }
+  let(:command_result) { command_capture2[2] }
 
   it 'is disabled by default' do
     expect(command_output).to eq('nil')

data/spec/record_sql_rails4_pg_spec.rb

@@ -7,8 +7,8 @@ describe 'Record SQL queries in a Rails4 app' do
   around(:each) do |example|
     FileUtils.rm_rf tmpdir
     FileUtils.mkdir_p tmpdir
-    cmd = "docker-compose run --rm -e ORM_MODULE=#{orm_module} -e APPMAP=true -v #{File.absolute_path tmpdir}:/app/tmp app ./bin/rspec -f doc -b spec/controllers/users_controller_api_spec.rb:#{test_line_number}"
-    system cmd, chdir: @fixture_dir or raise 'Failed to run rails_users_app container'
+    cmd = "docker-compose run --rm -e ORM_MODULE=#{orm_module} -e APPMAP=true -v #{File.absolute_path tmpdir}:/app/tmp app ./bin/rspec spec/controllers/users_controller_api_spec.rb:#{test_line_number}"
+    run_cmd cmd, chdir: @fixture_dir
 
     example.run
   end

data/spec/record_sql_rails_pg_spec.rb

@@ -8,7 +8,8 @@ describe 'Record SQL queries in a Rails app' do
     FileUtils.rm_rf tmpdir
     FileUtils.mkdir_p tmpdir
     cmd = "docker-compose run --rm -e ORM_MODULE=#{orm_module} -e APPMAP=true -v #{File.absolute_path tmpdir}:/app/tmp app ./bin/rspec spec/controllers/users_controller_api_spec.rb:#{test_line_number}"
-    system cmd, chdir: @fixture_dir or raise 'Failed to run rails_users_app container'
+    run_cmd cmd, chdir: @fixture_dir
+    
 
     example.run
   end

data/spec/rspec_feature_metadata_spec.rb

@@ -8,7 +8,7 @@ describe 'RSpec feature and feature group metadata' do
     FileUtils.rm_rf tmpdir
     FileUtils.mkdir_p tmpdir
     cmd = "docker-compose run --rm -e APPMAP=true -v #{File.absolute_path(tmpdir).shellescape}:/app/tmp app ./bin/rspec spec/models/user_spec.rb"
-    system cmd, chdir: @fixture_dir or raise 'Failed to run rails_users_app container'
+    run_cmd cmd, chdir: @fixture_dir
 
     example.run
   end

data/test/cli_test.rb

@@ -6,9 +6,11 @@ require 'English'
 
 class CLITest < Minitest::Test
   OUTPUT_FILENAME = File.expand_path('../tmp/appmap.json', __dir__)
+  STATS_OUTPUT_FILENAME = File.expand_path('../tmp/stats.txt', __dir__)
 
   def setup
     FileUtils.rm_f OUTPUT_FILENAME
+    FileUtils.rm_f STATS_OUTPUT_FILENAME
   end
 
   def test_config_file_must_exist
@@ -58,6 +60,72 @@ class CLITest < Minitest::Test
     assert output['events'], 'Output should contain events'
   end
 
+  def test_stats_to_file
+    Dir.chdir 'test/fixtures/cli_record_test' do
+      `#{File.expand_path '../exe/appmap', __dir__} record -o #{OUTPUT_FILENAME} ./lib/cli_record_test/main.rb`.strip
+    end
+    assert_equal 0, $CHILD_STATUS.exitstatus
+
+    output = Dir.chdir 'test/fixtures/cli_record_test' do
+      `#{File.expand_path '../exe/appmap', __dir__} stats -o #{STATS_OUTPUT_FILENAME} #{OUTPUT_FILENAME}`.strip
+    end
+    assert_equal 0, $CHILD_STATUS.exitstatus
+    assert_equal '', output
+    assert File.file?(OUTPUT_FILENAME), "#{OUTPUT_FILENAME} does not exist"
+  end
+
+
+  def test_stats_text
+    Dir.chdir 'test/fixtures/cli_record_test' do
+      `#{File.expand_path '../exe/appmap', __dir__} record -o #{OUTPUT_FILENAME} ./lib/cli_record_test/main.rb`.strip
+    end
+    assert_equal 0, $CHILD_STATUS.exitstatus
+
+    output = Dir.chdir 'test/fixtures/cli_record_test' do
+      `#{File.expand_path '../exe/appmap', __dir__} stats -o - #{OUTPUT_FILENAME}`.strip
+    end
+
+    assert_equal 0, $CHILD_STATUS.exitstatus
+    assert_equal <<~OUTPUT.strip, output.strip
+    Class frequency:
+    ----------------
+    2	Main
+
+    Method frequency:
+    ----------------
+    2	Main.say_hello
+    OUTPUT
+  end
+
+  def test_stats_json
+    Dir.chdir 'test/fixtures/cli_record_test' do
+      `#{File.expand_path '../exe/appmap', __dir__} record -o #{OUTPUT_FILENAME} ./lib/cli_record_test/main.rb`.strip
+    end
+    assert_equal 0, $CHILD_STATUS.exitstatus
+
+    output = Dir.chdir 'test/fixtures/cli_record_test' do
+      `#{File.expand_path '../exe/appmap', __dir__} stats -f json -o - #{OUTPUT_FILENAME}`.strip
+    end
+
+    assert_equal 0, $CHILD_STATUS.exitstatus
+    assert_equal <<~OUTPUT.strip, output.strip
+    {
+      "class_frequency": [
+        {
+          "name": "Main",
+          "count": 2
+        }
+      ],
+      "method_frequency": [
+        {
+          "name": "Main.say_hello",
+          "count": 2
+        }
+      ]
+    }
+    OUTPUT
+  end
+
   def test_record_to_default_location
     Dir.chdir 'test/fixtures/cli_record_test' do
       system({ 'APPMAP_FILE' => OUTPUT_FILENAME }, "#{File.expand_path '../exe/appmap', __dir__} record ./lib/cli_record_test/main.rb")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.23.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-16 00:00:00.000000000 Z
+date: 2020-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -219,6 +219,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
+- ".travis.yml"
 - CHANGELOG.md
 - Dockerfile.appmap
 - Gemfile
@@ -238,8 +239,10 @@ files:
 - exe/appmap
 - lib/appmap.rb
 - lib/appmap/algorithm/prune_class_map.rb
+- lib/appmap/algorithm/stats.rb
 - lib/appmap/command/inspect.rb
 - lib/appmap/command/record.rb
+- lib/appmap/command/stats.rb
 - lib/appmap/command/upload.rb
 - lib/appmap/config.rb
 - lib/appmap/config/directory.rb