storj/storagenode/reputation/reputation_test.go

// Copyright (C) 2019 Storj Labs, Inc.
// See LICENSE for copying information.

package reputation_test

import (
	"testing"
	"time"

	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"

	"storj.io/common/pb"
	"storj.io/common/testcontext"
	"storj.io/common/testrand"
	"storj.io/storj/storagenode"
	"storj.io/storj/storagenode/reputation"
	"storj.io/storj/storagenode/storagenodedb/storagenodedbtest"
)

func TestReputationDBGetInsert(t *testing.T) {
	storagenodedbtest.Run(t, func(ctx *testcontext.Context, t *testing.T, db storagenode.DB) {
		timestamp := time.Now()
		reputationDB := db.Reputation()

		stats := reputation.Stats{
			SatelliteID: testrand.NodeID(),
			Uptime: reputation.Metric{
				TotalCount:   1,
				SuccessCount: 2,
				Alpha:        3,
				Beta:         4,
				Score:        5,
			},
			Audit: reputation.Metric{
				TotalCount:   6,
				SuccessCount: 7,
				Alpha:        8,
				Beta:         9,
				Score:        10,
				UnknownAlpha: 11,
				UnknownBeta:  12,
				UnknownScore: 13,
			},
			OnlineScore:          14,
			OfflineUnderReviewAt: &timestamp,
			OfflineSuspendedAt:   &timestamp,
			DisqualifiedAt:       &timestamp,
			SuspendedAt:          &timestamp,
			UpdatedAt:            timestamp,
			JoinedAt:             timestamp,
		}

		t.Run("insert", func(t *testing.T) {
			err := reputationDB.Store(ctx, stats)
			assert.NoError(t, err)
		})

		t.Run("get", func(t *testing.T) {
			res, err := reputationDB.Get(ctx, stats.SatelliteID)
			assert.NoError(t, err)

			assert.Equal(t, res.SatelliteID, stats.SatelliteID)
			assert.True(t, res.DisqualifiedAt.Equal(*stats.DisqualifiedAt))
			assert.True(t, res.SuspendedAt.Equal(*stats.SuspendedAt))
			assert.True(t, res.UpdatedAt.Equal(stats.UpdatedAt))
			assert.True(t, res.JoinedAt.Equal(stats.JoinedAt))
			assert.True(t, res.OfflineSuspendedAt.Equal(*stats.OfflineSuspendedAt))
			assert.True(t, res.OfflineUnderReviewAt.Equal(*stats.OfflineUnderReviewAt))
			assert.Equal(t, res.OnlineScore, stats.OnlineScore)
			assert.Nil(t, res.AuditHistory)

			compareReputationMetric(t, &res.Uptime, &stats.Uptime)
			compareReputationMetric(t, &res.Audit, &stats.Audit)
		})
	})
}

func TestReputationDBGetAll(t *testing.T) {
	storagenodedbtest.Run(t, func(ctx *testcontext.Context, t *testing.T, db storagenode.DB) {
		reputationDB := db.Reputation()

		var stats []reputation.Stats
		for i := 0; i < 10; i++ {
			// we use UTC here to make struct equality testing easier
			timestamp := time.Now().UTC().Add(time.Hour * time.Duration(i))

			rep := reputation.Stats{
				SatelliteID: testrand.NodeID(),
				Uptime: reputation.Metric{
					TotalCount:   int64(i + 1),
					SuccessCount: int64(i + 2),
					Alpha:        float64(i + 3),
					Beta:         float64(i + 4),
					Score:        float64(i + 5),
				},
				Audit: reputation.Metric{
					TotalCount:   int64(i + 6),
					SuccessCount: int64(i + 7),
					Alpha:        float64(i + 8),
					Beta:         float64(i + 9),
					Score:        float64(i + 10),
					UnknownAlpha: float64(i + 11),
					UnknownBeta:  float64(i + 12),
					UnknownScore: float64(i + 13),
				},
				OnlineScore:          float64(i + 14),
				OfflineUnderReviewAt: &timestamp,
				OfflineSuspendedAt:   &timestamp,
				DisqualifiedAt:       &timestamp,
				SuspendedAt:          &timestamp,
				UpdatedAt:            timestamp,
				JoinedAt:             timestamp,
			}

			err := reputationDB.Store(ctx, rep)
			require.NoError(t, err)

			stats = append(stats, rep)
		}

		res, err := reputationDB.All(ctx)
		assert.NoError(t, err)
		assert.NotNil(t, res)
		assert.Equal(t, len(stats), len(res))

		for _, rep := range res {
			assert.Contains(t, stats, rep)

			if rep.SatelliteID == stats[0].SatelliteID {
				assert.Equal(t, rep.DisqualifiedAt, stats[0].DisqualifiedAt)
				assert.Equal(t, rep.SuspendedAt, stats[0].SuspendedAt)
				assert.Equal(t, rep.UpdatedAt, stats[0].UpdatedAt)
				assert.Equal(t, rep.JoinedAt, stats[0].JoinedAt)
				assert.Equal(t, rep.OfflineSuspendedAt, stats[0].OfflineSuspendedAt)
				assert.Equal(t, rep.OfflineUnderReviewAt, stats[0].OfflineUnderReviewAt)
				assert.Equal(t, rep.OnlineScore, stats[0].OnlineScore)
				assert.Nil(t, rep.AuditHistory)

				compareReputationMetric(t, &rep.Uptime, &stats[0].Uptime)
				compareReputationMetric(t, &rep.Audit, &stats[0].Audit)
			}
		}
	})
}

// compareReputationMetric compares two reputation metrics and asserts that they are equal.
func compareReputationMetric(t *testing.T, a, b *reputation.Metric) {
	assert.Equal(t, a.SuccessCount, b.SuccessCount)
	assert.Equal(t, a.TotalCount, b.TotalCount)
	assert.Equal(t, a.Alpha, b.Alpha)
	assert.Equal(t, a.Beta, b.Beta)
	assert.Equal(t, a.Score, b.Score)
}

func TestReputationDBGetInsertAuditHistory(t *testing.T) {
	storagenodedbtest.Run(t, func(ctx *testcontext.Context, t *testing.T, db storagenode.DB) {
		timestamp := time.Now()
		reputationDB := db.Reputation()

		stats := reputation.Stats{
			SatelliteID: testrand.NodeID(),
			Uptime:      reputation.Metric{},
			Audit:       reputation.Metric{},
			AuditHistory: &pb.AuditHistory{
				Score: 0.5,
				Windows: []*pb.AuditWindow{
					{
						WindowStart: timestamp,
						OnlineCount: 5,
						TotalCount:  10,
					},
				},
			},
		}

		t.Run("insert", func(t *testing.T) {
			err := reputationDB.Store(ctx, stats)
			assert.NoError(t, err)
		})

		t.Run("get", func(t *testing.T) {
			res, err := reputationDB.Get(ctx, stats.SatelliteID)
			assert.NoError(t, err)

			assert.Equal(t, res.AuditHistory.Score, stats.AuditHistory.Score)
			assert.Equal(t, len(res.AuditHistory.Windows), len(stats.AuditHistory.Windows))
			resWindow := res.AuditHistory.Windows[0]
			statsWindow := stats.AuditHistory.Windows[0]
			assert.True(t, resWindow.WindowStart.Equal(statsWindow.WindowStart))
			assert.Equal(t, resWindow.TotalCount, statsWindow.TotalCount)
			assert.Equal(t, resWindow.OnlineCount, statsWindow.OnlineCount)
		})
	})
}