[TECHDEBT][UTILITY] Fix Unit Tests using testing.M

[Olshansk]

Description

Fix unit tests that exist on the main branch.

Origin Document

Fixes conversation in #259:

Issue

Rather than the core Go documentation, I believe this article does a better job at explaining why we had broken tests:

Before this change, even when a unit test failed, we still got a pass:

Type of change

Please mark the relevant option(s):

• New feature, functionality or library
• Bug fix
• Code health or cleanup
• Major breaking change
• Documentation
• Other

List of changes

• Update test_utility target in the Makefile
• Not ignoring the exit code of m.Run() in all the files where we use it (several modules)
• Fix tests in the utility module:
  • Remove redundant tests (e.g. TestUtilityContext_UnstakesPausedBefore which was replaced by TestUtilityContext_UnstakePausedBefore)
  • Do not ignore m.Run exit code so broken tests are caught
  • Improve readability of some tests (whitespace)
  • Do not unnecessarily export helpers
• Fix unit tests in the persistence module related to type casting

Testing

• make develop_test
• LocalNet w/ all of the steps outlined in the README

Required Checklist

• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have tested my changes using the available tooling
• I have updated the corresponding CHANGELOG

If Applicable Checklist

• I have updated the corresponding README(s); local and/or global
• I have added tests that prove my fix is effective or that my feature works
• I have added, or updated, mermaid.js diagrams in the corresponding README(s)
• I have added, or updated, documentation and mermaid.js diagrams in shared/docs/* if I updated shared/*README(s)

[andrewnguyen22]

The base change of catching the error code LGTM

However, you introduce a TON of white space into the tests. This makes me think we need a style guide or something because (a) it seems unnecessary to me (b) possibly out of scope?

I also see you marked the issue/PR as Utility, but you did this for all modules. Please update the issue

[andrewnguyen22]

The base change of catching the error code LGTM

However, you introduce a TON of white space into the tests. This makes me think we need a style guide or something because (a) it seems unnecessary to me (b) possibly out of scope?

I also see you marked the issue/PR as Utility, but you did this for all modules. Please update the issue

[Olshansk]

@andrewnguyen22 I reverted whiteline changes.

The base change of catching the error code LGTM

Ty.

I also see you marked the issue/PR as Utility, but you did this for all modules. Please update the issue

Updated.

However, you introduce a TON of white space into the tests. This makes me think we need a style guide or something because (a) it seems unnecessary to me (b) possibly out of scope?

Agreed that the whiteline changes are out of scope. Reverted.

Generally, I've been introducing whitelines between different "logical components" of the test. I agree that this is ill-defined and will update a best practice doc once I can quantity it.

E.g.

			ctx := NewTestingUtilityContext(t, 0)

			actor := getFirstActor(t, ctx, actorType)
			addrBz, err := hex.DecodeString(actor.GetAddress())
			require.NoError(t, err)
			msgEditStake := &typesUtil.MessageEditStake{
				Address:   addrBz,
				Chains:    test_artifacts.DefaultChains,
				Amount:    test_artifacts.DefaultStakeAmountString,
				ActorType: actorType,
			}

			candidates, err := ctx.GetMessageEditStakeSignerCandidates(msgEditStake)
			require.NoError(t, err)
			require.Equal(t, len(candidates), 2, "unexpected number of candidates")
			require.Equal(t, actor.GetOutput(), hex.EncodeToString(candidates[0]), "incorrect output candidate")
			require.Equal(t, actor.GetAddress(), hex.EncodeToString(candidates[1]), "incorrect addr candidate")
			test_artifacts.CleanupTest(ctx)

            // We get the context and used that to get the actor we use for the remainder of the test
			ctx := NewTestingUtilityContext(t, 0)
			actor := getFirstActor(t, ctx, actorType)

            // We get the address and verify there's no error
			addrBz, err := hex.DecodeString(actor.GetAddress())
			require.NoError(t, err)

            // We prepare a test artifact
			msgEditStake := &typesUtil.MessageEditStake{
				Address:   addrBz,
				Chains:    test_artifacts.DefaultChains,
				Amount:    test_artifacts.DefaultStakeAmountString,
				ActorType: actorType,
			}

            // We retrieve candidates, validate there's no error and run test checks using that return value
			candidates, err := ctx.GetMessageEditStakeSignerCandidates(msgEditStake)
			require.NoError(t, err)
			require.Equal(t, len(candidates), 2, "unexpected number of candidates")
			require.Equal(t, actor.GetOutput(), hex.EncodeToString(candidates[0]), "incorrect output candidate")
			require.Equal(t, actor.GetAddress(), hex.EncodeToString(candidates[1]), "incorrect addr candidate")

            // Test cleanup is a separate independent issue
			test_artifacts.CleanupTest(ctx)