Merge pull request #5 from micwiel/notifications

Notifications

iapi/notifications.go

@@ -0,0 +1,85 @@
+package iapi
+
+import (
+	"encoding/json"
+	"fmt"
+)
+
+// GetNotification ...
+func (server *Server) GetNotification(name string) ([]NotificationStruct, error) {
+
+	var notifications []NotificationStruct
+	results, err := server.NewAPIRequest("GET", "/objects/notifications/"+name, nil)
+	if err != nil {
+		return nil, err
+	}
+
+	// Contents of the results is an interface object. Need to convert it to json first.
+	jsonStr, marshalErr := json.Marshal(results.Results)
+	if marshalErr != nil {
+		return nil, marshalErr
+	}
+
+	// then the JSON can be pushed into the appropriate struct.
+	// Note : Results is a slice so much push into a slice.
+
+	if unmarshalErr := json.Unmarshal(jsonStr, &notifications); unmarshalErr != nil {
+		return nil, unmarshalErr
+	}
+
+	return notifications, err
+}
+
+// CreateNotification ...
+func (server *Server) CreateNotification(name, hostname, command, servicename string, interval int, users []string, vars map[string]string, templates []string) ([]NotificationStruct, error) {
+
+	var newAttrs NotificationAttrs
+	newAttrs.Command = command
+	newAttrs.Users = users
+	newAttrs.Servicename = servicename
+	newAttrs.Interval = interval
+	newAttrs.Vars = vars
+	newAttrs.Templates = templates
+
+	var newNotification NotificationStruct
+	newNotification.Name = name
+	newNotification.Type = "Notification"
+	newNotification.Attrs = newAttrs
+
+	// Create JSON from completed struct
+	payloadJSON, marshalErr := json.Marshal(newNotification)
+	if marshalErr != nil {
+		return nil, marshalErr
+	}
+
+	//fmt.Printf("<payload> %s\n", payloadJSON)
+
+	// Make the API request to create the hosts.
+	results, err := server.NewAPIRequest("PUT", "/objects/notifications/"+name, []byte(payloadJSON))
+	if err != nil {
+		return nil, err
+	}
+
+	if results.Code == 200 {
+		notifications, err := server.GetNotification(name)
+		return notifications, err
+	}
+
+	return nil, fmt.Errorf("%s", results.ErrorString)
+}
+
+// DeleteNotification ...
+func (server *Server) DeleteNotification(name string) error {
+
+	results, err := server.NewAPIRequest("DELETE", "/objects/notifications/"+name+"?cascade=1", nil)
+	if err != nil {
+		return err
+	}
+
+	if results.Code == 200 {
+		return nil
+	} else {
+		return fmt.Errorf("%s", results.ErrorString)
+	}
+
+}

iapi/notifications_test.go

@@ -0,0 +1,233 @@
+package iapi
+
+import (
+	"strings"
+	"testing"
+)
+
+func TestGetValidNotification(t *testing.T) {
+
+	name := "valid-notification"
+	_, err := Icinga2_Server.GetNotification(name)
+
+	if err != nil {
+		t.Error(err)
+	}
+}
+
+func TestGetInvalidNotification(t *testing.T) {
+
+	name := "invalid-notification"
+
+	_, err := Icinga2_Server.GetNotification(name)
+
+	if err != nil {
+		t.Error(err)
+	}
+}
+
+func TestCreateNotificationCommandDNE(t *testing.T) {
+
+	hostname := "host"
+	notificationname := hostname+"!"+hostname
+	command := "invalid-command"
+	servicename := ""
+	interval := 1800
+
+	_, err := Icinga2_Server.CreateNotification(notificationname, hostname, command, servicename, interval, nil, nil, nil)
+
+	if !strings.Contains(err.Error(), "type 'NotificationCommand' does not exist.") {
+		t.Error(err)
+	}
+}
+
+// func TestCreateNotificationHostDNE
+// Try and create a notification for a host that does not exist.
+// Should fail with an error about the host not existing.
+func TestCreateNotificationHostDNE(t *testing.T) {
+
+	hostname := "host-dne"
+	notificationname := hostname+"!"+hostname
+	command := "mail-host-notification"
+	servicename := ""
+	interval := 1800
+
+	_, err := Icinga2_Server.CreateNotification(notificationname, hostname, command, servicename, interval, nil, nil, nil)
+
+	if !strings.Contains(err.Error(), "type 'Host' does not exist.") {
+		t.Error(err)
+	}
+}
+
+func TestCreateNotificationInvalidName(t *testing.T) {
+
+	hostname := "host-dne"
+	notificationname := "invalid-name"
+	command := "mail-host-notification"
+	servicename := ""
+	interval := 1800
+
+	_, err := Icinga2_Server.CreateNotification(notificationname, hostname, command, servicename, interval, nil, nil, nil)
+
+	if !strings.Contains(err.Error(), "Invalid Notification name.") {
+		t.Error(err)
+	}
+}
+
+func TestCreateNotificationUserDNE(t *testing.T) {
+
+	hostname := "host"
+	group := []string{"linux-servers"}
+	notificationname := hostname+"!"+hostname
+	command := "mail-host-notification"
+	servicename := ""
+	interval := 1800
+	users := []string{"user-dne"}
+
+
+    _, _ = Icinga2_Server.CreateHost(hostname, "127.0.0.1", "hostalive", nil, nil, group)
+	_, err := Icinga2_Server.CreateNotification(notificationname, hostname, command, servicename, interval, users, nil, nil)
+
+	if !strings.Contains(err.Error(), "type 'User' does not exist.") {
+		t.Error(err)
+	}
+}
+
+func TestCreateHostNotification(t *testing.T) {
+
+	hostname := "host"
+	groups := []string{"linux-servers"}
+	notificationname := hostname+"!"+hostname
+	command := "mail-host-notification"
+	servicename := ""
+	interval := 1800
+	username := "user"
+
+    _, _ = Icinga2_Server.CreateHost(hostname, "127.0.0.1", "hostalive", nil, nil, groups)
+    _, _ = Icinga2_Server.CreateUser(username, "[email protected]")
+	_, err := Icinga2_Server.CreateNotification(notificationname, hostname, command, servicename, interval, []string{username}, nil, nil)
+
+	if err != nil {
+		t.Error(err)
+	}
+}
+
+func TestCreateHostNotificationAlreadyExists(t *testing.T) {
+
+	hostname := "host"
+	notificationname := hostname+"!"+hostname
+	command := "mail-host-notification"
+	servicename := ""
+	interval := 1800
+	username := "user"
+
+	_, err := Icinga2_Server.CreateNotification(notificationname, hostname, command, servicename, interval, []string{username}, nil, nil)
+
+	if !strings.HasSuffix(err.Error(), " already exists.") {
+		t.Error(err)
+	}
+}
+
+func TestCreateServiceNotification(t *testing.T) {
+
+	hostname := "host"
+	servicename := "test"
+	check_command := "random"
+	notificationname := hostname+"!"+servicename+"!"+hostname+"-"+servicename
+	command := "mail-service-notification"
+	interval := 1800
+	username := "user"
+
+    _, _ = Icinga2_Server.CreateUser(username, "[email protected]")
+    _, _ = Icinga2_Server.CreateService(servicename, hostname, check_command)
+	_, err := Icinga2_Server.CreateNotification(notificationname, hostname, command, servicename, interval, []string{username}, nil, nil)
+
+	if err != nil {
+		t.Error(err)
+	}
+}
+
+func TestCreateServiceNotificationAlreadyExists(t *testing.T) {
+
+	hostname := "host"
+	servicename := "test"
+	check_command := "random"
+	notificationname := hostname+"!"+servicename+"!"+hostname+"-"+servicename
+	command := "mail-service-notification"
+	interval := 1800
+	username := "user"
+
+    _, _ = Icinga2_Server.CreateUser(username, "[email protected]")
+    _, _ = Icinga2_Server.CreateService(servicename, hostname, check_command)
+	_, err := Icinga2_Server.CreateNotification(notificationname, hostname, command, servicename, interval, []string{username}, nil, nil)
+
+	if !strings.HasSuffix(err.Error(), " already exists.") {
+		t.Error(err)
+	}
+}
+
+func TestDeleteServiceNotification(t *testing.T) {
+
+	hostname := "host"
+	servicename := "test"
+	notificationname := hostname+"!"+servicename+"!"+hostname+"-"+servicename
+
+	err := Icinga2_Server.DeleteNotification(notificationname)
+
+	if err != nil {
+		t.Error(err)
+	}
+}
+
+func TestDeleteServiceNotificationDNE(t *testing.T) {
+
+	hostname := "host"
+	servicename := "test"
+	notificationname := hostname+"!"+servicename+"!"+hostname+"-"+servicename
+
+	err := Icinga2_Server.DeleteNotification(notificationname)
+
+	if err.Error() != "No objects found." {
+		t.Error(err)
+	}
+}
+
+func TestDeleteHostNotification(t *testing.T) {
+
+	hostname := "host"
+	notificationname := hostname+"!"+hostname
+	username := "user"
+
+	err := Icinga2_Server.DeleteNotification(notificationname)
+    _ = Icinga2_Server.DeleteHost(hostname)
+    _ = Icinga2_Server.DeleteUser(username)
+
+	if err != nil {
+		t.Error(err)
+	}
+}
+
+func TestDeleteHostNotificationDNE(t *testing.T) {
+
+	hostname := "host"
+	notificationname := hostname+"!"+hostname
+
+	err := Icinga2_Server.DeleteNotification(notificationname)
+
+	if err.Error() != "No objects found." {
+		t.Error(err)
+	}
+}
+
+// func TestDeleteNotificationNonAPI
+// Notifications that were not created via the API, cannot be deleted via the API
+// Should get an error about not being created via the API
+func TestDeleteNotificationNonAPI(t *testing.T) {
+
+	notificationname := "mail-icingaadmin"
+
+	err := Icinga2_Server.DeleteNotification(notificationname)
+	if err.Error() != "No objects found." {
+		t.Error(err)
+	}
+}

iapi/structs.go

@@ -125,3 +125,34 @@ type APIStatus struct {
 		} `json:"status"`
 	} `json:"results"`
 }
+
+// UserStruct is a struct used to store results from an Icinga2 User API Call. The content are also used to generate the JSON for the CreateUser call
+type UserStruct struct {
+	Name  string    `json:"name"`
+	Type  string    `json:"type"`
+	Attrs UserAttrs `json:"attrs"`
+	Meta  struct{}  `json:"meta"`
+	Joins struct{}  `json:"stuct"`
+}
+
+// UserAttrs This is struct lists the attributes that can be set during a CreateUser call. The contents of the struct is converted into JSON
+type UserAttrs struct {
+	Email string `json:"email"`
+}
+
+//NotificationStruct stores notification results
+type NotificationStruct struct {
+	Attrs NotificationAttrs `json:"attrs"`
+	Joins struct{}          `json:"joins"`
+	Name  string            `json:"name"`
+	Type  string            `json:"type"`
+}
+
+type NotificationAttrs struct {
+	Command     string      `json:"command"`
+	Users       []string    `json:"users"`
+	Servicename string      `json:"service_name"`
+	Interval    int         `json:"interval"`
+	Vars        interface{} `json:"vars"`
+	Templates   []string    `json:"templates"`
+}