Add test cases for object.RestoreMutedObjects()

Author: yhabteab

internal/incident/incidents_test.go

@@ -2,8 +2,6 @@ package incident
 
 import (
 	"context"
-	"crypto/rand"
-	"fmt"
 	"github.com/icinga/icinga-go-library/database"
 	"github.com/icinga/icinga-go-library/logging"
 	"github.com/icinga/icinga-go-library/types"
@@ -138,10 +136,10 @@ func makeIncident(ctx context.Context, db *database.DB, t *testing.T, recovered
 	ev := &event.Event{
 		Time:     time.Time{},
 		SourceId: 1,
-		Name:     makeRandomString(t),
+		Name:     testutils.MakeRandomString(t),
 		Tags: map[string]string{ // Always generate unique object tags not to produce same object ID!
-			"host":    makeRandomString(t),
-			"service": makeRandomString(t),
+			"host":    testutils.MakeRandomString(t),
+			"service": testutils.MakeRandomString(t),
 		},
 		ExtraTags: map[string]string{
 			"hostgroup/database-server": "",
@@ -167,11 +165,3 @@ func makeIncident(ctx context.Context, db *database.DB, t *testing.T, recovered
 
 	return i
 }
-
-func makeRandomString(t *testing.T) string {
-	buf := make([]byte, 20)
-	_, err := rand.Read(buf)
-	require.NoError(t, err, "failed to generate random string")
-
-	return fmt.Sprintf("%x", buf)
-}

internal/object/objects_test.go

@@ -0,0 +1,102 @@
+package object
+
+import (
+	"context"
+	"github.com/icinga/icinga-go-library/database"
+	"github.com/icinga/icinga-go-library/types"
+	"github.com/icinga/icinga-notifications/internal/event"
+	"github.com/icinga/icinga-notifications/internal/testutils"
+	"github.com/icinga/icinga-notifications/internal/utils"
+	"github.com/jmoiron/sqlx"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"testing"
+	"time"
+)
+
+func TestRestoreMutedObjects(t *testing.T) {
+	ctx := context.Background()
+	db := testutils.GetTestDB(ctx, t)
+
+	var sourceID int64
+	err := utils.RunInTx(ctx, db, func(tx *sqlx.Tx) error {
+		args := map[string]interface{}{
+			"type":     "notifications",
+			"name":     "Icinga Notifications",
+			"insecure": "n",
+		}
+		// We can't use config.Source here unfortunately due to cyclic import error!
+		id, err := utils.InsertAndFetchId(ctx, tx, `INSERT INTO source (type, name, icinga2_insecure_tls) VALUES (:type, :name, :insecure)`, args)
+		require.NoError(t, err, "populating source table should not fail")
+
+		sourceID = id
+		return nil
+	})
+	require.NoError(t, err, "utils.RunInTx() should not fail")
+
+	ClearCache()
+
+	// Just to make sure that there are no objects that have already been muted.
+	require.NoError(t, RestoreMutedObjects(ctx, db), "restoring muted objects shouldn't fail")
+	require.Len(t, cache, 0, "found mysterious muted objects")
+
+	testObjects := map[string]*Object{}
+	for i := 0; i < 20; i++ {
+		o := makeObject(ctx, db, t, sourceID, true)
+		testObjects[o.ID.String()] = o
+		if i%2 == 0 { // Insert also some unmuted objects
+			makeObject(ctx, db, t, sourceID, false)
+		}
+	}
+	ClearCache()
+
+	require.NoError(t, RestoreMutedObjects(ctx, db), "restoring muted objects shouldn't fail")
+	assert.Len(t, cache, len(testObjects), "all muted objects should be restored")
+
+	for _, o := range testObjects {
+		objFromCache := GetFromCache(o.ID)
+		assert.NotNilf(t, objFromCache, "muted object %q was not restored correctly", o.DisplayName())
+
+		if objFromCache != nil {
+			assert.True(t, objFromCache.IsMuted(), "object should be muted")
+			assert.Equal(t, o.Name, objFromCache.Name, "objects name should match")
+			assert.Equal(t, o.URL, objFromCache.URL, "objects url should match")
+
+			assert.Equal(t, o.Tags, objFromCache.Tags, "objects tags should match")
+			assert.Equal(t, o.ExtraTags, objFromCache.ExtraTags, "objects tags should match")
+		}
+
+		// Purge all newly created objects and its relations not mes up local database tests.
+		_, err = db.NamedExecContext(ctx, `DELETE FROM object_id_tag WHERE object_id = :id`, o)
+		assert.NoError(t, err, "deleting object id tags should not fail")
+
+		_, err = db.NamedExecContext(ctx, `DELETE FROM object_extra_tag WHERE object_id = :id`, o)
+		assert.NoError(t, err, "deleting object extra tags should not fail")
+
+		_, err = db.NamedExecContext(ctx, `DELETE FROM object WHERE id = :id`, o)
+		assert.NoError(t, err, "deleting object should not fail")
+	}
+}
+
+func makeObject(ctx context.Context, db *database.DB, t *testing.T, sourceID int64, mute bool) *Object {
+	ev := &event.Event{
+		Time:       time.Time{},
+		SourceId:   sourceID,
+		Name:       testutils.MakeRandomString(t),
+		Mute:       types.Bool{Valid: true, Bool: mute},
+		MuteReason: "Just for testing",
+		Tags: map[string]string{ // Always generate unique object tags not to produce same object ID!
+			"host":    testutils.MakeRandomString(t),
+			"service": testutils.MakeRandomString(t),
+		},
+		ExtraTags: map[string]string{
+			"hostgroup/database-server": "",
+			"servicegroup/webserver":    "",
+		},
+	}
+
+	o, err := FromEvent(ctx, db, ev)
+	require.NoError(t, err)
+
+	return o
+}

internal/testutils/testutils.go

@@ -2,6 +2,8 @@ package testutils
 
 import (
 	"context"
+	"crypto/rand"
+	"fmt"
 	"github.com/creasty/defaults"
 	"github.com/icinga/icinga-go-library/database"
 	"github.com/icinga/icinga-go-library/logging"
@@ -55,3 +57,12 @@ func GetTestDB(ctx context.Context, t *testing.T) *database.DB {
 
 	return db
 }
+
+// MakeRandomString returns a 20 byte random hex string.
+func MakeRandomString(t *testing.T) string {
+	buf := make([]byte, 20)
+	_, err := rand.Read(buf)
+	require.NoError(t, err, "failed to generate random string")
+
+	return fmt.Sprintf("%x", buf)
+}