knife-push 0.4

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.rdoc

@@ -0,0 +1,101 @@
+= Knife Push
+
+= DESCRIPTION:
+
+The knife push plugin is used by the Chef workstation to interact with the Push API to start jobs, view job status, view job lists, and view node status.
+
+= INSTALLATION:
+
+To build and install the plugin, run:
+
+    rake install
+
+= CONFIGURATION:
+
+If push server is running on the same host as the OPC, then no reconfiguration is required on the Chef workstation.
+
+= SUBCOMMANDS:
+
+This plugin provides the following Knife subcommands.  Specific command options can be found by invoking the subcommand with a <tt>--help</tt> flag.
+
+== job list
+
+The <tt>job list</tt> subcommand is used to view a list of Push jobs.
+
+== Syntax
+  $ knife job list
+
+== job start
+
+The <tt>job start</tt> subcommand is used to start a Push job.
+
+== Syntax
+  $ knife job start (options) COMMAND [NODE, NODE, ...]
+
+== Options
+This argument has the following options:
+
+  --timeout TIMEOUT
+
+The maximum amount of time (in seconds) by which a job must complete, before it will be stopped.
+
+  -q QUORUM --quorum QUORUM
+
+The minimum number of nodes that match the search criteria, are available, and acknowledge the job request. This can be expressed as a
+percentage (e.g. 50%) or as an absolute number of nodes (e.g. 145). Default value: 100%
+
+== Examples
+For example, to search for nodes assigned the role “webapp”, and where 90% of those nodes must be available, enter:
+
+  $ knife job start -quorum 90% 'chef-client' --search 'role:webapp'
+
+To search for a specific set of nodes (named chico, harpo, groucho, gummo, zeppo), and where 90% of those nodes must be available, enter:
+
+  $ knife job start --quorum 90% 'chef-client' chico harpo groucho gummo zeppo
+
+Use the <tt>knife job start</tt> subcommand to run a job with the following syntax:
+
+  $ knife job start job_name node_name
+
+For example, to run a job named add-glasses against a node named “ricardosalazar”, enter the following:
+
+  $ knife job start add-glasses 'ricardosalazar'
+
+== job status
+
+The <tt>job status</tt> argument is used to view the status of Push jobs.
+
+== Syntax
+  $ knife job status
+
+== Examples
+For example, to view the status of a job that has the identifier of “235”, enter:
+
+  $ knife job status 235
+
+== node status
+
+The <tt>node status</tt> argument is used to identify nodes that Push may interact with.
+
+== Syntax
+  $ knife node status
+
+
+== License
+
+Push - The push jobs component for chef
+
+**Copyright:** Copyright (c) 2008-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.

data/Rakefile

@@ -0,0 +1,22 @@
+require 'bundler'
+require 'rubygems'
+require 'rspec/core/rake_task'
+require 'rdoc/task'
+
+Bundler::GemHelper.install_tasks
+
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+gem_spec = eval(File.read("knife-push.gemspec"))
+
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "knife-push #{gem_spec.version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/chef/knife/job_list.rb

@@ -0,0 +1,33 @@
+# @copyright Copyright 2014 Chef Software, Inc. All Rights Reserved.
+#
+# This file is provided to you 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
+  class Knife
+    class JobList < Chef::Knife
+      banner "knife job list"
+
+      def run
+        rest = Chef::REST.new(Chef::Config[:chef_server_url])
+
+        jobs = rest.get_rest("pushy/jobs")
+        output(jobs)
+      end
+    end
+  end
+end
+
+

data/lib/chef/knife/job_start.rb

@@ -0,0 +1,141 @@
+# @copyright Copyright 2014 Chef Software, Inc. All Rights Reserved.
+#
+# This file is provided to you 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
+  class Knife
+    class JobStart < Chef::Knife
+
+      deps do
+        require 'chef/rest'
+        require 'chef/node'
+        require 'chef/search/query'
+      end
+
+      banner "knife job start <command> [<node> <node> ...]"
+
+      option :run_timeout,
+        :long => '--timeout TIMEOUT',
+        :description => "Maximum time the job will be allowed to run (in seconds)."
+
+      option :quorum,
+            :short => '-q QUORUM',
+            :long => '--quorum QUORUM',
+            :default => '100%',
+            :description => 'Pushy job quorum. Percentage (-q 50%) or Count (-q 145).'
+
+      option :search,
+            :short => '-s QUERY',
+            :long => '--search QUERY',
+            :required => false,
+            :description => 'Solr query for list of job candidates.'
+
+      def run
+        @node_names = []
+        if config[:search]
+          q = Chef::Search::Query.new
+          @escaped_query = URI.escape(config[:search],
+                                     Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+          begin
+            nodes = q.search(:node, @escaped_query).first
+          rescue Net::HTTPServerException => e
+            msg Chef::JSONCompat.from_json(e.response.body)['error'].first
+            ui.error("knife search failed: #{msg}")
+            exit 1
+          end
+          nodes.each { |node| @node_names << node[:hostname] unless node[:hostname].nil? }
+        else
+          @node_names = name_args[1,name_args.length-1]
+        end
+
+        rest = Chef::REST.new(Chef::Config[:chef_server_url])
+
+        job_json = {
+          'command' => name_args[0],
+          'nodes' => @node_names,
+          'quorum' => get_quorum(config[:quorum], @node_names.length)
+        }
+        job_json['run_timeout'] = config[:run_timeout].to_i if config[:run_timeout]
+        result = rest.post_rest('pushy/jobs', job_json)
+        job_uri = result['uri']
+        puts "Started.  Job ID: #{job_uri[-32,32]}"
+        previous_state = "Initialized."
+        begin
+          sleep(0.1)
+          job = rest.get_rest(job_uri)
+          finished, state = status_string(job)
+          if state != previous_state
+            puts state
+            previous_state = state
+          end
+        end until finished
+
+        output(job)
+
+        exit(status_code(job))
+      end
+
+      private
+
+      def status_string(job)
+        case job['status']
+        when 'new'
+          [false, 'Initialized.']
+        when 'voting'
+          [false, job['status'].capitalize + '.']
+        else
+          total = job['nodes'].values.inject(0) { |sum,nodes| sum+nodes.length }
+          in_progress = job['nodes'].keys.inject(0) { |sum,status|
+            nodes = job['nodes'][status]
+            sum + (%w(new voting running).include?(status) ? 1 : 0)
+          }
+          if job['status'] == 'running'
+            [false, job['status'].capitalize + " (#{in_progress}/#{total} in progress) ..."]
+          else
+            [true, job['status'].capitalize + '.']
+          end
+        end
+      end
+
+      def get_quorum(quorum, total_nodes)
+        unless qmatch = /^(\d+)(\%?)$/.match(quorum)
+          raise "Invalid Format please enter integer or percent"
+        end
+
+        num = qmatch[1]
+
+        case qmatch[2]
+          when "%" then
+            ((num.to_f/100)*total_nodes).ceil
+          else
+            num.to_i
+        end
+      end
+
+      def status_code(job)
+        if job['status'] == "complete" && job["nodes"].keys.all? do |key|
+            key == "succeeded" || key == "nacked" || key == "unavailable"
+          end
+          0
+        else
+          1
+        end
+      end
+
+    end
+  end
+end
+

data/lib/chef/knife/job_status.rb

@@ -0,0 +1,33 @@
+# @copyright Copyright 2014 Chef Software, Inc. All Rights Reserved.
+#
+# This file is provided to you 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
+  class Knife
+    class JobStatus < Chef::Knife
+      banner "knife job status <job id>"
+
+      def run
+        rest = Chef::REST.new(Chef::Config[:chef_server_url])
+
+        job_id = name_args[0]
+        job = rest.get_rest("pushy/jobs/#{job_id}")
+        output(job)
+      end
+    end
+  end
+end
+

data/lib/chef/knife/node_status.rb

@@ -0,0 +1,55 @@
+# @copyright Copyright 2014 Chef Software, Inc. All Rights Reserved.
+#
+# This file is provided to you 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
+  class Knife
+    class NodeStatus < Chef::Knife
+      banner "knife node status [<node> <node> ...]"
+
+      def run
+        rest = Chef::REST.new(Chef::Config[:chef_server_url])
+
+        get_node_statuses(name_args).each do |node_status|
+          puts "#{node_status['node_name']}\t#{node_status['availability']}"
+        end
+      end
+
+      private
+
+      def get_node_statuses(name_args=[])
+        if name_args.length == 0
+          rest.get_rest("pushy/node_states")
+        else
+          results = []
+          name_args.each do |arg|
+            if arg.index(':')
+              search(:node, arg).each do |node|
+                results << rest.get_rest("pushy/node_states/#{node.node_name}")
+              end
+            else
+              results << rest.get_rest("pushy/node_states/#{arg}")
+            end
+          end
+          results
+        end
+      end
+
+    end
+  end
+end
+
+

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: knife-push
+version: !ruby/object:Gem::Version
+  version: '0.4'
+  prerelease: 
+platform: ruby
+authors:
+- John Keiser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 11.10.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 11.10.4
+description: Knife plugin for OPC push
+email: jkeiser@opscode.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- LICENSE
+files:
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/chef/knife/job_list.rb
+- lib/chef/knife/job_start.rb
+- lib/chef/knife/job_status.rb
+- lib/chef/knife/node_status.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 OPC push
+test_files: []
+has_rdoc: true