lita-rundeck 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 920881268d3717f0f643458c23cfb151436a1348
-  data.tar.gz: baac69e1fa774f74ef82a5855f64252d3afc894c
+  metadata.gz: e5fe181cc70a8be965758bb306c00a5dfddfe966
+  data.tar.gz: 68259387a4d5cc02522e2c0117fa92bc12942c26
 SHA512:
-  metadata.gz: adae124046d4cf97122a2ec8205de39698494d8d403b3e9041915f2bccf10f172e38d5cbc9c5e79d8851b038024e9ec9afb5569cfb47942717de130e28b14b3c
-  data.tar.gz: 7628d6080c38058e30c70f50164552d8161c472b7958215348a0accefba1498f7c11e816e880742f93d77a0c9509235b629d329a43f26283e7c1c9896d3913a4
+  metadata.gz: 337cb78204675edeb677679fa9819d4d0363c29a3712350c1f5ea614704dedef56f5455e8334c048e6af56c9fe777f354f296060f67f756654913e576ef01fa1
+  data.tar.gz: 2aafc6f0e73291c05f35d6456841a325b65ca48093388ed6eac73221b7f46b19a13c640083e751d1771745aef04f4884ac62f511aa54fbd0a9c99b311cb70c3f

data/README.md

@@ -38,23 +38,44 @@ end
 
 ### Run
 
-Start a job execution
+Start a job execution. Optionally, have Lita return part or all of the output log to the channel when complete.
+
+Syntax:
+```
+rundeck run ALIAS|--project NAME --job NAME [--options KEY=VALUE,KEY=VALUE] [--report all|NUMBER]
+```
+
+* Pass either an alias name or `--project` AND `--name` to execute the job
+* Optionally, pass Job options (defined in rundeck itself) as key/value pairs delimited by a comma
+* Finally, add `--report` with the string `all` to return the entirety of the log output to the channel once the job is complete. (Note Lita won't begin checking for job completion until the average duration of the job is complete.) You can also limit the output reported back to the channel. To do this, give the `--report` option an integer representing the number of lines to return from the end of the log.
+
+Examples:
 
 ```
 Lita > lita rundeck run aliasfoo
-Execution 297 is running
+Execution 285 is running. Average job duration is 1.717 seconds.
 
 Lita > rundeck run aliasfoo --options SECONDS=60
-Execution 298 is running
+Execution 286 is running. Average job duration is 1.717 seconds.
 
 Lita > rundeck run --project Litatest --job dateoutput
-Execution 299 is running
+Execution 287 is running. Average job duration is 1.717 seconds.
 
 Lita > rundeck run --project Litatest --job dateoutput --options SECONDS=60
-Execution 300 is running
+Execution 288 is running. Average job duration is 1.717 seconds.
 
 Lita > rundeck run --project Litatest --job dateoutput --options SECONDS=60,FORMAT=iso8601
-Execution 301 is running
+Execution 289 is running. Average job duration is 1.717 seconds.
+
+Lita > rundeck run --project Litatest --job dateoutput --options SECONDS=60,FORMAT=iso8601 --report 5
+Execution 289 is running. Average job duration is 1.717 seconds.
+Execution 289 output:
+  18:18:27 26 Sat May 9 18:18:27 UTC 2015
+  18:18:28 27 Sat May 9 18:18:28 UTC 2015
+  18:18:29 28 Sat May 9 18:18:29 UTC 2015
+  18:18:30 29 Sat May 9 18:18:30 UTC 2015
+  18:18:31 30 Sat May 9 18:18:31 UTC 2015
+Execution 289 is complete (took 30.49s)
 ```
 
 * Users must be [added by a Lita admin](http://docs.lita.io/getting-started/usage/#authorization-groups) to the rundeck_users group to execute jobs
@@ -109,6 +130,40 @@ Lita > lita rundeck running
 297 running Shell User [Litatest] dateoutput SECONDS:60 start:2014-08-16T05:46:32Z
 ```
 
+### Output
+
+List log output for given execution (showing last 10 lines, by default):
+
+```
+Lita > lita output 5
+Execution 5 output:
+  23:16:30 Text of line 1
+  23:16:31 Text of line 2
+  23:16:32 Text of line 3
+  23:16:33 Text of line 4
+  23:16:34 Text of line 5
+  23:16:35 Text of line 6
+  23:16:36 Text of line 7
+  23:16:37 Text of line 8
+  23:16:38 Text of line 9
+  23:16:39 Text of line 10
+Execution 5 is complete (took 10.348s)
+EOF
+```
+
+Optionally, take an extra integer for the number lines to return:
+
+```
+Lita > rundeck output 5 5
+Execution 5 output:
+  23:16:35 Text of line 6
+  23:16:36 Text of line 7
+  23:16:37 Text of line 8
+  23:16:38 Text of line 9
+  23:16:39 Text of line 10
+Execution 5 is complete (took 10.348s)
+```
+
 ### Options
 
 List options for a job in detail

data/lib/lita/handlers/rundeck.rb

@@ -25,6 +25,11 @@ module Lita
           t("help.exec_key") => t("help.exec_value")
       }
 
+      route /rundeck output (\d+)(?: (\d+)?)?/i,
+        :output, command: true, help: {
+          t("help.output_key") => t("help.output_value")
+      }
+
       route /rundeck running(?: (\d+)?)?/i,
         :running, command: true, help: {
           t("help.running_key") => t("help.running_value")
@@ -44,9 +49,6 @@ module Lita
           },
           job: {
             short: "j"
-          },
-          options: {
-            short: "o"
           }
         },
         help: {
@@ -70,6 +72,9 @@ module Lita
           },
           options: {
             short: "o"
+          },
+          report: {
+            short: "r"
           }
         },
         help: {
@@ -100,7 +105,10 @@ module Lita
 
       def info(response)
         text = []
-        text.push(client.info)
+        output = client.info
+        return unless output
+
+        text.push(output)
         if users
           text.push(t("info.users_allowed") +
             users.map{ |u| u.name }.join(",") )
@@ -182,7 +190,7 @@ module Lita
         user    = response.user.name || response.user.id || robot.name
         options = parse_options(args[:options]) if args[:options]
 
-        # keywoard arguments win over an alias (if someone happens to give both)
+        # keyword arguments win over an alias (if someone happens to give both)
         unless project && job
           project, job = aliasdb.forward(name)
         end
@@ -192,13 +200,45 @@ module Lita
           return
         end
 
-        response.reply resolve(client.run(project,job,options,user))
+        execution = client.run(project,job,options,user)
+        response.reply resolve(execution)
+
+        if execution.status == 'running' && args[:report]
+          report_back(response, execution, args[:report])
+        end
+      end
+
+      def report_back(response, execution, output_limit)
+        # remove the output log line limit if value is 'all' or 'full'
+        output_limit = nil if /^all$|^full$/i.match(output_limit)
+
+        # wait the average duration + 1s
+        average_duration = execution.job.average_duration.to_i / 1000
+        sleep average_duration + 1
+
+        # check if complete and loop until complete with 10 second check / announce
+        while true
+          execution = client.execution(execution.id)
+          if execution.status == 'running'
+            current_duration = Time.now.to_i - execution.start_unixtime.to_i / 1000
+            response.reply t(
+              "run.still_running",
+              id: execution.id,
+              current_duration: current_duration,
+              average_duration: average_duration
+              )
+            sleep 10
+          else
+            response.reply client.output(execution.id, output_limit).pretty_print_output
+            return
+          end
+        end
       end
 
       def resolve(e)
         case e.status
         when "running"
-          t("run.success", id: e.id)
+          t("run.success", id: e.id, average_duration: e.job.average_duration.to_f / 1000.0)
         when "api.error.execution.conflict"
           t("run.conflict")
         when "api.error.item.unauthorized"
@@ -208,6 +248,19 @@ module Lita
         end
       end
 
+      def output(response)
+        id  = response.matches[0][0]
+        max = response.matches[0][1] if response.matches[0][1]
+
+        output = client.output(id, max)
+
+        if output.error_code && output.error_code == 'api.error.item.doesnotexist'
+          response.reply t("misc.execution_not_found")
+        else
+          response.reply output.pretty_print_output
+        end
+      end
+
       def parse_options(string)
         options = {}
         pairs = string.split(/\|/)
@@ -387,6 +440,7 @@ module Lita
           attr_accessor :url, :token
 
           MAX_EXECUTIONS = 10
+          MAX_OUTPUT     = 10
 
           def self.ensure_array(ref)
             return [ref] if ref.is_a?(Hash)
@@ -402,31 +456,39 @@ module Lita
           end
 
           def get(path,options={})
-            uri = "#{@url}/#{path}"
+            uri = "#{@url}#{path}"
             # Replace double slashes with a single one, excluding the // after the :
             uri.gsub!(/([^:])\/\//, '\1/')
             options[:authtoken] = @token
 
+            request_failed = false
+
             http_response = @http.get(
               uri,
               options
             )
 
-            # Trying to avoid nokogiri but not wanting to use ReXML directly,
-            # hence the xmlsimple gem. ForceArray has usually worked well for
-            # me, but this XML data seemed to cause it to be inconsistent. So
-            # the ensure_array method and a little extra code has worked.
-            hash = ::XmlSimple.xml_in(
-              http_response.body,
-              {
-                "ForceArray" => false,
-                "GroupTags"  => {
-                  "options"    => "option"
+            hash = {}
+            if http_response.body =~ /<.*?>/m
+              # Trying to avoid nokogiri but not wanting to use ReXML directly,
+              # hence the xmlsimple gem. ForceArray has usually worked well for
+              # me, but this XML data seemed to cause it to be inconsistent. So
+              # the ensure_array method and a little extra code has worked.
+              hash = ::XmlSimple.xml_in(
+                http_response.body,
+                {
+                  "ForceArray" => false,
+                  "GroupTags"  => {
+                    "options"    => "option"
+                  }
                 }
-              }
-            )
+              )
+            else
+              @log.error "Request failed: API response not XML"
+              request_failed = true
+            end
 
-            if @debug
+            if @debug || request_failed
               output = options.map{ |k,v| "#{k.to_s}=#{v}" }.join("&")
               @log.debug "API request: GET #{uri}&#{output}"
               @log.debug "API response: (HTTP #{http_response.status}) #{http_response.body}"
@@ -437,7 +499,8 @@ module Lita
           end
 
           def info
-            get('/api/1/system/info')["success"][1]["message"]
+            response = get('/api/1/system/info')
+            response["success"][1]["message"] if response["success"]
           end
 
           def projects
@@ -456,6 +519,10 @@ module Lita
             Definition.load(self,job(project,name).id)
           end
 
+          def execution(id)
+            Execution.load(self, id)
+          end
+
           def executions(max)
             max ||= MAX_EXECUTIONS
             @executions ||= Execution.all(self,max).sort_by{|i| i.id}.reverse[0,max.to_i].reverse
@@ -470,6 +537,11 @@ module Lita
             job = job(project,name)
             Job.run(self,job.id,options,user)
           end
+
+          def output(id, max)
+            max ||= MAX_OUTPUT
+            Output.load(self, id, max)
+          end
         end
 
         class Project
@@ -529,6 +601,59 @@ module Lita
           end
         end
 
+        class Output
+          attr_accessor :id, :entries, :completed, :exec_duration, :error_code, :error_message
+
+          def self.load(client, id, max)
+            # @todo Workaround for this: https://github.com/rundeck/rundeck/issues/1207
+            max = max.to_i + 2
+            response = client.get("/api/5/execution/#{id}/output?lastlines=#{max}")
+            if response["output"]
+              Output.new(response["output"]) 
+            elsif response["error"][0]
+              Output.new(
+                "id" => id,
+                "error_code"  => response["error"][1]["code"],
+                "error_message" => response["error"][1]["message"]
+              )
+            end
+          end
+
+          def initialize(hash)
+            @id            = hash["id"]
+
+            if hash["completed"] == "true"
+              @completed = true
+            elsif hash["completed"] == "false"
+              @completed = false
+            end
+
+            @exec_duration = hash["execDuration"]
+
+            @entries       = []
+            if hash["entries"] && hash["entries"]["entry"]
+              @entries = hash["entries"]["entry"]
+            end
+
+            @error_code    = hash["error_code"]
+            @error_message = hash["error_message"]
+          end
+
+          def pretty_print_output
+            text = ["Execution #{id} output:"]
+            entries.each do |entry|
+              text.push("  #{entry["time"]} #{entry["content"]}")
+            end
+
+            if @completed
+              text.push("Execution #{id} is complete (took #{@exec_duration.to_i  / 1000.0}s)")
+            else
+              text.push("Execution #{id} is not complete (running #{@exec_duration.to_i / 1000.0}s)")
+            end
+            text.join("\n")
+          end
+        end
+
         class Job
           attr_accessor :id, :name, :group, :project, :description,
                         :average_duration, :options
@@ -574,15 +699,15 @@ module Lita
             @name             = hash["name"]
             @group            = hash["group"]
             @project          = hash["project"]
-            @description      = hash["description"]            
-            @average_duration = hash["average_duration"] if hash["average_duration"]
+            @description      = hash["description"]
+            @average_duration = hash["averageDuration"] if hash["averageDuration"]
             @options          = Client.ensure_array(hash["options"]) if hash["options"]
           end
         end
 
         class Execution
-          attr_accessor :id, :href, :status, :message, :project, :user, :start,
-                        :end, :job, :description, :argstring, :successful_nodes,
+          attr_accessor :id, :href, :status, :message, :project, :user, :start, :start_unixtime,
+                        :end, :end_unixtime, :job, :description, :argstring, :successful_nodes,
                         :failed_nodes, :aborted_by
 
           def self.all(client,max)
@@ -600,6 +725,11 @@ module Lita
             all
           end
 
+          def self.load(client, id)
+            response = client.get("/api/1/execution/#{id}")
+            Execution.new(response["executions"]["execution"]) if response["executions"]["count"].to_i == 1
+          end
+
           def initialize(hash)
             @id               = hash["id"]
             @href             = hash["href"]
@@ -607,8 +737,17 @@ module Lita
             @message          = hash["message"]
             @project          = hash["project"]
             @user             = hash["user"]
-            @start            = hash["date-started"]["content"] if hash["date-started"]
-            @end              = hash["date-ended"]["content"] if hash["date-ended"]
+
+            if hash["date-started"]
+              @start_unixtime = hash["date-started"]["unixtime"]
+              @start          = hash["date-started"]["content"]
+            end
+
+            if hash["date-ended"]
+              @end_unixtime = hash["date-ended"]["unixtime"]
+              @end          = hash["date-ended"]["content"]
+            end
+
             @job              = Job.new(hash["job"]) if hash["job"]
             @description      = hash["description"]
             @argstring        = hash["argstring"]
@@ -641,7 +780,7 @@ module Lita
             all
           end
 
-        end        
+        end
       end
     end
 

data/lita-rundeck.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-rundeck"
-  spec.version       = "0.0.2"
+  spec.version       = "0.0.3"
   spec.authors       = ["Harlan Barnes"]
   spec.email         = ["hbarnes@pobox.com"]
   spec.description   = %q{Lita handler for interacting with Rundeck}

data/locales/en.yml

@@ -13,13 +13,15 @@ en:
           exec_value: "Returns a number of recent executions (default: 10)"
           running_key: "rundeck running [NUM]"
           running_value: "Returns currently running executions (default: 10)"
-          run_key: "rundeck run ( ALIAS_NAME | --project PROJECT_NAME --job JOB_NAME )"
-          run_value: "Run a project/job either via an alias or explicit names"
+          output_key: "rundeck output ID [NUM]"
+          output_value: "Returns the last NUM lines (default: 10) of output for execution ID"
+          run_key: "rundeck run ( ALIAS_NAME | --project PROJECT_NAME --job JOB_NAME ) [--report all|NUM]"
+          run_value: "Run a project/job either via an alias or explicit names; optionally report log back to channel"
           alias_key: "rundeck alias(es)"
           alias_value: "List the Rundeck project/job aliases"
-          alias_register_key: "rundeck alias ALIAS_NAME --project PROJECT_NAME --job JOB_NAME"
+          alias_register_key: "rundeck alias register ALIAS_NAME --project PROJECT_NAME --job JOB_NAME"
           alias_register_value: "Create a new alias for a project / job combination"
-          alias_forget_key: "rundeck forget ALIAS_NAME"
+          alias_forget_key: "rundeck alias forget ALIAS_NAME"
           alias_forget_value: "Remove an alias"
           options_key: "rundeck options ( ALIAS_NAME | --project PROJECT_NAME --job JOB_NAME )"
           options_value: "Describe option details for a project/job either via an alias or explicit names"
@@ -36,7 +38,8 @@ en:
           token_unauthorized: "API token is unauthorized or lacks runAs permission; check the apitoken.aclpolicy"
           unauthorized: "You aren't authorized to run jobs"
           failed: "Something went wrong with the job execution"
-          success: "Execution %{id} is running"
+          success: "Execution %{id} is running. Average job duration is %{average_duration} seconds."
+          still_running: "Execution %{id} has been running for %{current_duration}s (%{average_duration}s average)"
           conflict: "Job is already running and only allows one execution at a time"
         alias:
           none: "No aliases have been registered yet"
@@ -49,3 +52,4 @@ en:
         misc:
           definition_error: "Something went wrong finding the job definition"
           job_not_found: "Can't find an alias or project and job"
+          execution_not_found: "Can't find execution for this command"

data/spec/files/execution.xml

@@ -0,0 +1,23 @@
+<result success='true' apiversion='10'>
+  <executions count='1'>
+    <execution id='285' href='https://release.bazumedia.com/execution/follow/285' status='succeeded' project='Litatest'>
+      <user>admin</user>
+      <date-started unixtime='1408028788860'>2014-08-14T15:06:28Z</date-started>
+      <date-ended unixtime='1408028808000'>2014-08-14T15:06:48Z</date-ended>
+      <job id='3ba7c6c8-3d79-4b02-807f-eda67e321c23' averageDuration='1717'>
+        <name>dateoutput</name>
+        <group></group>
+        <project>Litatest</project>
+        <description></description>
+        <options>
+          <option name='SECONDS' value='30' />
+        </options>
+      </job>
+      <description>Plugin[localexec, nodeStep: true]</description>
+      <argstring>-SECONDS 30</argstring>
+      <successfulNodes>
+        <node name='release.bazumedia.com' />
+      </successfulNodes>
+    </execution>
+  </executions>
+</result>

data/spec/files/output.xml

@@ -0,0 +1,26 @@
+<result success='true' apiversion='10'>
+  <output>
+    <id>285</id>
+    <offset>1545</offset>
+    <completed>true</completed>
+    <execCompleted>true</execCompleted>
+    <hasFailedNodes>false</hasFailedNodes>
+    <execState>succeeded</execState>
+    <lastModified>1430435800000</lastModified>
+    <execDuration>10348</execDuration>
+    <percentLoaded>99.61315280464217</percentLoaded>
+    <totalSize>1551</totalSize>
+    <entries>
+      <entry time='23:16:30' absolute_time='2015-04-30T23:16:30Z' level='NORMAL' user='rundeck' command='' stepctx='1' node='rundeck.mycompany.org'>Text of line 1</entry>
+      <entry time='23:16:31' absolute_time='2015-04-30T23:16:31Z' level='NORMAL' user='rundeck' command='' stepctx='1' node='rundeck.mycompany.org'>Text of line 2</entry>
+      <entry time='23:16:32' absolute_time='2015-04-30T23:16:32Z' level='NORMAL' user='rundeck' command='' stepctx='1' node='rundeck.mycompany.org'>Text of line 3</entry>
+      <entry time='23:16:33' absolute_time='2015-04-30T23:16:33Z' level='NORMAL' user='rundeck' command='' stepctx='1' node='rundeck.mycompany.org'>Text of line 4</entry>
+      <entry time='23:16:34' absolute_time='2015-04-30T23:16:34Z' level='NORMAL' user='rundeck' command='' stepctx='1' node='rundeck.mycompany.org'>Text of line 5</entry>
+      <entry time='23:16:35' absolute_time='2015-04-30T23:16:35Z' level='NORMAL' user='rundeck' command='' stepctx='1' node='rundeck.mycompany.org'>Text of line 6</entry>
+      <entry time='23:16:36' absolute_time='2015-04-30T23:16:36Z' level='NORMAL' user='rundeck' command='' stepctx='1' node='rundeck.mycompany.org'>Text of line 7</entry>
+      <entry time='23:16:37' absolute_time='2015-04-30T23:16:37Z' level='NORMAL' user='rundeck' command='' stepctx='1' node='rundeck.mycompany.org'>Text of line 8</entry>
+      <entry time='23:16:38' absolute_time='2015-04-30T23:16:38Z' level='NORMAL' user='rundeck' command='' stepctx='1' node='rundeck.mycompany.org'>Text of line 9</entry>
+      <entry time='23:16:39' absolute_time='2015-04-30T23:16:39Z' level='NORMAL' user='rundeck' command='' stepctx='1' node='rundeck.mycompany.org'>Text of line 10</entry>
+    </entries>
+  </output>
+</result>

data/spec/files/output_empty.xml

@@ -0,0 +1,15 @@
+<result success='true' apiversion='10'>
+  <output>
+    <id>6</id>
+    <offset>394</offset>
+    <completed>true</completed>
+    <execCompleted>true</execCompleted>
+    <hasFailedNodes>false</hasFailedNodes>
+    <execState>succeeded</execState>
+    <lastModified>1430436168000</lastModified>
+    <execDuration>171</execDuration>
+    <percentLoaded>98.5</percentLoaded>
+    <totalSize>400</totalSize>
+    <entries />
+  </output>
+</result>

data/spec/files/output_exec_noexist.xml

@@ -0,0 +1,5 @@
+<result error='true' apiversion='10'>
+  <error code='api.error.item.doesnotexist'>
+    <message>execution does not exist: 9999</message>
+  </error>
+</result>

data/spec/files/output_limit_five.xml

@@ -0,0 +1,21 @@
+<result success='true' apiversion='10'>
+  <output>
+    <id>285</id>
+    <offset>1545</offset>
+    <completed>true</completed>
+    <execCompleted>true</execCompleted>
+    <hasFailedNodes>false</hasFailedNodes>
+    <execState>succeeded</execState>
+    <lastModified>1430435800000</lastModified>
+    <execDuration>10348</execDuration>
+    <percentLoaded>99.61315280464217</percentLoaded>
+    <totalSize>1551</totalSize>
+    <entries>
+      <entry time='23:16:35' absolute_time='2015-04-30T23:16:35Z' level='NORMAL' user='rundeck' command='' stepctx='1' node='rundeck.mycompany.org'>Text of line 6</entry>
+      <entry time='23:16:36' absolute_time='2015-04-30T23:16:36Z' level='NORMAL' user='rundeck' command='' stepctx='1' node='rundeck.mycompany.org'>Text of line 7</entry>
+      <entry time='23:16:37' absolute_time='2015-04-30T23:16:37Z' level='NORMAL' user='rundeck' command='' stepctx='1' node='rundeck.mycompany.org'>Text of line 8</entry>
+      <entry time='23:16:38' absolute_time='2015-04-30T23:16:38Z' level='NORMAL' user='rundeck' command='' stepctx='1' node='rundeck.mycompany.org'>Text of line 9</entry>
+      <entry time='23:16:39' absolute_time='2015-04-30T23:16:39Z' level='NORMAL' user='rundeck' command='' stepctx='1' node='rundeck.mycompany.org'>Text of line 10</entry>
+    </entries>
+  </output>
+</result>

data/spec/files/output_notcomplete.xml

@@ -0,0 +1,19 @@
+<result success='true' apiversion='10'>
+  <output>
+    <id>8</id>
+    <offset>1583</offset>
+    <completed>false</completed>
+    <execCompleted>false</execCompleted>
+    <hasFailedNodes>false</hasFailedNodes>
+    <execState>running</execState>
+    <lastModified>1430873952000</lastModified>
+    <execDuration>3750</execDuration>
+    <percentLoaded>100.0</percentLoaded>
+    <totalSize>1583</totalSize>
+    <entries>
+      <entry time='23:16:30' absolute_time='2015-04-30T23:16:30Z' level='NORMAL' user='rundeck' command='' stepctx='1' node='rundeck.mycompany.org'>Text of line 1</entry>
+      <entry time='23:16:31' absolute_time='2015-04-30T23:16:31Z' level='NORMAL' user='rundeck' command='' stepctx='1' node='rundeck.mycompany.org'>Text of line 2</entry>
+      <entry time='23:16:32' absolute_time='2015-04-30T23:16:32Z' level='NORMAL' user='rundeck' command='' stepctx='1' node='rundeck.mycompany.org'>Text of line 3</entry>
+    </entries>
+  </output>
+</result>

data/spec/files/run.xml

@@ -3,17 +3,17 @@
     <execution id='285' href='https://rundeck.mycompany.org/execution/follow/285' status='running' project='Litatest'>
       <user>Shell User</user>
       <date-started unixtime='1408028788860'>2014-08-14T15:06:28Z</date-started>
-      <job id='3ba7c6c8-3d79-4b02-807f-eda67e321c23' averageDuration='128717'>
+      <job id='3ba7c6c8-3d79-4b02-807f-eda67e321c23' averageDuration='1717'>
         <name>dateoutput</name>
         <group></group>
         <project>Litatest</project>
         <description></description>
         <options>
-          <option name='SECONDS' value='600' />
+          <option name='SECONDS' value='30' />
         </options>
       </job>
       <description>Plugin[localexec, nodeStep: true]</description>
-      <argstring>-SECONDS 600</argstring>
+      <argstring>-SECONDS 30</argstring>
     </execution>
   </executions>
 </result>

data/spec/files/running.xml

@@ -3,17 +3,17 @@
     <execution id='285' href='https://rundeck.mycompany.org/execution/follow/285' status='running' project='Litatest'>
       <user>Shell User</user>
       <date-started unixtime='1408028788860'>2014-08-14T15:06:28Z</date-started>
-      <job id='3ba7c6c8-3d79-4b02-807f-eda67e321c23' averageDuration='128717'>
+      <job id='3ba7c6c8-3d79-4b02-807f-eda67e321c23' averageDuration='1717'>
         <name>dateoutput</name>
         <group></group>
         <project>Litatest</project>
         <description></description>
         <options>
-          <option name='SECONDS' value='600' />
+          <option name='SECONDS' value='30' />
         </options>
       </job>
       <description>Plugin[localexec, nodeStep: true]</description>
-      <argstring>-SECONDS 600</argstring>
+      <argstring>-SECONDS 30</argstring>
     </execution>
   </executions>
 </result>

data/spec/lita/handlers/rundeck_spec.rb

@@ -2,6 +2,10 @@ require "spec_helper"
 
 describe Lita::Handlers::Rundeck, lita_handler: true do
 
+  let(:rundeck_noxml) do
+    "This is not XML and should fail"
+  end
+
   let(:rundeck_info) do
     File.read("spec/files/info.xml")
   end
@@ -22,6 +26,10 @@ describe Lita::Handlers::Rundeck, lita_handler: true do
     File.read("spec/files/jobs_empty.xml")
   end
 
+  let(:rundeck_execution) do
+    File.read("spec/files/execution.xml")
+  end
+
   let(:rundeck_executions) do
     File.read("spec/files/executions.xml")
   end
@@ -58,6 +66,27 @@ describe Lita::Handlers::Rundeck, lita_handler: true do
     File.read("spec/files/definition.xml")
   end
 
+  let(:rundeck_output) do
+    File.read("spec/files/output.xml")
+  end
+
+  let(:rundeck_output_limit_five) do
+    File.read("spec/files/output_limit_five.xml")
+  end
+
+  let(:rundeck_output_empty) do
+    File.read("spec/files/output_empty.xml")
+  end
+
+  let(:rundeck_output_exec_noexist) do
+    File.read("spec/files/output_exec_noexist.xml")
+  end
+
+
+  let(:rundeck_output_notcomplete) do
+    File.read("spec/files/output_notcomplete.xml")
+  end
+
   it { routes_command("rundeck info").to(:info) }
   it { routes_command("rundeck projects").to(:projects) }
   it { routes_command("rundeck jobs").to(:jobs) }
@@ -70,13 +99,18 @@ describe Lita::Handlers::Rundeck, lita_handler: true do
   it { routes_command("rundeck run aliasfoo --options SECONDS=60").to(:run) }
   it { routes_command("rundeck run --project Litatest --job dateoutput").to(:run) }
   it { routes_command("rundeck run --project Litatest --job dateoutput --options SECONDS=60").to(:run) }
+  it { routes_command("rundeck run --project Litatest --job dateoutput --options SECONDS=60 --report all").to(:run) }
+  it { routes_command("rundeck run --project Litatest --job dateoutput --options SECONDS=60 --report 5").to(:run) }
   it { routes_command("rundeck options aliasfoo").to(:options) }
   it { routes_command("rundeck options --project Litatest --job dateoutput").to(:options) }
+  it { routes_command("rundeck output 285").to(:output) }
+  it { routes_command("rundeck output 285 5").to(:output) }
+  it { routes_command("rundeck output 6").to(:output) }
+  it { routes_command("rundeck output 7").to(:output) }
 
   def grab_request(method, status, body)
     response = double('Faraday::Response', status: status, body: body)
-    expect_any_instance_of(Faraday::Connection).to \
-      receive(method.to_sym).and_return(response)
+    expect_any_instance_of(Faraday::Connection).to receive(method.to_sym).and_return(response)
   end
 
   before do
@@ -86,6 +120,13 @@ describe Lita::Handlers::Rundeck, lita_handler: true do
   end
 
   describe "#info" do
+    it "returns nothing (but logs a message) if the API response is not XML" do
+      grab_request("get", 200, rundeck_noxml)
+      send_command("rundeck info")
+      # @todo - I don't know rspec well enough to mock up the logger
+      expect(replies.last).to be nil
+    end
+
     it "replies with the rundeck server information with no users" do
       grab_request("get", 200, rundeck_info)
       send_command("rundeck info")
@@ -199,7 +240,7 @@ EOF
       grab_request("get", 200, rundeck_running)
       send_command("rundeck running")
       expect(replies.last).to eq <<-EOF.chomp
-285 running Shell User [Litatest] dateoutput SECONDS:600 start:2014-08-14T15:06:28Z
+285 running Shell User [Litatest] dateoutput SECONDS:30 start:2014-08-14T15:06:28Z
 EOF
     end
 
@@ -230,7 +271,7 @@ EOF
       send_command("rundeck alias register aliasfoo --project Litatest --job dateoutput")
       send_command("rundeck run aliasfoo --options SECONDS=60")
       expect(replies.last).to eq <<-EOF.chomp
-Execution 285 is running
+Execution 285 is running. Average job duration is 1.717 seconds.
 EOF
     end
 
@@ -241,10 +282,115 @@ EOF
       grab_request("get", 200, rundeck_run)
       send_command("rundeck run --project Litatest --job dateoutput --options SECONDS=60")
       expect(replies.last).to eq <<-EOF.chomp
-Execution 285 is running
+Execution 285 is running. Average job duration is 1.717 seconds.
+EOF
+    end
+
+    it "submit a fully qualified job and have it report back all the log" do
+      allow(Lita::Authorization).to receive(:user_in_group?).and_return(true)
+      grab_request("get", 200, rundeck_projects)
+      grab_request("get", 200, rundeck_jobs)
+      grab_request("get", 200, rundeck_run)
+      grab_request("get", 200, rundeck_execution)
+      grab_request("get", 200, rundeck_output)
+      send_command("rundeck run --project Litatest --job dateoutput --options SECONDS=60 --report all")
+      expect(replies.first).to eq <<-EOF.chomp
+Execution 285 is running. Average job duration is 1.717 seconds.
+EOF
+      expect(replies.last).to eq <<-EOF.chomp
+Execution 285 output:
+  23:16:30 Text of line 1
+  23:16:31 Text of line 2
+  23:16:32 Text of line 3
+  23:16:33 Text of line 4
+  23:16:34 Text of line 5
+  23:16:35 Text of line 6
+  23:16:36 Text of line 7
+  23:16:37 Text of line 8
+  23:16:38 Text of line 9
+  23:16:39 Text of line 10
+Execution 285 is complete (took 10.348s)
+EOF
+    end
+
+    it "submit a fully qualified job and have it wait at least once, then report back all the log" do
+      @time_now = Time.parse("2014-08-14T15:06:33Z")
+      expect(Time).to receive(:now).and_return(@time_now)
+
+      allow(Lita::Authorization).to receive(:user_in_group?).and_return(true)
+      grab_request("get", 200, rundeck_projects)
+      grab_request("get", 200, rundeck_jobs)
+      grab_request("get", 200, rundeck_run)
+      grab_request("get", 200, rundeck_running)
+      grab_request("get", 200, rundeck_execution)
+      grab_request("get", 200, rundeck_output)
+      send_command("rundeck run --project Litatest --job dateoutput --options SECONDS=60 --report all")
+      expect(replies.first).to eq <<-EOF.chomp
+Execution 285 is running. Average job duration is 1.717 seconds.
+EOF
+      expect(replies[1]).to eq <<-EOF.chomp
+Execution 285 has been running for 5s (1s average)
+EOF
+      expect(replies.last).to eq <<-EOF.chomp
+Execution 285 output:
+  23:16:30 Text of line 1
+  23:16:31 Text of line 2
+  23:16:32 Text of line 3
+  23:16:33 Text of line 4
+  23:16:34 Text of line 5
+  23:16:35 Text of line 6
+  23:16:36 Text of line 7
+  23:16:37 Text of line 8
+  23:16:38 Text of line 9
+  23:16:39 Text of line 10
+Execution 285 is complete (took 10.348s)
+EOF
+    end
+
+    it "submit a fully qualified job and have it report back a limited log" do
+      allow(Lita::Authorization).to receive(:user_in_group?).and_return(true)
+      grab_request("get", 200, rundeck_projects)
+      grab_request("get", 200, rundeck_jobs)
+      grab_request("get", 200, rundeck_run)
+      grab_request("get", 200, rundeck_execution)
+      grab_request("get", 200, rundeck_output_limit_five)
+      send_command("rundeck run --project Litatest --job dateoutput --options SECONDS=60 --report 5")
+      expect(replies.first).to eq <<-EOF.chomp
+Execution 285 is running. Average job duration is 1.717 seconds.
+EOF
+      expect(replies.last).to eq <<-EOF.chomp
+Execution 285 output:
+  23:16:35 Text of line 6
+  23:16:36 Text of line 7
+  23:16:37 Text of line 8
+  23:16:38 Text of line 9
+  23:16:39 Text of line 10
+Execution 285 is complete (took 10.348s)
 EOF
     end
 
+#     it "submit a fully qualified job and have it report back a limited log" do
+#       allow(Lita::Authorization).to receive(:user_in_group?).and_return(true)
+#       grab_request("get", 200, rundeck_projects)
+#       grab_request("get", 200, rundeck_jobs)
+#       grab_request("get", 200, rundeck_run)
+#       grab_request("get", 200, rundeck_execution)
+#       grab_request("get", 200, rundeck_output_limit_five)
+#       send_command("rundeck run --project Litatest --job dateoutput --options SECONDS=60 --report 5")
+#       expect(replies.first).to eq <<-EOF.chomp
+# Execution 285 is running. Average job duration is 1.717 seconds.
+# EOF
+#       expect(replies.last).to eq <<-EOF.chomp
+# Execution 285 output:
+#   23:16:35 Text of line 6
+#   23:16:36 Text of line 7
+#   23:16:37 Text of line 8
+#   23:16:38 Text of line 9
+#   23:16:39 Text of line 10
+# Execution 285 is complete (took 10.348s)
+# EOF
+#     end
+
     it "submit a non-existent job" do
       allow(Lita::Authorization).to receive(:user_in_group?).and_return(true)
       send_command("rundeck run not-a-real-alias")
@@ -377,6 +523,70 @@ EOF
       send_command("rundeck options aliasfoo")
       expect(replies.last).to eq <<-EOF.chomp
 Can't find an alias or project and job
+EOF
+    end
+  end
+
+  describe "#output" do
+    it "display output of an existing job with default number of lines" do
+      grab_request("get", 200, rundeck_output)
+      send_command("rundeck output 5")
+      expect(replies.last).to eq <<-EOF.chomp
+Execution 285 output:
+  23:16:30 Text of line 1
+  23:16:31 Text of line 2
+  23:16:32 Text of line 3
+  23:16:33 Text of line 4
+  23:16:34 Text of line 5
+  23:16:35 Text of line 6
+  23:16:36 Text of line 7
+  23:16:37 Text of line 8
+  23:16:38 Text of line 9
+  23:16:39 Text of line 10
+Execution 285 is complete (took 10.348s)
+EOF
+    end
+
+    it "display output of an existing job with custom number of lines (5)" do
+      grab_request("get", 200, rundeck_output_limit_five)
+      send_command("rundeck output 285 5")
+      expect(replies.last).to eq <<-EOF.chomp
+Execution 285 output:
+  23:16:35 Text of line 6
+  23:16:36 Text of line 7
+  23:16:37 Text of line 8
+  23:16:38 Text of line 9
+  23:16:39 Text of line 10
+Execution 285 is complete (took 10.348s)
+EOF
+    end
+
+    it "display output of an existing job that has no output" do
+      grab_request("get", 200, rundeck_output_empty)
+      send_command("rundeck output 6")
+      expect(replies.last).to eq <<-EOF.chomp
+Execution 6 output:
+Execution 6 is complete (took 0.171s)
+EOF
+    end
+
+    it "display output of an existing job that has no output" do
+      grab_request("get", 200, rundeck_output_exec_noexist)
+      send_command("rundeck output 7")
+      expect(replies.last).to eq <<-EOF.chomp
+Can't find execution for this command
+EOF
+    end
+
+    it "display output of an existing job that hasn't completed with default number of lines" do
+      grab_request("get", 200, rundeck_output_notcomplete)
+      send_command("rundeck output 8")
+      expect(replies.last).to eq <<-EOF.chomp
+Execution 8 output:
+  23:16:30 Text of line 1
+  23:16:31 Text of line 2
+  23:16:32 Text of line 3
+Execution 8 is not complete (running 3.75s)
 EOF
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-rundeck
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Harlan Barnes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-30 00:00:00.000000000 Z
+date: 2015-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -141,11 +141,17 @@ files:
 - lita-rundeck.gemspec
 - locales/en.yml
 - spec/files/definition.xml
+- spec/files/execution.xml
 - spec/files/executions.xml
 - spec/files/executions_empty.xml
 - spec/files/info.xml
 - spec/files/jobs.xml
 - spec/files/jobs_empty.xml
+- spec/files/output.xml
+- spec/files/output_empty.xml
+- spec/files/output_exec_noexist.xml
+- spec/files/output_limit_five.xml
+- spec/files/output_notcomplete.xml
 - spec/files/projects.xml
 - spec/files/projects_empty.xml
 - spec/files/run.xml
@@ -183,11 +189,17 @@ specification_version: 4
 summary: Lita handler for interacting with Rundeck
 test_files:
 - spec/files/definition.xml
+- spec/files/execution.xml
 - spec/files/executions.xml
 - spec/files/executions_empty.xml
 - spec/files/info.xml
 - spec/files/jobs.xml
 - spec/files/jobs_empty.xml
+- spec/files/output.xml
+- spec/files/output_empty.xml
+- spec/files/output_exec_noexist.xml
+- spec/files/output_limit_five.xml
+- spec/files/output_notcomplete.xml
 - spec/files/projects.xml
 - spec/files/projects_empty.xml
 - spec/files/run.xml