appmap 0.27.0 → 0.28.0

data/spec/fixtures/rails_users_app/features/support/steps.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+When 'I create a user' do
+  @response = post '/api/users', login: 'alice'
+end
+
+Then(/the response status should be (\d+)/) do |status|
+  expect(@response.status).to eq(status.to_i)
+end
+
+When 'I list the users' do
+  @response = get '/api/users'
+  @users = JSON.parse(@response.body)
+end
+
+Then 'the response should include the user' do
+  expect(@users.map { |u| u['login'] }).to include('alice')
+end

data/spec/hook_spec.rb

@@ -31,8 +31,10 @@ describe 'AppMap class Hooking' do
   end
 
   def invoke_test_file(file, &block)
+    AppMap.configuration = nil
     package = AppMap::Hook::Package.new(file, [])
     config = AppMap::Hook::Config.new('hook_spec', [ package ])
+    AppMap.configuration = config
     AppMap::Hook.hook(config)
 
     tracer = AppMap.tracing.trace
@@ -55,6 +57,10 @@ describe 'AppMap class Hooking' do
     [ config, tracer ]
   end
 
+  after do
+    AppMap.configuration = nil
+  end
+
   it 'hooks an instance method that takes no arguments' do
     events_yaml = <<~YAML
     ---
@@ -90,10 +96,10 @@ describe 'AppMap class Hooking' do
   end
 
   it 'builds a class map of invoked methods' do
-    config, tracer = invoke_test_file 'spec/fixtures/hook/instance_method.rb' do
+    _, tracer = invoke_test_file 'spec/fixtures/hook/instance_method.rb' do
       InstanceMethod.new.say_default
     end
-    class_map = AppMap.class_map(config, tracer.event_methods).to_yaml
+    class_map = AppMap.class_map(tracer.event_methods).to_yaml
     expect(Diffy::Diff.new(class_map, <<~YAML).to_s).to eq('')
     ---
     - :name: spec/fixtures/hook/instance_method.rb

data/spec/rails_spec_helper.rb

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

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 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/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.27.0
+  version: 0.28.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-17 00:00:00.000000000 Z
+date: 2020-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -269,14 +269,17 @@ files:
 - lib/appmap/class_map.rb
 - lib/appmap/command/record.rb
 - lib/appmap/command/stats.rb
+- lib/appmap/cucumber.rb
 - lib/appmap/event.rb
 - lib/appmap/hook.rb
+- lib/appmap/metadata.rb
 - lib/appmap/middleware/remote_recording.rb
 - lib/appmap/rails/action_handler.rb
 - lib/appmap/rails/sql_handler.rb
 - lib/appmap/railtie.rb
 - lib/appmap/rspec.rb
 - lib/appmap/trace.rb
+- lib/appmap/util.rb
 - lib/appmap/version.rb
 - lore/pages/2019-05-21-install-and-record/index.pug
 - lore/pages/2019-05-21-install-and-record/install_example_appmap.png
@@ -436,6 +439,10 @@ files:
 - spec/fixtures/rails_users_app/db/migrate/20190728211408_create_users.rb
 - spec/fixtures/rails_users_app/db/schema.rb
 - spec/fixtures/rails_users_app/docker-compose.yml
+- spec/fixtures/rails_users_app/features/api_users.feature
+- spec/fixtures/rails_users_app/features/support/env.rb
+- spec/fixtures/rails_users_app/features/support/hooks.rb
+- spec/fixtures/rails_users_app/features/support/steps.rb
 - spec/fixtures/rails_users_app/lib/tasks/.keep
 - spec/fixtures/rails_users_app/log/.keep
 - spec/fixtures/rails_users_app/public/robots.txt
@@ -452,9 +459,26 @@ files:
 - spec/remote_recording_spec.rb
 - spec/rspec_feature_metadata_spec.rb
 - spec/spec_helper.rb
+- spec/util_spec.rb
 - test/cli_test.rb
+- test/cucumber_test.rb
 - test/fixtures/cli_record_test/appmap.yml
 - test/fixtures/cli_record_test/lib/cli_record_test/main.rb
+- test/fixtures/cucumber4_recorder/Gemfile
+- test/fixtures/cucumber4_recorder/appmap.yml
+- test/fixtures/cucumber4_recorder/features/say_hello.feature
+- test/fixtures/cucumber4_recorder/features/support/env.rb
+- test/fixtures/cucumber4_recorder/features/support/hooks.rb
+- test/fixtures/cucumber4_recorder/features/support/steps.rb
+- test/fixtures/cucumber4_recorder/lib/hello.rb
+- test/fixtures/cucumber_recorder/.bundle/config
+- test/fixtures/cucumber_recorder/Gemfile
+- test/fixtures/cucumber_recorder/appmap.yml
+- test/fixtures/cucumber_recorder/features/say_hello.feature
+- test/fixtures/cucumber_recorder/features/support/env.rb
+- test/fixtures/cucumber_recorder/features/support/hooks.rb
+- test/fixtures/cucumber_recorder/features/support/steps.rb
+- test/fixtures/cucumber_recorder/lib/hello.rb
 - test/fixtures/rspec_recorder/Gemfile
 - test/fixtures/rspec_recorder/appmap.yml
 - test/fixtures/rspec_recorder/lib/hello.rb