appmap 0.25.2 → 0.28.1

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/cli_test.rb

@@ -59,7 +59,7 @@ class CLITest < Minitest::Test
 
     Method frequency:
     ----------------
-    2	Main.say_hello
+    1	Main.say_hello
     OUTPUT
   end
 
@@ -85,7 +85,7 @@ class CLITest < Minitest::Test
       "method_frequency": [
         {
           "name": "Main.say_hello",
-          "count": 2
+          "count": 1
         }
       ]
     }
@@ -113,17 +113,4 @@ class CLITest < Minitest::Test
     assert_includes output, %("location":"lib/cli_record_test/main.rb:3")
     assert !File.file?(OUTPUT_FILENAME), "#{OUTPUT_FILENAME} should not exist"
   end
-
-  def test_upload
-    Dir.chdir 'test/fixtures/cli_record_test' do
-      `#{File.expand_path '../exe/appmap', __dir__} record -o #{OUTPUT_FILENAME} ./lib/cli_record_test/main.rb`
-    end
-
-    upload_output = `./exe/appmap upload --org default --user admin --no-open #{OUTPUT_FILENAME}`
-    assert_equal 0, $CHILD_STATUS.exitstatus
-    # Example: 93e1e07d-4b39-49ac-82bf-27d63e296cae
-    assert_match(/Scenario Id/, upload_output)
-    assert_match(/Batch Id/, upload_output)
-    assert_match(/[0-9a-f]+\-[0-9a-f\-]+/, upload_output)
-  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

data/test/fixtures/rspec_recorder/Gemfile

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

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

@@ -3,6 +3,18 @@ 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

data/test/rspec_test.rb

@@ -9,6 +9,7 @@ class RSpecTest < Minitest::Test
     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))
 
@@ -48,6 +49,10 @@ class RSpecTest < Minitest::Test
       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
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.25.2
+  version: 0.28.1
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-04 00:00:00.000000000 Z
+date: 2020-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -269,15 +269,17 @@ files:
 - lib/appmap/class_map.rb
 - lib/appmap/command/record.rb
 - lib/appmap/command/stats.rb
-- lib/appmap/command/upload.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
@@ -302,10 +304,10 @@ files:
 - spec/abstract_controller_base_spec.rb
 - spec/config_spec.rb
 - spec/fixtures/hook/attr_accessor.rb
-- spec/fixtures/hook/class_method.rb
 - spec/fixtures/hook/constructor.rb
 - spec/fixtures/hook/exception_method.rb
 - spec/fixtures/hook/instance_method.rb
+- spec/fixtures/hook/singleton_method.rb
 - spec/fixtures/rack_users_app/.dockerignore
 - spec/fixtures/rack_users_app/.gitignore
 - spec/fixtures/rack_users_app/Dockerfile
@@ -437,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
@@ -453,9 +459,25 @@ 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/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

data/lib/appmap/command/upload.rb

@@ -1,101 +0,0 @@
-# frozen_string_literal: true
-
-require 'json'
-require 'faraday'
-
-module AppMap
-  module Command
-    UploadResponse = Struct.new(:batch_id, :scenario_uuid)
-
-    UploadStruct = Struct.new(:data, :url, :user, :org)
-    class Upload < UploadStruct
-      MAX_DEPTH = 12
-
-      attr_accessor :batch_id
-
-      def initialize(data, url, user, org)
-        super
-
-        # TODO: Make this an option
-        @max_depth = MAX_DEPTH
-      end
-
-      def perform
-        appmap = data.clone
-
-        events = data.delete('events')
-        class_map = data.delete('classMap') || []
-
-        unless events.blank?
-          pruned_events = []
-          stack = []
-          events.each do |evt|
-            if evt['event'] == 'call'
-              stack << evt
-              stack_depth = stack.length
-            else
-              stack_depth = stack.length
-              stack.pop
-            end
-
-            prune = stack_depth > @max_depth
-
-            pruned_events << evt unless prune
-          end
-
-          warn "Pruned events to #{pruned_events.length}" if events.length > pruned_events.length
-
-          appmap[:events] = pruned_events
-          appmap[:classMap] = prune(class_map, events: pruned_events)
-        else
-          appmap[:events] = []
-          appmap[:classMap] = prune(class_map)
-        end
-
-        upload_file = { user: user, org: org, data: appmap }.compact
-
-        conn = Faraday.new(url: url)
-        response = conn.post do |req|
-          req.url '/api/scenarios'
-          req.headers['Content-Type'] = 'application/json'
-          req.headers[AppMap::BATCH_HEADER_NAME] = @batch_id if @batch_id
-          req.body = JSON.generate(upload_file)
-        end
-
-        unless response.body.blank?
-          message = begin
-                      JSON.parse(response.body)
-                    rescue JSON::ParserError => e
-                      warn "Response is not valid JSON (#{e.message})"
-                      nil
-                    end
-        end
-
-        unless response.success?
-          error = [ 'Upload failed' ]
-          error << ": #{message}" if message
-          raise error.join
-        end
-
-        batch_id = @batch_id || response.headers[AppMap::BATCH_HEADER_NAME]
-
-        uuid = message['uuid']
-        UploadResponse.new(batch_id, uuid)
-      end
-
-      protected
-
-      def debug?
-        ENV['DEBUG'] == 'true' || ENV['GLI_DEBUG'] == 'true'
-      end
-
-      def prune(class_map, events: nil)
-        require 'appmap/algorithm/prune_class_map'
-        Algorithm::PruneClassMap.new(class_map).tap do |alg|
-          alg.events = events if events
-          alg.logger = ->(msg) { warn msg } if debug?
-        end.perform
-      end
-    end
-  end
-end