appmap 0.31.0

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/cli_record_test/appmap.yml

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

data/test/fixtures/cli_record_test/lib/cli_record_test/main.rb

@@ -0,0 +1,9 @@
+class Main
+  class << self
+    def say_hello
+      puts 'Hello'
+    end
+  end
+end
+
+Main.say_hello

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

data/test/fixtures/rspec_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 'rspec'

data/test/fixtures/rspec_recorder/appmap.yml

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

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

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

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

@@ -0,0 +1,21 @@
+require 'rspec'
+require 'appmap/rspec'
+require 'hello'
+
+describe Hello, feature_group: 'Saying hello' do
+  before do
+    # Trick appmap-ruby into thinking we're a Rails app.
+    stub_const('Rails', double('rails', version: 'fake.0'))
+  end
+
+  # 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
+    expect(Hello.new.say_hello).not_to eq('Goodbye!')
+  end
+
+  it 'says hello', feature: 'Speak hello', appmap: true do
+    expect(Hello.new.say_hello).to eq('Hello!')
+  end
+end

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

@@ -0,0 +1,9 @@
+require 'rspec'
+require 'appmap/rspec'
+require 'hello'
+
+describe Hello, appmap: 'hello' do
+  it 'says hello', appmap: 'speak' do
+    expect(Hello.new.say_hello).to eq('Hello!')
+  end
+end

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

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

data/test/minitest_test.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'English'
+
+class MinitestTest < Minitest::Test
+  def perform_test(test_name)
+    Bundler.with_clean_env do
+      Dir.chdir 'test/fixtures/minitest_recorder' do
+        FileUtils.rm_rf 'tmp'
+        system 'bundle config --local local.appmap ../../..'
+        system 'bundle'
+        system({ 'APPMAP' => 'true' }, %(bundle exec ruby -Ilib -Itest test/#{test_name}_test.rb))
+
+        yield
+      end
+    end
+  end
+
+  def test_hello
+    perform_test 'hello' do
+      appmap_file = 'tmp/appmap/minitest/Hello_hello.appmap.json'
+
+      assert File.file?(appmap_file), 'appmap output file does not exist'
+      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 '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']
+    end
+  end
+end

data/test/record_process_test.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'English'
+
+class RecordProcessTest < Minitest::Test
+  def perform_test(program_name)
+    Bundler.with_clean_env do
+      Dir.chdir 'test/fixtures/process_recorder' do
+        FileUtils.rm_rf 'tmp'
+        system 'bundle config --local local.appmap ../../..'
+        system 'bundle'
+        system(%(bundle exec ruby #{program_name}))
+
+        yield
+      end
+    end
+  end
+
+  def test_hello
+    perform_test 'hello.rb' do
+      appmap_file = 'appmap.json'
+
+      assert File.file?(appmap_file), 'appmap output file does not exist'
+      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 'process_recorder', metadata['app']
+      assert_equal 'record_process', metadata['recorder']['name']
+      assert_equal 'ruby', metadata['language']['name']
+    end
+  end
+end

data/test/rspec_test.rb

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'English'
+
+class RSpecTest < Minitest::Test
+  def perform_test(test_name)
+    Bundler.with_clean_env do
+      Dir.chdir 'test/fixtures/rspec_recorder' do
+        FileUtils.rm_rf 'tmp'
+        system 'bundle config --local local.appmap ../../..'
+        system 'bundle'
+        system({ 'APPMAP' => 'true' }, %(bundle exec rspec spec/#{test_name}.rb))
+
+        yield
+      end
+    end
+  end
+
+  def test_inventory
+    perform_test 'plain_hello_spec' do
+      appmap_file = 'tmp/appmap/rspec/Inventory.appmap.json'
+
+      assert File.file?(appmap_file), 'appmap output file does not exist'
+      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 'Inventory', metadata['name']
+      assert_includes metadata.keys, 'labels'
+      assert_equal metadata['labels'], %w[inventory]
+    end
+  end
+
+  def test_record_decorated_rspec
+    perform_test 'decorated_hello_spec' do
+      appmap_file = 'tmp/appmap/rspec/Hello_says_hello.appmap.json'
+
+      assert File.file?(appmap_file), 'appmap output file does not exist'
+      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 'Saying hello', metadata['feature_group']
+      assert_equal 'Speak hello', metadata['feature']
+      assert_equal 'Hello says 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: 'rspec' }.stringify_keys, metadata['recorder'])
+
+      assert_includes metadata.keys, 'frameworks'
+      rspec = metadata['frameworks'].select {|f| f['name'] == 'rspec'}
+      assert_equal 1, rspec.count
+    end
+  end
+
+  def test_record_plain_rspec
+    perform_test 'plain_hello_spec' do
+      appmap_file = 'tmp/appmap/rspec/Hello_says_hello.appmap.json'
+      assert File.file?(appmap_file), 'appmap output file does not exist'
+      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
+
+  def test_record_labeled_rspec
+    perform_test 'labeled_hello_spec' do
+      appmap_file = 'tmp/appmap/rspec/Hello_says_hello.appmap.json'
+      assert File.file?(appmap_file), 'appmap output file does not exist'
+      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