Initial Icinga Notifications Support

.github/workflows/go.yml

@@ -10,29 +10,29 @@ jobs:
   fmt:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-go@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
         with:
-          go-version: '^1.16'
+          go-version: stable
       - name: go fmt
         run: test -z "$(gofmt -d . | tee /dev/stderr)"
 
   vet:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-go@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
         with:
-          go-version: '^1.16'
+          go-version: stable
       - name: go vet
         run: go vet ./...
 
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-go@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
         with:
-          go-version: '^1.16'
+          go-version: stable
       - name: go test
         run: go test ./...

go.mod

@@ -4,24 +4,33 @@ go 1.16
 
 require (
 	github.com/Icinga/go-libs v0.0.0-20220420130327-ef58ad52edd8
-	github.com/Microsoft/go-winio v0.5.0 // indirect
-	github.com/cespare/xxhash/v2 v2.1.2 // indirect
-	github.com/containerd/containerd v1.5.5 // indirect
-	github.com/docker/docker v20.10.8+incompatible
+	github.com/Microsoft/go-winio v0.6.1 // indirect
+	github.com/cespare/xxhash/v2 v2.2.0 // indirect
+	github.com/distribution/reference v0.5.0 // indirect
+	github.com/docker/distribution v2.8.3+incompatible // indirect
+	github.com/docker/docker v24.0.7+incompatible
 	github.com/docker/go-connections v0.4.0 // indirect
-	github.com/go-redis/redis/v8 v8.11.3
-	github.com/go-sql-driver/mysql v1.6.0
-	github.com/gorilla/mux v1.8.0 // indirect
-	github.com/lib/pq v1.10.4
-	github.com/moby/term v0.0.0-20201216013528-df9cb8a40635 // indirect
+	github.com/docker/go-units v0.5.0 // indirect
+	github.com/fsnotify/fsnotify v1.6.0 // indirect
+	github.com/go-redis/redis/v8 v8.11.5
+	github.com/go-sql-driver/mysql v1.7.1
+	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/google/go-cmp v0.6.0 // indirect
+	github.com/kr/pretty v0.3.1 // indirect
+	github.com/lib/pq v1.10.9
+	github.com/mattn/go-sqlite3 v1.14.15 // indirect
+	github.com/moby/term v0.0.0-20220808134915-39b0c02b01ae // indirect
 	github.com/morikuni/aec v1.0.0 // indirect
-	github.com/stretchr/testify v1.7.0
-	go.uber.org/atomic v1.9.0 // indirect
-	go.uber.org/multierr v1.7.0 // indirect
-	go.uber.org/zap v1.19.0
-	golang.org/x/net v0.0.0-20210813160813-60bc85c4be6d // indirect
-	golang.org/x/sync v0.0.0-20210220032951-036812b2e83c
-	golang.org/x/sys v0.0.0-20210823070655-63515b42dcdf // indirect
-	golang.org/x/time v0.0.0-20210220033141-f8bda1e9f3ba // indirect
-	google.golang.org/genproto v0.0.0-20210824181836-a4879c3d0e89 // indirect
+	github.com/onsi/gomega v1.24.2 // indirect
+	github.com/opencontainers/image-spec v1.1.0-rc5 // indirect
+	github.com/rogpeppe/go-internal v1.10.0 // indirect
+	github.com/stretchr/testify v1.8.4
+	go.uber.org/goleak v1.2.1 // indirect
+	go.uber.org/multierr v1.11.0 // indirect
+	go.uber.org/zap v1.26.0
+	golang.org/x/sync v0.5.0
+	golang.org/x/time v0.3.0 // indirect
+	golang.org/x/tools v0.16.1 // indirect
+	gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect
+	gotest.tools/v3 v3.5.0 // indirect
 )

internal/services/icinga2/docker.go

@@ -127,7 +127,7 @@ func (i *dockerCreator) CreateIcinga2(name string) services.Icinga2Base {
 func (i *dockerCreator) Cleanup() {
 	i.runningMutex.Lock()
 	nodes := make([]*dockerInstance, 0, len(i.running))
-	for n, _ := range i.running {
+	for n := range i.running {
 		nodes = append(nodes, n)
 	}
 	i.runningMutex.Unlock()
@@ -189,6 +189,10 @@ func (n *dockerInstance) EnableIcingaDb(redis services.RedisServerBase) {
 	services.Icinga2{Icinga2Base: n}.WriteIcingaDbConf(redis)
 }
 
+func (n *dockerInstance) EnableIcingaNotifications(notis services.IcingaNotificationsBase) {
+	services.Icinga2{Icinga2Base: n}.WriteIcingaNotificationsConf(notis)
+}
+
 func (n *dockerInstance) Cleanup() {
 	n.icinga2Docker.runningMutex.Lock()
 	delete(n.icinga2Docker.running, n)

internal/services/icingadb/docker_binary.go

@@ -11,7 +11,6 @@ import (
 	"github.com/icinga/icinga-testing/services"
 	"github.com/icinga/icinga-testing/utils"
 	"go.uber.org/zap"
-	"io/ioutil"
 	"os"
 	"path/filepath"
 	"sync"
@@ -67,7 +66,7 @@ func (i *dockerBinaryCreator) CreateIcingaDb(
 		icingaDbDockerBinary: i,
 	}
 
-	configFile, err := ioutil.TempFile("", "icingadb.yml")
+	configFile, err := os.CreateTemp("", "icingadb.yml")
 	if err != nil {
 		panic(err)
 	}
@@ -152,7 +151,7 @@ func (i *dockerBinaryCreator) CreateIcingaDb(
 func (i *dockerBinaryCreator) Cleanup() {
 	i.runningMutex.Lock()
 	instances := make([]*dockerBinaryInstance, 0, len(i.running))
-	for inst, _ := range i.running {
+	for inst := range i.running {
 		instances = append(instances, inst)
 	}
 	i.runningMutex.Unlock()

internal/services/notifications/docker.go

@@ -0,0 +1,190 @@
+package notifications
+
+import (
+	"context"
+	"fmt"
+	"github.com/docker/docker/api/types"
+	"github.com/docker/docker/api/types/container"
+	"github.com/docker/docker/api/types/mount"
+	"github.com/docker/docker/api/types/network"
+	"github.com/docker/docker/client"
+	"github.com/icinga/icinga-testing/services"
+	"github.com/icinga/icinga-testing/utils"
+	"go.uber.org/zap"
+	"os"
+	"sync"
+	"sync/atomic"
+)
+
+type dockerCreator struct {
+	logger              *zap.Logger
+	dockerClient        *client.Client
+	dockerNetworkId     string
+	containerNamePrefix string
+	sharedDirPath       string
+	containerCounter    uint32
+
+	runningMutex sync.Mutex
+	running      map[*dockerBinaryInstance]struct{}
+}
+
+var _ Creator = (*dockerCreator)(nil)
+
+func NewDockerCreator(
+	logger *zap.Logger,
+	dockerClient *client.Client,
+	containerNamePrefix string,
+	dockerNetworkId string,
+	sharedDirPath string,
+) Creator {
+	return &dockerCreator{
+		logger:              logger.With(zap.Bool("icinga_notifications", true)),
+		dockerClient:        dockerClient,
+		dockerNetworkId:     dockerNetworkId,
+		containerNamePrefix: containerNamePrefix,
+		sharedDirPath:       sharedDirPath,
+		running:             make(map[*dockerBinaryInstance]struct{}),
+	}
+}
+
+func (i *dockerCreator) CreateIcingaNotifications(
+	rdb services.RelationalDatabase,
+	options ...services.IcingaNotificationsOption,
+) services.IcingaNotificationsBase {
+	inst := &dockerBinaryInstance{
+		info: info{
+			rdb:  rdb,
+			port: defaultPort,
+		},
+		logger:                          i.logger,
+		icingaNotificationsDockerBinary: i,
+	}
+
+	configFile, err := os.CreateTemp("", "icinga_notifications.yml")
+	if err != nil {
+		panic(err)
+	}
+	err = configFile.Chmod(0666) // defaults to 0600, might result in being unreadable from container UID 1000
+	if err != nil {
+		panic(err)
+	}
+	idb := &services.IcingaNotifications{IcingaNotificationsBase: inst}
+	for _, option := range options {
+		option(idb)
+	}
+	if err = idb.WriteConfig(configFile); err != nil {
+		panic(err)
+	}
+	inst.configFileName = configFile.Name()
+	err = configFile.Close()
+	if err != nil {
+		panic(err)
+	}
+
+	containerName := fmt.Sprintf("%s-%d", i.containerNamePrefix, atomic.AddUint32(&i.containerCounter, 1))
+	inst.logger = inst.logger.With(zap.String("container-name", containerName))
+	networkName, err := utils.DockerNetworkName(context.Background(), i.dockerClient, i.dockerNetworkId)
+	if err != nil {
+		panic(err)
+	}
+
+	dockerImage := utils.GetEnvDefault("ICINGA_TESTING_NOTIFICATIONS_IMAGE", "icinga-notifications:latest")
+	err = utils.DockerImagePull(context.Background(), inst.logger, i.dockerClient, dockerImage, false)
+	if err != nil {
+		panic(err)
+	}
+
+	cont, err := i.dockerClient.ContainerCreate(context.Background(), &container.Config{
+		Image: dockerImage,
+	}, &container.HostConfig{
+		Mounts: []mount.Mount{{
+			Type:     mount.TypeBind,
+			Source:   inst.configFileName,
+			Target:   "/etc/icinga-notifications/config.yml",
+			ReadOnly: true,
+		}, {
+			Type:     mount.TypeBind,
+			Source:   i.sharedDirPath,
+			Target:   "/shared",
+			ReadOnly: true,
+		}},
+	}, &network.NetworkingConfig{
+		EndpointsConfig: map[string]*network.EndpointSettings{
+			networkName: {
+				NetworkID: i.dockerNetworkId,
+			},
+		},
+	}, nil, containerName)
+	if err != nil {
+		inst.logger.Fatal("failed to create icinga-notifications container", zap.Error(err))
+	}
+	inst.containerId = cont.ID
+	inst.logger = inst.logger.With(zap.String("container-id", cont.ID))
+	inst.logger.Debug("created container")
+
+	err = utils.ForwardDockerContainerOutput(context.Background(), i.dockerClient, cont.ID,
+		false, utils.NewLineWriter(func(line []byte) {
+			inst.logger.Debug("container output",
+				zap.ByteString("line", line))
+		}))
+	if err != nil {
+		inst.logger.Fatal("failed to attach to container output", zap.Error(err))
+	}
+
+	err = i.dockerClient.ContainerStart(context.Background(), cont.ID, types.ContainerStartOptions{})
+	if err != nil {
+		inst.logger.Fatal("failed to start container", zap.Error(err))
+	}
+	inst.logger.Debug("started container")
+
+	inst.info.host = utils.MustString(utils.DockerContainerAddress(context.Background(), i.dockerClient, cont.ID))
+
+	i.runningMutex.Lock()
+	i.running[inst] = struct{}{}
+	i.runningMutex.Unlock()
+
+	return inst
+}
+
+func (i *dockerCreator) Cleanup() {
+	i.runningMutex.Lock()
+	instances := make([]*dockerBinaryInstance, 0, len(i.running))
+	for inst := range i.running {
+		instances = append(instances, inst)
+	}
+	i.runningMutex.Unlock()
+
+	for _, inst := range instances {
+		inst.Cleanup()
+	}
+}
+
+type dockerBinaryInstance struct {
+	info
+	icingaNotificationsDockerBinary *dockerCreator
+	logger                          *zap.Logger
+	containerId                     string
+	configFileName                  string
+}
+
+var _ services.IcingaNotificationsBase = (*dockerBinaryInstance)(nil)
+
+func (i *dockerBinaryInstance) Cleanup() {
+	i.icingaNotificationsDockerBinary.runningMutex.Lock()
+	delete(i.icingaNotificationsDockerBinary.running, i)
+	i.icingaNotificationsDockerBinary.runningMutex.Unlock()
+
+	err := i.icingaNotificationsDockerBinary.dockerClient.ContainerRemove(context.Background(), i.containerId, types.ContainerRemoveOptions{
+		Force:         true,
+		RemoveVolumes: true,
+	})
+	if err != nil {
+		panic(err)
+	}
+	i.logger.Debug("removed container")
+
+	err = os.Remove(i.configFileName)
+	if err != nil {
+		panic(err)
+	}
+}

internal/services/notifications/notifications.go

@@ -0,0 +1,33 @@
+package notifications
+
+import (
+	"github.com/icinga/icinga-testing/services"
+)
+
+// defaultPort of the Icinga Notifications Web Listener.
+const defaultPort string = "5680"
+
+type Creator interface {
+	CreateIcingaNotifications(rdb services.RelationalDatabase, options ...services.IcingaNotificationsOption) services.IcingaNotificationsBase
+	Cleanup()
+}
+
+// info provides a partial implementation of the services.IcingaNotificationsBase interface.
+type info struct {
+	host string
+	port string
+
+	rdb services.RelationalDatabase
+}
+
+func (i *info) Host() string {
+	return i.host
+}
+
+func (i *info) Port() string {
+	return i.port
+}
+
+func (i *info) RelationalDatabase() services.RelationalDatabase {
+	return i.rdb
+}

internal/services/redis/docker.go

@@ -138,7 +138,7 @@ func (r *dockerCreator) CreateRedisServer() services.RedisServerBase {
 func (r *dockerCreator) Cleanup() {
 	r.runningMutex.Lock()
 	servers := make([]*dockerServer, 0, len(r.running))
-	for s, _ := range r.running {
+	for s := range r.running {
 		servers = append(servers, s)
 	}
 	r.runningMutex.Unlock()