mirror of
https://github.com/luxfi/node.git
synced 2026-10-30 15:24:05 +00:00
zeekay
7cf87b230b
The module already called itself github.com/luxfi/node while containing no node in Go: cmd/luxd was twenty-one lines that printed the size of a few types, and the Go column of the matrix measured a VM plugin. A repo that fetches the thing it claims to be has not replaced it, so the Go sources move in — 1515 files, the daemon and everything under it — and the build reaches outside this module for nothing. Rust and C++ sit beside it unchanged and are still measured against it by the differential. That is the point of one repo: the reference implementation and the two ports are the same checkout, so parity is a thing you can run rather than a thing you assert. Verified: builds, and the closure carries no lux-private — checked at build time rather than believed. The daemon starts twelve chains on a local network (P X C Q Z A B G K M F, plus D through its plugin) and reports healthy.
393 lines
10 KiB
Go
393 lines
10 KiB
Go
// Copyright (C) 2019-2025, Lux Industries Inc. All rights reserved.
|
|
// See the file LICENSE for licensing terms.
|
|
|
|
package health
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"sync"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/luxfi/atomic"
|
|
"github.com/luxfi/log"
|
|
"github.com/luxfi/metric"
|
|
)
|
|
|
|
const (
|
|
checkFreq = time.Millisecond
|
|
awaitFreq = 50 * time.Microsecond
|
|
awaitTimeout = 30 * time.Second
|
|
)
|
|
|
|
var errUnhealthy = errors.New("unhealthy")
|
|
|
|
func awaitReadiness(t *testing.T, r Reporter, ready bool) {
|
|
require.Eventually(t, func() bool {
|
|
_, ok := r.Readiness()
|
|
return ok == ready
|
|
}, awaitTimeout, awaitFreq)
|
|
}
|
|
|
|
func awaitHealthy(t *testing.T, r Reporter, healthy bool) {
|
|
require.Eventually(t, func() bool {
|
|
_, ok := r.Health()
|
|
return ok == healthy
|
|
}, awaitTimeout, awaitFreq)
|
|
}
|
|
|
|
func awaitLiveness(t *testing.T, r Reporter, liveness bool) {
|
|
require.Eventually(t, func() bool {
|
|
_, ok := r.Liveness()
|
|
return ok == liveness
|
|
}, awaitTimeout, awaitFreq)
|
|
}
|
|
|
|
func TestDuplicatedRegistrations(t *testing.T) {
|
|
require := require.New(t)
|
|
|
|
check := CheckerFunc(func(context.Context) (interface{}, error) {
|
|
return "", nil
|
|
})
|
|
|
|
h, err := New(log.NewNoOpLogger(), metric.NewRegistry())
|
|
require.NoError(err)
|
|
|
|
require.NoError(h.RegisterReadinessCheck("check", check))
|
|
err = h.RegisterReadinessCheck("check", check)
|
|
require.ErrorIs(err, errDuplicateCheck)
|
|
|
|
require.NoError(h.RegisterHealthCheck("check", check))
|
|
err = h.RegisterHealthCheck("check", check)
|
|
require.ErrorIs(err, errDuplicateCheck)
|
|
|
|
require.NoError(h.RegisterLivenessCheck("check", check))
|
|
err = h.RegisterLivenessCheck("check", check)
|
|
require.ErrorIs(err, errDuplicateCheck)
|
|
}
|
|
|
|
func TestDefaultFailing(t *testing.T) {
|
|
require := require.New(t)
|
|
|
|
check := CheckerFunc(func(context.Context) (interface{}, error) {
|
|
return "", nil
|
|
})
|
|
|
|
h, err := New(log.NewNoOpLogger(), metric.NewRegistry())
|
|
require.NoError(err)
|
|
|
|
{
|
|
require.NoError(h.RegisterReadinessCheck("check", check))
|
|
|
|
readinessResult, readiness := h.Readiness()
|
|
require.Len(readinessResult, 1)
|
|
require.Contains(readinessResult, "check")
|
|
require.Equal(notYetRunResult, readinessResult["check"])
|
|
require.False(readiness)
|
|
}
|
|
|
|
{
|
|
require.NoError(h.RegisterHealthCheck("check", check))
|
|
|
|
healthResult, health := h.Health()
|
|
require.Len(healthResult, 1)
|
|
require.Contains(healthResult, "check")
|
|
require.Equal(notYetRunResult, healthResult["check"])
|
|
require.False(health)
|
|
}
|
|
|
|
{
|
|
require.NoError(h.RegisterLivenessCheck("check", check))
|
|
|
|
livenessResult, liveness := h.Liveness()
|
|
require.Len(livenessResult, 1)
|
|
require.Contains(livenessResult, "check")
|
|
require.Equal(notYetRunResult, livenessResult["check"])
|
|
require.False(liveness)
|
|
}
|
|
}
|
|
|
|
func TestPassingChecks(t *testing.T) {
|
|
require := require.New(t)
|
|
|
|
check := CheckerFunc(func(context.Context) (interface{}, error) {
|
|
return "", nil
|
|
})
|
|
|
|
h, err := New(log.NewNoOpLogger(), metric.NewRegistry())
|
|
require.NoError(err)
|
|
|
|
require.NoError(h.RegisterReadinessCheck("check", check))
|
|
require.NoError(h.RegisterHealthCheck("check", check))
|
|
require.NoError(h.RegisterLivenessCheck("check", check))
|
|
|
|
h.Start(context.Background(), checkFreq)
|
|
defer h.Stop()
|
|
|
|
{
|
|
awaitReadiness(t, h, true)
|
|
|
|
readinessResult, readiness := h.Readiness()
|
|
require.Len(readinessResult, 1)
|
|
require.Contains(readinessResult, "check")
|
|
|
|
result := readinessResult["check"]
|
|
require.JSONEq(`""`, string(result.Details), "the check answered with an empty string and the reply carries exactly that")
|
|
require.Nil(result.Error)
|
|
require.Zero(result.ContiguousFailures)
|
|
require.True(readiness)
|
|
}
|
|
|
|
{
|
|
awaitHealthy(t, h, true)
|
|
|
|
healthResult, health := h.Health()
|
|
require.Len(healthResult, 1)
|
|
require.Contains(healthResult, "check")
|
|
|
|
result := healthResult["check"]
|
|
require.JSONEq(`""`, string(result.Details), "the check answered with an empty string and the reply carries exactly that")
|
|
require.Nil(result.Error)
|
|
require.Zero(result.ContiguousFailures)
|
|
require.True(health)
|
|
}
|
|
|
|
{
|
|
awaitLiveness(t, h, true)
|
|
|
|
livenessResult, liveness := h.Liveness()
|
|
require.Len(livenessResult, 1)
|
|
require.Contains(livenessResult, "check")
|
|
|
|
result := livenessResult["check"]
|
|
require.JSONEq(`""`, string(result.Details), "the check answered with an empty string and the reply carries exactly that")
|
|
require.Nil(result.Error)
|
|
require.Zero(result.ContiguousFailures)
|
|
require.True(liveness)
|
|
}
|
|
}
|
|
|
|
func TestPassingThenFailingChecks(t *testing.T) {
|
|
require := require.New(t)
|
|
|
|
var shouldCheckErr atomic.Atomic[bool]
|
|
check := CheckerFunc(func(context.Context) (interface{}, error) {
|
|
if shouldCheckErr.Get() {
|
|
return errUnhealthy.Error(), errUnhealthy
|
|
}
|
|
return "", nil
|
|
})
|
|
|
|
h, err := New(log.NewNoOpLogger(), metric.NewRegistry())
|
|
require.NoError(err)
|
|
|
|
require.NoError(h.RegisterReadinessCheck("check", check))
|
|
require.NoError(h.RegisterHealthCheck("check", check))
|
|
require.NoError(h.RegisterLivenessCheck("check", check))
|
|
|
|
h.Start(context.Background(), checkFreq)
|
|
defer h.Stop()
|
|
|
|
awaitReadiness(t, h, true)
|
|
awaitHealthy(t, h, true)
|
|
awaitLiveness(t, h, true)
|
|
|
|
{
|
|
_, readiness := h.Readiness()
|
|
require.True(readiness)
|
|
|
|
_, health := h.Health()
|
|
require.True(health)
|
|
|
|
_, liveness := h.Liveness()
|
|
require.True(liveness)
|
|
}
|
|
|
|
shouldCheckErr.Set(true)
|
|
|
|
awaitHealthy(t, h, false)
|
|
awaitLiveness(t, h, false)
|
|
|
|
{
|
|
// Notice that Readiness is a monotonic check - so it still reports
|
|
// ready.
|
|
_, readiness := h.Readiness()
|
|
require.True(readiness)
|
|
|
|
_, health := h.Health()
|
|
require.False(health)
|
|
|
|
_, liveness := h.Liveness()
|
|
require.False(liveness)
|
|
}
|
|
}
|
|
|
|
func TestDeadlockRegression(t *testing.T) {
|
|
require := require.New(t)
|
|
|
|
h, err := New(log.NewNoOpLogger(), metric.NewRegistry())
|
|
require.NoError(err)
|
|
|
|
var lock sync.Mutex
|
|
check := CheckerFunc(func(context.Context) (interface{}, error) {
|
|
lock.Lock()
|
|
time.Sleep(time.Nanosecond)
|
|
lock.Unlock()
|
|
return "", nil
|
|
})
|
|
|
|
h.Start(context.Background(), time.Nanosecond)
|
|
defer h.Stop()
|
|
|
|
for i := 0; i < 100; i++ {
|
|
lock.Lock()
|
|
require.NoError(h.RegisterHealthCheck(fmt.Sprintf("check-%d", i), check))
|
|
lock.Unlock()
|
|
}
|
|
|
|
awaitHealthy(t, h, true)
|
|
}
|
|
|
|
func TestTags(t *testing.T) {
|
|
require := require.New(t)
|
|
|
|
check := CheckerFunc(func(context.Context) (interface{}, error) {
|
|
return "", nil
|
|
})
|
|
|
|
h, err := New(log.NewNoOpLogger(), metric.NewRegistry())
|
|
require.NoError(err)
|
|
require.NoError(h.RegisterHealthCheck("check1", check))
|
|
require.NoError(h.RegisterHealthCheck("check2", check, "tag1"))
|
|
require.NoError(h.RegisterHealthCheck("check3", check, "tag2"))
|
|
require.NoError(h.RegisterHealthCheck("check4", check, "tag1", "tag2"))
|
|
require.NoError(h.RegisterHealthCheck("check5", check, ApplicationTag))
|
|
|
|
// default checks
|
|
{
|
|
healthResult, health := h.Health()
|
|
require.Len(healthResult, 5)
|
|
require.Contains(healthResult, "check1")
|
|
require.Contains(healthResult, "check2")
|
|
require.Contains(healthResult, "check3")
|
|
require.Contains(healthResult, "check4")
|
|
require.Contains(healthResult, "check5")
|
|
require.False(health)
|
|
|
|
healthResult, health = h.Health("tag1")
|
|
require.Len(healthResult, 3)
|
|
require.Contains(healthResult, "check2")
|
|
require.Contains(healthResult, "check4")
|
|
require.Contains(healthResult, "check5")
|
|
require.False(health)
|
|
|
|
healthResult, health = h.Health("tag1", "tag2")
|
|
require.Len(healthResult, 4)
|
|
require.Contains(healthResult, "check2")
|
|
require.Contains(healthResult, "check3")
|
|
require.Contains(healthResult, "check4")
|
|
require.Contains(healthResult, "check5")
|
|
require.False(health)
|
|
|
|
healthResult, health = h.Health("nonExistentTag")
|
|
require.Len(healthResult, 1)
|
|
require.Contains(healthResult, "check5")
|
|
require.False(health)
|
|
|
|
healthResult, health = h.Health("tag1", "tag2", "nonExistentTag")
|
|
require.Len(healthResult, 4)
|
|
require.Contains(healthResult, "check2")
|
|
require.Contains(healthResult, "check3")
|
|
require.Contains(healthResult, "check4")
|
|
require.Contains(healthResult, "check5")
|
|
require.False(health)
|
|
}
|
|
|
|
h.Start(context.Background(), checkFreq)
|
|
|
|
awaitHealthy(t, h, true)
|
|
|
|
{
|
|
healthResult, health := h.Health()
|
|
require.Len(healthResult, 5)
|
|
require.Contains(healthResult, "check1")
|
|
require.Contains(healthResult, "check2")
|
|
require.Contains(healthResult, "check3")
|
|
require.Contains(healthResult, "check4")
|
|
require.Contains(healthResult, "check5")
|
|
require.True(health)
|
|
|
|
healthResult, health = h.Health("tag1")
|
|
require.Len(healthResult, 3)
|
|
require.Contains(healthResult, "check2")
|
|
require.Contains(healthResult, "check4")
|
|
require.Contains(healthResult, "check5")
|
|
require.True(health)
|
|
|
|
healthResult, health = h.Health("tag1", "tag2")
|
|
require.Len(healthResult, 4)
|
|
require.Contains(healthResult, "check2")
|
|
require.Contains(healthResult, "check3")
|
|
require.Contains(healthResult, "check4")
|
|
require.Contains(healthResult, "check5")
|
|
require.True(health)
|
|
|
|
healthResult, health = h.Health("nonExistentTag")
|
|
require.Len(healthResult, 1)
|
|
require.Contains(healthResult, "check5")
|
|
require.True(health)
|
|
|
|
healthResult, health = h.Health("tag1", "tag2", "nonExistentTag")
|
|
require.Len(healthResult, 4)
|
|
require.Contains(healthResult, "check2")
|
|
require.Contains(healthResult, "check3")
|
|
require.Contains(healthResult, "check4")
|
|
require.Contains(healthResult, "check5")
|
|
require.True(health)
|
|
}
|
|
|
|
// stop the health check
|
|
h.Stop()
|
|
|
|
{
|
|
// now we'll add a new check which is unhealthy by default (notYetRunResult)
|
|
require.NoError(h.RegisterHealthCheck("check6", check, "tag1"))
|
|
|
|
awaitHealthy(t, h, false)
|
|
|
|
healthResult, health := h.Health("tag1")
|
|
require.Len(healthResult, 4)
|
|
require.Contains(healthResult, "check2")
|
|
require.Contains(healthResult, "check4")
|
|
require.Contains(healthResult, "check5")
|
|
require.Contains(healthResult, "check6")
|
|
require.Equal(notYetRunResult, healthResult["check6"])
|
|
require.False(health)
|
|
|
|
healthResult, health = h.Health("tag2")
|
|
require.Len(healthResult, 3)
|
|
require.Contains(healthResult, "check3")
|
|
require.Contains(healthResult, "check4")
|
|
require.Contains(healthResult, "check5")
|
|
require.True(health)
|
|
|
|
// add application tag
|
|
require.NoError(h.RegisterHealthCheck("check7", check, ApplicationTag))
|
|
|
|
awaitHealthy(t, h, false)
|
|
|
|
healthResult, health = h.Health("tag2")
|
|
require.Len(healthResult, 4)
|
|
require.Contains(healthResult, "check3")
|
|
require.Contains(healthResult, "check4")
|
|
require.Contains(healthResult, "check5")
|
|
require.Contains(healthResult, "check7")
|
|
require.Equal(notYetRunResult, healthResult["check7"])
|
|
require.False(health)
|
|
}
|
|
}
|