[+] add new testutil package

[0xgouda]

• Add a new testutil package that contains helper functions for different tests.
• Create a new SetupPostgresContainer() function that contains the pg container setup and termination logic.
• Move RPC tests servers setup, and mock Receiver to testutil/rpc.go.
• Create a separate sinks/test_main.go file containing the TestMain() for sinks tests.

[coveralls]

Pull Request Test Coverage Report for Build 19968467613

Details

• 83 of 88 (94.32%) changed or added relevant lines in 2 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage increased (+0.4%) to 73.972%

---

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
internal/testutil/setup.go	59	64	92.19%

Totals
Change from base Build 19930713686:	0.4%
Covered Lines:	3777
Relevant Lines:	5106

---

💛 - Coveralls

[pashagolub]

Great idea! Was on my todo list for a long time! :-)

Let's go further! We need the same functions in many test packages anyway, not only sinks!

The idea is:

• add /internal/testutil special package
• put only xxx_test.go files in it (e.g. docker_test.go, mock_test.go), so we can sure it won't be ever used in production
• add SetupXXX and TearDownXXX functions, e..g

   	func SetupPostgresDocker(t *testing.T) *Environment {
   		t.Helper()
   		var err error
   		const ImageName = "docker.io/postgres:17-alpine"
   		pgContainer, err = postgres.Run(...)

• each setup helper will return unique env for test, this way we are safe to run many tests in parallel

[0xgouda]

• each setup helper will return unique env for test, this way we are safe to run many tests in parallel

I am not sure I understand this point.

[0xgouda]

• put only xxx_test.go files in it (e.g. docker_test.go, mock_test.go), so we can sure it won't be ever used in production

This means we will be moving all our *_test.go files to this /interna/testutil dir, right?

[pashagolub]

I am not sure I understand this point.

If you setup a docker container, you want to return it to the test, right? If you setup a mock, you want the test to use it. That's what I mean under "return the environment". Every setup function should return test environment to the test case. No global vars or something like that.

[pashagolub]

This means we will be moving all our *_test.go files to this /interna/testutil dir, right?

No, testutil is exactly what the name says: "utilities to be used by tests".

For example instead of

func TestReadMetricSchemaType(t *testing.T) {
	conn, err := pgxmock.NewPool()
	assert.NoError(t, err)
...
}

We could

func TestReadMetricSchemaType(t *testing.T) {
	conn, tearDown := testutil.SetupMock()
	defer tearDown()
...
}

or in case of the docker:

func TestFoo(t *testing.T) {
	pg, tearDown := testutil.SetupPgContainer()
	defer tearDown()
	connStr, err = pg.ConnectionString(ctx)
	assert.NoError(t, err)
	assert.NoError(t, db.Ping(ctx, connStr))
}

Setup returns everything test case needs to run (environment) and the tearDown() function that test calls at the end to free resources, cleanup temp files, etc.

[pashagolub]

One more thing. I don't like helper_vars.go name. It might be just types.go, the same way as in other packages

[pashagolub]

+1