appmap 0.27.0 → 0.28.0

data/lib/appmap/cucumber.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'appmap/util'
+
+module AppMap
+  module Cucumber
+    ScenarioAttributes = Struct.new(:name, :feature, :feature_group)
+
+    ProviderStruct = Struct.new(:scenario) do
+      def feature_group
+        # e.g. <Cucumber::Core::Ast::Location::Precise: cucumber/api/features/authenticate.feature:1>
+        feature_path.split('/').last.split('.')[0]
+      end
+    end
+
+    # ProviderBefore4 provides scenario name, feature name, and feature group name for Cucumber
+    # versions before 4.0.
+    class ProviderBefore4 < ProviderStruct
+      def attributes
+        ScenarioAttributes.new(scenario.name, scenario.feature.name, feature_group)
+      end
+
+      def feature_path
+        scenario.feature.location.to_s
+      end
+    end
+
+    # Provider4 provides scenario name, feature name, and feature group name for Cucumber
+    # versions 4.0 and later.
+    class Provider4 < ProviderStruct
+      def attributes
+        ScenarioAttributes.new(scenario.name, scenario.name.split(' ')[0..1].join(' '), feature_group)
+      end
+
+      def feature_path
+        scenario.location.file
+      end
+    end
+
+    class << self
+      def write_scenario(scenario, appmap)
+        appmap['metadata'] = update_metadata(scenario, appmap['metadata'])
+        scenario_filename = AppMap::Util.scenario_filename(appmap['metadata']['name'])
+
+        FileUtils.mkdir_p 'tmp/appmap/cucumber'
+        File.write(File.join('tmp/appmap/cucumber', scenario_filename), JSON.generate(appmap))
+      end
+
+      def enabled?
+        ENV['APPMAP'] == 'true'
+      end
+
+      protected
+
+      def cucumber_version
+        Gem.loaded_specs['cucumber']&.version&.to_s
+      end
+
+      def provider(scenario)
+        major, = cucumber_version.split('.').map(&:to_i)
+        if major < 4
+          ProviderBefore4
+        else
+          Provider4
+        end.new(scenario)
+      end
+
+      def update_metadata(scenario, base_metadata)
+        attributes = provider(scenario).attributes
+
+        base_metadata.tap do |m|
+          m['name'] = attributes.name
+          m['feature'] = attributes.feature
+          m['feature_group'] = attributes.feature_group
+          m['labels'] ||= []
+          m['labels'] += (scenario.tags&.map(&:name) || [])
+          m['frameworks'] ||= []
+          m['frameworks'] << {
+            'name' => 'cucumber',
+            'version' => Gem.loaded_specs['cucumber']&.version&.to_s
+          }
+          m['recorder'] = {
+            'name' => 'cucumber'
+          }
+        end
+      end
+    end
+  end
+end

data/lib/appmap/hook.rb

@@ -115,7 +115,12 @@ module AppMap
                   [ method.owner.name, '#' ]
                 end
 
-              warn "AppMap: Hooking #{defined_class}#{method_symbol}#{method.name}" if LOG
+              method_display_name = "#{defined_class}#{method_symbol}#{method.name}"
+              # Don't try and trace the tracing method or there will be a stack overflow
+              # in the defined hook method.
+              next if method_display_name == "AppMap.tracing"
+
+              warn "AppMap: Hooking #{method_display_name}" if LOG
 
               cls.define_method method_id do |*args, &block|
                 base_method = method.bind(self).to_proc

data/lib/appmap/metadata.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module AppMap
+  module Metadata
+    class << self
+      def detect
+        {
+          app: AppMap.configuration.name,
+          language: {
+            name: 'ruby',
+            engine: RUBY_ENGINE,
+            version: RUBY_VERSION
+          },
+          client: {
+            name: 'appmap',
+            url: AppMap::URL,
+            version: AppMap::VERSION
+          }
+        }.tap do |m|
+          if defined?(::Rails)
+            m[:frameworks] ||= []
+            m[:frameworks] << {
+              name: 'rails',
+              version: ::Rails.version
+            }
+          end
+          m[:git] = git_metadata if git_available
+        end
+      end
+
+      protected
+
+      def git_available
+        @git_available = system('git status 2>&1 > /dev/null') if @git_available.nil?
+      end
+
+      def git_metadata
+        git_repo = `git config --get remote.origin.url`.strip
+        git_branch = `git rev-parse --abbrev-ref HEAD`.strip
+        git_sha = `git rev-parse HEAD`.strip
+        git_status = `git status -s`.split("\n").map(&:strip)
+        git_last_annotated_tag = `git describe --abbrev=0 2>/dev/null`.strip
+        git_last_annotated_tag = nil if git_last_annotated_tag.blank?
+        git_last_tag = `git describe --abbrev=0 --tags 2>/dev/null`.strip
+        git_last_tag = nil if git_last_tag.blank?
+        git_commits_since_last_annotated_tag = `git describe`.strip =~ /-(\d+)-(\w+)$/[1] rescue 0 if git_last_annotated_tag
+        git_commits_since_last_tag = `git describe --tags`.strip =~ /-(\d+)-(\w+)$/[1] rescue 0 if git_last_tag
+
+        {
+          repository: git_repo,
+          branch: git_branch,
+          commit: git_sha,
+          status: git_status,
+          git_last_annotated_tag: git_last_annotated_tag,
+          git_last_tag: git_last_tag,
+          git_commits_since_last_annotated_tag: git_commits_since_last_annotated_tag,
+          git_commits_since_last_tag: git_commits_since_last_tag
+        }
+      end
+    end
+  end
+end

data/lib/appmap/middleware/remote_recording.rb

@@ -5,12 +5,9 @@ module AppMap
     # RemoteRecording adds `/_appmap/record` routes to control recordings via HTTP requests
     class RemoteRecording
       def initialize(app)
-        require 'appmap/command/record'
         require 'json'
 
         @app = app
-        @config = AppMap.configure
-        AppMap::Hook.hook(@config)
       end
 
       def event_loop
@@ -63,15 +60,14 @@ module AppMap
         @events.delete_if(&is_control_command_event)
         @events.delete_if(&is_return_from_control_command_event)
 
-        require 'appmap/command/record'
-        metadata = AppMap::Command::Record.detect_metadata
+        metadata = AppMap.detect_metadata
         metadata[:recorder] = {
           name: 'remote_recording'
         }
 
         response = JSON.generate \
           version: AppMap::APPMAP_FORMAT_VERSION,
-          classMap: AppMap.class_map(@config, tracer.event_methods),
+          classMap: AppMap.class_map(tracer.event_methods),
           metadata: metadata,
           events: @events
 

data/lib/appmap/railtie.rb

@@ -5,8 +5,8 @@ module AppMap
   class Railtie < ::Rails::Railtie
     config.appmap = ActiveSupport::OrderedOptions.new
 
-    initializer 'appmap.init' do |_| #  params: app
-      AppMap.configure
+    initializer 'appmap.init' do |_| # params: app
+      require 'appmap'
     end
 
     # appmap.subscribe subscribes to ActiveSupport Notifications so that they can be recorded as

data/lib/appmap/rspec.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'appmap/util'
+
 module AppMap
   # Integration of AppMap with RSpec. When enabled with APPMAP=true, the AppMap tracer will
   # be activated around each scenario which has the metadata key `:appmap`.
@@ -8,10 +10,7 @@ module AppMap
     LOG = false
 
     def self.metadata
-      require 'appmap/command/record'
-      @metadata ||= AppMap::Command::Record.detect_metadata
-      @metadata.freeze
-      @metadata.deep_dup
+      AppMap.detect_metadata
     end
 
     module FeatureAnnotations
@@ -139,7 +138,7 @@ module AppMap
 
         AppMap::RSpec.add_event_methods @trace.event_methods
 
-        class_map = AppMap.class_map(AppMap::RSpec.config, @trace.event_methods)
+        class_map = AppMap.class_map(@trace.event_methods)
 
         description = []
         scope = ScopeExample.new(example)
@@ -190,7 +189,6 @@ module AppMap
     end
 
     @recordings_by_example = {}
-    @config = nil
     @event_methods = Set.new
 
     class << self
@@ -198,10 +196,6 @@ module AppMap
         warn 'Configuring AppMap recorder for RSpec'
 
         FileUtils.mkdir_p APPMAP_OUTPUT_DIR
-
-        require 'appmap/hook'
-        @config = AppMap.configure
-        AppMap::Hook.hook(@config)
       end
 
       def begin_spec(example)
@@ -226,7 +220,7 @@ module AppMap
       def save(example_name, class_map, events: nil, feature_name: nil, feature_group_name: nil, labels: nil)
         metadata = RSpec.metadata.tap do |m|
           m[:name] = example_name
-          m[:app] = @config.name
+          m[:app] = AppMap.configuration.name
           m[:feature] = feature_name if feature_name
           m[:feature_group] = feature_group_name if feature_group_name
           m[:labels] = labels if labels
@@ -246,13 +240,13 @@ module AppMap
           classMap: class_map,
           events: events
         }.compact
-        fname = sanitize_filename(example_name)
+        fname = AppMap::Util.scenario_filename(example_name)
 
-        File.write(File.join(APPMAP_OUTPUT_DIR, "#{fname}.appmap.json"), JSON.generate(appmap))
+        File.write(File.join(APPMAP_OUTPUT_DIR, fname), JSON.generate(appmap))
       end
 
       def print_inventory
-        class_map = AppMap.class_map(@config, @event_methods)
+        class_map = AppMap.class_map(@event_methods)
         save 'Inventory', class_map, labels: %w[inventory]
       end
 
@@ -266,28 +260,6 @@ module AppMap
           print_inventory
         end
       end
-
-      private
-
-      # Cribbed from v5 version of ActiveSupport:Inflector#parameterize:
-      # https://github.com/rails/rails/blob/v5.2.4/activesupport/lib/active_support/inflector/transliterate.rb#L92
-      def sanitize_filename(fname, separator: '_')
-        # Replace accented chars with their ASCII equivalents.
-        fname = fname.encode('utf-8', invalid: :replace, undef: :replace, replace: '_')
-
-        # Turn unwanted chars into the separator.
-        fname.gsub!(/[^a-z0-9\-_]+/i, separator)
-
-        re_sep = Regexp.escape(separator)
-        re_duplicate_separator        = /#{re_sep}{2,}/
-        re_leading_trailing_separator = /^#{re_sep}|#{re_sep}$/i
-
-        # No more than one of the separator in a row.
-        fname.gsub!(re_duplicate_separator, separator)
-
-        # Finally, Remove leading/trailing separator.
-        fname.gsub(re_leading_trailing_separator, '')
-      end
     end
   end
 end

data/lib/appmap/trace.rb

@@ -4,36 +4,36 @@ module AppMap
   module Trace
     ScopedMethod = Struct.new(:defined_class, :method)
 
-    class Tracers
+    class Tracing
       def initialize
-        @tracers = []
+        @Tracing = []
       end
 
       def empty?
-        @tracers.empty?
+        @Tracing.empty?
       end
 
       def trace(enable: true)
         Tracer.new.tap do |tracer|
-          @tracers << tracer
+          @Tracing << tracer
           tracer.enable if enable
         end
       end
 
       def enabled?
-        @tracers.any?(&:enabled?)
+        @Tracing.any?(&:enabled?)
       end
 
       def record_event(event, defined_class: nil, method: nil)
-        @tracers.each do |tracer|
+        @Tracing.each do |tracer|
           tracer.record_event(event, defined_class: defined_class, method: method)
         end
       end
 
       def delete(tracer)
-        return unless @tracers.member?(tracer)
+        return unless @Tracing.member?(tracer)
 
-        @tracers.delete(tracer)
+        @Tracing.delete(tracer)
         tracer.disable
       end
     end

data/lib/appmap/util.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module AppMap
+  module Util
+    class << self
+      # scenario_filename builds a suitable file name from a scenario name.
+      # Special characters are removed, and the file name is truncated to fit within
+      # shell limitations.
+      def scenario_filename(name, max_length: 255, separator: '_', extension: '.appmap.json')
+        # Cribbed from v5 version of ActiveSupport:Inflector#parameterize:
+        # https://github.com/rails/rails/blob/v5.2.4/activesupport/lib/active_support/inflector/transliterate.rb#L92
+        # Replace accented chars with their ASCII equivalents.
+
+        fname = name.encode('utf-8', invalid: :replace, undef: :replace, replace: '_')
+
+        # Turn unwanted chars into the separator.
+        fname.gsub!(/[^a-z0-9\-_]+/i, separator)
+
+        re_sep = Regexp.escape(separator)
+        re_duplicate_separator        = /#{re_sep}{2,}/
+        re_leading_trailing_separator = /^#{re_sep}|#{re_sep}$/i
+
+        # No more than one of the separator in a row.
+        fname.gsub!(re_duplicate_separator, separator)
+
+        # Finally, Remove leading/trailing separator.
+        fname.gsub!(re_leading_trailing_separator, '')
+
+        if (fname.length + extension.length) > max_length
+          require 'base64'
+          require 'digest'
+          fname_digest = Base64.urlsafe_encode64 Digest::MD5.digest(fname), padding: false
+          fname[max_length - fname_digest.length - extension.length - 1..-1] = [ '-', fname_digest ].join
+        end
+
+        [ fname, extension ].join
+      end
+    end
+  end
+end

data/lib/appmap/version.rb

@@ -3,7 +3,7 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.27.0'
+  VERSION = '0.28.0'
 
   APPMAP_FORMAT_VERSION = '1.2'
 end

data/spec/fixtures/rails_users_app/Gemfile

@@ -39,6 +39,7 @@ appmap_options = \
 gem 'appmap', appmap_options
 
 group :development, :test do
+  gem 'cucumber-rails', require: false
   gem 'rspec-rails'
   # Required for Sequel, since without ActiveRecord, the Rails transactional fixture support
   # isn't activated.

data/spec/fixtures/rails_users_app/features/api_users.feature

@@ -0,0 +1,13 @@
+Feature: /api/users
+
+  @appmap-disable
+  Scenario: A user can be created
+    When I create a user
+    Then the response status should be 201
+
+  Scenario: When a user is created, it should be in the user list
+    Given I create a user
+    And the response status should be 201
+    When I list the users
+    Then the response status should be 200
+    And the response should include the user

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

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'cucumber/rails'
+require 'appmap/cucumber'

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

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