sensu-plugins-jenkins 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7918b4078d558782344da984a537da2f240fa2ba
-  data.tar.gz: 52709e0d5ea8e79130064b9a9379eba7a88c2fae
+  metadata.gz: deb1fb9a4cca84c812d40c614d17fc9cd5f701f9
+  data.tar.gz: aed0d9935e51586b5da4d5c935009b6b804a5bb3
 SHA512:
-  metadata.gz: bd9e06d9fc9f86ea1e33fa4e660545dd4d997bc4085389f5b9be38e8ecc41e2d00a626340ddb33b0be14125b21cd155c0fe77f5ba609369e56f0305e9979bae4
-  data.tar.gz: 5422e5254ba9d83bb7091a74cc95894576a20f11daef65642929658b24f83f1bca3127968092541d6ed476e01f309a4eda306e05626807adee32798e43c29346
+  metadata.gz: 892ae6fc25459aa1ff0be4b815d86c38a9337223a4b24a7186733ff4c10d012da97b489b7b986d7b957e1104c24003814d63095f8d63880fff3d1205fac48343
+  data.tar.gz: c702b9eafc459fd07f8413a62ca31375325e17b3bdf3e1dba877bc562aac36d248297f85e61482b5063c83c0e50367c3c7f87f4145ec9b3d435c2ef0a15a87fb

data/CHANGELOG.md

@@ -3,9 +3,18 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
 
-## Unreleased][unreleased]
+## [Unreleased][unreleased]
 
-## [0.0.2] - 2015-06-04
+## [0.0.4] - 2015-07-14
+### Changed
+- updated sensu-plugin gem to 1.2.0
+
+## [0.0.3] - 2015-06-4
+### Added
+- New check `bin/check-jenkins-build-time.rb` which alerts when Jenkins builds
+  fail to succeed within a certain duration or configurable time window.
+
+## [0.0.2] - 2015-06-03
 
 ### Added
 - PR #1

data/README.md

@@ -1,6 +1,6 @@
 ## Sensu-Plugins-jenkins
 
-[![Build Status](https://travis-ci.org/sensu-plugins/sensu-plugins-jenkins.svg?branch=master)](https://travis-ci.org/sensu-plugins/sensu-plugins-jenkins)
+[ ![Build Status](https://travis-ci.org/sensu-plugins/sensu-plugins-jenkins.svg?branch=master)](https://travis-ci.org/sensu-plugins/sensu-plugins-jenkins)
 [![Gem Version](https://badge.fury.io/rb/sensu-plugins-jenkins.svg)](http://badge.fury.io/rb/sensu-plugins-jenkins)
 [![Code Climate](https://codeclimate.com/github/sensu-plugins/sensu-plugins-jenkins/badges/gpa.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-jenkins)
 [![Test Coverage](https://codeclimate.com/github/sensu-plugins/sensu-plugins-jenkins/badges/coverage.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-jenkins)
@@ -10,6 +10,7 @@
 ## Functionality
 
 ## Files
+ * bin/check-jenkins-build-time.rb
  * bin/check-jenkins-health.rb
  * bin/check-jenkins-job-status.rb
  * bin/check-jenkins.rb

data/bin/check-jenkins-build-time.rb

@@ -0,0 +1,147 @@
+#!/usr/bin/env ruby
+#
+#   check-jenkins-build-time
+#
+# DESCRIPTION:
+#   Alert if the last successful build timestamp of a jenkins job is older than
+#   a specified time duration OR not within a specific daily time window.
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# USAGE:
+#   check-jenkins-build-time -u JENKINS_URL -j job_1_name=30min,job_2_name=1:30am-2:30am
+#
+#   -j parameter should be a comma-separated list of JOB_NAME=TIME_EXPRESSION
+#   where TIME_EXPRESSION is either a relative time duration from now (30m, 1h) or
+#   a daily time window (1am-2am, 1:01am-2:01am), without spaces.
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   jenkins_api_client
+#   chronic_duration
+#
+#
+# LICENSE:
+#   Copyright Matt Greensmith  mgreensmith@cozy.co  matt@mattgreensmith.net
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/check/cli'
+require 'jenkins_api_client'
+require 'chronic_duration'
+
+class JenkinsBuildTime < Sensu::Plugin::Check::CLI
+  ONE_DAY = 86_400
+
+  option :url,
+         description: 'URL to Jenkins API',
+         short: '-u JENKINS_URL',
+         long: '--url JENKINS_URL',
+         required: true
+
+  option :jobs,
+         description: 'Jobs to check. Comma-separated list of JOB_NAME=TIME_EXPRESSION',
+         short: '-j JOB_NAME=TIME_EXPRESSION,[JOB_NAME=TIME_EXPRESSION]',
+         long: '--jobs JOB_NAME=TIME_EXPRESSION,[JOB_NAME=TIME_EXPRESSION]',
+         required: true
+
+  def run
+    @now = Time.now
+    critical_jobs = []
+
+    jobs = parse_jobs_param
+
+    jobs.each do |job_name, time_expression|
+      last_build_time = build_time(job_name, last_successful_build_number(job_name))
+      if time_expression_is_window?(time_expression)
+        unless time_within_window?(last_build_time,
+                                   parse_window_start(time_expression),
+                                   parse_window_end(time_expression))
+          critical_jobs << critical_message(job_name, last_build_time, time_expression)
+        end
+      else
+        unless time_within_allowed_duration?(last_build_time,
+                                             parse_duration_seconds(time_expression))
+          critical_jobs << critical_message(job_name, last_build_time, time_expression)
+        end
+      end
+    end
+
+    critical "#{critical_jobs.length} failure(s): #{critical_jobs.join(', ')}" unless critical_jobs.empty?
+    ok "#{jobs.keys.length} job(s) had successful builds within allowed times"
+  end
+
+  private
+
+  def jenkins
+    @jenkins ||= JenkinsApi::Client.new(server_ip: config[:url], log_level: 3)
+  end
+
+  def last_successful_build_number(job_name)
+    jenkins.job.list_details(job_name)['lastSuccessfulBuild']['number']
+  end
+
+  def build_time(job_name, build_number)
+    # Jenkins expresses timestamps in epoch millis
+    Time.at(jenkins.job.get_build_details(job_name, build_number)['timestamp'] / 1000)
+  end
+
+  def time_expression_is_window?(time_expression)
+    time_expression.index('-') ? true : false
+  end
+
+  def parse_window_start(time_expression)
+    Time.parse(time_expression.split('-')[0])
+  end
+
+  def parse_window_end(time_expression)
+    Time.parse(time_expression.split('-')[1])
+  end
+
+  def time_within_window?(time, window_start, window_end)
+    time_after_window_start_today = window_start < time
+    time_in_window_today = time_after_window_start_today && window_end > time
+
+    time_after_window_start_yesterday = (window_start - ONE_DAY) < time
+    time_in_window_yesterday = time_after_window_start_yesterday && (window_end - ONE_DAY) > time
+
+    if @now < window_end && @now > window_start # we are in the window, so we will accept today or yesterday
+      time_ok = (time_in_window_today || time_in_window_yesterday)
+    elsif @now < window_end
+      # we are before the window, so we only accept yesterday
+      time_ok = time_in_window_yesterday
+    else
+      # we are after the window, so we only accept today
+      time_ok = time_in_window_today
+    end
+    time_ok
+  end
+
+  def parse_duration_seconds(time_expression)
+    ChronicDuration.parse(time_expression)
+  end
+
+  def time_within_allowed_duration?(time, duration_seconds)
+    time > (@now - duration_seconds)
+  end
+
+  def critical_message(job_name, last_build_time, time_expression)
+    "#{job_name}: last built at #{last_build_time}, not within allowed time: #{time_expression}"
+  end
+
+  def parse_jobs_param
+    jobs = {}
+    job_param = config[:jobs].split(',')
+    job_param.each do |j|
+      name, time_expression = j.split('=')
+      fail "Jobs mut be expressed as JOB_NAME=TIME_EXPRESSION. Invalid parameter: '#{j}'" if time_expression.nil?
+      jobs[name] = time_expression
+    end
+    jobs
+  end
+end

data/lib/sensu-plugins-jenkins/version.rb

@@ -2,7 +2,7 @@ module SensuPluginsJenkins
   module Version
     MAJOR = 0
     MINOR = 0
-    PATCH = 3
+    PATCH = 4
 
     VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-jenkins
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
@@ -30,7 +30,7 @@ cert_chain:
   8sHuVruarogxxKPBzlL2is4EUb6oN/RdpGx2l4254+nyR+abg//Ed27Ym0PkB4lk
   HP0m8WSjZmFr109pE/sVsM5jtOCvogyujQOjNVGN4gz1wwPr
   -----END CERTIFICATE-----
-date: 2015-06-04 00:00:00.000000000 Z
+date: 2015-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
@@ -38,14 +38,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -74,6 +74,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: chronic_duration
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.6
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -92,14 +106,14 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: '0.30'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: '0.30'
 - !ruby/object:Gem::Dependency
@@ -208,12 +222,14 @@ executables:
 - check-jenkins.rb
 - check-jenkins-job-status.rb
 - check-jenkins-health.rb
+- check-jenkins-build-time.rb
 extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - LICENSE
 - README.md
+- bin/check-jenkins-build-time.rb
 - bin/check-jenkins-health.rb
 - bin/check-jenkins-job-status.rb
 - bin/check-jenkins.rb