Add minimal jenkins plugin to display failed jobs

Author: carstene1ns

EV0002.rb

@@ -16,6 +16,7 @@
 require_relative "plugins/playstore_reviews"
 require_relative "plugins/twitter_webhooks"
 require_relative "plugins/discourse_webhooks"
+require_relative "plugins/jenkins_failures"
 
 PWD = File.dirname(File.expand_path(__FILE__))
 
@@ -48,7 +49,8 @@
                           Cinch::BlogWebhooks,
                           Cinch::PlayStoreReviews,
                           Cinch::TwitterWebhooks,
-                          Cinch::DiscourseWebhooks
+                          Cinch::DiscourseWebhooks,
+                          Cinch::JenkinsFailures
                         ]
   end
 
@@ -110,6 +112,13 @@
     :secret => $secrets["discourse_hooks"]["secret"]
   }
 
+  config.plugins.options[Cinch::JenkinsFailures] = {
+    :server => "https://ci.easyrpg.org/",
+    :view => "failing",
+    :user => $secrets["jenkins_failures"]["user"],
+    :pass => $secrets["jenkins_failures"]["pass"]
+  }
+
   # log to file
   file = File.open("#{PWD}/data/bot.log", "a")
   file.sync = true

Gemfile

@@ -8,6 +8,7 @@ gem "sinatra"
 gem "chronic"
 gem "googleauth"
 gem "http"
+gem "jenkins2-api"
 
 gem "xmlrpc" if RUBY_VERSION >= "2.4.0"
 

Gemfile.lock

@@ -54,6 +54,8 @@ GEM
     http-cookie (1.0.3)
       domain_name (~> 0.5)
     http-form_data (2.3.0)
+    jenkins2-api (1.0.17)
+      thor (~> 0.19)
     json (2.5.1)
     jwt (2.2.3)
     llhttp-ffi (0.0.1)
@@ -96,6 +98,7 @@ GEM
       daemons (~> 1.0, >= 1.0.9)
       eventmachine (~> 1.0, >= 1.0.4)
       rack (>= 1, < 3)
+    thor (0.20.3)
     tilt (2.0.10)
     time (0.1.0)
     time-lord (1.0.1)
@@ -115,6 +118,7 @@ DEPENDENCIES
   cinch-seen
   googleauth
   http
+  jenkins2-api
   json
   sinatra
   thin

README.md

@@ -15,14 +15,11 @@ Needed gems besides `cinch` are (see Gemfile for details):
  * [thin][thin]
  * [sinatra][sinatra]
  * [chronic][chronic]
- * [http][http]
  * [googleauth][googleauth]
+ * [http][http]
+ * [jenkins2-api][jenkins2-api]
  * [xmlrpc][xmlrpc] (for ruby 2.4+)
 
-Deprecated/Optional gems:
-
- * [cinch-identify][cinch-identify], SASL is preferred now.
-
 You can use bundler to install them and their dependencies.
 
     $ bundle config set --local path 'vendor/bundle'
@@ -111,6 +108,15 @@ https://github.com/Quintus/cinch-plugins
    happens on Twitter. This uses the webserver provided by http_server.rb and
    relies on the Zapier service and Twitter api.
 
+ * plugins/discourse_webhooks.rb:
+
+   Uses webhooks to provide channel notifications, when a new topic is added on the forums.
+
+ * plugins/jenkins_failures.rb:
+
+   Uses the Jenkins API (pulled with a timer) to provide channel notifications about
+   failed builds.
+
 [webchat]: https://kiwiirc.com/nextclient/#ircs://irc.libera.chat/#easyrpg?nick=rpgguest??
 [cinch]: https://github.com/cinchrb/cinch
 [ev0001]: https://github.com/EasyRPG/EV0001
@@ -122,5 +128,6 @@ https://github.com/Quintus/cinch-plugins
 [chronic]: https://github.com/mojombo/chronic
 [http]: https://github.com/httprb/http
 [googleauth]: https://github.com/google/google-auth-library-ruby
+[jenkins2-api]: https://github.com/yitsushi/jenkins2-api
 [xmlrpc]: https://github.com/ruby/xmlrpc
 [quintus]: https://github.com/Quintus

plugins/jenkins_failures.rb

@@ -0,0 +1,61 @@
+#
+# This cinch plugin is part of EV0002
+#
+# written by carstene1ns <dev @ f4ke . de> 2021
+# available under ISC license
+#
+
+require 'jenkins2-api'
+
+class Cinch::JenkinsFailures
+  include Cinch::Plugin
+
+  # Every 10 minutes
+  timer 10 * 60, method: :get_failures
+
+  def get_failures
+    server = config[:server]
+    user = config[:user]
+    pass = config[:pass]
+    view = config[:view]
+
+    # not found, ignore
+    return if server.nil? or user.nil? or pass.nil? or view.nil?
+
+    client = Jenkins2API::Client.new(
+      :server   => server,
+      :username => user,
+      :password => pass
+    )
+
+    # get failed jobs, ignoring pull requests
+    jobs = client.job.list
+    failed = Array.new
+    jobs.each do |job|
+      if job['color'] == "red" and job['name'] !~ /.*-pr/
+        failed.push(job['name'])
+      end
+    end
+
+    return if failed.empty?
+
+    # filter last 10 minutes
+    recent = Array.new
+    failed.each do |job|
+      build = client.build.latest(job)
+      endtime = Time.at((build['timestamp'].to_i + build['duration'].to_i) / 1000)
+      recent.push(job) if endtime > Time.now - (10 * 60)
+    end
+
+    return if recent.empty?
+
+    shown = recent.join(",")
+    message = "New failing jobs (see " + server + "view/" + view + "/ for details): "
+
+    # add up to 200 characters
+    message << "\n" + Format(:red, shown[0, 200])
+    message << "…" if shown.length > 200
+
+    bot.channels[0].send("[Jenkins] #{message}")
+  end
+end

template.secrets.yml

@@ -21,3 +21,7 @@ twitter_hooks:
 
 discourse_hooks:
     secret: SomethingSecret
+
+jenkins_failures:
+    user: username
+    pass: passorapikey