appmap 0.27.0 → 0.33.0

data/spec/open_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe AppMap::Open do
+  context 'a block of Ruby code' do
+    it 'opens in the browser' do
+      appmap = AppMap.record do
+        File.read __FILE__
+      end
+
+      open = AppMap::Open.new(appmap)
+      server = open.run_server
+      page = Net::HTTP.get URI.parse("http://localhost:#{open.port}")
+      expect(page).to include(%(name="data" value='{"version))
+      server.kill
+    end
+  end
+end

data/spec/rails_spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'open3'
 

data/spec/record_sql_rails_pg_spec.rb

@@ -1,6 +1,6 @@
 require 'rails_spec_helper'
 
-describe 'Record SQL queries in a Rails app' do
+describe 'SQL events' do
   before(:all) { @fixture_dir = 'spec/fixtures/rails_users_app' }
   include_context 'Rails app pg database'
 
@@ -14,54 +14,77 @@ describe 'Record SQL queries in a Rails app' do
   end
 
   let(:tmpdir) { "tmp/spec/record_sql_rails_pg_spec" }
-  let(:appmap) { JSON.parse(File.read(appmap_json)).to_yaml }
 
-  context 'while creating a new record' do
+  describe 'fields' do
     let(:test_line_number) { 8 }
     let(:appmap_json) { File.join(tmpdir, 'appmap/rspec/Api_UsersController_POST_api_users_with_required_parameters_creates_a_user.appmap.json') }
+    let(:orm_module) { 'sequel' }
+    let(:appmap) { JSON.parse(File.read(appmap_json)) }
+    describe 'on a call event' do
+      let(:event) do
+        appmap['events'].find do |event|
+          event['event'] == 'call' &&
+            event.keys.include?('sql_query')
+        end
+      end
+      it 'do not include function-only fields' do
+        expect(event.keys).to_not include('defined_class')
+        expect(event.keys).to_not include('method_id')
+        expect(event.keys).to_not include('path')
+        expect(event.keys).to_not include('lineno')
+      end
+    end
+  end
+
+  describe 'in a Rails app' do
+    let(:appmap) { JSON.parse(File.read(appmap_json)).to_yaml }
+    context 'while creating a new record' do
+      let(:test_line_number) { 8 }
+      let(:appmap_json) { File.join(tmpdir, 'appmap/rspec/Api_UsersController_POST_api_users_with_required_parameters_creates_a_user.appmap.json') }
 
-    context 'using Sequel ORM' do
-      let(:orm_module) { 'sequel' }
-      it 'detects the sql INSERT' do
-        expect(appmap).to include(<<-SQL_QUERY.strip)
+      context 'using Sequel ORM' do
+        let(:orm_module) { 'sequel' }
+        it 'detects the sql INSERT' do
+          expect(appmap).to include(<<-SQL_QUERY.strip)
   sql_query:
     sql: INSERT INTO "users" ("login") VALUES ('alice') RETURNING *
-        SQL_QUERY
+          SQL_QUERY
+        end
       end
-    end
-    context 'using ActiveRecord ORM' do
-      let(:orm_module) { 'activerecord' }
-      it 'detects the sql INSERT' do
-        expect(appmap).to include(<<-SQL_QUERY.strip)
+      context 'using ActiveRecord ORM' do
+        let(:orm_module) { 'activerecord' }
+        it 'detects the sql INSERT' do
+          expect(appmap).to include(<<-SQL_QUERY.strip)
   sql_query:
     sql: INSERT INTO "users" ("login") VALUES ($1) RETURNING "id"
-        SQL_QUERY
+          SQL_QUERY
+        end
       end
     end
-  end
-
-  context 'while listing records' do
-    let(:test_line_number) { 23 }
-    let(:appmap_json) { File.join(tmpdir, 'appmap/rspec/Api_UsersController_GET_api_users_lists_the_users.appmap.json') }
-
-    context 'using Sequel ORM' do
-      let(:orm_module) { 'sequel' }
-      it 'detects the sql SELECT' do
-        expect(appmap).to include(<<-SQL_QUERY.strip)
+  
+    context 'while listing records' do
+      let(:test_line_number) { 23 }
+      let(:appmap_json) { File.join(tmpdir, 'appmap/rspec/Api_UsersController_GET_api_users_lists_the_users.appmap.json') }
+  
+      context 'using Sequel ORM' do
+        let(:orm_module) { 'sequel' }
+        it 'detects the sql SELECT' do
+          expect(appmap).to include(<<-SQL_QUERY.strip)
   sql_query:
     sql: SELECT * FROM "users"
-        SQL_QUERY
-
-        expect(appmap).to include('sql:')
+          SQL_QUERY
+  
+          expect(appmap).to include('sql:')
+        end
       end
-    end
-    context 'using ActiveRecord ORM' do
-      let(:orm_module) { 'activerecord' }
-      it 'detects the sql SELECT' do
-        expect(appmap).to include(<<-SQL_QUERY.strip)
+      context 'using ActiveRecord ORM' do
+        let(:orm_module) { 'activerecord' }
+        it 'detects the sql SELECT' do
+          expect(appmap).to include(<<-SQL_QUERY.strip)
   sql_query:
     sql: SELECT "users".* FROM "users"
-        SQL_QUERY
+          SQL_QUERY
+        end
       end
     end
   end

data/spec/rspec_feature_metadata_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_spec_helper'
 
 describe 'RSpec feature and feature group metadata' do

data/spec/spec_helper.rb

@@ -4,6 +4,10 @@ require 'json'
 require 'yaml'
 require 'English'
 require 'webdrivers/chromedriver'
+
+# Disable default initialization of AppMap
+ENV['APPMAP_INITIALIZE'] = 'false'
+
 require 'appmap'
 
 RSpec.configure do |config|

data/spec/util_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'appmap/util'
+
+describe AppMap::Util, docker: false do
+  let(:subject) { AppMap::Util.method(:scenario_filename) }
+  describe 'scenario_filename' do
+    it 'leaves short names alone' do
+      expect(subject.call('foobar')).to eq('foobar.appmap.json')
+    end
+    it 'has a customizable suffix' do
+      expect(subject.call('foobar', extension: '.json')).to eq('foobar.json')
+    end
+    it 'limits the filename length' do
+      fname = (0...104).map { |i| ((i % 26) + 97).chr }.join
+
+      expect(subject.call(fname, max_length: 50)).to eq('abcdefghijklmno-RAd_SFbH1sUZ_OXfwPsfzw.appmap.json')
+    end
+  end
+end

data/test/cli_test.rb

@@ -55,11 +55,11 @@ class CLITest < Minitest::Test
     assert_equal <<~OUTPUT.strip, output.strip
     Class frequency:
     ----------------
-    2	Main
+    1	Main
 
     Method frequency:
     ----------------
-    2	Main.say_hello
+    1	Main.say_hello
     OUTPUT
   end
 
@@ -79,13 +79,13 @@ class CLITest < Minitest::Test
       "class_frequency": [
         {
           "name": "Main",
-          "count": 2
+          "count": 1
         }
       ],
       "method_frequency": [
         {
           "name": "Main.say_hello",
-          "count": 2
+          "count": 1
         }
       ]
     }

data/test/cucumber_test.rb

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'English'
+
+class CucumberTest < Minitest::Test
+  def perform_test(dir)
+    Bundler.with_clean_env do
+      Dir.chdir "test/fixtures/#{dir}" do
+        FileUtils.rm_rf 'tmp'
+        system 'bundle config --local local.appmap ../../..'
+        system 'bundle'
+        system({ 'APPMAP' => 'true' }, %(bundle exec cucumber))
+
+        yield
+      end
+    end
+  end
+
+  def test_cucumber
+    perform_test 'cucumber_recorder' do
+      appmap_file = 'tmp/appmap/cucumber/Say_hello.appmap.json'
+
+      assert File.file?(appmap_file),
+             %(appmap output file does not exist in #{Dir.new('tmp/appmap/cucumber').entries.join(', ')})
+      appmap = JSON.parse(File.read(appmap_file))
+      assert_equal AppMap::APPMAP_FORMAT_VERSION, appmap['version']
+      assert_includes appmap.keys, 'metadata'
+      metadata = appmap['metadata']
+
+      assert_equal 'say_hello', metadata['feature_group']
+      assert_equal 'I can say hello', metadata['feature']
+      assert_equal 'Say hello', metadata['name']
+      assert_includes metadata.keys, 'client'
+      assert_equal({ name: 'appmap', url: AppMap::URL, version: AppMap::VERSION }.stringify_keys, metadata['client'])
+      assert_includes metadata.keys, 'recorder'
+      assert_equal({ name: 'cucumber' }.stringify_keys, metadata['recorder'])
+
+      assert_includes metadata.keys, 'frameworks'
+      cucumber = metadata['frameworks'].select {|f| f['name'] == 'cucumber'}
+      assert_equal 1, cucumber.count
+    end
+  end
+
+  def test_cucumber4
+    perform_test 'cucumber4_recorder' do
+      appmap_file = 'tmp/appmap/cucumber/Say_hello.appmap.json'
+
+      assert File.file?(appmap_file),
+             %(appmap output file does not exist in #{Dir.new('tmp/appmap/cucumber').entries.join(', ')})
+      appmap = JSON.parse(File.read(appmap_file))
+      assert_equal AppMap::APPMAP_FORMAT_VERSION, appmap['version']
+      assert_includes appmap.keys, 'metadata'
+      metadata = appmap['metadata']
+
+      assert_equal 'say_hello', metadata['feature_group']
+      # In cucumber4, there's no access to the feature name from within the executing scenario
+      # (as far as I can tell).
+      assert_equal 'Say hello', metadata['feature']
+      assert_equal 'Say hello', metadata['name']
+      assert_includes metadata.keys, 'client'
+      assert_equal({ name: 'appmap', url: AppMap::URL, version: AppMap::VERSION }.stringify_keys, metadata['client'])
+      assert_includes metadata.keys, 'recorder'
+      assert_equal({ name: 'cucumber' }.stringify_keys, metadata['recorder'])
+
+      assert_includes metadata.keys, 'frameworks'
+      cucumber = metadata['frameworks'].select {|f| f['name'] == 'cucumber'}
+      assert_equal 1, cucumber.count
+    end
+  end
+end

data/test/fixtures/cucumber4_recorder/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'appmap', git: 'applandinc/appmap-ruby', branch: `git rev-parse --abbrev-ref HEAD`.strip
+gem 'byebug'
+gem 'cucumber', '>= 4'

data/test/fixtures/cucumber4_recorder/appmap.yml

@@ -0,0 +1,3 @@
+name: cucumber_recorder
+packages:
+  - path: lib

data/test/fixtures/cucumber4_recorder/features/say_hello.feature

@@ -0,0 +1,5 @@
+Feature: I can say hello
+
+  Scenario: Say hello
+    When I say hello
+    Then the message is hello

data/test/fixtures/cucumber4_recorder/features/support/env.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'cucumber'
+require 'appmap/cucumber'
+require File.join(__dir__, '../../lib/hello')

data/test/fixtures/cucumber4_recorder/features/support/hooks.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'appmap'
+
+Around('not @appmap-disable') do |scenario, block|
+  appmap = AppMap.record do
+    block.call
+  end
+
+  AppMap::Cucumber.write_scenario(scenario, appmap)
+end

data/test/fixtures/cucumber4_recorder/features/support/steps.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+When('I say hello') do
+  @message = Hello.new.say_hello
+end
+
+Then('the message is hello') do
+  raise 'Wrong message!' unless @message == 'Hello!'
+end

data/test/fixtures/cucumber4_recorder/lib/hello.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Hello
+  def say_hello
+    'Hello!'
+  end
+end

data/test/fixtures/cucumber_recorder/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'appmap', git: 'applandinc/appmap-ruby', branch: `git rev-parse --abbrev-ref HEAD`.strip
+gem 'byebug'
+gem 'cucumber', '< 4'

data/test/fixtures/cucumber_recorder/appmap.yml

@@ -0,0 +1,3 @@
+name: cucumber_recorder
+packages:
+  - path: lib

data/test/fixtures/cucumber_recorder/features/say_hello.feature

@@ -0,0 +1,5 @@
+Feature: I can say hello
+
+  Scenario: Say hello
+    When I say hello
+    Then the message is hello

data/test/fixtures/cucumber_recorder/features/support/env.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'cucumber'
+require 'appmap/cucumber'
+require File.join(__dir__, '../../lib/hello')

data/test/fixtures/cucumber_recorder/features/support/hooks.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'appmap'
+
+Around('not @appmap-disable') do |scenario, block|
+  appmap = AppMap.record do
+    block.call
+  end
+
+  AppMap::Cucumber.write_scenario(scenario, appmap)
+end

data/test/fixtures/cucumber_recorder/features/support/steps.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+When('I say hello') do
+  @message = Hello.new.say_hello
+end
+
+Then('the message is hello') do
+  raise 'Wrong message!' unless @message == 'Hello!'
+end

data/test/fixtures/cucumber_recorder/lib/hello.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Hello
+  def say_hello
+    'Hello!'
+  end
+end

data/test/fixtures/minitest_recorder/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'appmap', git: 'applandinc/appmap-ruby', branch: `git rev-parse --abbrev-ref HEAD`.strip
+gem 'byebug'
+gem 'minitest'

data/test/fixtures/minitest_recorder/appmap.yml

@@ -0,0 +1,3 @@
+name: minitest_recorder
+packages:
+  - path: .

data/test/fixtures/minitest_recorder/lib/hello.rb

@@ -0,0 +1,5 @@
+class Hello
+  def say_hello
+    'Hello!'
+  end
+end

data/test/fixtures/minitest_recorder/test/hello_test.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require 'appmap/minitest'
+require 'hello'
+
+class HelloTest < ::Minitest::Test
+  def test_hello
+    assert_equal 'Hello!', Hello.new.say_hello
+  end
+end

data/test/fixtures/process_recorder/appmap.yml

@@ -0,0 +1,3 @@
+name: process_recorder
+packages:
+  - path: .

data/test/fixtures/process_recorder/hello.rb

@@ -0,0 +1,9 @@
+require 'appmap/record'
+
+class Hello
+  def say_hello
+    'Hello!'
+  end
+end
+
+Hello.new.say_hello