summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAdam Jacob <adam@hjksolutions.com>2009-03-11 13:25:45 -0700
committerAdam Jacob <adam@hjksolutions.com>2009-03-11 13:25:45 -0700
commita136f9823b8b0fa01da4e758e64c89bbab0036dc (patch)
tree9eece42b81546f39e6fe460e093f41d646a285c4
downloadmixlib-log-a136f9823b8b0fa01da4e758e64c89bbab0036dc.tar.gz
Initial commit
-rw-r--r--LICENSE201
-rw-r--r--NOTICE27
-rw-r--r--README.rdoc26
-rw-r--r--Rakefile67
-rw-r--r--features/log.feature37
-rw-r--r--features/steps/log.rb48
-rw-r--r--features/support/env.rb46
-rw-r--r--features/support/logit.rb23
-rw-r--r--lib/mixlib/log.rb84
-rw-r--r--lib/mixlib/log/formatter.rb56
-rwxr-xr-xscript/destroy14
-rwxr-xr-xscript/generate14
-rw-r--r--spec/mixlib/log/formatter_spec.rb51
-rw-r--r--spec/mixlib/log_spec.rb62
-rw-r--r--spec/spec_helper.rb11
15 files changed, 767 insertions, 0 deletions
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..11069ed
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+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.
diff --git a/NOTICE b/NOTICE
new file mode 100644
index 0000000..77028c0
--- /dev/null
+++ b/NOTICE
@@ -0,0 +1,27 @@
+Mixin::Log NOTICE
+=================
+
+Developed at Opscode (http://www.opscode.com).
+
+ * Copyright 2009, Opscode, Inc. <legal@opscode.com>
+
+Mixin::Log incorporates code from Chef. The Chef notice file follows:
+
+Chef NOTICE
+===========
+
+Developed at Opscode (http://www.opscode.com).
+
+Contributors and Copyright holders:
+
+ * Copyright 2008, Adam Jacob <adam@opscode.com>
+ * Copyright 2008, Arjuna Christensen <aj@hjksolutions.com>
+ * Copyright 2008, Bryan McLellan <btm@loftninjas.org>
+ * Copyright 2008, Ezra Zygmuntowicz <ezra@engineyard.com>
+ * Copyright 2009, Sean Cribbs <seancribbs@gmail.com>
+ * Copyright 2009, Christopher Brown <cb@opscode.com>
+ * Copyright 2009, Thom May <thom@clearairturbulence.org>
+
+Chef incorporates code modified from Open4 (http://www.codeforpeople.com/lib/ruby/open4/), which was written by Ara T. Howard.
+
+Chef incorporates code modified from Merb (http://www.merbivore.com), which is Copyright (c) 2008 Engine Yard.
diff --git a/README.rdoc b/README.rdoc
new file mode 100644
index 0000000..933918a
--- /dev/null
+++ b/README.rdoc
@@ -0,0 +1,26 @@
+== Mixlib::Logger
+
+Mixlib::Logger provides a mixin for enabling a class based logger object, a-la Merb, Chef, and Nanite. To use it:
+
+ require 'mixlib/logger'
+
+ class Log
+ class << self
+ include 'mixlib/logger'
+ end
+ end
+
+You can then do:
+
+ Log.debug("foo")
+ Log.info("bar")
+ Log.warn("baz")
+ Log.error("baz")
+ Log.fatal("wewt")
+
+By default, Mixlib::Logger logs to STDOUT. To alter this, you should call Log.init, passing any arguments to the standard Ruby Logger. For example:
+
+ Log.init("/tmp/logfile") # log to /tmp/logfile
+ Log.init("/tmp/logfile", 7) # log to /tmp/logfile, rotate every day
+
+Enjoy!
diff --git a/Rakefile b/Rakefile
new file mode 100644
index 0000000..1c8d46b
--- /dev/null
+++ b/Rakefile
@@ -0,0 +1,67 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+require 'date'
+require 'spec/rake/spectask'
+require 'cucumber/rake/task'
+
+GEM = "mixlib-log"
+GEM_VERSION = "0.0.1"
+AUTHOR = "Opscode, Inc."
+EMAIL = "info@opscode.com"
+HOMEPAGE = "http://www.opscode.com"
+SUMMARY = "A gem that provides a simple mixin for log functionality"
+
+spec = Gem::Specification.new do |s|
+ s.name = GEM
+ s.version = GEM_VERSION
+ s.platform = Gem::Platform::RUBY
+ s.has_rdoc = true
+ s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
+ s.summary = SUMMARY
+ s.description = s.summary
+ s.author = AUTHOR
+ s.email = EMAIL
+ s.homepage = HOMEPAGE
+
+ # Uncomment this to add a dependency
+ # s.add_dependency "foo"
+
+ s.require_path = 'lib'
+ s.autorequire = GEM
+ s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,spec}/**/*")
+end
+
+task :default => :test
+
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+ t.spec_files = FileList['spec/**/*_spec.rb']
+ t.spec_opts = %w(-fs --color)
+end
+
+
+Rake::GemPackageTask.new(spec) do |pkg|
+ pkg.gem_spec = spec
+end
+
+desc "install the gem locally"
+task :install => [:package] do
+ sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
+end
+
+desc "create a gemspec file"
+task :make_spec do
+ File.open("#{GEM}.gemspec", "w") do |file|
+ file.puts spec.to_ruby
+ end
+end
+
+Cucumber::Rake::Task.new(:features) do |t|
+ t.step_pattern = 'features/steps/**/*.rb'
+ supportdir = 'features/support'
+ t.cucumber_opts = "--format pretty -r #{supportdir}"
+end
+
+desc "Run the spec and features"
+task :test => [ :features, :spec ] \ No newline at end of file
diff --git a/features/log.feature b/features/log.feature
new file mode 100644
index 0000000..78a65f3
--- /dev/null
+++ b/features/log.feature
@@ -0,0 +1,37 @@
+Feature: Log output
+ In order to keep a record of application specific information
+ As a developer
+ I want to publish information through a configurable log interface
+
+ Scenario: Log a message at the debug level
+ Given a base log level of 'debug'
+ When the message 'this goes out' is sent at the 'debug' level
+ Then the regex '\[.+\] DEBUG: this goes out' should be logged
+
+ Scenario: Log a message at the info level
+ Given a base log level of 'info'
+ When the message 'this goes out' is sent at the 'info' level
+ Then the regex '\[.+\] INFO: this goes out' should be logged
+
+ Scenario: Log a message at the warn level
+ Given a base log level of 'warn'
+ When the message 'this goes out' is sent at the 'warn' level
+ Then the regex '\[.+\] WARN: this goes out' should be logged
+
+ Scenario: Log a message at the error level
+ Given a base log level of 'error'
+ When the message 'this goes out' is sent at the 'error' level
+ Then the regex '\[.+\] ERROR: this goes out' should be logged
+
+ Scenario: Log a message at the fatal level
+ Given a base log level of 'fatal'
+ When the message 'this goes out' is sent at the 'fatal' level
+ Then the regex '\[.+\] FATAL: this goes out' should be logged
+
+ Scenario: Log messages below the current threshold should not appear
+ Given a base log level of 'fatal'
+ When the message 'this goes out' is sent at the 'error' level
+ And the message 'this goes out' is sent at the 'warn' level
+ And the message 'this goes out' is sent at the 'info' level
+ And the message 'this goes out' is sent at the 'debug' level
+ Then nothing should be logged
diff --git a/features/steps/log.rb b/features/steps/log.rb
new file mode 100644
index 0000000..13a8fea
--- /dev/null
+++ b/features/steps/log.rb
@@ -0,0 +1,48 @@
+#
+# Author:: Adam Jacob (<adam@opscode.com>)
+# Copyright:: Copyright (c) 2008 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+Given /^a base log level of '(.+)'$/ do |level|
+ Logit.level(level.to_sym)
+end
+
+When /^the message '(.+)' is sent at the '(.+)' level$/ do |message, level|
+ case level.to_sym
+ when :debug
+ Logit.debug(message)
+ when :info
+ Logit.info(message)
+ when :warn
+ Logit.warn(message)
+ when :error
+ Logit.error(message)
+ when :fatal
+ Logit.fatal(message)
+ else
+ raise ArgumentError, "Level is not one of debug, info, warn, error, or fatal"
+ end
+end
+
+Then /^the regex '(.+)' should be logged$/ do |regex_string|
+ regex = Regexp.new(regex_string, Regexp::MULTILINE)
+ regex.match(@output).should_not == nil
+end
+
+Then /^nothing should be logged$/ do
+ @output.should == ""
+end
+
diff --git a/features/support/env.rb b/features/support/env.rb
new file mode 100644
index 0000000..56dee6c
--- /dev/null
+++ b/features/support/env.rb
@@ -0,0 +1,46 @@
+#
+# Author:: Adam Jacob (<adam@opscode.com>)
+# Copyright:: Copyright (c) 2008 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+$: << File.join(File.dirname(__FILE__), '..', '..', 'lib')
+
+require 'spec/expectations'
+require 'mixlib/log'
+require 'tmpdir'
+require 'stringio'
+
+class MyWorld
+ def initialize
+ @tmpdir = File.join(Dir.tmpdir, "mixlib_log")
+ @output = ''
+ @output_io = StringIO.new(@output)
+ Logit.init(@output_io)
+ end
+end
+
+World do
+ MyWorld.new
+end
+
+Before do
+ system("mkdir -p #{@tmpdir}")
+end
+
+After do
+ system("rm -rf #{@tmpdir}")
+end
+
diff --git a/features/support/logit.rb b/features/support/logit.rb
new file mode 100644
index 0000000..4bc0d50
--- /dev/null
+++ b/features/support/logit.rb
@@ -0,0 +1,23 @@
+#
+# Author:: Adam Jacob (<adam@opscode.com>)
+# Copyright:: Copyright (c) 2008 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+class Logit
+ class << self
+ include Mixlib::Log
+ end
+end \ No newline at end of file
diff --git a/lib/mixlib/log.rb b/lib/mixlib/log.rb
new file mode 100644
index 0000000..1f64c5a
--- /dev/null
+++ b/lib/mixlib/log.rb
@@ -0,0 +1,84 @@
+#
+# Author:: Adam Jacob (<adam@opscode.com>)
+# Copyright:: Copyright (c) 2008 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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 'mixlib/log/formatter'
+require 'logger'
+
+module Mixlib
+ module Log
+
+ @logger = nil
+
+ attr_accessor :logger #:nodoc
+
+ # Use Mixlib::Log.init when you want to set up the logger manually. Arguments to this method
+ # get passed directly to Logger.new, so check out the documentation for the standard Logger class
+ # to understand what to do here.
+ #
+ # If this method is called with no arguments, it will log to STDOUT at the :info level.
+ #
+ # It also configures the Logger instance it creates to use the custom Mixlib::Log::Formatter class.
+ def init(*opts)
+ if opts.length == 0
+ @logger = Logger.new(STDOUT)
+ else
+ @logger = Logger.new(*opts)
+ end
+ @logger.formatter = Mixlib::Log::Formatter.new()
+ end
+
+ # Sets the level for the Logger object by symbol. Valid arguments are:
+ #
+ # :debug
+ # :info
+ # :warn
+ # :error
+ # :fatal
+ #
+ # Throws an ArgumentError if you feed it a bogus log level.
+ def level(loglevel=:warn)
+ init() unless @logger
+ case loglevel
+ when :debug
+ @logger.level = Logger::DEBUG
+ when :info
+ @logger.level = Logger::INFO
+ when :warn
+ @logger.level = Logger::WARN
+ when :error
+ @logger.level = Logger::ERROR
+ when :fatal
+ @logger.level = Logger::FATAL
+ else
+ raise ArgumentError, "Log level must be one of :debug, :info, :warn, :error, or :fatal"
+ end
+ end
+
+ # Passes any other method calls on directly to the underlying Logger object created with init. If
+ # this method gets hit before a call to Mixlib::Logger.init has been made, it will call
+ # Mixlib::Logger.init() with no arguments.
+ def method_missing(method_symbol, *args)
+ init() unless @logger
+ if args.length > 0
+ @logger.send(method_symbol, *args)
+ else
+ @logger.send(method_symbol)
+ end
+ end
+
+ end
+end \ No newline at end of file
diff --git a/lib/mixlib/log/formatter.rb b/lib/mixlib/log/formatter.rb
new file mode 100644
index 0000000..54ea3fe
--- /dev/null
+++ b/lib/mixlib/log/formatter.rb
@@ -0,0 +1,56 @@
+#
+# Author:: Adam Jacob (<adam@opscode.com>)
+# Copyright:: Copyright (c) 2008 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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 'logger'
+require 'time'
+
+module Mixlib
+ module Log
+ class Formatter < Logger::Formatter
+ @@show_time = true
+
+ def self.show_time=(show=false)
+ @@show_time = show
+ end
+
+ # Prints a log message as '[time] severity: message' if Chef::Log::Formatter.show_time == true.
+ # Otherwise, doesn't print the time.
+ def call(severity, time, progname, msg)
+ if @@show_time
+ sprintf("[%s] %s: %s\n", time.rfc2822(), severity, msg2str(msg))
+ else
+ sprintf("%s: %s\n", severity, msg2str(msg))
+ end
+ end
+
+ # Converts some argument to a Logger.severity() call to a string. Regular strings pass through like
+ # normal, Exceptions get formatted as "message (class)\nbacktrace", and other random stuff gets
+ # put through "object.inspect"
+ def msg2str(msg)
+ case msg
+ when ::String
+ msg
+ when ::Exception
+ "#{ msg.message } (#{ msg.class })\n" <<
+ (msg.backtrace || []).join("\n")
+ else
+ msg.inspect
+ end
+ end
+ end
+ end
+end \ No newline at end of file
diff --git a/script/destroy b/script/destroy
new file mode 100755
index 0000000..40901a8
--- /dev/null
+++ b/script/destroy
@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+ require 'rubigen'
+rescue LoadError
+ require 'rubygems'
+ require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:newgem_simple, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)
diff --git a/script/generate b/script/generate
new file mode 100755
index 0000000..5c8ed01
--- /dev/null
+++ b/script/generate
@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+ require 'rubigen'
+rescue LoadError
+ require 'rubygems'
+ require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:newgem_simple, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)
diff --git a/spec/mixlib/log/formatter_spec.rb b/spec/mixlib/log/formatter_spec.rb
new file mode 100644
index 0000000..909436a
--- /dev/null
+++ b/spec/mixlib/log/formatter_spec.rb
@@ -0,0 +1,51 @@
+#
+# Author:: Adam Jacob (<adam@opscode.com>)
+# Copyright:: Copyright (c) 2008 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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 'time'
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "spec_helper"))
+
+describe Mixlib::Log::Formatter do
+ before(:each) do
+ @formatter = Mixlib::Log::Formatter.new
+ end
+
+ it "should print raw strings with msg2str(string)" do
+ @formatter.msg2str("nuthin new").should == "nuthin new"
+ end
+
+ it "should format exceptions properly with msg2str(e)" do
+ e = IOError.new("legendary roots crew")
+ @formatter.msg2str(e).should == "legendary roots crew (IOError)\n"
+ end
+
+ it "should format random objects via inspect with msg2str(Object)" do
+ @formatter.msg2str([ "black thought", "?uestlove" ]).should == '["black thought", "?uestlove"]'
+ end
+
+ it "should return a formatted string with call" do
+ time = Time.new
+ Mixlib::Log::Formatter.show_time = true
+ @formatter.call("monkey", time, "test", "mos def").should == "[#{time.rfc2822}] monkey: mos def\n"
+ end
+
+ it "should allow you to turn the time on and off in the output" do
+ Mixlib::Log::Formatter.show_time = false
+ @formatter.call("monkey", Time.new, "test", "mos def").should == "monkey: mos def\n"
+ end
+
+end \ No newline at end of file
diff --git a/spec/mixlib/log_spec.rb b/spec/mixlib/log_spec.rb
new file mode 100644
index 0000000..4621969
--- /dev/null
+++ b/spec/mixlib/log_spec.rb
@@ -0,0 +1,62 @@
+#
+# Author:: Adam Jacob (<adam@opscode.com>)
+# Copyright:: Copyright (c) 2008 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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 'tempfile'
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
+
+describe Mixlib::Log do
+
+ it "should accept regular options to Logger.new via init" do
+ tf = Tempfile.new("chef-test-log")
+ tf.open
+ lambda { Logit.init(STDOUT) }.should_not raise_error
+ lambda { Logit.init(tf) }.should_not raise_error
+ end
+
+ it "should set the log level with :debug, :info, :warn, :error, or :fatal" do
+ levels = {
+ :debug => Logger::DEBUG,
+ :info => Logger::INFO,
+ :warn => Logger::WARN,
+ :error => Logger::ERROR,
+ :fatal => Logger::FATAL
+ }
+ levels.each do |symbol, constant|
+ Logit.level(symbol)
+ Logit.logger.level.should == constant
+ end
+ end
+
+ it "should raise an ArgumentError if you try and set the level to something strange" do
+ lambda { Logit.level(:the_roots) }.should raise_error(ArgumentError)
+ end
+
+ it "should pass other method calls directly to logger" do
+ Logit.level(:debug)
+ Logit.should be_debug
+ lambda { Logit.debug("Gimme some sugar!") }.should_not raise_error
+ end
+
+ it "should default to STDOUT if init is called with no arguments" do
+ logger_mock = mock(Logger, :null_object => true)
+ Logger.stub!(:new).and_return(logger_mock)
+ Logger.should_receive(:new).with(STDOUT).and_return(logger_mock)
+ Logit.init
+ end
+
+end \ No newline at end of file
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
new file mode 100644
index 0000000..2680dba
--- /dev/null
+++ b/spec/spec_helper.rb
@@ -0,0 +1,11 @@
+$TESTING=true
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'mixlib/log'
+require 'mixlib/log/formatter'
+
+class Logit
+ class << self
+ include Mixlib::Log
+ end
+end \ No newline at end of file