chef_sous_vide 0.1.0

data/lib/sous_vide/outputs/json_file.rb

@@ -0,0 +1,43 @@
+require "chef/config"
+require "chef/json_compat"
+require "chef/log"
+
+module SousVide
+  module Outputs
+    # Saves the report to a JSON file on a node.  The file will be saved to chef cache directory.
+    #
+    #   Outputs::JsonFile.new
+    #
+    # By the report will be saved to "<chef-cache-path>/sous-vide-report.json".
+    class JsonFile
+      def initialize(logger: logger)
+        @logger = logger
+      end
+
+      def call(run_data:, node_data:, resources_data:)
+        log "=============== #{self.class.name} ==============="
+        log ""
+        log "Processing #{resources_data.size} resources."
+
+        json_data = resources_data.map do |tracked|
+          tracked.to_h.merge(node_data).merge(run_data)
+        end
+
+        ::Chef::FileCache.store("sous-vide-report.json",
+                                ::Chef::JSONCompat.to_json_pretty(json_data))
+
+        log "The report is in #{Chef::Config[:file_cache_path]}/sous-vide-report.json file."
+        log ""
+      end
+
+      def log(*args)
+        message = args.compact.join(" ")
+        logger.info(message)
+      end
+
+      def logger
+        @logger ||= ::Chef::Log
+      end
+    end
+  end
+end

data/lib/sous_vide/outputs/json_http.rb

@@ -0,0 +1,66 @@
+require "net/http"
+require "time"
+require "uri"
+
+module SousVide
+  module Outputs
+    # Makes a POST request to a configured endpoint. Logstash & Elasticsearch friendly format.
+    #
+    #   JsonHTTP.new(url: "http://localhost:9200/endpoint", max_retries: 10)
+    class JsonHTTP
+      def initialize(url:, max_retries: 0, logger: nil)
+        @endpoint = URI(url)
+        @logger = logger
+
+        @max_retries = max_retries || 2
+        @http_client = Net::HTTP.new(@endpoint.host, @endpoint.port)
+      end
+
+      def call(run_data:, node_data:, resources_data:)
+        log "=============== #{self.class.name} ==============="
+        log ""
+        log "Processing #{resources_data.size} resources."
+        log "Target: #{@endpoint.to_s}"
+
+        resources_data.each do |tracked|
+          _path = @endpoint.path == "" ? "/" : @endpoint.path
+          post_request = Net::HTTP::Post.new(_path, "Content-Type" => "application/json")
+
+          payload = tracked.to_h.merge(node_data).merge(run_data)
+          payload["@timestamp"] = Time.parse(payload[:chef_resource_started_at]).iso8601(3)
+
+          post_request.body = payload.to_json
+
+          call_with_retries(post_request)
+        end
+
+        log "All resources processed."
+        log ""
+      end
+
+      def call_with_retries(nethttp_request)
+        _retry = 0
+        begin
+          @http_client.request(nethttp_request)
+        rescue
+          if _retry < @max_retries
+            _retry += 1
+            sleep 2
+            retry
+          else
+            raise
+          end
+        end
+      end
+
+      def log(*args)
+        message = args.compact.join(" ")
+        logger.info(message)
+      end
+
+      def logger
+        @logger ||= ::Chef::Log
+      end
+    end
+  end
+end

data/lib/sous_vide/outputs/logger.rb

@@ -0,0 +1,48 @@
+module SousVide
+  module Outputs
+    # Prints the report to the logger (usually Chef logger).
+    #
+    #   Outputs::Logger.new
+    class Logger
+      def initialize(logger: nil)
+        @logger = logger
+      end
+
+      def call(run_data:, node_data:, resources_data:)
+        log "=============== #{self.class.name} ==============="
+        log ""
+        log "Processing #{resources_data.size} resources."
+        log ""
+
+        resources_data.each do |tracked|
+          log("#{tracked.execution_order}.", tracked.to_s, tracked.status,
+              "(#{tracked.duration_ms.to_i} ms)", tracked.execution_phase)
+        end
+
+        log ""
+        log "Node info:"
+        log ""
+        log "Name:", node_data[:chef_node_instance_id]
+        log "IP Address:", node_data[:chef_node_ipv4]
+        log "Role:", node_data[:chef_node_role]
+        log ""
+        log "Run info:"
+        log ""
+        log "ID:", run_data[:chef_run_id]
+        log "Started at:", run_data[:chef_run_started_at]
+        log "Completed at:", run_data[:chef_run_completed_at]
+        log "Success:", run_data[:chef_run_success]
+        log ""
+      end
+
+      def log(*args)
+        message = args.compact.join(' ')
+        logger.info(message)
+      end
+
+      def logger
+        @logger ||= ::Chef::Log
+      end
+    end
+  end
+end

data/lib/sous_vide/outputs/multi.rb

@@ -0,0 +1,21 @@
+module SousVide
+  module Outputs
+    # Combines multiple outputs
+    #
+    #   es = Outputs::ES.new ...
+    #   log = Outputs::Logger.new ...
+    #   multi = Outputs::Multi.new(es, log)
+    class Multi
+      def initialize(*outputs)
+        @outputs = outputs
+      end
+
+      def call(run_data:, node_data:, resources_data:)
+        @outputs.each do |output|
+          output.call(run_data: run_data, node_data: node_data,
+                      resources_data: resources_data)
+        end
+      end
+    end
+  end
+end

data/lib/sous_vide/tracked_resource.rb

@@ -0,0 +1,75 @@
+module SousVide
+  # == SousVide::TrackedResource
+  #
+  # This is a very simple data structure SousVide uses to capture interesting
+  # information.
+  class TrackedResource
+    attr_accessor :type,
+                  :name,
+                  :action,
+                  :status,
+                  :duration_ms,
+                  :guard_description,
+                  :execution_phase,
+                  :execution_order,
+                  :notifying_resource,
+                  :notification_type,
+                  :before_notifications,
+                  :immediate_notifications,
+                  :delayed_notifications,
+                  :retries,
+                  :error_output,
+                  :error_source,
+                  :cookbook_name,
+                  :cookbook_recipe,
+                  :source_line,
+                  :started_at,
+                  :completed_at
+
+    attr_accessor :chef_resource_handle
+
+    def initialize(name:, action:, type:)
+      @name = name
+      @action = action
+      @type = type
+
+      @status = "unprocessed"
+      @duration_ms = nil
+      @guard_description = nil
+
+      @retries = 0
+      @error_output = nil
+      @error_source = nil
+    end
+
+    def to_s
+      "#{@type}[#{@name}]##{@action}"
+    end
+
+    def to_h
+      {
+        chef_resource: "#{@type}[#{@name}]##{@action}",
+        chef_resource_name: @name,
+        chef_resource_type: @type,
+        chef_resource_cookbook: @cookbook_name,
+        chef_resource_recipe: @cookbook_recipe,
+        chef_resource_action: @action,
+        chef_resource_guard: @guard_description,
+        chef_resource_duration_ms: @duration_ms,
+        chef_resource_error_output: @error_output,
+        chef_resource_error_source: @error_source,
+        chef_resource_retries: @retries,
+        chef_resource_notified_by: @notifying_resource,
+        chef_resource_notified_via: @notification_type,
+        chef_resource_before_notifications: @before_notifications,
+        chef_resource_immediate_notifications: @immediate_notifications,
+        chef_resource_delayed_notifications: @delayed_notifications,
+        chef_resource_order: @execution_order,
+        chef_resource_execution_phase: @execution_phase,
+        chef_resource_started_at: @started_at,
+        chef_resource_completed_at: @completed_at,
+        chef_resource_status: @status
+      }
+    end
+  end
+end

data/lib/sous_vide/version.rb

@@ -0,0 +1,3 @@
+module SousVide
+  VERSION = "0.1.0".freeze
+end

data/sous_vide.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sous_vide/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "chef_sous_vide"
+  spec.version = SousVide::VERSION
+  spec.authors = ["robuye"]
+  spec.email = ["rulejczyk@gmail.com"]
+
+  spec.summary = "Sous vide cooking utilizes precise temperature control with circulation to produce results that you can’t achieve through any other cooking technique."
+  spec.description = "SousVide is a Chef Handler who will precisely track a converge process of your recipes and help you become a better cook."
+  spec.homepage = "https://github.com/lonelyplanet/sous_vide"
+  spec.license = "MIT"
+
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(cookbooks|kitchen|features)/}) }
+  end
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "chef", "~> 12.17.44"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "cucumber", "~> 3.1.2"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "test-kitchen"
+  spec.add_development_dependency "kitchen-docker"
+  spec.add_development_dependency "kitchen-transport-rsync"
+  spec.add_development_dependency "berkshelf"
+end

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: chef_sous_vide
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- robuye
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.17.44
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.17.44
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: test-kitchen
+  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'
+- !ruby/object:Gem::Dependency
+  name: kitchen-docker
+  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'
+- !ruby/object:Gem::Dependency
+  name: kitchen-transport-rsync
+  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'
+- !ruby/object:Gem::Dependency
+  name: berkshelf
+  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: SousVide is a Chef Handler who will precisely track a converge process
+  of your recipes and help you become a better cook.
+email:
+- rulejczyk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Berksfile
+- Berksfile.lock
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kitchen.yml
+- lib/sous_vide.rb
+- lib/sous_vide/event_methods.rb
+- lib/sous_vide/handler.rb
+- lib/sous_vide/outputs/json_file.rb
+- lib/sous_vide/outputs/json_http.rb
+- lib/sous_vide/outputs/logger.rb
+- lib/sous_vide/outputs/multi.rb
+- lib/sous_vide/tracked_resource.rb
+- lib/sous_vide/version.rb
+- sous_vide.gemspec
+homepage: https://github.com/lonelyplanet/sous_vide
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Sous vide cooking utilizes precise temperature control with circulation to
+  produce results that you can’t achieve through any other cooking technique.
+test_files: []