capistrano2-zabbix 0.1.2

data/lib/capistrano/tasks.rb

@@ -0,0 +1,40 @@
+require 'capistrano'
+require_relative '../zabbix_maintenance'
+
+Capistrano::Configuration.instance.load do
+  def set_default(pname, *args, &bl)
+    set(pname, *args, &bl) unless exists? pname
+  end
+
+  # Defaults
+  set_default(:zabbix_url)  { 'http://192.168.56.2/zabbix/' }
+  set_default(:zabbix_user) { 'Admin' }
+  set_default(:zabbix_password) { 'zabbix' }
+  set_default(:zabbix_period) { 60 * 60 * 10 } # 10 hours
+  set_default(:zabbix_groupid) { 2 }
+  set_default(:zabbix_auto_trigger) { false }
+
+  namespace :zabbix do
+    desc 'Create maintenance in Zabbix'
+    task :create do
+      zm_api.create_or_replace [zabbix_groupid], period: zabbix_period
+    end
+
+    desc 'Delete maintenance in Zabbix'
+    task :delete do
+      zm_api.delete(id: zm_api.maint_id)
+    end
+  end
+
+  if zabbix_auto_trigger
+    after 'deploy:setup',           'zabbix:create'
+    after 'deploy:restart',         'zabbix:delete'
+  end
+
+  def zm_api
+    zbx = ZabbixMaintenance.new("#{zabbix_url}/api_jsonrpc.php",
+                                zabbix_user,
+                                zabbix_password)
+    set(:zbx_handle, zbx)
+  end
+end

data/lib/capistrano2-zabbix.rb

@@ -0,0 +1 @@
+require_relative './capistrano/tasks'

data/lib/zabbix_maintenance.rb

@@ -0,0 +1,64 @@
+require 'zabbixapi'
+
+# Communicates with Zabbix through API and performs actions on
+# maintenance objects.
+class ZabbixMaintenance
+  attr_reader :id, :maint_title, :zbx
+
+  def initialize(url, user, password, title: 'capistrano auto maintenance')
+    begin
+      @zbx = ZabbixApi.connect(url: url, user: user, password: password)
+    rescue RuntimeError
+      @zbx = nil
+    end
+
+    @maint_title = title
+    @id = nil
+  end
+
+  def maint_id
+    ret = @zbx.query method: 'maintenance.get', params: {
+      'search': {
+        'name': @maint_title
+      }
+    }
+    begin
+      ret.first['maintenanceid'].to_i
+    rescue KeyError
+      nil
+    end
+  end
+
+  def create_or_replace(*args)
+    delete(id: maint_id) if exists?
+    create(*args)
+  end
+
+  def create(groupids, period: 3600)
+    maint_params = {
+      name: @maint_title,
+      active_since: Time.now.to_i - 200,
+      active_till: Time.now.to_i + 866_00,
+      groupids: groupids,
+      timeperiods: [{ period: period }]
+    }
+    ret = @zbx.query method: 'maintenance.create', params: maint_params
+    @id = ret['maintenanceids'].first.to_i
+  end
+
+  def delete(id: @id)
+    ret = @zbx.query method: 'maintenance.delete', params: [id]
+    unless ret['maintenanceids'] == [id]
+      fail "Maintenance id:#{id} has not been deleted"
+    end
+    true
+  end
+
+  def exists?
+    @zbx.query method: 'maintenance.exists', params: { name: @maint_title }
+  end
+
+  def authenticated?
+    !(@zbx.nil? || @zbx.client.auth.nil?)
+  end
+end

data/spec/capistrano2-zabbix_spec.rb

@@ -0,0 +1,4 @@
+require_relative './spec_helper'
+
+describe 'Capistrano2Zabbix' do
+end

data/spec/cassettes/ZabbixMaintenance/_authenticated_/when_authenticated/.yml

@@ -0,0 +1,108 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://192.168.56.2/zabbix/api_jsonrpc.php
+    body:
+      encoding: UTF-8
+      string: '{"method":"user.authenticate","params":{"user":"Admin","password":"zabbix"},"auth":null,"id":90443,"jsonrpc":"2.0"}'
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/json-rpc
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 14 May 2015 04:45:14 GMT
+      Server:
+      - Apache/2.2.22 (Linux/SUSE)
+      X-Powered-By:
+      - PHP/5.3.17
+      Content-Length:
+      - '72'
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '{"jsonrpc":"2.0","result":"9cea11e673f8859e7c09085362dc99c1","id":90443}'
+    http_version: 
+  recorded_at: Thu, 14 May 2015 12:16:34 GMT
+- request:
+    method: post
+    uri: http://192.168.56.2/zabbix/api_jsonrpc.php
+    body:
+      encoding: UTF-8
+      string: '{"method":"apiinfo.version","params":{},"auth":"9cea11e673f8859e7c09085362dc99c1","id":36215,"jsonrpc":"2.0"}'
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/json-rpc
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 14 May 2015 04:45:14 GMT
+      Server:
+      - Apache/2.2.22 (Linux/SUSE)
+      X-Powered-By:
+      - PHP/5.3.17
+      Content-Length:
+      - '45'
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '{"jsonrpc":"2.0","result":"2.2.2","id":36215}'
+    http_version: 
+  recorded_at: Thu, 14 May 2015 12:16:34 GMT
+- request:
+    method: post
+    uri: http://192.168.56.2/zabbix/api_jsonrpc.php
+    body:
+      encoding: UTF-8
+      string: '{"method":"user.authenticate","params":{"user":"Admin","password":"zabbix"},"auth":"9cea11e673f8859e7c09085362dc99c1","id":89508,"jsonrpc":"2.0"}'
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/json-rpc
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 14 May 2015 04:45:14 GMT
+      Server:
+      - Apache/2.2.22 (Linux/SUSE)
+      X-Powered-By:
+      - PHP/5.3.17
+      Content-Length:
+      - '72'
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '{"jsonrpc":"2.0","result":"fdab665e94c7e4632823694c6b88f2f2","id":89508}'
+    http_version: 
+  recorded_at: Thu, 14 May 2015 12:16:34 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/ZabbixMaintenance/_authenticated_/when_not_authenticated/returns_false.yml

@@ -0,0 +1,39 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://192.168.56.2/zabbix/api_jsonrpc.php
+    body:
+      encoding: UTF-8
+      string: '{"method":"user.authenticate","params":{"user":"wronglogin","password":"wrongpw"},"auth":null,"id":63859,"jsonrpc":"2.0"}'
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/json-rpc
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 14 May 2015 04:47:04 GMT
+      Server:
+      - Apache/2.2.22 (Linux/SUSE)
+      X-Powered-By:
+      - PHP/5.3.17
+      Content-Length:
+      - '126'
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '{"jsonrpc":"2.0","error":{"code":-32602,"message":"Invalid params.","data":"Login
+        name or password is incorrect."},"id":63859}'
+    http_version: 
+  recorded_at: Thu, 14 May 2015 12:18:23 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/ZabbixMaintenance/_create/with_valid_parameters/creates_maintenance_period_with_correct_groupid.yml

@@ -0,0 +1,143 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://192.168.56.2/zabbix/api_jsonrpc.php
+    body:
+      encoding: UTF-8
+      string: '{"method":"user.authenticate","params":{"user":"Admin","password":"zabbix"},"auth":null,"id":12876,"jsonrpc":"2.0"}'
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/json-rpc
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 14 May 2015 04:05:39 GMT
+      Server:
+      - Apache/2.2.22 (Linux/SUSE)
+      X-Powered-By:
+      - PHP/5.3.17
+      Content-Length:
+      - '72'
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '{"jsonrpc":"2.0","result":"d0762dbd317f9340c2f50e3740fb32b4","id":12876}'
+    http_version: 
+  recorded_at: Thu, 14 May 2015 11:36:59 GMT
+- request:
+    method: post
+    uri: http://192.168.56.2/zabbix/api_jsonrpc.php
+    body:
+      encoding: UTF-8
+      string: '{"method":"apiinfo.version","params":{},"auth":"d0762dbd317f9340c2f50e3740fb32b4","id":92137,"jsonrpc":"2.0"}'
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/json-rpc
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 14 May 2015 04:05:40 GMT
+      Server:
+      - Apache/2.2.22 (Linux/SUSE)
+      X-Powered-By:
+      - PHP/5.3.17
+      Content-Length:
+      - '45'
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '{"jsonrpc":"2.0","result":"2.2.2","id":92137}'
+    http_version: 
+  recorded_at: Thu, 14 May 2015 11:36:59 GMT
+- request:
+    method: post
+    uri: http://192.168.56.2/zabbix/api_jsonrpc.php
+    body:
+      encoding: UTF-8
+      string: '{"method":"maintenance.create","params":{"name":"capistrano auto maintenance","active_since":1431603219,"active_till":1431690019,"groupids":[2],"timeperiods":[{"period":3200}]},"auth":"d0762dbd317f9340c2f50e3740fb32b4","id":11855,"jsonrpc":"2.0"}'
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/json-rpc
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 14 May 2015 04:05:40 GMT
+      Server:
+      - Apache/2.2.22 (Linux/SUSE)
+      X-Powered-By:
+      - PHP/5.3.17
+      Content-Length:
+      - '63'
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '{"jsonrpc":"2.0","result":{"maintenanceids":["13"]},"id":11855}'
+    http_version: 
+  recorded_at: Thu, 14 May 2015 11:36:59 GMT
+- request:
+    method: post
+    uri: http://192.168.56.2/zabbix/api_jsonrpc.php
+    body:
+      encoding: UTF-8
+      string: '{"method":"maintenance.delete","params":[13],"auth":"d0762dbd317f9340c2f50e3740fb32b4","id":93840,"jsonrpc":"2.0"}'
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/json-rpc
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 14 May 2015 04:05:40 GMT
+      Server:
+      - Apache/2.2.22 (Linux/SUSE)
+      X-Powered-By:
+      - PHP/5.3.17
+      Content-Length:
+      - '61'
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '{"jsonrpc":"2.0","result":{"maintenanceids":[13]},"id":93840}'
+    http_version: 
+  recorded_at: Thu, 14 May 2015 11:37:00 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/ZabbixMaintenance/_delete/removes_the_maintenance.yml

@@ -0,0 +1,213 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://192.168.56.2/zabbix/api_jsonrpc.php
+    body:
+      encoding: UTF-8
+      string: '{"method":"user.authenticate","params":{"user":"Admin","password":"zabbix"},"auth":null,"id":76622,"jsonrpc":"2.0"}'
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/json-rpc
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 14 May 2015 04:34:45 GMT
+      Server:
+      - Apache/2.2.22 (Linux/SUSE)
+      X-Powered-By:
+      - PHP/5.3.17
+      Content-Length:
+      - '72'
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '{"jsonrpc":"2.0","result":"aebd33c25d82d0bab6c1477705762484","id":76622}'
+    http_version: 
+  recorded_at: Thu, 14 May 2015 12:06:05 GMT
+- request:
+    method: post
+    uri: http://192.168.56.2/zabbix/api_jsonrpc.php
+    body:
+      encoding: UTF-8
+      string: '{"method":"apiinfo.version","params":{},"auth":"aebd33c25d82d0bab6c1477705762484","id":77881,"jsonrpc":"2.0"}'
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/json-rpc
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 14 May 2015 04:34:45 GMT
+      Server:
+      - Apache/2.2.22 (Linux/SUSE)
+      X-Powered-By:
+      - PHP/5.3.17
+      Content-Length:
+      - '45'
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '{"jsonrpc":"2.0","result":"2.2.2","id":77881}'
+    http_version: 
+  recorded_at: Thu, 14 May 2015 12:06:05 GMT
+- request:
+    method: post
+    uri: http://192.168.56.2/zabbix/api_jsonrpc.php
+    body:
+      encoding: UTF-8
+      string: '{"method":"maintenance.create","params":{"name":"capistrano auto maintenance","active_since":1431604965,"active_till":1431691765,"groupids":[2],"timeperiods":[{"period":3600}]},"auth":"aebd33c25d82d0bab6c1477705762484","id":74046,"jsonrpc":"2.0"}'
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/json-rpc
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 14 May 2015 04:34:45 GMT
+      Server:
+      - Apache/2.2.22 (Linux/SUSE)
+      X-Powered-By:
+      - PHP/5.3.17
+      Content-Length:
+      - '63'
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '{"jsonrpc":"2.0","result":{"maintenanceids":["14"]},"id":74046}'
+    http_version: 
+  recorded_at: Thu, 14 May 2015 12:06:05 GMT
+- request:
+    method: post
+    uri: http://192.168.56.2/zabbix/api_jsonrpc.php
+    body:
+      encoding: UTF-8
+      string: '{"method":"maintenance.exists","params":{"name":"capistrano auto maintenance"},"auth":"aebd33c25d82d0bab6c1477705762484","id":93394,"jsonrpc":"2.0"}'
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/json-rpc
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 14 May 2015 04:34:46 GMT
+      Server:
+      - Apache/2.2.22 (Linux/SUSE)
+      X-Powered-By:
+      - PHP/5.3.17
+      Content-Length:
+      - '42'
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '{"jsonrpc":"2.0","result":true,"id":93394}'
+    http_version: 
+  recorded_at: Thu, 14 May 2015 12:06:05 GMT
+- request:
+    method: post
+    uri: http://192.168.56.2/zabbix/api_jsonrpc.php
+    body:
+      encoding: UTF-8
+      string: '{"method":"maintenance.delete","params":[14],"auth":"aebd33c25d82d0bab6c1477705762484","id":15338,"jsonrpc":"2.0"}'
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/json-rpc
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 14 May 2015 04:34:46 GMT
+      Server:
+      - Apache/2.2.22 (Linux/SUSE)
+      X-Powered-By:
+      - PHP/5.3.17
+      Content-Length:
+      - '61'
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '{"jsonrpc":"2.0","result":{"maintenanceids":[14]},"id":15338}'
+    http_version: 
+  recorded_at: Thu, 14 May 2015 12:06:05 GMT
+- request:
+    method: post
+    uri: http://192.168.56.2/zabbix/api_jsonrpc.php
+    body:
+      encoding: UTF-8
+      string: '{"method":"maintenance.exists","params":{"name":"capistrano auto maintenance"},"auth":"aebd33c25d82d0bab6c1477705762484","id":600,"jsonrpc":"2.0"}'
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/json-rpc
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 14 May 2015 04:34:46 GMT
+      Server:
+      - Apache/2.2.22 (Linux/SUSE)
+      X-Powered-By:
+      - PHP/5.3.17
+      Content-Length:
+      - '41'
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: '{"jsonrpc":"2.0","result":false,"id":600}'
+    http_version: 
+  recorded_at: Thu, 14 May 2015 12:06:05 GMT
+recorded_with: VCR 2.9.3