[Testing] Unit tests, E2E tests, logging and other Fixes / "Touchups"

[Olshansk]

Summary

Human Summary

This is aiming to fix multiple issues in E2E tests and just general QoL improvements:

1. Adding a comment in relay.feature about the need to run make supplier1_stake && make app1_stake until we fix [Configs] Make Genesis staked Actors available via the AccountKeeper #180 (known issue)
2. Replacing the reference to host sequencer-poktroll-sequencer with localhost (see first screenshot below)
3. Fixed a bug leading us to assert against a MsgSubmitProof event instead of a MsgCreateClaim event (see second screenshot below)
4. Fixed on-chain logging under x/* by replacing logger\.(Info|Error)\("([^"]+)"(?:, (.*))?\) with logger.$1(fmt.Sprintf("$2", $3)) so it works as expected
5. Some quality-of-life comments & TODOs
6. Minor additions to unit tests from [Off-Chain] Add EventsReplayClient Generic Event Listener for BlockClient and DelegationClient #220

Reasoning for s/sequencer-poktroll-sequencer/localhost:

Unresolved yet:

AI Summary

review pad:summary

Issue

Improving the

Type of change

Select one or more:

• New feature, functionality or library
• Bug fix
• Code health or cleanup
• Documentation
• Other (specify)

Testing

• Run all unit tests: make go_develop_and_test
• Run E2E tests: make e2e_test

Sanity Checklist

• I have tested my changes using the available tooling
• I have performed a self-review of my own code
• I have commented my code, updated documentation and left TODOs throughout the codebase

[github-actions]

The CI will now also run the e2e tests on devnet, which increases the time it takes to complete all CI checks.

[github-actions]

The CI will now also run the e2e tests on devnet, which increases the time it takes to complete all CI checks.

[Olshansk]

@okdas Seems like the change I made from sequencer-poktroll-sequencer to localhost works when I run make test_e2e locally but fails in CI. Either I'm missing something or we might have to add an environment variable to configure this, please let me know what you suggest!

[github-actions]

The CI will now also run the e2e tests on devnet, which increases the time it takes to complete all CI checks.

[Olshansk]

@bryanchriswhite @h5law Please see my comment above regarding imports. I've re-validated that make go_test and make test_e2e work, and checking here now if it also works in devnet.

@okdas Can you please verify this change. I believe this was an artifact that's no longer necessary (@red-0ne and I discovered it yesterday) but would appreciate another set of 👀 .

[h5law]

LGTM few files to goimports-reviser left but approving so we can merge <3

[Olshansk]

@h5law See the comment I left here regarding imports. I'll make the manual changes suggested, but can you look into why tools/scripts/imports/main.go (executed via make go_imports) doesn't fix it.

[bryanchriswhite]

@Olshansk @h5law

1. I resolved all import related comments without looking into it (see more details below).
2. I tried to setup goimports-reviser but it did not work and opened an issue here.
3. I ran make go_imports locally and am under the assumption it should solve what we need.
4. If make go_imports does not fix issues introduced by my IDE, I suggest the following (in a followup PR):

• Update go_imports
• A PR that updates the imports
• Document suggested import configs for poktroll developers

Please lmk if anything import-related is still blocking this PR.

BUMP:

[bryanchriswhite]

I had a couple of NITs but otherwise let's 🚢

[bryanchriswhite]

I did experiment with Lenf, but I did experiment with giving require.Len an unformatted string.

I'm assuming one of those is suppose to be a "didn't". 😅

---

For the record, in other cases, I would argue that #Lenf() produces the least ambiguous output. I agree that the output can be large if the list is not empty; however, that information is useful when debugging, and isn't obscuring the reason for failure as it's on its own line.

#Lenf()

func TestSanity(t *testing.T) {
	x := []struct{ a, b int }{{1, 2}, {3, 4}}
	require.Lenf(t, x, 3, "x should have 3 elements, got %d", len(x))
}

#Len()

func TestSanity(t *testing.T) {
	x := []struct{ a, b int }{{1, 2}, {3, 4}}
	require.Len(t, x, 3)
}

#Greater()

func TestSanity(t *testing.T) {
	x := []struct{ a, b int }{{1, 2}, {3, 4}}
	require.Greater(t, len(x), 2)
}