knife-push 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 10bd3739e9d8155db578d60947f5149d825c011c
-  data.tar.gz: d3d2037fe10e4ce7e31718a72256d9943a0445b7
+SHA256:
+  metadata.gz: 636e6fa1d65f445cf9f4981f3d75b857854b756f507468f6950a4234e3b6f980
+  data.tar.gz: 11b1c0bbec31bb8a6e69469cafd3d385458d3f3f8f21e42b9afae6bd673c971f
 SHA512:
-  metadata.gz: 0706958a8cad9e8426edb6049ced027b2ee04369bd1c625b7e57d5acc33adc9cf3ff87cbb9e4c8f2206d7e90bd46a6e8bee4cf03f93b3080e1878a5c9ce7fb57
-  data.tar.gz: 065e930d0d88fc8fe5df166aaea51d48a85805011bb5a14e3cfe2bcf1761cfdf6fd802c15edefdde747a25c067bc32e3bb7a0811ff24d017c612e95415fe9eee
+  metadata.gz: 4ed039e98ff4e483ac41f03c2f17b7b58e344236d1e92954e3850ca947fef6a48c3333cb10cc75f7dad56868d27010f2a41439542160a3d4682011fb63844601
+  data.tar.gz: 25f6b27f874f515b06857c57c450652c824a6471dcba8114c9a92255e9eeffd591c935a5b7d2d026edb22090a2bd52dbaa804d766a382fd10120dfdac1f252ba

data/lib/chef/knife/job_helpers.rb

@@ -15,6 +15,8 @@
 # under the License.
 #
 
+require "addressable/uri"
+
 class Chef
   class Knife
     module JobHelpers
@@ -22,11 +24,10 @@ class Chef
         node_names = []
         if search
           q = Chef::Search::Query.new
-          escaped_query = URI.escape(search,
-                                      Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+          escaped_query = Addressable::URI.encode_component(search, Addressable::URI::CharacterClasses::QUERY)
           begin
             nodes = q.search(:node, escaped_query).first
-          rescue Net::HTTPServerException => e
+          rescue Net::HTTPClientException => e
             msg Chef::JSONCompat.from_json(e.response.body)["error"].first
             ui.error("knife search failed: #{msg}")
             exit 1
@@ -41,7 +42,7 @@ class Chef
           exit 1
         end
 
-        return node_names
+        node_names
       end
 
       def status_string(job)
@@ -81,8 +82,8 @@ class Chef
 
       def status_code(job)
         if job["status"] == "complete" && job["nodes"].keys.all? do |key|
-             key == "succeeded" || key == "nacked" || key == "unavailable"
-           end
+          key == "succeeded" || key == "nacked" || key == "unavailable"
+        end
           0
         else
           1
@@ -117,7 +118,7 @@ class Chef
           exit 1
         end
         contents = ""
-        if File.exists?(file_name)
+        if File.exist?(file_name)
           File.open(file_name, "rb") do |file|
             contents = file.read
           end
@@ -125,7 +126,7 @@ class Chef
           ui.error "#{file_name} not found"
           exit 1
         end
-        return contents
+        contents
       end
 
       def get_env(config)

data/lib/chef/knife/job_output.rb

@@ -21,9 +21,9 @@ class Chef
       banner "knife job output <job id> <node> [<node> ...]"
 
       option :channel,
-             :long => "--channel stdout|stderr",
-             :default => "stdout",
-             :description => "Which output channel to fetch (default stdout)."
+        long: "--channel stdout|stderr",
+        default: "stdout",
+        description: "Which output channel to fetch (default stdout)."
 
       def run
         job_id = name_args[0]
@@ -38,17 +38,11 @@ class Chef
       end
 
       def get_channel(channel)
-        channel = channel || "stdout"
-        case channel
-        when "stdout"
-          return channel
-        when "stderr"
-          return channel
-        else
-          raise "Invalid Format please enter stdout or stderr"
-        end
-      end
+        channel ||= "stdout"
+        return channel if channel == "stdout" || channel == "stderr"
 
+        raise "Invalid Format please enter stdout or stderr"
+      end
     end
   end
 end

data/lib/chef/knife/job_start.rb

@@ -15,7 +15,7 @@
 # under the License.
 #
 
-require "chef/knife/job_helpers"
+require_relative "job_helpers"
 
 class Chef
   class Knife
@@ -24,7 +24,6 @@ class Chef
       include JobHelpers
 
       deps do
-        require "chef/rest"
         require "chef/node"
         require "chef/search/query"
       end
@@ -32,58 +31,58 @@ class Chef
       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)."
+        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",
-            :required => false,
-            :description => "Solr query for list of job candidates."
+        short: "-s QUERY",
+        long: "--search QUERY",
+        required: false,
+        description: "Solr query for list of job candidates."
 
       option :send_file,
-             :long => "--file FILE",
-             :default => nil,
-             :description => "File to send to job."
+        long: "--file FILE",
+        default: nil,
+        description: "File to send to job."
 
       option :capture_output,
-             :long => "--capture",
-             :boolean => true,
-             :default => false,
-             :description => "Capture job output."
+        long: "--capture",
+        boolean: true,
+        default: false,
+        description: "Capture job output."
 
       option :with_env,
-             :long => "--with-env ENV",
-             :default => nil,
-             :description => "JSON blob of environment variables to set."
+        long: "--with-env ENV",
+        default: nil,
+        description: "JSON blob of environment variables to set."
 
       option :as_user,
-             :long => "--as-user USER",
-             :default => nil,
-             :description => "User id to run as."
+        long: "--as-user USER",
+        default: nil,
+        description: "User id to run as."
 
       option :in_dir,
-             :long => "--in-dir DIR",
-             :default => nil,
-             :description => "Directory to execute the command in."
+        long: "--in-dir DIR",
+        default: nil,
+        description: "Directory to execute the command in."
 
       option :nowait,
-             :long => "--nowait",
-             :short => "-b",
-             :boolean => true,
-             :default => false,
-             :description => "Rather than waiting for each job to complete, exit immediately after starting the job."
+        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",
-             :default => 1.0,
-             :description => "Repeat interval for job status update (in seconds)."
+        long: "--poll-interval RATE",
+        default: 1.0,
+        description: "Repeat interval for job status update (in seconds)."
 
       def run
         job_name = @name_args[0]
@@ -114,7 +113,7 @@ class Chef
 
         begin
           job = run_helper(config, v2_json)
-        rescue Net::HTTPServerException => e
+        rescue Net::HTTPClientException => e
           raise e if e.response.code != "400"
 
           ui.warn "Falling back to Push Jobs v1 mode."
@@ -139,8 +138,6 @@ class Chef
         exit(status_code(job))
       end
 
-      private
-
     end
   end
 end

data/lib/chef/knife/node_status.rb

@@ -22,7 +22,7 @@ class Chef
 
       def run
         get_node_statuses(name_args).each do |node_status|
-          puts "#{node_status['node_name']}\t#{node_status['availability']}"
+          puts "#{node_status["node_name"]}\t#{node_status["availability"]}"
         end
       end
 

data/lib/knife-push/version.rb

@@ -1,7 +1,7 @@
 
 module Knife
   module Push
-    VERSION = "1.0.2"
+    VERSION = "2.0.0".freeze
     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.2
+  version: 2.0.0
 platform: ruby
 authors:
 - John Keiser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-21 00:00:00.000000000 Z
+date: 2020-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -16,25 +16,35 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.7.2
+        version: '15.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.7.2
-description: Knife plugin for Chef push
+        version: '15.0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Knife plugin for Chef Push Jobs
 email: jkeiser@chef.io
 executables: []
 extensions: []
-extra_rdoc_files:
-- README.md
-- LICENSE
+extra_rdoc_files: []
 files:
 - LICENSE
-- README.md
-- Rakefile
 - lib/chef/knife/job_helpers.rb
 - lib/chef/knife/job_list.rb
 - lib/chef/knife/job_output.rb
@@ -42,7 +52,7 @@ files:
 - lib/chef/knife/job_status.rb
 - lib/chef/knife/node_status.rb
 - lib/knife-push/version.rb
-homepage: https://www.chef.io
+homepage: https://github.com/chef/knife-push/
 licenses:
 - Apache-2.0
 metadata: {}
@@ -54,16 +64,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.2
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Knife plugin for Chef push
+summary: Knife plugin for Chef Push Jobs
 test_files: []

data/README.md

@@ -1,177 +0,0 @@
-# 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,14 +0,0 @@
-require "bundler"
-require "rubygems"
-require "rspec/core/rake_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"))