knife-push 0.5.2 → 1.0.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2e3fa58643a7d957722e6b41f35d385026978e5
-  data.tar.gz: d23116a303eb6a6b7ec9f6829f1f6bcbd9de2c0a
+  metadata.gz: 2dc8400554d194b41e9b0a7d76d5b2754617725e
+  data.tar.gz: af456e39586721e50d9379e89e68b5eb0d906e97
 SHA512:
-  metadata.gz: 151042bedd64c58c71b5e750c42f70a67c31cb0aa331d71d24c080496d2424b1dee2686274afe828d20553991a846253bbb11cf0fcdb231fe8b52e253ead0a78
-  data.tar.gz: a0e4fa73d2993a7834d27583d0684d9e143a2c3e7ac00a07b35444d5c13608fad848bb4b027c5697d3d0af852531cda66ef98ff1e491b1ec0f0eb9fc36e4f7df
+  metadata.gz: 3d312ddaa30d594c0933f49455dd3cbffeade09b2b9ce33e700d31973d7e71825f7183f140ddfb1305cd1200fd1a1cbdbea466d0f8f6cb2a2025aead4a096700
+  data.tar.gz: 342d3aba428326497b981bf09541ab66f1d348157b7301866d012f5dc731491f49a510182db0b1f38fe6b10b876e709410c3d17dae5c09e00e5bedba24705d01

data/README.rdoc

@@ -22,17 +22,17 @@ This plugin provides the following Knife subcommands.  Specific command options
 
 The <tt>job list</tt> subcommand is used to view a list of Push jobs.
 
-== Syntax
+=== Syntax
   $ knife job list
 
 == job start
 
 The <tt>job start</tt> subcommand is used to start a Push job.
 
-== Syntax
+=== Syntax
   $ knife job start (options) COMMAND [NODE, NODE, ...]
 
-== Options
+=== Options
 This argument has the following options:
 
   --timeout TIMEOUT
@@ -44,11 +44,30 @@ The maximum amount of time (in seconds) by which a job must complete, before it
 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 --no-wait
+  -b --nowait
 
 Exit immediately after starting a job instead of waiting for it to complete.
 
-== Examples
+  --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'
@@ -65,14 +84,35 @@ For example, to run a job named add-glasses against a node named “ricardosalaz
 
   $ 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> argument is used to view the status of Push jobs.
+The <tt>job status</tt> command is used to view the status of Push jobs.
 
-== Syntax
-  $ knife job status
+=== Syntax
+  $ knife job status JOBID
 
-== Examples
+=== Examples
 For example, to view the status of a job that has the identifier of “235”, enter:
 
   $ knife job status 235
@@ -81,10 +121,12 @@ For example, to view the status of a job that has the identifier of “235”, e
 
 The <tt>node status</tt> argument is used to identify nodes that Push may interact with.
 
-== Syntax
+=== Syntax
   $ knife node status
 
 
+
+
 == License
 
 Push - The push jobs component for chef

data/lib/chef/knife/job_helpers.rb

@@ -0,0 +1,141 @@
+# @copyright Copyright 2015 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
+    module JobHelpers
+      def process_search(search, nodes)
+        node_names = []
+        if search
+          q = Chef::Search::Query.new
+          escaped_query = URI.escape(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.name }
+        else
+          node_names = nodes
+        end
+
+        if node_names.empty?
+          ui.error "No nodes to run job on. Specify nodes as arguments or use -s to specify a search query."
+          exit 1
+        end
+
+        return node_names
+      end
+
+      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
+
+      def run_helper(config, job_json)
+        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]}"
+        exit(0) if config[:nowait]
+        previous_state = "Initialized."
+        begin
+          sleep(config[:poll_interval].to_f)
+          putc(".")
+          job = rest.get_rest(job_uri)
+          finished, state = JobHelpers.status_string(job)
+          if state != previous_state
+            puts state
+            previous_state = state
+          end
+        end until finished
+        job
+      end
+
+      def file_helper(file_name)
+        if file_name.nil?
+          ui.error "No file specified."
+          show_usage
+          exit 1
+        end
+        contents = ""
+        if File.exists?(file_name)
+          File.open(file_name, "rb") do |file|
+            contents = file.read
+          end
+        else
+          ui.error "#{file_name} not found"
+          exit 1
+        end
+        return contents
+      end
+
+      def get_env(config)
+        env = {}
+        begin
+          env = config[:with_env] ? JSON.parse(config[:with_env]) : {}
+        rescue Exception => e
+           Chef::Log.info("Can't parse environment as JSON")
+        end
+      end
+    end
+  end
+end

data/lib/chef/knife/job_list.rb

@@ -21,8 +21,6 @@ class Chef
       banner "knife job list"
 
       def run
-        rest = Chef::REST.new(Chef::Config[:chef_server_url])
-
         jobs = rest.get_rest("pushy/jobs")
         output(jobs)
       end
@@ -30,4 +28,3 @@ class Chef
   end
 end
 
-

data/lib/chef/knife/job_output.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 JobOutput < Chef::Knife
+      banner "knife job output <job id> <node> [<node> ...]"
+
+      option :channel,
+             :long => '--channel stdout|stderr',
+             :default => 'stdout',
+             :description => "Which output channel to fetch (default stdout)."
+
+      def run
+        job_id = name_args[0]
+        channel = get_channel(config[:channel])
+        node = name_args[1]
+
+        uri = "pushy/jobs/#{job_id}/output/#{node}/#{channel}"
+
+        job = rest.get_rest(uri, false, {"Accept"=>"application/octet-stream"})
+
+        output(job)
+      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
+
+    end
+  end
+end
+

data/lib/chef/knife/job_start.rb

@@ -15,10 +15,14 @@
 # under the License.
 #
 
+require 'chef/knife/job_helpers'
+
 class Chef
   class Knife
     class JobStart < Chef::Knife
 
+      include JobHelpers
+
       deps do
         require 'chef/rest'
         require 'chef/node'
@@ -43,16 +47,45 @@ class Chef
             :required => false,
             :description => 'Solr query for list of job candidates.'
 
+      option :send_file,
+             :long => '--file FILE',
+             :default => nil,
+             :description => 'File to send to job.'
+
+      option :capture_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.'
+
+      option :as_user,
+             :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.'
+
       option :nowait,
-        :long => '--no-wait',
-        :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."
 
-      def run
-        @node_names = []
+      option :poll_interval,
+             :long => '--poll-interval RATE',
+             :default => 1.0,
+             :description => "Repeat interval for job status update (in seconds)."
 
+      def run
         job_name = @name_args[0]
         if job_name.nil?
           ui.error "No job specified."
@@ -60,101 +93,29 @@ class Chef
           exit 1
         end
 
-        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.name }
-        else
-          @node_names = name_args[1,name_args.length-1]
-        end
-
-        if @node_names.empty?
-          ui.error "No nodes to run job on. Specify nodes as arguments or use -s to specify a search query."
-          exit 1
-        end
-
-        rest = Chef::REST.new(Chef::Config[:chef_server_url])
+        @node_names = process_search(config[:search], name_args[1,@name_args.length-1])
 
         job_json = {
           'command' => job_name,
           'nodes' => @node_names,
-          'quorum' => get_quorum(config[:quorum], @node_names.length)
+          'capture_output' => config[:capture_output]
         }
-        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]}"
-        exit(0) if config[:nowait]
-        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
+        job_json['file'] = "raw:" + file_helper(config[:send_file]) if config[:send_file]
+        job_json['quorum'] = get_quorum(config[:quorum], @node_names.length)
+        env = get_env(config)
+        job_json['env'] = env if env
+        job_json['dir'] = config[:in_dir] if config[:in_dir]
+        job_json['user'] = config[:as_user] if config[:as_user]
+
+        job = run_helper(config, job_json)
 
         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
+      private
 
     end
   end

data/lib/chef/knife/job_status.rb

@@ -14,15 +14,12 @@
 # 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)

data/lib/chef/knife/node_status.rb

@@ -21,8 +21,6 @@ class Chef
       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

data/lib/knife-push/version.rb

@@ -1,6 +1,7 @@
+
 module Knife
   module Push
-    VERSION = '0.5.2'
+    VERSION = '1.0.0.pre'
     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: 0.5.2
+  version: 1.0.0.pre
 platform: ruby
 authors:
 - John Keiser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-09 00:00:00.000000000 Z
+date: 2016-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -38,7 +38,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Knife plugin for OPC push
+description: Knife plugin for chef push
 email: jkeiser@opscode.com
 executables: []
 extensions: []
@@ -49,12 +49,14 @@ files:
 - LICENSE
 - README.rdoc
 - Rakefile
+- lib/chef/knife/job_helpers.rb
 - lib/chef/knife/job_list.rb
+- lib/chef/knife/job_output.rb
 - lib/chef/knife/job_start.rb
 - lib/chef/knife/job_status.rb
 - lib/chef/knife/node_status.rb
 - lib/knife-push/version.rb
-homepage: http://www.opscode.com
+homepage: http://www.chef.io
 licenses: []
 metadata: {}
 post_install_message: 
@@ -68,13 +70,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
-summary: Knife plugin for OPC push
+summary: Knife plugin for chef push
 test_files: []
+has_rdoc: true