zabbirc 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fbf557c48488047ac885b6c749418c0eb726276
-  data.tar.gz: a2076325c55e080a5045688708ef5937abb5b869
+  metadata.gz: fc13d87c01a24f572c2335c3b833a67bd69ac32e
+  data.tar.gz: f52a51ece4b4cadbccf80667bc0318ef49200624
 SHA512:
-  metadata.gz: cbc6ffaa1d3054149f3d433123caf35abd158644c0c2b15a70e391ec51260c967758928fbc207d1852698dbbafa36a7bcbbfa0b028874b4ec4eae684daf9b848
-  data.tar.gz: 0e881776f3a7ba5cb204878b474368525ef710fda6b69b0cec504d8de36f3787f30e67cf9e669abbf863a086752030b316b494f4ab8e3252ebd22ab70669af24
+  metadata.gz: 6dce36ab81b1e7ec021e638a3df1a005ecd028031bb882823cfc86a50f10f905156c191de858cb121ab3ae69741313d3be0187a2a16e77b352cfe97a91193d1b
+  data.tar.gz: 0bd55518c88310f0d03ba5bff6308a19bd8a657690dfcc324a673850e898af0efad0e99a8956625fea044888cab047a0f0b8bc53cab1f3e1215d9cec46670df8

data/lib/zabbirc.rb

@@ -22,6 +22,10 @@ module Zabbirc
   def self.events_id_shortener
     @events_id_shortener ||= IdShortener.new
   end
+
+  def self.maintenances_id_shortener
+    @maintenances_id_shortener ||= IdShortener.new
+  end
 end
 
 require 'zabbirc/configuration'

data/lib/zabbirc/irc/base_command.rb

@@ -16,8 +16,14 @@ module Zabbirc
         @ops = ops
         @message = message
         @op = get_op @message
-        @cmd = cmd.to_s.strip.gsub(/\s{2,}/," ")
-        @args = @cmd.split(/ /)
+        @cmd = cmd.to_s.strip.gsub(/\s{2,}/," ").freeze
+        @args = parse_arguments @cmd
+      end
+
+      def parse_arguments cmd
+        cmd.scan(/'[a-zA-Z0-9_\-,# ]+'|[a-zA-Z0-9_\-,#]+/).collect do |x|
+          x.match(/[a-zA-Z0-9_\-,# ]+/)[0]
+        end
       end
 
       def run
@@ -68,18 +74,39 @@ module Zabbirc
       end
 
       def find_host host
-        hosts = Zabbix::Host.get(search: {host: host})
+        hosts = Zabbix::Host.get(search: {name: host})
         case hosts.size
         when 0
-          reply "Host not found `#{host}`"
+          raise UserInputError, "Host not found `#{host}`"
         when 1
           return hosts.first
         when 2..10
-          reply "Found #{hosts.size} hosts: #{hosts.collect(&:name).join(', ')}. Be more specific"
+          raise UserInputError, "Found #{hosts.size} hosts: #{hosts.collect(&:name).join(', ')}. Be more specific"
         else
-          reply "Found #{hosts.size} Be more specific"
+          raise UserInputError, "Found #{hosts.size} Be more specific"
+        end
+      end
+
+      def find_hosts names
+        names.collect{|name| find_host name }
+      end
+
+      def find_host_group name
+        host_group = Zabbix::HostGroup.get(search: { name: name })
+        case host_group.size
+          when 0
+            raise UserInputError, "Cannot find hostgroup with name: `#{name}`"
+          when 1
+            host_group.first
+          when 2..10
+            raise UserInputError, "Found #{host_group.size} host groups using name: `#{name}` be more specific. Host groups: #{host_group.collect(&:name).join(", ")}"
+          else
+            raise UserInputError, "Found #{host_group.size} host groups using name: `#{name}` be more specific"
         end
-        false
+      end
+
+      def find_host_groups names
+        names.collect{ |name| find_host_group(name) }
       end
 
       def find_event short_eventid

data/lib/zabbirc/irc/maintenance_command.rb

@@ -0,0 +1,103 @@
+module Zabbirc
+  module Irc
+    class MaintenanceCommand < BaseCommand
+      register_help "maint", [
+          "Show active maintenances: !maint",
+          "Schedule a maintenance: !maint [hostgroups] '<host_name>|<hostgroup_name>[, <host_name>|<hostgroup_name>]' <duration> <reason>",
+          " - duration format: 1h, 30m, 1h30m. h - hour, m - minute.",
+          "Delete a maintenance: !maint delete <maintenance-id>"
+      ]
+      private
+      def perform
+        first_arg = @args.first
+        case first_arg
+        when nil
+          perform_list
+        when "delete"
+          @args.shift
+          perform_delete
+        else
+          perform_create
+        end
+      end
+
+      def perform_list
+        maintenances = Zabbix::Maintenance.get(selectHosts: :extend, selectGroups: :extend, selectTimePeriods: :extend)
+        active_maintenances = maintenances.select(&:active?)
+        if active_maintenances.empty?
+          reply "No active maintenances at this moment."
+        else
+          reply active_maintenances.collect(&:label)
+        end
+
+      end
+
+      def perform_create
+        params = {}
+        hostgroups_flag = @args.shift
+        if hostgroups_flag == "hostgroups"
+          target_names = @args.shift
+          raise UserInputError, help_features["maint"] unless target_names
+          target_names = target_names.split(/,/).collect(&:strip)
+          params[:host_group_ids] = find_host_groups(target_names).collect(&:id)
+        else
+          target_names = hostgroups_flag.split(/,/).collect(&:strip)
+          params[:host_ids] = find_hosts(target_names).collect(&:id)
+        end
+
+        params[:duration] = parse_duration @args.shift
+        params[:name] = @args.join(" ")
+        raise raise UserInputError, "no reason specified" if params[:name].blank?
+
+        id = Zabbix::Maintenance.create params
+        maintenance = Zabbix::Maintenance.find(id)
+        reply [
+                "maintenance scheduled since #{maintenance.active_since.to_formatted_s(:short)} till #{maintenance.active_till.to_formatted_s(:short)}",
+                maintenance.label
+              ]
+      end
+
+      def perform_delete
+        maintenance = find_maintenance @args.shift
+
+        begin
+          maintenance.destroy
+          reply "maintenance with id #{maintenance.shorten_id} has been deleted"
+        rescue ::Zabbix::Client::Error => e
+          reply "an error occured while deleting maintenance with id #{maintenance.shorten_id}: #{e}"
+        end
+      end
+
+      def find_maintenance shorten_id
+        maintenance_id = Zabbirc.maintenances_id_shortener.get_id shorten_id
+        raise UserInputError, "Bad maintenance id `#{shorten_id}`" unless maintenance_id
+
+        maintenance = Zabbix::Maintenance.find(maintenance_id)
+        raise UserInputError, "Could not find maintenance with id `#{shorten_id}`" if maintenance.nil?
+        maintenance
+
+      rescue Zabbix::IDNotUniqueError => e
+        raise UserInputError, "Could not find maintenance: #{e}"
+      end
+
+      def find_targets names, hostgroups_flag
+        names = names.split(/,/).collect(&:strip)
+        if hostgroups_flag
+          find_host_groups names
+        else
+          find_hosts names
+        end
+      end
+
+      def parse_duration duration_str
+        raise UserInputError, help_features["maint"] unless duration_str
+        match_data = duration_str.match(/(?:(?<minutes>[0-9]+[mM])|(?:(?<hours>[0-9]+)[hH](?<minutes>[0-9]+[mM])?))/)
+        raise UserInputError, ["cannot parse duration `#{duration_str}`", help_features["maint"]].flatten unless match_data
+        duration = 0
+        duration += match_data[:hours].to_i.hours if match_data[:hours]
+        duration += match_data[:minutes].to_i.minutes if match_data[:minutes]
+        duration
+      end
+    end
+  end
+end

data/lib/zabbirc/irc/plugin.rb

@@ -22,6 +22,10 @@ module Zabbirc
 
       # Host
       match /((?:status|latest)(?: .*)?)/, method: :host_command
+
+      # Maintenance
+      match /maint(?: (.*))?\Z/, method: :maintenance_command
+
     end
   end
 end

data/lib/zabbirc/irc/plugin_methods.rb

@@ -39,6 +39,11 @@ module Zabbirc
         cmd.run
       end
 
+      def maintenance_command m, cmd
+        cmd = MaintenanceCommand.new(ops, m, cmd)
+        cmd.run
+      end
+
       def sync_ops m, u=nil
         return if u and u.nick == bot.nick
         bot.zabbirc_service.ops_service.iterate

data/lib/zabbirc/irc/settings_command.rb

@@ -135,25 +135,6 @@ module Zabbirc
         end
         [key, value, host_groups_flag, host_groups]
       end
-
-      def find_host_groups names
-        names.collect do |name|
-          host_group = Zabbix::HostGroup.get(search: { name: name })
-          case host_group.size
-          when 0
-            raise UserInputError, "Cannot find hostgroup with name: `#{name}`"
-          when 1
-            host_group.first
-          when 2..10
-            raise UserInputError, "Found #{host_group.size} host groups using name: `#{name}` be more specific. Host groups: #{host_group.collect(&:name).join(", ")}"
-          else
-            raise UserInputError, "Found #{host_group.size} host groups using name: `#{name}` be more specific"
-          end
-        end
-      end
-
     end
   end
-end
-
-# TODO filtrovanie eventov podla hostgroup
+end

data/lib/zabbirc/version.rb

@@ -1,3 +1,3 @@
 module Zabbirc
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/zabbirc/zabbix/maintenance.rb

@@ -0,0 +1,94 @@
+module Zabbirc
+  module Zabbix
+    class Maintenance < Resource::Base
+
+      has_many :hosts
+      has_many :groups, class_name: "HostGroup"
+
+      def self.find id, *options
+        options = options.extract_options!
+        options[:selectHosts] = :extend
+        options[:selectGroups] = :extend
+        super(id, options)
+      end
+
+      def self.create *options
+        default_options = {
+            host_ids: [],
+            host_group_ids: []
+        }
+
+        options = options.extract_options!
+        options = options.reverse_merge(default_options)
+
+        duration = options[:duration]
+        name = options[:name]
+        host_ids = options[:host_ids]
+        host_group_ids = options[:host_group_ids]
+        maint_start = Time.current
+        maint_end = maint_start + duration
+
+        r = api.maintenance.create(
+            name: name,
+            active_since: maint_start.to_i,
+            active_till: maint_end.to_i,
+            hostids: host_ids,
+            groupids: host_group_ids,
+            timeperiods: [
+                {
+                    timeperiod_type: 0,
+                    start_time: maint_start.to_i,
+                    period: duration
+                }
+            ]
+        )
+
+        r["maintenanceids"].first
+      end
+
+      def shorten_id
+        @shorten_id ||= Zabbirc.maintenances_id_shortener.get_shorten_id id
+      end
+
+      def active_since
+        Time.at(super.to_i)
+      end
+
+      def active_till
+        Time.at(super.to_i)
+      end
+
+      def active?
+        (active_since..active_till).cover? Time.current
+      end
+
+      def label
+        format_label "|%sid| %start -> %end >> %name %targets"
+      end
+
+      def format_label fmt
+        fmt.gsub("%start", "#{active_since.to_formatted_s(:short)}").
+            gsub("%end", "#{active_till.to_formatted_s(:short)}").
+            gsub("%name", "#{name}").
+            gsub("%id", "#{id}").
+            gsub("%sid", "#{shorten_id}").
+            gsub("%targets", "#{target_labels}")
+      end
+
+      def target_labels
+        host_names = hosts.collect(&:name)
+        group_names = groups.collect(&:name)
+
+        r = ""
+        r << "Hosts: #{host_names.join(", ")}" if host_names.present?
+        r << "Host Groups: #{group_names.join(", ")}" if group_names.present?
+        r
+      end
+
+      def destroy
+        api.maintenance.delete [id]
+      end
+
+    end
+  end
+end

data/lib/zabbirc/zabbix/resource/associations.rb

@@ -16,7 +16,7 @@ module Zabbirc
               hash_data = @attrs[options[:zabbix_attribute]]
               if hash_data.blank?
                 this = self.class.find id, extend_key => :extend
-                raise StandardError, "zabbix response does not contain #{options[:zabbix_attribute]}" if this[options[:zabbix_attribute]].blank?
+                raise StandardError, "zabbix response does not contain #{options[:zabbix_attribute]}" if this[options[:zabbix_attribute]].nil?
                 hash_data = this[options[:zabbix_attribute]]
               end
 

data/spec/maintenance_command_spec.rb

@@ -0,0 +1,92 @@
+describe Zabbirc::Irc::MaintenanceCommand do
+  let(:ops_builder) { Zabbirc::OpsBuilder.new }
+  let(:mock_nick) { "op1" }
+  let(:mock_op) { ops_builder.build_op(mock_nick, mock_user_settings) }
+  let(:mock_message) { double("Cinch::Message", user: mock_op.irc_user) }
+  let(:mock_user_settings) { nil }
+  let(:maintenance_command) { Zabbirc::Irc::MaintenanceCommand.new ops_builder.ops, mock_message, cmd }
+
+
+  describe "list maintenances" do
+    let(:cmd) { "" }
+
+    before do
+      allow(Zabbirc::Zabbix::Maintenance).to receive(:get).and_return(maintenances)
+    end
+
+    context "no active maintenances" do
+      let(:maintenances) { [] }
+      let(:expected_message) { "#{mock_nick}: No active maintenances at this moment." }
+
+      it "should print active maintenances" do
+        expect(mock_message).to receive(:reply).with(expected_message)
+        maintenance_command.run
+      end
+    end
+
+    context "active maintenances exist" do
+      let(:maint1) { double("Maintenance", label: "maint 1 label", active?: true) }
+      let(:maint2) { double("Maintenance", label: "maint 2 label", active?: true) }
+      let(:maintenances) { [maint1, maint2] }
+
+      let(:expected_message) do
+        maintenances.collect do |maintenance|
+          "#{mock_nick}: #{maintenance.label}"
+        end.join("\n")
+      end
+
+
+      it "should print active maintenances" do
+        expect(mock_message).to receive(:reply).with(expected_message)
+        maintenance_command.run
+      end
+    end
+  end
+
+  describe "create maintenance" do
+    let(:host1) { double("Host", id: 1, name: "Host1") }
+    let(:host2) { double("Host", id: 2, name: "Host2") }
+    let(:hosts) { [host1, host2] }
+
+    let(:host_group1) { double("HostGroup", id: 11, name: "HostGroup1") }
+    let(:host_group2) { double("HostGroup", id: 12, name: "HostGroup2") }
+    let(:host_groups) { [host_group1, host_group2] }
+
+    let(:duration) { "1h30m" }
+    let(:duration_int) { (1.hour + 30.minutes).to_i }
+    let(:reason) { "some reason" }
+
+    let(:created_maintenance) { double("Maintenance", label: "maintenance label", active_since: Time.now, active_till: Time.now) }
+
+    before do
+      allow(Zabbirc::Zabbix::Maintenance).to receive(:create).with(any_args).and_return(true)
+      allow(Zabbirc::Zabbix::Host).to receive(:get).with(hash_including(search: { name: anything })) do |params|
+        hosts.select{|g| g.name =~ /#{params[:search][:name]}/ }
+      end
+      allow(Zabbirc::Zabbix::HostGroup).to receive(:get).with(hash_including(search: { name: anything })) do |params|
+        host_groups.select{|g| g.name =~ /#{params[:search][:name]}/ }
+      end
+      allow(Zabbirc::Zabbix::Maintenance).to receive(:find).and_return(created_maintenance)
+    end
+
+    context "hosts" do
+      let(:cmd) { "'#{host1.name},#{host2.name}' #{duration} #{reason}" }
+      it "should create maintenance" do
+        expect(Zabbirc::Zabbix::Maintenance).to receive(:create).with(duration: duration_int, host_ids: hosts.collect(&:id), name: reason)
+        expect(mock_message).to receive(:reply)
+        maintenance_command.run
+      end
+    end
+
+    context "host groups" do
+      let(:cmd) { "hostgroups '#{host_group1.name},#{host_group2.name}' #{duration} #{reason}" }
+      it "should create maintenance" do
+        expect(Zabbirc::Zabbix::Maintenance).to receive(:create).with(duration: duration_int, host_group_ids: host_groups.collect(&:id), name: reason)
+        expect(mock_message).to receive(:reply)
+        maintenance_command.run
+      end
+    end
+
+
+  end
+end

data/spec/settings_command_spec.rb

@@ -51,7 +51,8 @@ describe Zabbirc::Irc::SettingsCommand do
     context "group specific" do
       let(:group1) { double "HostGroup", id: 1, name: "Group1" }
       let(:group2) { double "HostGroup", id: 2, name: "Group2" }
-      let(:groups) { [group1, group2] }
+      let(:group3) { double "HostGroup", id: 3, name: "Group3" }
+      let(:groups) { [group1, group2, group3] }
       before do
         allow(Zabbirc::Zabbix::HostGroup).to receive(:get) { groups }
         allow(Zabbirc::Zabbix::HostGroup).to receive(:get).with(hash_including(search: { name: anything })) do |params|
@@ -60,64 +61,72 @@ describe Zabbirc::Irc::SettingsCommand do
       end
 
       shared_examples "set_group_setting" do |key, value, expected_setting_value|
-        let(:expected_msg) { "#{mock_nick}: setting `#{key}` has been set to `#{expected_setting_value}` for host groups: #{affected_host_group.name}" }
-        let(:cmd) { "set #{key} #{value} hostgroups #{affected_host_group.name}"}
+        let(:affected_host_groups_names) { affected_host_groups.collect(&:name).join(", ") }
+        let(:expected_msg) { "#{mock_nick}: setting `#{key}` has been set to `#{expected_setting_value}` for host groups: #{affected_host_groups_names}" }
+        let(:cmd) { "set #{key} #{value} hostgroups '#{affected_host_groups_names}'"}
         it "should set #{key} setting to #{value} for host group" do
           old_global_value = mock_op.setting.get(key)
 
           expect(mock_message).to receive(:reply).with(expected_msg)
           settings_command.run
-          expect(mock_op.setting.get(key, host_group_id: affected_host_group.id)).to eq expected_setting_value
+          affected_host_groups.each do |group|
+            expect(mock_op.setting.get(key, host_group_id: group.id)).to eq expected_setting_value
+          end
 
           expect(mock_op.setting.get(key)).to eq old_global_value
         end
       end
 
       shared_examples "set_all_groups_setting" do |key, value, expected_setting_value|
+        let(:affected_host_groups_names) { affected_host_groups.collect(&:name).join(", ") }
         let(:settings_command1) { Zabbirc::Irc::SettingsCommand.new ops_builder.ops, mock_message, cmd1 }
         let(:settings_command2) { Zabbirc::Irc::SettingsCommand.new ops_builder.ops, mock_message, cmd2 }
 
-        let!(:old_global_value) { mock_op.setting.get(key, host_group_id: affected_host_group.id) }
-        let(:expected_msg1) { "#{mock_nick}: setting `#{key}` has been set to `#{expected_setting_value}` for host groups: #{affected_host_group.name}" }
+        let!(:old_global_value) { mock_op.setting.get(key) }
+        let(:expected_msg1) { "#{mock_nick}: setting `#{key}` has been set to `#{expected_setting_value}` for host groups: #{affected_host_groups_names}" }
         let(:expected_msg2) { "#{mock_nick}: setting `#{key}` has been set to `#{old_global_value}` for all host groups" }
-        let(:cmd1) { "set #{key} #{value} hostgroups #{affected_host_group.name}"}
+        let(:cmd1) { "set #{key} #{value} hostgroups #{affected_host_groups_names}"}
         let(:cmd2) { "set #{key} #{old_global_value} hostgroups-all"}
         it "should set #{key} setting to #{value} for all host groups" do
           # sets host group specific setting
           expect(mock_message).to receive(:reply).with(expected_msg1)
           settings_command1.run
-          expect(mock_op.setting.get(key, host_group_id: affected_host_group.id)).to eq expected_setting_value
+          affected_host_groups.each do |group|
+            expect(mock_op.setting.get(key, host_group_id: group.id)).to eq expected_setting_value
+          end
           expect(mock_op.setting.get(key)).to eq old_global_value
 
           expect(mock_message).to receive(:reply).with(expected_msg2)
           settings_command2.run
-          expect(mock_op.setting.get(key, host_group_id: affected_host_group.id)).to eq old_global_value
+          affected_host_groups.each do |group|
+            expect(mock_op.setting.get(key, host_group_id: group.id)).to eq old_global_value
+          end
           expect(mock_op.setting.get(key)).to eq old_global_value
         end
       end
 
       it_should_behave_like "set_group_setting", "notify", "false", false do
-        let(:affected_host_group) { group1 }
+        let(:affected_host_groups) { [group1, group2] }
       end
 
       it_should_behave_like "set_group_setting", "events_priority", "high", :high do
-        let(:affected_host_group) { group1 }
+        let(:affected_host_groups) { [group1, group2] }
       end
 
       it_should_behave_like "set_group_setting", "events_priority", "5", :disaster do
-        let(:affected_host_group) { group1 }
+        let(:affected_host_groups) { [group1, group2] }
       end
 
       it_should_behave_like "set_all_groups_setting", "notify", "false", false do
-        let(:affected_host_group) { group1 }
+        let(:affected_host_groups) { [group1, group2] }
       end
 
       it_should_behave_like "set_all_groups_setting", "events_priority", "high", :high do
-        let(:affected_host_group) { group1 }
+        let(:affected_host_groups) { [group1, group2] }
       end
 
       it_should_behave_like "set_all_groups_setting", "events_priority", "5", :disaster do
-        let(:affected_host_group) { group1 }
+        let(:affected_host_groups) { [group1, group2] }
       end
 
     end

data/tmp/playground.rb

@@ -20,3 +20,13 @@ s.set :events_priority, :high, host_group_id: 1
 
 
 c = SettingsCommand.new
+
+
+def get_event short_id
+  Zabbirc.events_id_shortener.get_id(short_id)
+  Event.get(
+      event_ids: short_id,
+      selectRelatedObject: :extend,
+      selectHosts: :extend
+  )
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zabbirc
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Filip Zachar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-06 00:00:00.000000000 Z
+date: 2015-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -123,6 +123,7 @@ files:
 - lib/zabbirc/irc/help.rb
 - lib/zabbirc/irc/help_command.rb
 - lib/zabbirc/irc/host_command.rb
+- lib/zabbirc/irc/maintenance_command.rb
 - lib/zabbirc/irc/plugin.rb
 - lib/zabbirc/irc/plugin_methods.rb
 - lib/zabbirc/irc/settings_command.rb
@@ -141,6 +142,7 @@ files:
 - lib/zabbirc/zabbix/event.rb
 - lib/zabbirc/zabbix/host.rb
 - lib/zabbirc/zabbix/host_group.rb
+- lib/zabbirc/zabbix/maintenance.rb
 - lib/zabbirc/zabbix/resource/associations.rb
 - lib/zabbirc/zabbix/resource/base.rb
 - lib/zabbirc/zabbix/resource/finders.rb
@@ -149,6 +151,7 @@ files:
 - spec/event_command_spec.rb
 - spec/host_command_spec.rb
 - spec/id_shortener_spec.rb
+- spec/maintenance_command_spec.rb
 - spec/settings_command_spec.rb
 - spec/spec_helper.rb
 - spec/support/mock_bot.rb