appmap 0.41.0 → 0.43.0

data/lib/appmap/rspec.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'appmap/util'
+require 'set'
 
 module AppMap
   # Integration of AppMap with RSpec. When enabled with APPMAP=true, the AppMap tracer will
@@ -13,58 +14,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 +35,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 +83,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 +104,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 +127,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 +163,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.0'
+  VERSION = '0.43.0'
 
   APPMAP_FORMAT_VERSION = '1.4'
 end

data/spec/abstract_controller_base_spec.rb

@@ -1,12 +1,11 @@
 require 'rails_spec_helper'
 
-describe 'AbstractControllerBase' do
+describe 'Rails' do
   %w[5 6].each do |rails_major_version| # rubocop:disable Metrics/BlockLength
-    context "in Rails #{rails_major_version}" do
-      include_context 'Rails app pg database', "spec/fixtures/rails#{rails_major_version}_users_app"
+    context "#{rails_major_version}" do
+      include_context 'Rails app pg database', "spec/fixtures/rails#{rails_major_version}_users_app" unless use_existing_data?
+
       def run_spec(spec_name)
-        FileUtils.rm_rf tmpdir
-        FileUtils.mkdir_p tmpdir
         cmd = <<~CMD.gsub "\n", ' '
           docker-compose run --rm -e RAILS_ENV=test -e APPMAP=true
           -v #{File.absolute_path tmpdir}:/app/tmp app ./bin/rspec #{spec_name}
@@ -18,12 +17,20 @@ describe 'AbstractControllerBase' do
         'tmp/spec/AbstractControllerBase'
       end
 
+      unless use_existing_data?
+        before(:all) do
+          FileUtils.rm_rf tmpdir
+          FileUtils.mkdir_p tmpdir
+          run_spec 'spec/controllers/users_controller_spec.rb'
+          run_spec 'spec/controllers/users_controller_api_spec.rb'
+        end
+      end
+
       let(:appmap) { JSON.parse File.read File.join tmpdir, 'appmap/rspec', appmap_json_file }
       let(:events) { appmap['events'] }
 
-      describe 'testing with rspec' do
-        describe 'creating a user' do
-          before(:all) { run_spec 'spec/controllers/users_controller_api_spec.rb:8' }
+      describe 'an API route' do
+        describe 'creating an object' do
           let(:appmap_json_file) do
             'Api_UsersController_POST_api_users_with_required_parameters_creates_a_user.appmap.json'
           end
@@ -32,11 +39,12 @@ describe 'AbstractControllerBase' do
             expect(File).to exist(File.join(tmpdir, 'appmap/rspec/Inventory.appmap.json'))
           end
 
-          it 'message fields are recorded in the appmap' do
+          it 'http_server_request is recorded in the appmap' do
             expect(events).to include(
               hash_including(
                 'http_server_request' => hash_including(
                   'request_method' => 'POST',
+                  'normalized_path_info' => '/api/users(.:format)',
                   'path_info' => '/api/users'
                 ),
                 'message' => include(
@@ -53,12 +61,17 @@ describe 'AbstractControllerBase' do
                     'object_id' => Integer
                   )
                 )
-              ),
+              )
+            )
+          end
+
+          it 'http_server_response is recorded in the appmap' do
+            expect(events).to include(
               hash_including(
-                'http_server_response' => {
+                'http_server_response' => hash_including(
                   'status' => 201,
                   'mime_type' => 'application/json; charset=utf-8'
-                }
+                )
               )
             )
           end
@@ -70,7 +83,7 @@ describe 'AbstractControllerBase' do
               'defined_class' => 'Api::UsersController',
               'method_id' => 'build_user',
               'path' => 'app/controllers/api/users_controller.rb',
-              'lineno' => 23,
+              'lineno' => Integer,
               'static' => false,
               'parameters' => include(
                 'name' => 'params',
@@ -93,10 +106,47 @@ describe 'AbstractControllerBase' do
               'elapsed' => Numeric
             )
           end
+
+          context 'with an object-style message' do
+            let(:appmap_json_file) { 'Api_UsersController_POST_api_users_with_required_parameters_with_object-style_parameters_creates_a_user.appmap.json' }
+
+            it 'message properties are recorded in the appmap' do
+              expect(events).to include(
+                hash_including(
+                  'message' => include(
+                    hash_including(
+                      'name' => 'user',
+                      'properties' => [
+                        { 'name' => 'login', 'class' => 'String' },
+                        { 'name' => 'password', 'class' => 'String' }
+                      ]
+                    )
+                  )
+                )
+              )    
+            end
+          end
         end
 
-        describe 'showing a user' do
-          before(:all) { run_spec 'spec/controllers/users_controller_spec.rb:22' }
+        describe 'listing objects' do
+          context 'with a custom header' do
+            let(:appmap_json_file) { 'Api_UsersController_GET_api_users_with_a_custom_header_lists_the_users.appmap.json' }
+
+            it 'custom header is recorded in the appmap' do
+              expect(events).to include(
+                hash_including(
+                  'http_server_request' => hash_including(
+                    'headers' => hash_including('X-Sandwich' => 'turkey')
+                  )
+                )
+              )
+            end
+          end
+        end
+      end
+
+      describe 'a UI route' do
+        describe 'rendering a page' do
           let(:appmap_json_file) do
             'UsersController_GET_users_login_shows_the_user.appmap.json'
           end
@@ -112,11 +162,6 @@ describe 'AbstractControllerBase' do
               )
             )
           end
-        end
-
-        describe 'listing users' do
-          before(:all) { run_spec 'spec/controllers/users_controller_spec.rb:11' }
-          let(:appmap_json_file) { 'UsersController_GET_users_lists_the_users.appmap.json' }
 
           it 'records and labels view rendering' do
             expect(events).to include hash_including(
@@ -128,7 +173,7 @@ describe 'AbstractControllerBase' do
               'lineno' => Integer,
               'static' => false
             )
-
+  
             expect(appmap['classMap']).to include hash_including(
               'name' => 'action_view',
               'children' => include(hash_including(
@@ -142,7 +187,7 @@ describe 'AbstractControllerBase' do
                 ))
               ))
             )
-          end
+          end  
         end
       end
     end

data/spec/fixtures/rails5_users_app/Gemfile

@@ -39,12 +39,16 @@ group :development, :test do
   gem 'appmap', appmap_options
   gem 'cucumber-rails', require: false
   gem 'rspec-rails'
-  # Required for Sequel, since without ActiveRecord, the Rails transactional fixture support
-  # isn't activated.
-  gem 'database_cleaner'
   # Call 'byebug' anywhere in the code to stop execution and get a debugger console
   gem 'pry-byebug'
 end
 
+group :test do
+  # Require only one of these.
+  # 'database_cleaner' requries 'database_cleaner-active_record', so don't require it.
+  gem 'database_cleaner-active_record', require: false
+  gem 'database_cleaner-sequel', require: false
+end
+
 group :development do
 end

data/spec/fixtures/rails5_users_app/app/controllers/api/users_controller.rb

@@ -6,6 +6,8 @@ module Api
     end
 
     def create
+      params = self.params.key?(:user) ? self.params[:user] : self.params
+      
       @user = build_user(params.slice(:login).to_unsafe_h)
       unless @user.valid?
         error = {

data/spec/fixtures/rails5_users_app/app/controllers/users_controller.rb

@@ -4,7 +4,15 @@ class UsersController < ApplicationController
   end
 
   def show
-    if (@user = User[login: params[:id]])
+    find_user = lambda do |id|
+      if User.respond_to?(:[])
+        User[login: id]
+      else
+        User.find_by_login!(id)
+      end
+    end
+
+    if (@user = find_user.(params[:id]))
       render plain: @user
     else
       render plain: 'Not found', status: 404

data/spec/fixtures/rails5_users_app/config/application.rb

@@ -15,8 +15,10 @@ case orm_module
 when 'sequel'
   require 'sequel-rails'
   require 'sequel_secure_password'
+  require 'database_cleaner-sequel' if Rails.env.test?
 when 'activerecord'
   require 'active_record/railtie'
+  require 'database_cleaner-active_record' if Rails.env.test?
 end
 
 require 'appmap/railtie' if defined?(AppMap)

data/spec/fixtures/rails5_users_app/create_app

@@ -16,11 +16,17 @@ if [[ $? != 0 ]]; then
    exit 1
 fi
 
-psql -h pg -U postgres -c "create database app_development"
-psql -h pg -U postgres -c "create database app_test"
+# Required for migrations
+export ORM_MODULE=sequel
 
+set +e
+psql -h pg -U postgres -c "drop database if exists app_development"
+psql -h pg -U postgres -c "drop database if exists app_test"
 set -e
 
+psql -h pg -U postgres -c "create database app_development"
+psql -h pg -U postgres -c "create database app_test"
+
 RAILS_ENV=development ./bin/rake db:migrate
 RAILS_ENV=test ./bin/rake db:migrate
 

data/spec/fixtures/rails5_users_app/docker-compose.yml

@@ -19,6 +19,9 @@ services:
     environment:
       RAILS_ENV:
       ORM_MODULE:
+      PGHOST: pg
+      PGPORT: '5432'
+      DATABASE_URL: postgres://postgres@pg
       APPMAP:
     volumes:
     - .:/src/app

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

@@ -1,13 +1,19 @@
 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' }
         expect(response.status).to eq(201)
       end
+      describe 'with object-style parameters' do
+        it 'creates a user' do
+          post :create, params: { user: { login: 'alice', password: 'foobar' } }
+          expect(response.status).to eq(201)
+        end
+      end
     end
     describe 'with a missing parameter' do
       it 'reports error 422' do
@@ -16,7 +22,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
@@ -25,5 +31,12 @@ RSpec.describe Api::UsersController, feature_group: 'Users', type: :controller,
       users = JSON.parse(response.body)
       expect(users.map { |r| r['login'] }).to include('alice')
     end
+    describe 'with a custom header' do
+      it 'lists the users' do
+        request.headers['X-Sandwich'] = 'turkey'
+        get :index, params: {}
+        expect(response.status).to eq(200)
+      end
+    end
   end
 end