From 7a915880ac9af2e1dd528df3ffeb977d5e635fa8 Mon Sep 17 00:00:00 2001 From: Julien Robert Date: Mon, 16 May 2022 18:16:08 +0200 Subject: [PATCH] test: add test on `StringifyEvents` (#11972) --- types/events.go | 2 +- types/events_test.go | 47 +++++++++++++++++++++++++++++++----------- x/bank/types/events.go | 2 +- 3 files changed, 37 insertions(+), 14 deletions(-) diff --git a/types/events.go b/types/events.go index 664a0082f8..dbff89ce2d 100644 --- a/types/events.go +++ b/types/events.go @@ -211,7 +211,7 @@ func (e Events) ToABCIEvents() []abci.Event { } // Common event types and attribute keys -var ( +const ( EventTypeTx = "tx" AttributeKeyAccountSequence = "acc_seq" diff --git a/types/events_test.go b/types/events_test.go index 87622550d2..df49138d4f 100644 --- a/types/events_test.go +++ b/types/events_test.go @@ -103,20 +103,43 @@ func (s *eventsTestSuite) TestEventManagerTypedEvents() { } func (s *eventsTestSuite) TestStringifyEvents() { - e := sdk.Events{ - sdk.NewEvent("message", sdk.NewAttribute("sender", "foo")), - sdk.NewEvent("message", sdk.NewAttribute("module", "bank")), + cases := []struct { + name string + events sdk.Events + expTxtStr string + expJSONStr string + }{ + { + name: "default", + events: sdk.Events{ + sdk.NewEvent("message", sdk.NewAttribute(sdk.AttributeKeySender, "foo")), + sdk.NewEvent("message", sdk.NewAttribute(sdk.AttributeKeyModule, "bank")), + }, + expTxtStr: "\t\t- message\n\t\t\t- sender: foo\n\t\t\t- module: bank", + expJSONStr: "[{\"type\":\"message\",\"attributes\":[{\"key\":\"sender\",\"value\":\"foo\"},{\"key\":\"module\",\"value\":\"bank\"}]}]", + }, + { + name: "multiple events with same attributes", + events: sdk.Events{ + sdk.NewEvent( + "message", + sdk.NewAttribute(sdk.AttributeKeyModule, "staking"), + sdk.NewAttribute(sdk.AttributeKeySender, "cosmos1foo"), + ), + sdk.NewEvent("message", sdk.NewAttribute(sdk.AttributeKeySender, "foo")), + }, + expTxtStr: "\t\t- message\n\t\t\t- module: staking\n\t\t\t- sender: cosmos1foo\n\t\t\t- sender: foo", + expJSONStr: `[{"type":"message","attributes":[{"key":"module","value":"staking"},{"key":"sender","value":"cosmos1foo"},{"key":"sender","value":"foo"}]}]`, + }, } - se := sdk.StringifyEvents(e.ToABCIEvents()) - expectedTxtStr := "\t\t- message\n\t\t\t- sender: foo\n\t\t\t- module: bank" - s.Require().Equal(expectedTxtStr, se.String()) - - bz, err := json.Marshal(se) - s.Require().NoError(err) - - expectedJSONStr := "[{\"type\":\"message\",\"attributes\":[{\"key\":\"sender\",\"value\":\"foo\"},{\"key\":\"module\",\"value\":\"bank\"}]}]" - s.Require().Equal(expectedJSONStr, string(bz)) + for _, test := range cases { + se := sdk.StringifyEvents(test.events.ToABCIEvents()) + s.Require().Equal(test.expTxtStr, se.String()) + bz, err := json.Marshal(se) + s.Require().NoError(err) + s.Require().Equal(test.expJSONStr, string(bz)) + } } func (s *eventsTestSuite) TestMarkEventsToIndex() { diff --git a/x/bank/types/events.go b/x/bank/types/events.go index 9f06b85e49..2293083e51 100644 --- a/x/bank/types/events.go +++ b/x/bank/types/events.go @@ -9,7 +9,7 @@ const ( EventTypeTransfer = "transfer" AttributeKeyRecipient = "recipient" - AttributeKeySender = "sender" + AttributeKeySender = sdk.AttributeKeySender AttributeValueCategory = ModuleName