appmap 0.41.2 → 0.42.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adc97c5504b0171bfe253ae399f75ceabce09325656572f921520263023f3f8c
-  data.tar.gz: 35e0ca65e34c843ace959017ee2830e74d2f49878b8b0538f42ebde37855f6bb
+  metadata.gz: 50826fcf91733d3bb29aad0b6c77af2516ad08aa87557c3675d4be896f7790db
+  data.tar.gz: 4e5ee3f431b68a69de5ff6b080eeae861f3f7de6fe952ea1e71b5c30d4777bc1
 SHA512:
-  metadata.gz: 7ee982724e27a8252a7506dda4ea9bf0817bd39f258d9d1ea01bd9b393aa3e523043ff2120e191806a6d41df096bfde110abf4956e4cd56ee1064aa12f4def9f
-  data.tar.gz: 715e4b8a140e8be61be375500a701ede6c01f0a709aee0cde0b65bd809a04b4c50543900ca9ac7bcbedd30f4252ef66ae9f18246eaa5591d3a9eeb7d5ba28be4
+  metadata.gz: fcd01c7d1a3d70c29e33d8890e8f1ea8d7dc5cd2fbca7724618fcc76190c2d0217b89ba69e4de5003eb80147d44c15335cfdff60e67cdaf3eeaa18655fdf2b4f
+  data.tar.gz: 32c714968c8669f3a9dceb20543a0f09856948f4b4d6b8584ad06d6347cf10f28a4d0386e4f3af1aaccb1709ec2a88fefe88da88104ffbe18dfd0fd81fb5cb95

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# v0.42.0
+
+* Remove `feature_group` and `feature` metadata from minitest and RSpec AppMaps.
+* Add `metadata.source_location`.
+
 # v0.41.2
 
 * Don't rely on `gemspec.source_paths` to list all the source locations in a gem. Hook any code that's loaded

data/lib/appmap.rb

@@ -50,6 +50,11 @@ module AppMap
       end
     end
 
+    # Whether to include source and comments in all class maps.
+    def include_source?
+      ENV['APPMAP_SOURCE'] == 'true'
+    end
+
     # Used to start tracing, stop tracing, and record events.
     def tracing
       @tracing ||= Trace::Tracing.new

data/lib/appmap/command/record.rb

@@ -27,7 +27,7 @@ module AppMap
           event_thread.join
           yield AppMap::APPMAP_FORMAT_VERSION,
                 AppMap.detect_metadata,
-                AppMap.class_map(tracer.event_methods),
+                AppMap.class_map(tracer.event_methods, include_source: AppMap.include_source?),
                 events
         end
 

data/lib/appmap/middleware/remote_recording.rb

@@ -67,7 +67,7 @@ module AppMap
 
         response = JSON.generate \
           version: AppMap::APPMAP_FORMAT_VERSION,
-          classMap: AppMap.class_map(tracer.event_methods),
+          classMap: AppMap.class_map(tracer.event_methods, include_source: AppMap.include_source?),
           metadata: metadata,
           events: @events
 

data/lib/appmap/minitest.rb

@@ -7,20 +7,25 @@ module AppMap
   # be activated around each test.
   module Minitest
     APPMAP_OUTPUT_DIR = 'tmp/appmap/minitest'
-    LOG = false
+    LOG = ( ENV['APPMAP_DEBUG'] == 'true' || ENV['DEBUG'] == 'true' )
 
     def self.metadata
       AppMap.detect_metadata
     end
 
-    Recording = Struct.new(:test) do
-      def initialize(test)
+    Recording = Struct.new(:test, :test_name) do
+      def initialize(test, test_name)
         super
 
-        warn "Starting recording of test #{test.class}.#{test.name}" if AppMap::Minitest::LOG
+        warn "Starting recording of test #{test.class}.#{test.name}@#{source_location}" if AppMap::Minitest::LOG
         @trace = AppMap.tracing.trace
       end
 
+      def source_location
+        test.method(test_name).source_location.join(':')
+      end
+
+
       def finish
         warn "Finishing recording of test #{test.class}.#{test.name}" if AppMap::Minitest::LOG
 
@@ -31,7 +36,7 @@ module AppMap
 
         AppMap::Minitest.add_event_methods @trace.event_methods
 
-        class_map = AppMap.class_map(@trace.event_methods)
+        class_map = AppMap.class_map(@trace.event_methods, include_source: AppMap.include_source?)
 
         feature_group = test.class.name.underscore.split('_')[0...-1].join('_').capitalize
         feature_name = test.name.split('_')[1..-1].join(' ')
@@ -39,9 +44,8 @@ module AppMap
 
         AppMap::Minitest.save scenario_name,
                               class_map,
-                              events: events,
-                              feature_name: feature_name,
-                              feature_group_name: feature_group
+                              source_location,
+                              events: events
       end
     end
 
@@ -55,8 +59,8 @@ module AppMap
         FileUtils.mkdir_p APPMAP_OUTPUT_DIR
       end
 
-      def begin_test(test)
-        @recordings_by_test[test.object_id] = Recording.new(test)
+      def begin_test(test, name)
+        @recordings_by_test[test.object_id] = Recording.new(test, name)
       end
 
       def end_test(test)
@@ -74,12 +78,11 @@ module AppMap
         @event_methods += event_methods
       end
 
-      def save(example_name, class_map, events: nil, feature_name: nil, feature_group_name: nil, labels: nil)
+      def save(example_name, class_map, source_location, events: nil, labels: nil)
         metadata = AppMap::Minitest.metadata.tap do |m|
           m[:name] = example_name
+          m[:source_location] = source_location
           m[:app] = AppMap.configuration.name
-          m[:feature] = feature_name if feature_name
-          m[:feature_group] = feature_group_name if feature_group_name
           m[:frameworks] ||= []
           m[:frameworks] << {
             name: 'minitest',
@@ -128,7 +131,7 @@ if AppMap::Minitest.enabled?
     alias run_without_hook run
 
     def run
-      AppMap::Minitest.begin_test self
+      AppMap::Minitest.begin_test self, name
       begin
         run_without_hook
       ensure

data/lib/appmap/rspec.rb

@@ -13,58 +13,9 @@ module AppMap
       AppMap.detect_metadata
     end
 
-    module FeatureAnnotations
-      def feature
-        return nil unless annotations
-
-        annotations[:feature]
-      end
-
-      def labels
-        labels = metadata[:appmap]
-        if labels.is_a?(Array)
-          labels
-        elsif labels.is_a?(String) || labels.is_a?(Symbol)
-          [ labels ]
-        else
-          []
-        end
-      end
-
-      def feature_group
-        return nil unless annotations
-
-        annotations[:feature_group]
-      end
-
-      def annotations
-        metadata.tap do |md|
-          description_args_hashes.each do |h|
-            md.merge! h
-          end
-        end
-      end
-
-      protected
-
-      def metadata
-        return {} unless example_obj.respond_to?(:metadata)
-
-        example_obj.metadata
-      end
-
-      def description_args_hashes
-        return [] unless example_obj.respond_to?(:metadata)
-
-        (example_obj.metadata[:description_args] || []).select { |arg| arg.is_a?(Hash) }
-      end
-    end
-
     # ScopeExample and ScopeExampleGroup is a way to handle the weird way that RSpec
     # stores the nested example names.
     ScopeExample = Struct.new(:example) do
-      include FeatureAnnotations
-
       alias_method :example_obj, :example
 
       def description?
@@ -83,8 +34,6 @@ module AppMap
     # As you can see here, the way that RSpec stores the example description and
     # represents the example group hierarchy is pretty weird.
     ScopeExampleGroup = Struct.new(:example_group) do
-      include FeatureAnnotations
-
       alias_method :example_obj, :example_group
 
       def description_args
@@ -133,11 +82,17 @@ module AppMap
           page.driver.options[:http_client].instance_variable_get('@server_url').port
         end
 
-        warn "Starting recording of example #{example}" if AppMap::RSpec::LOG
+        warn "Starting recording of example #{example}@#{source_location}" if AppMap::RSpec::LOG
         @trace = AppMap.tracing.trace
         @webdriver_port = webdriver_port.()
       end
 
+      def source_location
+        result = example.location_rerun_argument.split(':')[0]
+        result = result[2..-1] if result.index('./') == 0
+        result
+      end
+
       def finish
         warn "Finishing recording of example #{example}" if AppMap::RSpec::LOG
 
@@ -148,22 +103,16 @@ module AppMap
 
         AppMap::RSpec.add_event_methods @trace.event_methods
 
-        class_map = AppMap.class_map(@trace.event_methods, include_source: false)
+        class_map = AppMap.class_map(@trace.event_methods, include_source: AppMap.include_source?)
 
         description = []
         scope = ScopeExample.new(example)
-        feature_group = feature = nil
 
-        labels = []
         while scope
-          labels += scope.labels
           description << scope.description
-          feature ||= scope.feature
-          feature_group ||= scope.feature_group
           scope = scope.parent
         end
 
-        labels = labels.map(&:to_s).map(&:strip).reject(&:blank?).map(&:downcase).uniq
         description.reject!(&:nil?).reject!(&:blank?)
         default_description = description.last
         description.reverse!
@@ -177,24 +126,10 @@ module AppMap
 
         full_description = normalize.call(description.join(' '))
 
-        compute_feature_name = lambda do
-          return 'unknown' if description.empty?
-
-          feature_description = description.dup
-          num_tokens = [2, feature_description.length - 1].min
-          feature_description[0...num_tokens].map(&:strip).join(' ')
-        end
-
-        feature_group ||= normalize.call(default_description).underscore.gsub('/', '_').humanize
-        feature_name = feature || compute_feature_name.call if feature_group
-        feature_name = normalize.call(feature_name) if feature_name
-
         AppMap::RSpec.save full_description,
                            class_map,
-                           events: events,
-                           feature_name: feature_name,
-                           feature_group_name: feature_group,
-                           labels: labels.blank? ? nil : labels
+                           source_location,
+                           events: events
       end
     end
 
@@ -227,12 +162,11 @@ module AppMap
         @event_methods += event_methods
       end
 
-      def save(example_name, class_map, events: nil, feature_name: nil, feature_group_name: nil, labels: nil)
+      def save(example_name, class_map, source_location, events: nil, labels: nil)
         metadata = AppMap::RSpec.metadata.tap do |m|
           m[:name] = example_name
+          m[:source_location] = source_location
           m[:app] = AppMap.configuration.name
-          m[:feature] = feature_name if feature_name
-          m[:feature_group] = feature_group_name if feature_group_name
           m[:labels] = labels if labels
           m[:frameworks] ||= []
           m[:frameworks] << {

data/lib/appmap/version.rb

@@ -3,7 +3,7 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.41.2'
+  VERSION = '0.42.0'
 
   APPMAP_FORMAT_VERSION = '1.4'
 end

data/spec/fixtures/rails5_users_app/spec/controllers/users_controller_api_spec.rb

@@ -1,8 +1,8 @@
 require 'rails_helper'
 require 'rack/test'
 
-RSpec.describe Api::UsersController, feature_group: 'Users', type: :controller, appmap: true do
-  describe 'POST /api/users', feature: 'Create a user' do
+RSpec.describe Api::UsersController, type: :controller do
+  describe 'POST /api/users' do
     describe 'with required parameters' do
       it 'creates a user' do
         post :create, params: { login: 'alice', password: 'foobar' }
@@ -16,7 +16,7 @@ RSpec.describe Api::UsersController, feature_group: 'Users', type: :controller,
       end
     end
   end
-  describe 'GET /api/users', feature: 'List users' do
+  describe 'GET /api/users' do
     before do
       post :create, params: { login: 'alice' }
     end

data/spec/fixtures/rails5_users_app/spec/models/user_spec.rb

@@ -1,6 +1,6 @@
 require 'rails_helper'
 
-describe User, feature_group: 'User', appmap: true do
+describe User do
   # TODO: appmap/rspec doesn't handle shared_examples_for 100% correctly yet.
   # In my tests, only one of these two tests will be emitted as an appmap.
   shared_examples_for 'creates the user' do |username|
@@ -11,17 +11,7 @@ describe User, feature_group: 'User', appmap: true do
     end
   end
 
-  describe 'creation', feature: 'Create a user' do
-    context 'using shared_examples_for' do
-      # AppMap.
-#      context "with username 'alice'" do
-#        it_should_behave_like 'creates the user', 'alice'
-#      end
-#      context "with username 'bob'" do
-#        it_should_behave_like 'creates the user', 'bob'
-#      end
-    end
-
+  describe 'creation' do
     # So, instead of shared_examples_for, let's go with a simple method
     # containing the assertions. The method can be called from within an example.
     def save_and_verify

data/spec/fixtures/rails6_users_app/spec/controllers/users_controller_api_spec.rb

@@ -1,8 +1,8 @@
 require 'rails_helper'
 require 'rack/test'
 
-RSpec.describe Api::UsersController, feature_group: 'Users', type: :controller, appmap: true do
-  describe 'POST /api/users', feature: 'Create a user' do
+RSpec.describe Api::UsersController, type: :controller do
+  describe 'POST /api/users' do
     describe 'with required parameters' do
       it 'creates a user' do
         post :create, params: { login: 'alice', password: 'foobar' }
@@ -16,7 +16,7 @@ RSpec.describe Api::UsersController, feature_group: 'Users', type: :controller,
       end
     end
   end
-  describe 'GET /api/users', feature: 'List users' do
+  describe 'GET /api/users' do
     before do
       post :create, params: { login: 'alice' }
     end

data/spec/fixtures/rails6_users_app/spec/models/user_spec.rb

@@ -1,6 +1,6 @@
 require 'rails_helper'
 
-describe User, feature_group: 'User', appmap: true do
+describe User  do
   # TODO: appmap/rspec doesn't handle shared_examples_for 100% correctly yet.
   # In my tests, only one of these two tests will be emitted as an appmap.
   shared_examples_for 'creates the user' do |username|
@@ -11,17 +11,7 @@ describe User, feature_group: 'User', appmap: true do
     end
   end
 
-  describe 'creation', feature: 'Create a user' do
-    context 'using shared_examples_for' do
-      # AppMap.
-#      context "with username 'alice'" do
-#        it_should_behave_like 'creates the user', 'alice'
-#      end
-#      context "with username 'bob'" do
-#        it_should_behave_like 'creates the user', 'bob'
-#      end
-    end
-
+  describe 'creation' do
     # So, instead of shared_examples_for, let's go with a simple method
     # containing the assertions. The method can be called from within an example.
     def save_and_verify

data/test/fixtures/rspec_recorder/spec/decorated_hello_spec.rb

@@ -2,7 +2,7 @@ require 'rspec'
 require 'appmap/rspec'
 require 'hello'
 
-describe Hello, feature_group: 'Saying hello' do
+describe Hello do
   before do
     # Trick appmap-ruby into thinking we're a Rails app.
     stub_const('Rails', double('rails', version: 'fake.0'))
@@ -11,11 +11,11 @@ describe Hello, feature_group: 'Saying hello' do
   # The order of these examples is important. The tests check the
   # appmap for 'says hello', and we want another example to get run
   # before it.
-  it 'does not say goodbye', feature: 'Speak hello', appmap: true do
+  it 'does not say goodbye' do
     expect(Hello.new.say_hello).not_to eq('Goodbye!')
   end
 
-  it 'says hello', feature: 'Speak hello', appmap: true do
+  it 'says hello' do
     expect(Hello.new.say_hello).to eq('Hello!')
   end
 end

data/test/fixtures/rspec_recorder/spec/plain_hello_spec.rb

@@ -2,7 +2,7 @@ require 'rspec'
 require 'appmap/rspec'
 require 'hello'
 
-describe Hello, appmap: true do
+describe Hello do
   it 'says hello' do
     expect(Hello.new.say_hello).to eq('Hello!')
   end

data/test/minitest_test.rb

@@ -30,9 +30,8 @@ class MinitestTest < Minitest::Test
       assert_equal 'minitest_recorder', metadata['app']
       assert_equal 'minitest', metadata['recorder']['name']
       assert_equal 'ruby', metadata['language']['name']
-      assert_equal 'Hello', metadata['feature_group']
-      assert_equal 'hello', metadata['feature']
       assert_equal 'Hello hello', metadata['name']
+      assert_equal 'test/hello_test.rb:9', metadata['source_location']
     end
   end
 end

data/test/rspec_test.rb

@@ -28,8 +28,6 @@ class RSpecTest < Minitest::Test
       assert_includes appmap.keys, 'metadata'
       metadata = appmap['metadata']
       assert_equal 'Inventory', metadata['name']
-      assert_includes metadata.keys, 'labels'
-      assert_equal metadata['labels'], %w[inventory]
     end
   end
 
@@ -42,9 +40,8 @@ class RSpecTest < Minitest::Test
       assert_equal AppMap::APPMAP_FORMAT_VERSION, appmap['version']
       assert_includes appmap.keys, 'metadata'
       metadata = appmap['metadata']
-      assert_equal 'Saying hello', metadata['feature_group']
-      assert_equal 'Speak hello', metadata['feature']
       assert_equal 'Hello says hello', metadata['name']
+      assert_equal 'spec/decorated_hello_spec.rb', metadata['source_location']
       assert_includes metadata.keys, 'client'
       assert_equal({ name: 'appmap', url: AppMap::URL, version: AppMap::VERSION }.stringify_keys, metadata['client'])
       assert_includes metadata.keys, 'recorder'
@@ -63,8 +60,6 @@ class RSpecTest < Minitest::Test
       appmap = JSON.parse(File.read(appmap_file))
       assert_includes appmap.keys, 'metadata'
       metadata = appmap['metadata']
-      assert_equal 'Hello', metadata['feature_group']
-      assert_equal 'Hello', metadata['feature']
       assert_equal 'Hello says hello', metadata['name']
     end
   end
@@ -76,7 +71,6 @@ class RSpecTest < Minitest::Test
       appmap = JSON.parse(File.read(appmap_file))
       assert_includes appmap.keys, 'metadata'
       metadata = appmap['metadata']
-      assert_equal %w[hello speak], metadata['labels'].sort
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.41.2
+  version: 0.42.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-10 00:00:00.000000000 Z
+date: 2021-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -548,7 +548,6 @@ files:
 - spec/railtie_spec.rb
 - spec/record_sql_rails_pg_spec.rb
 - spec/remote_recording_spec.rb
-- spec/rspec_feature_metadata_spec.rb
 - spec/spec_helper.rb
 - spec/util_spec.rb
 - test/cli_test.rb

data/spec/rspec_feature_metadata_spec.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_spec_helper'
-
-describe 'RSpec feature and feature group metadata' do
-  include_examples 'Rails app pg database', 'spec/fixtures/rails5_users_app' do
-    around(:each) do |example|
-      FileUtils.rm_rf tmpdir
-      FileUtils.mkdir_p tmpdir
-      cmd = "docker-compose run --rm -e RAILS_ENV=test -e APPMAP=true -v #{File.absolute_path(tmpdir).shellescape}:/app/tmp app ./bin/rspec spec/models/user_spec.rb"
-      run_cmd cmd, chdir: fixture_dir
-
-      example.run
-    end
-
-    let(:tmpdir) { 'tmp/spec/RSpec feature and feature group metadata' }
-    let(:appmap_json) { File.join(tmpdir, %(appmap/rspec/User_creation_creates_charles.appmap.json)) }
-
-    describe do
-      it 'are recorded in the appmap' do
-        expect(File).to exist(appmap_json)
-        appmap = JSON.parse(File.read(appmap_json)).to_yaml
-
-        expect(appmap).to include(<<-METADATA.strip)
-  feature: Create a user
-  feature_group: User
-        METADATA
-      end
-    end
-  end
-end