knife-reporting 0.1.1 → 0.3.1

data/README.md

@@ -12,11 +12,24 @@ optional node name parameter.
 * `knife runs list` - returns a list of all runs within the organization
 * `knife runs list bobsnode` - return a list of all runs on "bobsnode"
 
-`knife runs show` returns a detailed list of runs. It has two parameters
-node name and run id. run id is optional. Calling `knife runs show` with only
-a node name will return a detailed list of runs within that node. Calling
-it with both node name and run id will return that specific run.
+These commands default to returning the last 24 hours worth of data.
+
+If more than 24 hours worth of data is desired, or if a different time frame
+is desired, the --startime or -s option and --endtime or -e option can be given.
+They specify a starting and ending time to returns runs from. They take an
+argument in the date form of MM-DD-YYYY. If one of these options is specified
+the other must also be specified.
+
+The start and end time can be specified as a unix timestamp if the
+--unixtimestamps or -u option is also specified.
+
+Note that no more than three months worth of data can be requested at a time.
+If more than three months of data is asked for an error will be returned.
+
+User can also specify the number of rows that should be returned with
+the result. This parameter is optional and defaults to 10.
+
+`knife runs show` has one  parameter run id. It will return that specific run details.
 
-* `knife runs show bobsnode` - returns a detailed list of all runs within that node
 * `knife runs show bobsnode 30077269-59d0-4283-81f6-8d23cbed3a7a` - returns details
 about that specific node run

data/lib/chef/knife/reporting_helpers.rb

@@ -0,0 +1,73 @@
+module ReportingHelpers
+
+  # Need the unless guard b/c this code is dynamically loaded
+  # and can result in ruby warnings if it attempts to define the
+  # constant again
+  SECONDS_IN_24HOURS = 86400 unless const_defined?(:SECONDS_IN_24HOURS)
+  # Approximate, b/c of course the length of a month can vary
+  SECONDS_IN_3MONTHS = 7889230 unless const_defined?(:SECONDS_IN_3MONTHS)
+
+  def uuid?(run_id)
+    if run_id =~ /^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
+      return false
+    else
+      return true
+    end
+  end
+
+  def apply_time_args()
+    if config[:start_time] && config[:end_time]
+      start_time, end_time = convert_to_unix_timestamps()
+    else
+      start_time, end_time = last_24hours_time_window()
+    end
+
+    return start_time, end_time
+  end
+
+  def last_24hours_time_window()
+    # Time is calculated as a unix timestamp
+    end_time = Time.now.to_i
+    start_time = end_time - SECONDS_IN_24HOURS
+    return start_time, end_time
+  end
+
+  def check_start_and_end_times_provided()
+    if config[:start_time] && !config[:end_time]
+      ui.error("The start_time option was provided, but the end_time option was not. If one is provided, the other is required.")
+      exit 1
+    elsif config[:end_time] && !config[:start_time]
+      ui.error("The end_time option was provided, but the start_time option was not. If one is provided, the other is required.")
+      exit 1
+    end
+  end
+
+  def convert_to_unix_timestamps()
+    if config[:unix_timestamps]
+      start_time = config[:start_time].to_i
+      end_time = config[:end_time].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
+      start_time = Time.parse(Date.strptime(config[:start_time], '%m-%d-%Y').to_s).to_i
+      end_time = Time.parse(Date.strptime(config[:end_time], '%m-%d-%Y').to_s).to_i
+    end
+
+    return start_time, end_time
+  end
+
+  def check_3month_window(start_time, end_time)
+    # start_time and end_time are unix timestamps
+    if (end_time - start_time) > SECONDS_IN_3MONTHS
+      ui.error("Requesting information for more than three months at a time is disallowed. Please try a smaller timeframe.")
+      exit 1
+    end
+  end
+
+end

data/lib/chef/knife/runs_list.rb

@@ -1,41 +1,83 @@
 class Chef
   class Knife
     class RunsList < Chef::Knife
+
+      deps do
+        # While Ruby automatically includes some data & time functions in the
+        # base class, more advanced data & time functions still required the
+        # modules be loaded.
+        require 'time'
+        require 'date'
+        require 'chef/knife/reporting_helpers'
+      end
+
+      include ReportingHelpers
+
       banner "knife runs list [<node name>]"
 
       PROTOCOL_VERSION = '0.1.0'
       HEADERS = {'X-Ops-Reporting-Protocol-Version' => PROTOCOL_VERSION}
 
+      option :start_time,
+        :long => '--starttime MM-DD-YYYY',
+        :short => '-s MM-DD-YYYY',
+        :required => false,
+        :description => 'Find runs with a start 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 runs with an end 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 :rows,
+        :long => '--rows N',
+        :short => '-r N',
+        :required => false,
+        :description => 'Specifies the rows to be returned from the database. The default is 10.'
+
       def run
         @rest = Chef::REST.new(Chef::Config[:chef_server_url])
 
         node_name = name_args[0]
 
-        if node_name
-          runs = node_history(node_name)
-        else
-          runs = org_history
-        end
+        check_start_and_end_times_provided()
+        start_time, end_time = apply_time_args()
+        check_3month_window(start_time, end_time)
 
+        query_string = generate_query(start_time, end_time, node_name, config[:rows])
+        runs = history(query_string)
 
         output(runs)
       end
 
       private
 
-      def org_history
-        runs = @rest.get_rest("reports/org/runs", false,  HEADERS)
-
-        runs["run_history"].map do |run|
-          { :run_id => run["run_id"],
-            :node_name => run["node_name"],
-            :status => run["status"],
-            :start_time => run["start_time"] }
+      def generate_query(start_time, end_time, node_name = nil, rows = nil)
+        if node_name
+          if rows
+            "reports/nodes/#{node_name}/runs?from=#{start_time}&until=#{end_time}&rows=#{rows}"
+          else
+            "reports/nodes/#{node_name}/runs?from=#{start_time}&until=#{end_time}"
+          end
+        else
+          if rows
+            "reports/org/runs?from=#{start_time}&until=#{end_time}&rows=#{rows}"
+          else
+            "reports/org/runs?from=#{start_time}&until=#{end_time}"
+          end
         end
       end
 
-      def node_history(node_name)
-        runs = @rest.get_rest( "reports/nodes/#{node_name}/runs", false, HEADERS )
+      def history(query_string)
+        runs = @rest.get_rest(query_string, false,  HEADERS)
 
         runs["run_history"].map do |run|
           { :run_id => run["run_id"],
@@ -45,8 +87,7 @@ class Chef
         end
       end
 
-    end
   end
 end
-
+end
 

data/lib/chef/knife/runs_show.rb

@@ -1,7 +1,19 @@
 class Chef
   class Knife
     class RunsShow < Chef::Knife
-      banner "knife runs show <node name> [<run id>]"
+
+      deps do
+        # While Ruby automatically includes some data & time functions in the
+        # base class, more advanced data & time functions still required the
+        # modules be loaded.
+        require 'time'
+        require 'date'
+        require 'chef/knife/reporting_helpers'
+      end
+
+      include ReportingHelpers
+
+      banner "knife runs show <run id>"
 
       PROTOCOL_VERSION = '0.1.0'
       HEADERS = {'X-Ops-Reporting-Protocol-Version' => PROTOCOL_VERSION}
@@ -9,18 +21,23 @@ class Chef
       def run
         rest = Chef::REST.new(Chef::Config[:chef_server_url])
 
-        node_name = name_args[0]
-        run_id = name_args[1]
+        run_id = name_args[0]
 
-        if node_name.nil?
+        if run_id.nil?
           show_usage
           exit 1
+        elsif uuid?(run_id)
+          puts "Run ID should be a Chef Client Run ID, e.g: 11111111-1111-1111-1111-111111111111"
+          exit 1
         end
 
-        runs = rest.get_rest( "reports/nodes/#{node_name}/runs/#{run_id}", false, HEADERS )
+        query_string = "reports/org/runs/#{run_id}"
+
+        runs = rest.get(query_string, false, HEADERS)
 
         output(runs)
       end
+
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-reporting
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-22 00:00:00.000000000 Z
+date: 2013-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-cli
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70220669244540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,13 +21,8 @@ dependencies:
         version: 1.2.2
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.2.2
-description: Knife plugin for OpsCode Reporting
+  version_requirements: *70220669244540
+description: Knife plugin for Opscode Reporting
 email: matthew@opscode.com
 executables: []
 extensions: []
@@ -38,6 +33,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- lib/chef/knife/reporting_helpers.rb
 - lib/chef/knife/runs_list.rb
 - lib/chef/knife/runs_show.rb
 homepage: http://www.opscode.com
@@ -60,9 +56,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: Knife plugin for OpsCode Reporting
+summary: Knife plugin for Opscode Reporting
 test_files: []
 has_rdoc: false