chef-formatters-simple 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c6b2b11bc6d9144438ab437e4a0d4b4079b43285
+  data.tar.gz: 4909f78fd17c715ecce63a18f47d3e43b0eadb7d
+SHA512:
+  metadata.gz: bcf4e1151a5fecb3b6573c87fd4754e51e58c15cd4f64e2fb55fb4818591290ee606c2d6bb706ea87d1382b4e3fc743c9b82fdda397d965f134341d9b57f3745
+  data.tar.gz: ed5f8c56ed1247e77ddcf275f97f5ae3b06b293c1dc23dbde74a0ce08c4f3d58bfed85ac3d29f71bd985c0f6e0ab4c8f15e53337036c8a14bc60d1280b080fa1

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in chef-formatters-simple.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 sakazuki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,41 @@
+# Chef::Formatters::Simple
+
+chef-client simple formatter
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chef-formatters-simple'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chef-formatters-simple
+
+## Usage
+
+Add below in /etc/chef/client.rb:
+
+```
+require 'chef/formatters/simple'
+```
+
+Use chef-client with -F or --format option
+
+```bash
+chef-client -F simple -W
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/chef-formatters-simple/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/chef-formatters-simple.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chef/formatters/simple/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "chef-formatters-simple"
+  spec.version       = Chef::Formatters::Simple::VERSION
+  spec.authors       = ["sakazuki"]
+  spec.email         = ["sakazuki@gmail.com"]
+  spec.summary       = %q{chef-client simple formatter}
+  spec.description   = %q{chef-client simple formatter outputs that minimal's output plus delta}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/chef/formatters/simple.rb

@@ -0,0 +1,271 @@
+require "chef/formatters/simple/version"
+require "chef/formatters/base"
+
+class Chef
+
+  module Formatters
+
+
+    # == Formatters::Simple
+    # Shows the progress of the chef run by printing single characters, and
+    # displays a summary of updates at the conclusion of the run. For events
+    # that don't have meaningful status information (loading a file, syncing a
+    # cookbook) a dot is printed. For resources, a dot, 'S' or 'U' is printed
+    # if the resource is up to date, skipped by not_if/only_if, or updated,
+    # respectively.
+    class Simple < Formatters::Base
+
+      cli_name(:simple)
+
+      attr_reader :updated_resources
+      attr_reader :updates_by_resource
+
+
+      def initialize(out, err)
+        super
+        @updated_resources = []
+        @updates_by_resource = Hash.new {|h, k| h[k] = []}
+      end
+
+      # Called at the very start of a Chef Run
+      def run_start(version)
+        puts "Starting Chef Client, version #{version}"
+      end
+
+      # Called at the end of the Chef run.
+      def run_completed(node)
+        puts "chef client finished, #{@updated_resources.size} resources updated"
+      end
+
+      # called at the end of a failed run
+      def run_failed(exception)
+        puts "chef client failed. #{@updated_resources.size} resources updated"
+      end
+
+      # Called right after ohai runs.
+      def ohai_completed(node)
+      end
+
+      # Already have a client key, assuming this node has registered.
+      def skipping_registration(node_name, config)
+      end
+
+      # About to attempt to register as +node_name+
+      def registration_start(node_name, config)
+      end
+
+      def registration_completed
+      end
+
+      # Failed to register this client with the server.
+      def registration_failed(node_name, exception, config)
+        super
+      end
+
+      def node_load_start(node_name, config)
+      end
+
+      # Failed to load node data from the server
+      def node_load_failed(node_name, exception, config)
+      end
+
+      # Default and override attrs from roles have been computed, but not yet applied.
+      # Normal attrs from JSON have been added to the node.
+      def node_load_completed(node, expanded_run_list, config)
+      end
+
+      # Called before the cookbook collection is fetched from the server.
+      def cookbook_resolution_start(expanded_run_list)
+        puts "resolving cookbooks for run list: #{expanded_run_list.inspect}"
+      end
+
+      # Called when there is an error getting the cookbook collection from the
+      # server.
+      def cookbook_resolution_failed(expanded_run_list, exception)
+      end
+
+      # Called when the cookbook collection is returned from the server.
+      def cookbook_resolution_complete(cookbook_collection)
+      end
+
+      # Called before unneeded cookbooks are removed
+      #--
+      # TODO: Should be called in CookbookVersion.sync_cookbooks
+      def cookbook_clean_start
+      end
+
+      # Called after the file at +path+ is removed. It may be removed if the
+      # cookbook containing it was removed from the run list, or if the file was
+      # removed from the cookbook.
+      def removed_cookbook_file(path)
+      end
+
+      # Called when cookbook cleaning is finished.
+      def cookbook_clean_complete
+      end
+
+      # Called before cookbook sync starts
+      def cookbook_sync_start(cookbook_count)
+        puts "Synchronizing cookbooks"
+      end
+
+      # Called when cookbook +cookbook_name+ has been sync'd
+      def synchronized_cookbook(cookbook_name)
+        print "."
+      end
+
+      # Called when an individual file in a cookbook has been updated
+      def updated_cookbook_file(cookbook_name, path)
+      end
+
+      # Called after all cookbooks have been sync'd.
+      def cookbook_sync_complete
+        puts "done."
+      end
+
+      # Called when cookbook loading starts.
+      def library_load_start(file_count)
+        puts "Compiling cookbooks"
+      end
+
+      # Called after a file in a cookbook is loaded.
+      def file_loaded(path)
+        print '.'
+      end
+
+      def file_load_failed(path, exception)
+        super
+      end
+
+      # Called when recipes have been loaded.
+      def recipe_load_complete
+        puts "done."
+      end
+
+      # Called before convergence starts
+      def converge_start(run_context)
+        puts "Converging #{run_context.resource_collection.all_resources.size} resources"
+      end
+
+      # Called when the converge phase is finished.
+      def converge_complete
+        prefix = Chef::Config[:why_run] ? "Would " : ""
+        puts "\n"
+        puts "System converged."
+        if updated_resources.empty?
+          puts "no resources updated"
+        else
+          puts "\n"
+          puts "resources updated this run:"
+          updated_resources.each do |resource|
+            if resource.cookbook_name && resource.recipe_name
+              resource_recipe = "#{resource.cookbook_name}::#{resource.recipe_name}"
+            else
+              resource_recipe = "<Dynamically Defined Resource>"
+            end
+            if resource_recipe != @current_recipe && !resource.enclosing_provider
+              unindent if @current_recipe
+              puts_line "Recipe: #{resource_recipe}"
+              @current_recipe = resource_recipe
+              indent
+            end
+            puts "* #{resource.to_s}"
+            updates_by_resource[resource.name].each do |update|
+              Array(update).each do |line|
+                next if line.nil?
+                output_record line
+                if line.kind_of? String
+                  start_line "- #{prefix}#{line}", :green
+                elsif line.kind_of? Array
+                  # Expanded output - delta
+                  # @todo should we have a resource_update_delta callback?
+                  indent
+                  line.each do |detail|
+                    start_line detail, :white
+                  end
+                  unindent
+                end
+              end
+            end
+            puts "\n"
+          end
+        end
+      end
+
+      def output_record(line)
+      end
+
+      # Called before action is executed on a resource.
+      def resource_action_start(resource, action, notification_type=nil, notifier=nil)
+      end
+
+      # Called when a resource fails, but will retry.
+      def resource_failed_retriable(resource, action, retry_count, exception)
+      end
+
+      # Called when a resource fails and will not be retried.
+      def resource_failed(resource, action, exception)
+      end
+
+      # Called when a resource action has been skipped b/c of a conditional
+      def resource_skipped(resource, action, conditional)
+        print "S"
+      end
+
+      # Called after #load_current_resource has run.
+      def resource_current_state_loaded(resource, action, current_resource)
+      end
+
+      # Called when a resource has no converge actions, e.g., it was already correct.
+      def resource_up_to_date(resource, action)
+        print "."
+      end
+
+      ## TODO: callback for assertion failures
+
+      ## TODO: callback for assertion fallback in why run
+
+      # Called when a change has been made to a resource. May be called multiple
+      # times per resource, e.g., a file may have its content updated, and then
+      # its permissions updated.
+      def resource_update_applied(resource, action, update)
+        @updates_by_resource[resource.name] << Array(update) #[0]
+      end
+
+      # Called after a resource has been completely converged.
+      def resource_updated(resource, action)
+        updated_resources << resource
+        print "U"
+      end
+
+      # Called before handlers run
+      def handlers_start(handler_count)
+      end
+
+      # Called after an individual handler has run
+      def handler_executed(handler)
+      end
+
+      # Called after all handlers have executed
+      def handlers_completed
+      end
+
+      # An uncategorized message. This supports the case that a user needs to
+      # pass output that doesn't fit into one of the callbacks above. Note that
+      # there's no semantic information about the content or importance of the
+      # message. That means that if you're using this too often, you should add a
+      # callback for it.
+      def msg(message)
+      end
+
+      def indent
+        indent_by(2)
+      end
+
+      def unindent
+        indent_by(-2)
+      end
+
+    end
+  end
+end

data/lib/chef/formatters/simple/version.rb

@@ -0,0 +1,7 @@
+module Chef
+  module Formatters
+    module Simple
+      VERSION = "0.0.1"
+    end
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: chef-formatters-simple
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- sakazuki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: chef-client simple formatter outputs that minimal's output plus delta
+email:
+- sakazuki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- chef-formatters-simple.gemspec
+- lib/chef/formatters/simple.rb
+- lib/chef/formatters/simple/version.rb
+homepage: ''
+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.4.1
+signing_key: 
+specification_version: 4
+summary: chef-client simple formatter
+test_files: []