poise-profiler 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49c8eb66b3fe44be2c98d12116db4f5857beb630
-  data.tar.gz: fd85bde56d734b842283b9244f8ab4e89654b287
+  metadata.gz: e984488349e52e2006619ea29e69fc5392eecacc
+  data.tar.gz: f5ce15b89376f591c8c1f193b14240349572d956
 SHA512:
-  metadata.gz: 2031781bcd4e85f76f0032ff32466aa231b658f2326abda476248040e26a447f76e0a6efcc3397c52f2f1aa8bb9bd00cdb80f7522c891d8e4d21f00a4aae1d98
-  data.tar.gz: 1b9964024659e600d5adcb63b90f6a574f4ffba3fc0e73279d813ca2d5f2c78cacf9f2317b54fac96b3c44e050c96c9ea0e455050f212e43ed8301aabd6a5d23
+  metadata.gz: 3b1d594912bd19a629f1fe57f24ef874273c15efd6940d98fe437f180f04c69d77fe894a86e167207724f337b646d2362fc5ef9af59ee5f7fff608183d264e94
+  data.tar.gz: 0a621221e1d9aa4c8ab957265a2a303e2a694618ffae8d7f71f7a1e243dc5fa79c00079c86698728977052234d7cd37c199ef9225a274bd656d697f6d0f50b4c

data/.travis.yml

@@ -1,22 +1,66 @@
 sudo: false
 cache: bundler
 language: ruby
-rvm:
-- '2.2'
 env:
   global:
-  - secure: DxJdl4xHPBB3mdM2c0qhdjpxEkWuv0vF9MFrrblSjM3VF5kIkkhSRG+zvyJNg2u+zu76XCEvf+pEt2Ltsl7TzY/AdkeyyhEX2JxcPMkAl5KJmssEQPHkkLowTCK4rfVuakCDjkuXRReSdfH3vBSAX1/SqUZelVZjNV4AZcGHykv5WE0hBmOMGuY9mmsZyg7f91vifCGWk+7SexF+jcuqQh7ZKeJiLcERMdS2K568zkOYZyHXaS+31ic5HW3Jfh929+chg0iSCXL7xhCoUFF4K/aUfi/40LVVHAnBVi0NT/79/KbQBKvYYsCPr0Bw4QqVfRuz6Puxf0FWpLmuRdj1gxvHRKJ18PoKXdET+XsORJV+Qs0EXATR+bzqT9hXSJ16DEaJn8Sx4bA9YqDlBSSGwHqlLj3ql78e5UqkG4yHSLPTjz1uDA+56ZadTLliWR6uFna4HSPx8T4z7FSYMqoLS2Z59I3/JhZ/aSlEnW4FVpQW5XXxz1KVFnOHoz9gGHq+uJChFaAM2mq1MlXzbflpnLe3D/2k2daC0ss4dRrE2jplqpDWwjSK4CrXNRjKiiDr/KScgFYPz7wNg1Acq2hbYXx5J/pTi+sSjZjEUtXRTVzutm9KgLNPlz/MmUamd1maK9APhFdlrOTGFF4fXgE5OeVcSz+lF+Zi8qiXxfUFuvQ=
-before_install: "gem install bundler"
-bundler_args: "--binstubs=$PWD/bin --jobs 3 --retry 3"
+    - secure: DxJdl4xHPBB3mdM2c0qhdjpxEkWuv0vF9MFrrblSjM3VF5kIkkhSRG+zvyJNg2u+zu76XCEvf+pEt2Ltsl7TzY/AdkeyyhEX2JxcPMkAl5KJmssEQPHkkLowTCK4rfVuakCDjkuXRReSdfH3vBSAX1/SqUZelVZjNV4AZcGHykv5WE0hBmOMGuY9mmsZyg7f91vifCGWk+7SexF+jcuqQh7ZKeJiLcERMdS2K568zkOYZyHXaS+31ic5HW3Jfh929+chg0iSCXL7xhCoUFF4K/aUfi/40LVVHAnBVi0NT/79/KbQBKvYYsCPr0Bw4QqVfRuz6Puxf0FWpLmuRdj1gxvHRKJ18PoKXdET+XsORJV+Qs0EXATR+bzqT9hXSJ16DEaJn8Sx4bA9YqDlBSSGwHqlLj3ql78e5UqkG4yHSLPTjz1uDA+56ZadTLliWR6uFna4HSPx8T4z7FSYMqoLS2Z59I3/JhZ/aSlEnW4FVpQW5XXxz1KVFnOHoz9gGHq+uJChFaAM2mq1MlXzbflpnLe3D/2k2daC0ss4dRrE2jplqpDWwjSK4CrXNRjKiiDr/KScgFYPz7wNg1Acq2hbYXx5J/pTi+sSjZjEUtXRTVzutm9KgLNPlz/MmUamd1maK9APhFdlrOTGFF4fXgE5OeVcSz+lF+Zi8qiXxfUFuvQ=
+before_install:
+  - 'if [[ $BUNDLE_GEMFILE == *master.gemfile ]]; then gem update --system; fi'
+  - gem --version
+  - gem install bundler
+  - bundle --version
+  - 'bundle config --local path ${BUNDLE_PATH:-$(dirname $BUNDLE_GEMFILE)/vendor/bundle}'
+  - bundle config --local bin $PWD/bin
+install: bundle update --jobs=3 --retry=3
 script:
-- "./bin/rake travis"
-gemfile:
-- test/gemfiles/chef-12.gemfile
-- test/gemfiles/chef-12.0.gemfile
-- test/gemfiles/chef-12.1.gemfile
-- test/gemfiles/chef-12.2.gemfile
-- test/gemfiles/chef-12.3.gemfile
-- test/gemfiles/chef-12.4.gemfile
-- test/gemfiles/chef-12.5.gemfile
-- test/gemfiles/chef-12.6.gemfile
-- test/gemfiles/master.gemfile
+  - ./bin/rake travis
+matrix:
+  include:
+    - rvm: 2.3.1
+      gemfile: test/gemfiles/chef-12.gemfile
+    - rvm: 2.4.1
+      gemfile: test/gemfiles/chef-13.gemfile
+    - rvm: 2.1.4
+      gemfile: test/gemfiles/chef-12.0.gemfile
+    - rvm: 2.1.4
+      gemfile: test/gemfiles/chef-12.1.gemfile
+    - rvm: 2.1.4
+      gemfile: test/gemfiles/chef-12.2.gemfile
+    - rvm: 2.1.4
+      gemfile: test/gemfiles/chef-12.3.gemfile
+    - rvm: 2.1.6
+      gemfile: test/gemfiles/chef-12.4.gemfile
+    - rvm: 2.1.6
+      gemfile: test/gemfiles/chef-12.5.gemfile
+    - rvm: 2.1.6
+      gemfile: test/gemfiles/chef-12.6.gemfile
+    - rvm: 2.1.6
+      gemfile: test/gemfiles/chef-12.7.gemfile
+    - rvm: 2.1.6
+      gemfile: test/gemfiles/chef-12.8.gemfile
+    - rvm: 2.1.8
+      gemfile: test/gemfiles/chef-12.9.gemfile
+    - rvm: 2.1.8
+      gemfile: test/gemfiles/chef-12.10.gemfile
+    - rvm: 2.1.8
+      gemfile: test/gemfiles/chef-12.11.gemfile
+    - rvm: 2.1.8
+      gemfile: test/gemfiles/chef-12.12.gemfile
+    - rvm: 2.1.9
+      gemfile: test/gemfiles/chef-12.13.gemfile
+    - rvm: 2.3.1
+      gemfile: test/gemfiles/chef-12.14.gemfile
+    - rvm: 2.3.1
+      gemfile: test/gemfiles/chef-12.15.gemfile
+    - rvm: 2.3.1
+      gemfile: test/gemfiles/chef-12.16.gemfile
+    - rvm: 2.3.1
+      gemfile: test/gemfiles/chef-12.17.gemfile
+    - rvm: 2.3.1
+      gemfile: test/gemfiles/chef-12.18.gemfile
+    - rvm: 2.3.1
+      gemfile: test/gemfiles/chef-12.19.gemfile
+    - rvm: 2.4.1
+      gemfile: test/gemfiles/chef-13.0.gemfile
+    - rvm: 2.4.1
+      gemfile: test/gemfiles/master.gemfile

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Poise-Profiler Changelog
 
+## v1.1.0
+
+* Chef 13 support.
+* A variety of internal refactoring to support more profiling plugins than just
+  timing.
+
 ## v1.0.1
 
 * Only display JSON on CI. This can be set via either an environment variable or

data/Gemfile

@@ -29,4 +29,4 @@ end
 
 dev_gem 'halite'
 dev_gem 'poise'
-dev_gem 'poise-boiler', github: 'poise/poise-boiler'
+dev_gem 'poise-boiler'

data/README.md

@@ -14,7 +14,7 @@ Based on [chef-handler-profiler](https://github.com/joemiller/chef-handler-profi
 by Joe Miller.
 
 ```
-Poise Profiler:
+Poise Profiler Timing:
 Time          Resource
 ------------  -------------
     1.018142  execute[sleep 1]

data/lib/poise_profiler.rb

@@ -16,6 +16,7 @@
 
 
 module PoiseProfiler
-  autoload :Handler, 'poise_profiler/handler'
+  autoload :Config, 'poise_profiler/config'
+  autoload :Timing, 'poise_profiler/timing'
   autoload :VERSION, 'poise_profiler/version'
 end

data/lib/poise_profiler/base.rb

@@ -0,0 +1,121 @@
+#
+# Copyright 2016, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'chef/config'
+require 'chef/event_dispatch/base'
+require 'chef/json_compat'
+require 'chef/version'
+
+begin
+  require 'chef/chef_class'
+rescue LoadError
+  # ¯\_(ツ)_/¯ Chef < 12.3.
+end
+
+module PoiseProfiler
+  # Base class for poise-provider event handlers.
+  #
+  # @api private
+  # @since 1.1.0
+  class Base < Chef::EventDispatch::Base
+    include Singleton
+
+    # Install this event handler in to Chef.
+    #
+    # @return [void]
+    def self.install!
+      # Clear instance state to be safe.
+      instance.reset!
+      # For pre-Chef.run_context, use the monkey patch. Otherwise use the
+      # events API or global config.
+      if Gem::Version.create(Chef::VERSION) <= Gem::Version.create('12.2.1')
+        Chef::Log.debug("Registering poise-profiler handler #{self} using monkey patch")
+        instance._monkey_patch_old_chef!
+      elsif Chef.run_context && Chef.run_context.events
+        # :nocov:
+        Chef::Log.debug("Registering poise-profiler handler #{self} using events API")
+        Chef.run_context.events.register(instance)
+        # :nocov:
+      else
+        Chef::Log.debug("Registering poise-profiler handler #{self} using global config")
+        Chef::Config[:event_handlers] |= [instance]
+      end
+    end
+
+    # Used in {#_monkey_patch_old_chef}.
+    #
+    # @api private
+    attr_writer :events, :monkey_patched
+
+    # Hook to reset the handler for testing.
+    #
+    # @api private
+    # @return [void]
+    def reset!
+      @events = nil
+    end
+
+    # Inject this instance for Chef < 12.3. Don't call this on newer Chef.
+    #
+    # @api private
+    # @see Base.install
+    # @return [void]
+    def _monkey_patch_old_chef!
+      require 'chef/event_dispatch/dispatcher'
+      instance = self
+      orig_method = Chef::EventDispatch::Dispatcher.instance_method(:library_file_loaded)
+      Chef::EventDispatch::Dispatcher.send(:define_method, :library_file_loaded) do |filename|
+        instance.events = self
+        instance.monkey_patched = false
+        @subscribers |= [instance]
+        Chef::EventDispatch::Dispatcher.send(:define_method, :library_file_loaded, orig_method)
+        orig_method.bind(self).call(filename)
+      end
+    end
+
+    private
+
+    # Convenience helper to print a line of text out via the event handler.
+    #
+    # @api private
+    # @param line [String] Line to display.
+    # @return [void]
+    def puts(line)
+      events.stream_output(:profiler, line+"\n")
+    end
+
+    # Accessor for the current global event handler. The is either set via
+    # {#_monkey_patch_old_chef} (<= 12.2.1) or retrieved via the global API (>=
+    # 12.3).
+    #
+    # @api private
+    # return [Chef::EventDispatch::Dispatcher]
+    def events
+      @events ||= Chef.run_context.events
+    end
+
+    # Accessor for the profiler config.
+    #
+    # @api private
+    # @return [PoiseProfiler::Config]
+    def config
+      # This could be a single global but it doesn't use enough RAM or CPU
+      # cycles that I care.
+      @config ||= PoiseProfiler::Config.new
+    end
+
+  end
+end

data/lib/poise_profiler/cheftie.rb

@@ -14,24 +14,8 @@
 # limitations under the License.
 #
 
-begin
-  require 'chef/chef_class'
-rescue LoadError
-  # ¯\_(ツ)_/¯ Chef < 12.3.
-end
-require 'chef/config'
-require 'poise_profiler/handler'
+require 'poise_profiler'
+require 'poise_profiler/core_ext'
 
-# Install the handler.
-if Gem::Version.create(Chef::VERSION) <= Gem::Version.create('12.2.1')
-  Chef::Log.debug('Registering poise-profiler using monkey patch')
-  PoiseProfiler::Handler.instance.monkey_patch_old_chef!
-elsif Chef.run_context && Chef.run_context.events
-  # :nocov:
-  Chef::Log.debug('Registering poise-profiler using events api')
-  Chef.run_context.events.register(PoiseProfiler::Handler.instance)
-  # :nocov:
-else
-  Chef::Log.debug('Registering poise-profiler using global config')
-  Chef::Config[:event_handlers] << PoiseProfiler::Handler.instance
-end
+# Install the handlers.
+PoiseProfiler::Timing.install!

data/lib/poise_profiler/config.rb

@@ -0,0 +1,68 @@
+#
+# Copyright 2016, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'yaml'
+
+require 'chef/mash'
+begin
+  require 'chef/chef_class'
+rescue LoadError
+  # ¯\_(ツ)_/¯ Chef < 12.3.
+end
+
+
+module PoiseProfiler
+  # Configuration wrapper for poise-profiler to combine input from a number of
+  # sources.
+  #
+  # @since 1.1.0
+  # @api private
+  # @example
+  #   cfg = Config.new
+  #   puts cfg[:profile_memory]
+  class Config < Mash
+    def initialize
+      super
+      gather_from_env
+      gather_from_node
+    end
+
+    private
+
+    # Find configuration data in environment variables. This is the only option
+    # on Chef 12.0, 12.1, and 12.2.
+    #
+    # @api private
+    def gather_from_env
+      ENV.each do |key, value|
+        if key.downcase =~ /^poise(_|-)profiler_(.+)$/
+          self[$2] = YAML.safe_load(value)
+        end
+      end
+    end
+
+    # Find configuration data in node attributes.
+    #
+    # @api private
+    def gather_from_node
+      return unless defined?(Chef.node)
+      (Chef.node['poise-profiler'] || {}).each do |key, value|
+        self[key] = value
+      end
+    end
+
+  end
+end

data/lib/poise_profiler/core_ext.rb

@@ -0,0 +1,19 @@
+#
+# Copyright 2016, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'poise_profiler/core_ext/cookbook_version'
+require 'poise_profiler/core_ext/dispatcher'
+require 'poise_profiler/core_ext/event_base'

data/lib/poise_profiler/core_ext/cookbook_version.rb

@@ -0,0 +1,42 @@
+#
+# Copyright 2016, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'chef/cookbook_version'
+require 'chef/version'
+
+
+module PoiseProfiler
+  module CoreExt
+    # Monkeypatch extensions for Chef::CookbookVersion to support the
+    # new recipe_loaded event.
+    #
+    # @since 1.1.0
+    # @api private
+    module CookbookVersion
+      def load_recipe(recipe_name, run_context)
+        super.tap do |recipe|
+          run_context.events.recipe_loaded("#{name}::#{recipe_name}")
+        end
+      end
+
+      # Monkeypatch us in for ?. TODO THIS
+      if Gem::Version.create(Chef::VERSION) < Gem::Version.create('14')
+        Chef::CookbookVersion.prepend(self)
+      end
+
+    end
+  end
+end

data/lib/poise_profiler/core_ext/dispatcher.rb

@@ -0,0 +1,45 @@
+#
+# Copyright 2016, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'chef/event_dispatch/dispatcher'
+require 'chef/version'
+
+
+module PoiseProfiler
+  module CoreExt
+    # Monkeypatch extensions for Chef::EventDispatch::Dispatcher to support the
+    # new recipe_loaded event.
+    #
+    # @since 1.1.0
+    # @api private
+    module Dispatcher
+      def recipe_loaded(*args)
+        if defined?(call_subscribers)
+          call_subscribers(:recipe_loaded, *args)
+        else
+          @subscribers.each { |s| s.recipe_loaded(*args) }
+        end
+      end
+
+      # Monkeypatch us in for ?. TODO THIS
+      if Gem::Version.create(Chef::VERSION) < Gem::Version.create('14')
+        Chef::EventDispatch::Dispatcher.include(self)
+      end
+
+    end
+  end
+end
+