appmap 0.34.0 → 0.34.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47030df4910179ac636b8a2c4c3c29c25225deb1b9cbce851264d1e2ae8dacf1
-  data.tar.gz: 84bc3de36a1f7700fe32128c40f8d2bf6d698208689e856fd2bc696c38be6500
+  metadata.gz: 39576d59d2648a009f888fa9c5720d8fdb91b04fcb4d08949a05a0a5c453d0c8
+  data.tar.gz: 8b1d5442421d9dd37c3db4fa0329321e6b6e6ebc87e94bb67be3da9b3f1467b0
 SHA512:
-  metadata.gz: 98d8933599f9cdb39d2ab9d69d1c11c7f06972603c30b5d79b3c57dc2ec246aec2c432da4835bcab805d49ec17e757fc0377d583908c6894380e951071b2d797
-  data.tar.gz: eefe2496acc6be7ebfe20eee2ab9ed0e708658a039c196757dd00ca18351e0425d3a6d1f0599cca37bd4a2c786469d61fdc7ad0e50a56d9223360204e2bc4206
+  metadata.gz: 40bc1a630b65a83f7516085ec4cd25a72f83e574a9c2f150f8e302c9756c376a1fc820d490393d9625aeb3f5b781ca44d34431efe2722a7a0031b49334ccbca7
+  data.tar.gz: 9d32eb02deebdfb16e99ee0f157f5c9de6cb77cafa46233867e0173577609d4390b98a675f67c11868d57370066666bf9f9da39b2ee2ab25ba16cbaf4ebcd8ca

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# v0.34.1
+* Ensure that capturing events doesn't change the behavior of a hooked method that uses
+  `Time.now`. For example, if a test expects that `Time.now` will be called a certain
+  number of times by a hooked method, that expectation will now be met.
+* Make sure `appmap/cucumber` requires `appmap`.
+
 # v0.34.0
 
 * Records builtin security and I/O methods from `OpenSSL`, `Net`, and `IO`.

data/appmap.gemspec

@@ -42,4 +42,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'selenium-webdriver'
   spec.add_development_dependency 'webdrivers', '~> 4.0'
+  spec.add_development_dependency 'timecop'
 end

data/lib/appmap/cucumber.rb

@@ -4,6 +4,8 @@ require 'appmap/util'
 
 module AppMap
   module Cucumber
+    APPMAP_OUTPUT_DIR = 'tmp/appmap/cucumber'
+    
     ScenarioAttributes = Struct.new(:name, :feature, :feature_group)
 
     ProviderStruct = Struct.new(:scenario) do
@@ -38,18 +40,27 @@ module AppMap
     end
 
     class << self
+      def init
+        warn 'Configuring AppMap recorder for Cucumber'
+
+        FileUtils.mkdir_p APPMAP_OUTPUT_DIR
+      end
+      
       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))
+        File.write(File.join(APPMAP_OUTPUT_DIR, scenario_filename), JSON.generate(appmap))
       end
 
       def enabled?
         ENV['APPMAP'] == 'true'
       end
 
+      def run
+        init
+      end
+      
       protected
 
       def cucumber_version
@@ -87,3 +98,9 @@ module AppMap
     end
   end
 end
+
+if AppMap::Cucumber.enabled?
+  require 'appmap'
+
+  AppMap::Cucumber.run
+end

data/lib/appmap/hook/method.rb

@@ -6,6 +6,11 @@ module AppMap
       HOOK_DISABLE_KEY = 'AppMap::Hook.disable'
       private_constant :HOOK_DISABLE_KEY
 
+      # Grab the definition of Time.now here, to avoid interfering
+      # with the method we're hooking.
+      TIME_NOW = Time.method(:now)
+      private_constant :TIME_NOW
+      
       def initialize(hook_class, hook_method)
         @hook_class = hook_class
         @hook_method = hook_method
@@ -52,12 +57,12 @@ module AppMap
         require 'appmap/event'
         call_event = AppMap::Event::MethodCall.build_from_invocation(defined_class, hook_method, receiver, args)
         AppMap.tracing.record_event call_event, defined_class: defined_class, method: hook_method
-        [ call_event, Time.now ]
+        [ call_event, TIME_NOW.call ]
       end
 
       def after_hook(call_event, start_time, return_value, exception)
         require 'appmap/event'
-        elapsed = Time.now - start_time
+        elapsed = TIME_NOW.call - start_time
         return_event = \
           AppMap::Event::MethodReturn.build_from_invocation call_event.id, elapsed, return_value, exception
         AppMap.tracing.record_event return_event

data/lib/appmap/version.rb

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

data/spec/fixtures/hook/instance_method.rb

@@ -20,4 +20,8 @@ class InstanceMethod
   def say_block(&block)
     yield
   end
+
+  def say_the_time
+    Time.now.to_s
+  end
 end

data/spec/hook_spec.rb

@@ -599,4 +599,40 @@ describe 'AppMap class Hooking', docker: false do
       expect(Diffy::Diff.new(classmap_yaml, cm.to_yaml).to_s).to eq('')
     end
   end
+
+  it "doesn't cause expectations on Time.now to fail" do
+    events_yaml = <<~YAML
+    ---
+    - :id: 1
+      :event: :call
+      :defined_class: InstanceMethod
+      :method_id: say_the_time
+      :path: spec/fixtures/hook/instance_method.rb
+      :lineno: 24
+      :static: false
+      :parameters: []
+      :receiver:
+        :class: InstanceMethod
+        :value: Instance Method fixture
+    - :id: 2
+      :event: :return
+      :parent_id: 1
+      :return_value:
+        :class: String
+        :value: '2020-01-01 00:00:00 +0000'
+    YAML
+    test_hook_behavior 'spec/fixtures/hook/instance_method.rb', events_yaml do
+      require 'timecop'
+      begin
+        tz = ENV['TZ']
+        ENV['TZ'] = 'UTC'
+        Timecop.freeze(Time.utc('2020-01-01')) do
+          expect(Time).to receive(:now).exactly(3).times.and_call_original
+          expect(InstanceMethod.new.say_the_time).to be
+        end
+      ensure
+        ENV['TZ'] = tz
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.34.0
+  version: 0.34.1
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-21 00:00:00.000000000 Z
+date: 2020-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -248,6 +248,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - kgilpin@gmail.com