Skip to content

Commit

Permalink
👌 Applied suggestions
Browse files Browse the repository at this point in the history
  • Loading branch information
@nagdahimanshu
nagdahimanshu committed Feb 22, 2024
1 parent 823db75 commit 414b68c
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 24 deletions.
58 changes: 35 additions & 23 deletions cmd/faultdetector/main_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"fmt"
"io"
"math/big"
"math/rand"
"net/http"
"strconv"
"strings"
Expand All @@ -22,6 +23,7 @@ import (
"github.com/ethereum/go-ethereum/common"
"github.com/gin-gonic/gin"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promhttp"
promClient "github.com/prometheus/client_model/go"
"github.com/prometheus/common/expfmt"
slackClient "github.com/slack-go/slack"
Expand All @@ -30,16 +32,19 @@ import (
)

const (
host = "127.0.0.1"
port = 8088
faultProofWindow = 1000
currentOutputIndex = 1
l1RpcApi = "https://rpc.notadegen.com/eth"
l2RpcApi = "https://mainnet.optimism.io/"
faultDetectorStateMismatch = "fault_detector_is_state_mismatch"
host = "127.0.0.1"
port = 8088
faultProofWindow = 1000
currentOutputIndex = 1
l1RpcApi = "https://rpc.notadegen.com/eth"
l2RpcApi = "https://mainnet.optimism.io/"
faultDetectorStateMismatchMetricKey = "fault_detector_is_state_mismatch"
metricValue = "value"
postMessageContextFnName = "PostMessageContext"
channelID = "TestChannelID"
)

type parseMetric map[string]map[string]interface{}
type parsedMetricMap map[string]map[string]interface{}

type mockContractOracleAccessor struct {
mock.Mock
Expand All @@ -65,7 +70,7 @@ func (o *mockContractOracleAccessor) FinalizationPeriodSeconds() (*big.Int, erro
}

func (o *mockSlackClient) PostMessageContext(ctx context.Context, channelID string, options ...slackClient.MsgOption) (string, string, error) {
called := o.MethodCalled("PostMessageContext")
called := o.MethodCalled(postMessageContextFnName)
return called.Get(0).(string), called.Get(1).(string), called.Error(2)
}

Expand All @@ -76,13 +81,18 @@ func randHash() (out common.Hash) {
return out
}

func randTimestamp() (out uint64) {
timestamp := uint64(rand.Int63n(time.Now().Unix()))
return timestamp
}

func prepareHTTPServer(t *testing.T, ctx context.Context, logger log.Logger, config *config.Config, wg *sync.WaitGroup, erroChan chan error) *api.HTTPServer {
testServer := api.NewHTTPServer(ctx, logger, wg, config, erroChan)
return testServer
}

func prepareNotification(t *testing.T, ctx context.Context, logger log.Logger, config *config.Config) *notification.Notification {
slackNotificationClient.On("PostMessageContext").Return("TestChannelID", "1234569.1000", nil)
slackNotificationClient.On(postMessageContextFnName).Return(channelID, "1234569.1000", nil)
testNotificationService := notification.GetNotification(ctx, logger, slackNotificationClient, config.Notification)
return testNotificationService
}
Expand All @@ -100,19 +110,19 @@ func prepareFaultDetector(t *testing.T, ctx context.Context, logger log.Logger,

latestL2BlockNumber, _ := l2RpcApi.GetLatestBlockNumber(ctx)

// Mock oracle conmtract accessor
// Mock oracle contract accessor
var oracle *mockContractOracleAccessor = new(mockContractOracleAccessor)
oracle.On("GetNextOutputIndex").Return(big.NewInt(2), nil)
oracle.On("FinalizationPeriodSeconds").Return(faultProofWindow, nil)
oracle.On("GetL2Output", big.NewInt(0)).Return(chain.L2Output{
OutputRoot: randHash().String(),
L1Timestamp: 1000000,
L1Timestamp: randTimestamp(),
L2BlockNumber: latestL2BlockNumber,
L2OutputIndex: 2,
}, nil)
oracle.On("GetL2Output", big.NewInt(1)).Return(chain.L2Output{
OutputRoot: randHash().String(),
L1Timestamp: 1000000,
L1Timestamp: randTimestamp(),
L2BlockNumber: latestL2BlockNumber,
L2OutputIndex: 2,
}, nil)
Expand Down Expand Up @@ -147,17 +157,17 @@ func prepareConfig(t *testing.T) *config.Config {
Notification: &config.Notification{
Enable: true,
Slack: &config.SlackConfig{
ChannelID: "TestChannelID",
ChannelID: channelID,
},
},
}
}

func parseMetricRes(input *strings.Reader) []parseMetric {
func parseMetricRes(input *strings.Reader) []parsedMetricMap {
parser := &expfmt.TextParser{}
metricFamilies, _ := parser.TextToMetricFamilies(input)

var parsedOutput []parseMetric
var parsedOutput []parsedMetricMap
for _, metricFamily := range metricFamilies {
for _, m := range metricFamily.GetMetric() {
metric := make(map[string]interface{})
Expand All @@ -166,11 +176,11 @@ func parseMetricRes(input *strings.Reader) []parseMetric {
}
switch metricFamily.GetType() {
case promClient.MetricType_COUNTER:
metric["value"] = m.GetCounter().GetValue()
metric[metricValue] = m.GetCounter().GetValue()
case promClient.MetricType_GAUGE:
metric["value"] = m.GetGauge().GetValue()
metric[metricValue] = m.GetGauge().GetValue()
}
parsedOutput = append(parsedOutput, parseMetric{
parsedOutput = append(parsedOutput, parsedMetricMap{
metricFamily.GetName(): metric,
})
}
Expand All @@ -194,7 +204,7 @@ func TestMain_E2E(t *testing.T) {
assertion: func(isStateMismatch float64, err error) {
const expected float64 = 0
assert.Equal(t, isStateMismatch, expected)
slackNotificationClient.AssertNotCalled(t, "PostMessageContext")
slackNotificationClient.AssertNotCalled(t, postMessageContextFnName)
},
},
{
Expand All @@ -203,7 +213,7 @@ func TestMain_E2E(t *testing.T) {
assertion: func(isStateMismatch float64, err error) {
const expected float64 = 1
assert.Equal(t, isStateMismatch, expected)
slackNotificationClient.AssertCalled(t, "PostMessageContext")
slackNotificationClient.AssertCalled(t, postMessageContextFnName)
},
},
}
Expand All @@ -220,6 +230,8 @@ func TestMain_E2E(t *testing.T) {
testNotificationService := prepareNotification(&testing.T{}, ctx, logger, testConfig)
testFaultDetector := prepareFaultDetector(&testing.T{}, ctx, logger, testNotificationService, &wg, registry, testConfig, errorChan, tt.mock)

testServer.RegisterHandler("GET", "/metrics", promhttp.HandlerFor(registry, promhttp.HandlerOpts{Registry: registry, ProcessStartTime: time.Now()}))

app := &App{
ctx: ctx,
logger: logger,
Expand Down Expand Up @@ -250,8 +262,8 @@ func TestMain_E2E(t *testing.T) {
assert.NoError(t, err)
parsedMetric := parseMetricRes(strings.NewReader(string(body)))
for _, m := range parsedMetric {
if m[faultDetectorStateMismatch] != nil {
isStateMismatch := m[faultDetectorStateMismatch]["value"].(float64)
if m[faultDetectorStateMismatchMetricKey] != nil {
isStateMismatch := m[faultDetectorStateMismatchMetricKey][metricValue].(float64)
tt.assertion(isStateMismatch, nil)
}
}
Expand Down
2 changes: 1 addition & 1 deletion pkg/faultdetector/faultdetector.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ func GetFaultDetector(ctx context.Context, logger log.Logger, l1RpcApi *chain.Ch
oracleContractAccessor: oracleContractAccessor,
faultProofWindow: faultProofWindow,
currentOutputIndex: currentOutputIndex,
diverged: false,
diverged: diverged,
metrics: metrics,
notification: notification,
}
Expand Down

0 comments on commit 414b68c

Please sign in to comment.