knife-goiardi-event-log 0.1.1 → 0.2.0

data/README.md

@@ -11,6 +11,13 @@ goiardi gel show`, `knife goiardi gel delete` and `knife goiardi gel purge`.
 `knife goiardi gel list` returns a list of logged events. A limit may be 
 specified with `--limit`; the default limit is 15. An offset may also be specified; the default offset is 0.
 
+Results may be further narrowed using the `--starttime`, `--endtime`, `--doer`,
+`--object-type`, and `--object-name` options. The time options narrow the 
+results by date range, the `--doer` option searches for events done by the named
+user, and `--object-type` and `--object-name` limit the search to objects of the
+given type and name respectively. NB: these options only work with goiardi 0.6.0
+and above. Earlier versions that support event logging will ignore them.
+
 `knife goiardi gel show [id]` gives a detailed listing of a particular event log
 item.
 
@@ -23,7 +30,7 @@ were purged.
 
 ## Installation
 
-The best way to install this plugin is with gem (once it's on rubygems):
+The best way to install this plugin is with gem:
 
     $ gem install knife-goiardi-event-log
 
@@ -50,3 +57,20 @@ 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.
+
+This plugin also contains code from the Chef knife-reporting plugin, available
+under the terms of the Apache 2.0 license:
+
+Copyright 2013-2014, Chef 
+
+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.

data/lib/chef/goiardi/knife_helpers.rb

@@ -1,19 +1,63 @@
 class Chef
   module Goiardi
-    module KnifeHelpers
-      def format_object_type(obj)
-	obj =~ /^\*?(\w+)\.?/
-	$1 || obj
-      end
-      def format_time(timestamp)
-	Time.parse(timestamp).strftime("%c")
-      end
-      def format_event(gel)
-	gel["object_type"] = format_object_type(gel["object_type"])
-	gel["actor_info"] = JSON.parse(gel["actor_info"])
-	gel["extended_info"] = JSON.parse(gel["extended_info"])
-	gel["time"] = format_time(gel["time"])
-	gel
+    module Gel
+      module KnifeHelpers
+	def format_object_type(obj)
+	  if obj == "*cookbook.CookbookVersion"
+	    "cookbook_version"
+	  else
+	    obj =~ /^\*?(\w+)\.?/
+	    $1 || obj
+	  end
+	end
+	def format_time(timestamp)
+	  Time.parse(timestamp).strftime("%c")
+	end
+
+	def format_event(gel)
+	  gel["object_type"] = format_object_type(gel["object_type"])
+	  gel["actor_info"] = JSON.parse(gel["actor_info"])
+	  gel["extended_info"] = JSON.parse(gel["extended_info"])
+	  gel["time"] = format_time(gel["time"])
+	  gel
+	end
+
+	# Code below adapted from the knife-reporting plugin
+	def apply_time_args()
+	  if config[:start_time]
+	    start_time = convert_to_unix_timestamps(config[:start_time])
+	  else
+	    start_time = nil
+	  end
+
+	  if config[:end_time]
+	    end_time = convert_to_unix_timestamps(config[:end_time])
+	  else
+	    end_time = nil
+	  end
+
+
+	  return start_time, end_time
+	end
+
+
+	def convert_to_unix_timestamps(time_to_change)
+	  if config[:unix_timestamps]
+	    new_time = time_to_change.to_i
+	  else
+	    # Take user supplied input, assumes it is in a valid date format,
+	    # convert to a date object to ensure we have the proper date format for
+	    # passing to the time object (but converting is not a validation step,
+	    # so bad user input will still be bad)
+	    # then convert to a time object, and then convert to a unix timestamp
+	    # An error could potentially be thrown if the conversions don't work
+	    # This does work on windows - to_i on time even on windows still returns a unix timestamp
+	    # Verified on ruby 1.9.3 on a windows 2000 ami on aws
+	    new_time = Time.parse(Date.strptime(time_to_change, '%m-%d-%Y').to_s).to_i
+	  end
+
+	  return new_time
+	end
       end
     end
   end

data/lib/chef/knife/goiardi_gel_delete.rb

@@ -8,7 +8,7 @@ class Chef
 	require 'json'
       end
 
-      include Chef::Goiardi::KnifeHelpers
+      include Chef::Goiardi::Gel::KnifeHelpers
       
       banner "knife goiardi gel delete [id]"
 

data/lib/chef/knife/goiardi_gel_list.rb

@@ -6,7 +6,7 @@ class Chef
     class GoiardiGelList < Chef::Knife
       banner "knife goiardi gel list [options]"
 
-      include Chef::Goiardi::KnifeHelpers
+      include Chef::Goiardi::Gel::KnifeHelpers
 
       option :limit,
 	:long => '--limit N',
@@ -20,22 +20,87 @@ class Chef
 	:required => false,
 	:description => "Offset to fetch events from. Default is 0."
 
+      option :start_time,
+        :long => '--starttime MM-DD-YYYY',
+        :short => '-s MM-DD-YYYY',
+        :required => false,
+        :description => 'Find events logged at a time great than or equal to the date provided. If the -u option is provided unix timestamps can be given instead.'
+
+      option :end_time,
+        :long => '--endtime MM-DD-YYYY',
+        :short => '-e MM-DD-YYYY',
+        :required => false,
+        :description => 'Find events logged at a time less than or equal to the date provided. If the -u option is provided unix timestamps can be given instead.'
+
+      option :unix_timestamps,
+        :long => '--unixtimestamps',
+        :short => '-u',
+        :required => false,
+        :boolean => true,
+        :description => 'Indicates start and end times are given as unix time stamps and not date formats.'
+
+      option :object_type,
+	:long => '--object-type N',
+	:short => '-T N',
+	:required => false,
+	:description => 'Narrow search for logged events to this object type (node, role, environment, etc.)'
+
+      option :object_name,
+	:long => '--object-name N',
+	:short => '-N N',
+	:required => false,
+	:description => 'Narrow search for logged events to objects with this name.'
+
+      option :doer,
+	:long => '--doer N',
+	:short => '-D N',
+	:required => false,
+	:description => 'Narrow search for logged events to actions performed by the given user or client.'
+
       def run
 	@rest = Chef::REST.new(Chef::Config[:chef_server_url])
 	rows = config[:limit] || 15
 	offset = config[:offset] || 0
-	list = @rest.get_rest("events?limit=#{rows}&offset=#{offset}", false, {})
+        start_time, end_time = apply_time_args()
+	list = @rest.get_rest(generate_query(rows, offset, start_time, end_time, config), false, {})
 	list.map! do |l|
 	  l["event"]["object_type"] = format_object_type(l["event"]["object_type"])
-	  { :event => { :id => l["event"]["id"],
+	  li = { :event => { :id => l["event"]["id"],
 	    :action => l["event"]["action"],
 	    :name => l["event"]["object_name"],
 	    :type => l["event"]["object_type"],
 	    :time => format_time(l["event"]["time"]) } }
+	  if config[:doer]
+	    actor_info = JSON.parse(l["event"]["actor_info"])
+	    li[:event][:performed_by] = actor_info["username"]
+	  end
+	  li
 	end
 	output(list)
       end
 
+      private
+
+      def generate_query(rows, offset, start_time, end_time, options)
+	  query = "events?limit=#{rows}&offset=#{offset}"
+	  if start_time
+	    query += "&from=#{start_time}"
+	  end
+	  if end_time
+	    query += "&until=#{end_time}"
+	  end
+	  if options[:object_type]
+	    query += "&object_type=#{options[:object_type]}"
+	  end
+	  if options[:object_name]
+	    query += "&object_name=#{options[:object_name]}"
+	  end
+	  if options[:doer]
+	    query += "&doer=#{options[:doer]}"
+	  end
+	  query
+      end
+
     end
   end
 

data/lib/chef/knife/goiardi_gel_purge.rb

@@ -8,7 +8,7 @@ class Chef
 	require 'json'
       end
 
-      include Chef::Goiardi::KnifeHelpers
+      include Chef::Goiardi::Gel::KnifeHelpers
       
       banner "knife goiardi gel purge [id]"
 

data/lib/chef/knife/goiardi_gel_show.rb

@@ -8,7 +8,7 @@ class Chef
 	require 'json'
       end
 
-      include Chef::Goiardi::KnifeHelpers
+      include Chef::Goiardi::Gel::KnifeHelpers
       
       banner "knife goiardi gel show [id]"
 

data/lib/knife-goiardi-event-log/version.rb

@@ -1,6 +1,6 @@
 module Knife
   module GoiardiEventLog
-    VERSION = '0.1.1'
+    VERSION = '0.2.0'
     MAJOR, MINOR, TINY = VERSION.split('.')
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-goiardi-event-log
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-29 00:00:00.000000000 Z
+date: 2014-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler