knife-push 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 038f57928247aec7d8738ba995ef7c55c0aad8df
-  data.tar.gz: c4a210015c78ef8ffb3c744cf0a3e177c5e1ce39
+  metadata.gz: 10bd3739e9d8155db578d60947f5149d825c011c
+  data.tar.gz: d3d2037fe10e4ce7e31718a72256d9943a0445b7
 SHA512:
-  metadata.gz: bab6b08e47fabe72250eb77e928c9ff8da38abb9000553c145c80ac8672d6cc3c6db847edc45f950f7a7c8fab9fe14ac61efedebed44a3cc9e65834adb4756f1
-  data.tar.gz: d1312745ef63c28bca515568a0d1f19d246bc52ea10e8483c7e14ff1ac5e2361e941435f8040c16ad174227903303b69664a617f2e3ac162b0ffd2ae9f534622
+  metadata.gz: 0706958a8cad9e8426edb6049ced027b2ee04369bd1c625b7e57d5acc33adc9cf3ff87cbb9e4c8f2206d7e90bd46a6e8bee4cf03f93b3080e1878a5c9ce7fb57
+  data.tar.gz: 065e930d0d88fc8fe5df166aaea51d48a85805011bb5a14e3cfe2bcf1761cfdf6fd802c15edefdde747a25c067bc32e3bb7a0811ff24d017c612e95415fe9eee

data/README.md

@@ -0,0 +1,177 @@
+# Knife Push
+
+[![Gem Version](https://badge.fury.io/rb/knife-push.svg)](https://badge.fury.io/rb/knife-push) [![Build Status](https://travis-ci.org/chef/knife-push.svg?branch=master)](https://travis-ci.org/chef/knife-push)
+
+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.
+
+## Requirements
+
+- Chef 12.0 higher
+- Ruby 2.2.2 or higher
+
+## Installation:
+
+To build and install the plugin, run:
+
+```shell
+    rake install
+```
+
+## Configuration:
+
+If push server is running on the same host as the Chef Server, 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 `--help` flag.
+
+### job list
+
+The `job list` subcommand is used to view a list of Push jobs.
+
+#### Syntax $ knife job list
+
+### job start
+
+The `job start` subcommand is used to start a Push job.
+
+#### Syntax
+
+```shell
+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%
+
+`-b --nowait`
+
+Exit immediately after starting a job instead of waiting for it to complete.
+
+`--with-env ENVIRONMENT`
+
+Accept a json blob of environment variables and use those to set the variables for the client. For example '{"test": "foo"}' will set the push client environment variable "test" to "foo". (Push 2.0 and later)
+
+`--in-dir DIR`
+
+Execute the remote command in the directory DIR. (Push 2.0 and later)
+
+`--file DATAFILE`
+
+Send the file to the client. (Push 2.0 and later)
+
+`--capture`
+
+Capture stdin and stdout for this job. (Push 2.0 and later)
+
+#### Examples
+
+For example, to search for nodes assigned the role "webapp", and where 90% of those nodes must be available, enter:
+
+```shell
+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:
+
+```shell
+knife job start --quorum 90% 'chef-client' chico harpo groucho gummo zeppo
+```
+
+Use the `knife job start` subcommand to run a job with the following syntax:
+
+```shell
+knife job start job_name node_name
+```
+
+For example, to run a job named add-glasses against a node named "ricardosalazar", enter the following:
+
+```shell
+knife job start add-glasses 'ricardosalazar'
+```
+
+### job output
+
+The `job output` command is used to view the output of Push jobs. (Push 2.0 and later). The output capture flag must have been set on job start; see the --capture option.
+
+#### Syntax
+
+```shell
+knife job output JOBID
+```
+
+#### Examples
+
+```shell
+knife job output 26e98ba162fa7ba6fb2793125553c7ae test --channel stdout
+```
+
+#### Options
+
+--channel [stderr|stdout]
+
+The output channel to capture.
+
+### job status
+
+The `job status` command is used to view the status of Push jobs.
+
+#### Syntax
+
+```shell
+knife job status JOBID
+```
+
+#### Examples
+
+For example, to view the status of a job that has the identifier of "235", enter:
+
+```shell
+knife job status 235
+```
+
+### node status
+
+The `node status` argument is used to identify nodes that Push may interact with.
+
+#### Syntax
+
+```shell
+knife node status
+```
+
+## Contributing
+
+For information on contributing to this project see <https://github.com/chef/chef/blob/master/CONTRIBUTING.md>
+
+
+## License
+
+**Author:** John Keiser([jkeiser@chef.io](mailto:jkeiser@chef.io))
+
+**Copyright:** Copyright 2008-2016, Chef Software, Inc.
+
+**License:** Apache License, Version 2.0
+
+```text
+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

@@ -1,7 +1,6 @@
-require 'bundler'
-require 'rubygems'
-require 'rspec/core/rake_task'
-require 'rdoc/task'
+require "bundler"
+require "rubygems"
+require "rspec/core/rake_task"
 
 Bundler::GemHelper.install_tasks
 
@@ -9,14 +8,7 @@ task :default => :spec
 
 desc "Run specs"
 RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
+  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_helpers.rb

@@ -27,7 +27,7 @@ class Chef
           begin
             nodes = q.search(:node, escaped_query).first
           rescue Net::HTTPServerException => e
-            msg Chef::JSONCompat.from_json(e.response.body)['error'].first
+            msg Chef::JSONCompat.from_json(e.response.body)["error"].first
             ui.error("knife search failed: #{msg}")
             exit 1
           end
@@ -45,21 +45,21 @@ class Chef
       end
 
       def status_string(job)
-        case job['status']
-        when 'new'
-          [false, 'Initialized.']
-        when 'voting'
-          [false, job['status'].capitalize + '.']
+        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) ..."]
+          total = job["nodes"].values.inject(0) { |sum, nodes| sum + nodes.length }
+          in_progress = job["nodes"].keys.inject(0) do |sum, status|
+            nodes = job["nodes"][status]
+            sum + (%w{new voting running}.include?(status) ? 1 : 0)
+          end
+          if job["status"] == "running"
+            [false, job["status"].capitalize + " (#{in_progress}/#{total} in progress) ..."]
           else
-            [true, job['status'].capitalize + '.']
+            [true, job["status"].capitalize + "."]
           end
         end
       end
@@ -73,16 +73,16 @@ class Chef
 
         case qmatch[2]
           when "%" then
-            ((num.to_f/100)*total_nodes).ceil
+            ((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
+        if job["status"] == "complete" && job["nodes"].keys.all? do |key|
+             key == "succeeded" || key == "nacked" || key == "unavailable"
+           end
           0
         else
           1
@@ -90,11 +90,11 @@ class Chef
       end
 
       def run_helper(config, job_json)
-        job_json['run_timeout'] ||= config[:run_timeout].to_i if config[:run_timeout]
+        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]}"
+        result = rest.post_rest("pushy/jobs", job_json)
+        job_uri = result["uri"]
+        puts "Started.  Job ID: #{job_uri[-32, 32]}"
         exit(0) if config[:nowait]
         previous_state = "Initialized."
         begin
@@ -133,7 +133,7 @@ class Chef
         begin
           env = config[:with_env] ? JSON.parse(config[:with_env]) : {}
         rescue Exception => e
-           Chef::Log.info("Can't parse environment as JSON")
+          Chef::Log.info("Can't parse environment as JSON")
         end
       end
     end

data/lib/chef/knife/job_list.rb

@@ -27,4 +27,3 @@ class Chef
     end
   end
 end
-

data/lib/chef/knife/job_output.rb

@@ -21,8 +21,8 @@ class Chef
       banner "knife job output <job id> <node> [<node> ...]"
 
       option :channel,
-             :long => '--channel stdout|stderr',
-             :default => 'stdout',
+             :long => "--channel stdout|stderr",
+             :default => "stdout",
              :description => "Which output channel to fetch (default stdout)."
 
       def run
@@ -32,7 +32,7 @@ class Chef
 
         uri = "pushy/jobs/#{job_id}/output/#{node}/#{channel}"
 
-        job = rest.get_rest(uri, false, {"Accept"=>"application/octet-stream"})
+        job = rest.get_rest(uri, { "Accept" => "application/octet-stream" })
 
         output(job)
       end
@@ -52,4 +52,3 @@ class Chef
     end
   end
 end
-

data/lib/chef/knife/job_start.rb

@@ -15,7 +15,7 @@
 # under the License.
 #
 
-require 'chef/knife/job_helpers'
+require "chef/knife/job_helpers"
 
 class Chef
   class Knife
@@ -24,64 +24,64 @@ class Chef
       include JobHelpers
 
       deps do
-        require 'chef/rest'
-        require 'chef/node'
-        require 'chef/search/query'
+        require "chef/rest"
+        require "chef/node"
+        require "chef/search/query"
       end
 
       banner "knife job start <command> [<node> <node> ...]"
 
       option :run_timeout,
-        :long => '--timeout 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).'
+            :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',
+            :short => "-s QUERY",
+            :long => "--search QUERY",
             :required => false,
-            :description => 'Solr query for list of job candidates.'
+            :description => "Solr query for list of job candidates."
 
       option :send_file,
-             :long => '--file FILE',
+             :long => "--file FILE",
              :default => nil,
-             :description => 'File to send to job.'
+             :description => "File to send to job."
 
       option :capture_output,
-             :long => '--capture',
+             :long => "--capture",
              :boolean => true,
              :default => false,
-             :description => 'Capture job output.'
+             :description => "Capture job output."
 
       option :with_env,
              :long => "--with-env ENV",
              :default => nil,
-             :description => 'JSON blob of environment variables to set.'
+             :description => "JSON blob of environment variables to set."
 
       option :as_user,
              :long => "--as-user USER",
              :default => nil,
-             :description => 'User id to run as.'
+             :description => "User id to run as."
 
       option :in_dir,
              :long => "--in-dir DIR",
              :default => nil,
-             :description => 'Directory to execute the command in.'
+             :description => "Directory to execute the command in."
 
       option :nowait,
-             :long => '--nowait',
-             :short => '-b',
+             :long => "--nowait",
+             :short => "-b",
              :boolean => true,
              :default => false,
              :description => "Rather than waiting for each job to complete, exit immediately after starting the job."
 
       option :poll_interval,
-             :long => '--poll-interval RATE',
+             :long => "--poll-interval RATE",
              :default => 1.0,
              :description => "Repeat interval for job status update (in seconds)."
 
@@ -93,24 +93,24 @@ class Chef
           exit 1
         end
 
-        @node_names = process_search(config[:search], name_args[1,@name_args.length-1])
+        @node_names = process_search(config[:search], name_args[1, @name_args.length - 1])
 
         job_json = {
-          'command' => job_name,
-          'nodes' => @node_names,
+          "command" => job_name,
+          "nodes" => @node_names,
         }
 
-        job_json['quorum'] = get_quorum(config[:quorum], @node_names.length)
+        job_json["quorum"] = get_quorum(config[:quorum], @node_names.length)
 
         v2_json = job_json.dup
 
-        v2_json['file'] = "raw:" + file_helper(config[:send_file]) if config[:send_file]
+        v2_json["file"] = "raw:" + file_helper(config[:send_file]) if config[:send_file]
 
-        v2_json['capture_output'] = config[:capture_output]
+        v2_json["capture_output"] = config[:capture_output]
         env = get_env(config)
-        v2_json['env'] = env if env
-        v2_json['dir'] = config[:in_dir] if config[:in_dir]
-        v2_json['user'] = config[:as_user] if config[:as_user]
+        v2_json["env"] = env if env
+        v2_json["dir"] = config[:in_dir] if config[:in_dir]
+        v2_json["user"] = config[:as_user] if config[:as_user]
 
         begin
           job = run_helper(config, v2_json)
@@ -126,7 +126,7 @@ class Chef
 
           %i{ send_file dir user }.each do |feature|
             if config[feature]
-              ui.error "Can't use a 2.0 feature (#{feature.to_s}) with a 1.0 server"
+              ui.error "Can't use a 2.0 feature (#{feature}) with a 1.0 server"
               exit 1
             end
           end
@@ -137,7 +137,6 @@ class Chef
         output(job)
 
         exit(status_code(job))
-
       end
 
       private

data/lib/chef/knife/job_status.rb

@@ -27,4 +27,3 @@ class Chef
     end
   end
 end
-

data/lib/chef/knife/node_status.rb

@@ -28,13 +28,13 @@ class Chef
 
       private
 
-      def get_node_statuses(name_args=[])
+      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(':')
+            if arg.index(":")
               search(:node, arg).each do |node|
                 results << rest.get_rest("pushy/node_states/#{node.node_name}")
               end
@@ -49,5 +49,3 @@ class Chef
     end
   end
 end
-
-

data/lib/knife-push/version.rb

@@ -1,7 +1,7 @@
 
 module Knife
   module Push
-    VERSION = '1.0.1'
-    MAJOR, MINOR, TINY = VERSION.split('.')
+    VERSION = "1.0.2"
+    MAJOR, MINOR, TINY = VERSION.split(".")
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knife-push
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - John Keiser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-05 00:00:00.000000000 Z
+date: 2016-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -16,52 +16,24 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 11.10.4
+        version: 12.7.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 11.10.4
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: Knife plugin for chef push
-email: jkeiser@opscode.com
+        version: 12.7.2
+description: Knife plugin for Chef push
+email: jkeiser@chef.io
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.rdoc
+- README.md
 - LICENSE
 files:
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - lib/chef/knife/job_helpers.rb
 - lib/chef/knife/job_list.rb
@@ -70,8 +42,9 @@ files:
 - lib/chef/knife/job_status.rb
 - lib/chef/knife/node_status.rb
 - lib/knife-push/version.rb
-homepage: http://www.chef.io
-licenses: []
+homepage: https://www.chef.io
+licenses:
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -81,7 +54,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -89,8 +62,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Knife plugin for chef push
+summary: Knife plugin for Chef push
 test_files: []

data/README.rdoc

@@ -1,147 +0,0 @@
-= 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%
-
-  -b --nowait
-
-Exit immediately after starting a job instead of waiting for it to complete.
-
-  --with-env ENVIRONMENT
-
-Accept a json blob of environment variables and use those to set the
-variables for the client. For example '{"test": "foo"}' will set the
-push client environment variable "test" to "foo". (Push 2.0 and later)
-
-  --in-dir DIR
-
-Execute the remote command in the directory DIR. (Push 2.0 and later)
-
-  --file DATAFILE
-
-Send the file to the client. (Push 2.0 and later)
-
-  --capture
-
-Capture stdin and stdout for this job. (Push 2.0 and later)
-
-
-=== 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 output
-
-The <tt>job output </tt> command is used to view the output of Push
-jobs. (Push 2.0 and later). The output capture flag must have been set
-on job start; see the --capture option.
-
-=== Syntax
-
-  $ knife job output JOBID 
-
-=== Examples
-
-  $ knife job output 26e98ba162fa7ba6fb2793125553c7ae test --channel stdout
-
-=== Options
-
-  --channel [stderr|stdout]
-
-The output channel to capture. 
-
-
-== job status
-
-The <tt>job status</tt> command is used to view the status of Push jobs.
-
-=== Syntax
-  $ knife job status JOBID
-
-=== 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.