Merge pull request #266 from applandinc/feat/dont-record-appmap-false

feat: Don't record rspec tests when appmap: false

Author: kgilpin

lib/appmap/rspec.rb

@@ -157,14 +157,20 @@ def begin_spec(example)
         AppMap.info 'Configuring AppMap recorder for RSpec' if first_recording?
         @recording_count += 1
 
-        @recordings_by_example[example.object_id] = Recording.new(example)
+        recording = if example.metadata[:appmap] != false
+          Recording.new(example)
+        else
+          :false
+        end
+
+        @recordings_by_example[example.object_id] = recording
       end
 
       def end_spec(example, exception:)
         recording = @recordings_by_example.delete(example.object_id)
         return warn "No recording found for #{example}" unless recording
 
-        recording.finish exception
+        recording.finish exception unless recording == :false
       end
 
       def config

spec/fixtures/rails6_users_app/spec/controllers/users_controller_spec.rb

@@ -23,5 +23,7 @@
       get :show, params: { id: 'alice' }
       expect(response).to be_ok
     end
+    it 'performance test', appmap: false do
+    end
   end
 end

spec/rails_recording_spec.rb

@@ -15,6 +15,18 @@ def rails_versions
       include_context 'Rails app pg database', "spec/fixtures/rails#{rails_major_version}_users_app" unless use_existing_data?
       include_context 'rails integration test setup'
 
+      describe 'rspec metadata' do
+        let(:appmap_json_files) { Dir.glob("#{tmpdir}/appmap/rspec/*.appmap.json") }
+
+        it 'appmap: false disables recording' do
+          test_names = appmap_json_files.map(&File.method(:read)).map(&JSON.method(:parse)).map do |json|
+            json['metadata']['name']
+          end
+          expect(test_names).to include('UsersController GET /users/:login shows the user')
+          expect(test_names).to_not include('UsersController GET /users/:login performance test')
+        end
+      end
+
       describe 'an API route' do
         describe 'creating an object' do
           let(:appmap_json_file) do

spec/rails_spec_helper.rb

@@ -98,7 +98,6 @@ def run_process(method, cmd, env, options = {})
 
 shared_context 'rails integration test setup' do
   let(:tmpdir) { app.tmpdir }
-
   before(:all) { @app.run_specs } unless use_existing_data?
 
   let(:appmap_json_path) { File.join(tmpdir, 'appmap/rspec', appmap_json_file) }