knife-goiardi-reporting 0.3.3

data/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.

data/README.md

@@ -0,0 +1,67 @@
+# Knife Reporting
+
+A knife plugin for use with OpsCode Chef's reporting system.
+
+## Commands
+There are two basic commands `knife runs list` and `knife runs show`
+
+`knife runs list` returns a listing of node runs by org or by node. To get a
+listing by org just use the basic command. To get a listing by node pass the
+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"
+
+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 30077269-59d0-4283-81f6-8d23cbed3a7a` - returns details
+about that specific node run
+
+## License
+
+Copyright 2013-2014, Chef Software 
+
+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.
+
+The status extension for goiardi was is
+
+Copyright 2014, Jeremy Bingham (<jbingham@gmail.com>)
+
+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/Rakefile

@@ -0,0 +1,20 @@
+require 'bundler'
+require 'rubygems'
+# Workaround for rake 10.0.4/Ruby 1.9.2p290 rdoc collision
+# https://github.com/jimweirich/rake/issues/157
+gem 'rdoc', ">= 2.4.2"
+require 'rdoc/task'
+
+Bundler::GemHelper.install_tasks
+
+task :default => :install
+
+gem_spec = eval(File.read("knife-goiardi-reporting.gemspec"))
+
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "knife-goiardi-reporting #{gem_spec.version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/lib/chef/goiardi/reporting/knife_helpers.rb

@@ -0,0 +1,95 @@
+#
+# Copyright:: Copyright (c) 2013-2014 Chef Software, 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 Chef
+  module Goiardi
+    module Reporting
+      module KnifeHelpers
+
+	# 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
+    end
+  end
+end

data/lib/chef/knife/goiardi_runs_list.rb

@@ -0,0 +1,120 @@
+#
+# Copyright:: Copyright (c) 2013-2014 Chef Software, 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 'chef/goiardi/reporting/knife_helpers'
+
+class Chef
+  class Knife
+    class GoiardiRunsList < 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'
+      end
+
+      include Chef::Goiardi::Reporting::KnifeHelpers
+
+      banner "knife goiardi 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.'
+
+      option :status,
+        :long => '--status N',
+        :short => '-S N',
+        :required => false,
+        :description => "Only return reports matching the given status. Acceptable status are 'started', 'success', and 'failure'."
+
+      def run
+        @rest = Chef::REST.new(Chef::Config[:chef_server_url])
+
+        node_name = name_args[0]
+
+        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])
+	if config[:status]
+	  query_string += "&status=#{config[:status]}"
+	end
+        runs = history(query_string)
+
+        output(runs)
+      end
+
+      private
+
+      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 history(query_string)
+        runs = @rest.get_rest(query_string, 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"] }
+        end
+      end
+
+    end
+  end
+end
+

data/lib/chef/knife/goiardi_runs_show.rb

@@ -0,0 +1,62 @@
+#
+# Copyright:: Copyright (c) 2013-2014 Chef Software, 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 'chef/goiardi/reporting/knife_helpers'
+
+class Chef
+  class Knife
+    class GoiardiRunsShow < 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'
+      end
+
+      include Chef::Goiardi::Reporting::KnifeHelpers
+
+      banner "knife goiardi runs show <run id>"
+
+      PROTOCOL_VERSION = '0.1.0'
+      HEADERS = {'X-Ops-Reporting-Protocol-Version' => PROTOCOL_VERSION}
+
+      def run
+        rest = Chef::REST.new(Chef::Config[:chef_server_url])
+
+        run_id = name_args[0]
+
+        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
+
+        query_string = "reports/org/runs/#{run_id}"
+
+        runs = rest.get(query_string, false, HEADERS)
+
+        output(runs)
+      end
+
+    end
+  end
+end
+

data/lib/knife-goiardi-reporting/version.rb

@@ -0,0 +1,6 @@
+module Knife
+  module GoiardiReporting
+    VERSION = '0.3.3'
+    MAJOR, MINOR, TINY = VERSION.split('.')
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: knife-goiardi-reporting
+version: !ruby/object:Gem::Version
+  version: 0.3.3
+  prerelease: 
+platform: ruby
+authors:
+- Matthew Peck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mixlib-cli
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        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
+email: matthew@opscode.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/chef/knife/goiardi_runs_list.rb
+- lib/chef/knife/goiardi_runs_show.rb
+- lib/chef/goiardi/reporting/knife_helpers.rb
+- lib/knife-goiardi-reporting/version.rb
+homepage: http://www.opscode.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Knife plugin for Opscode Reporting
+test_files: []