feat: setup unit tests with database

[Vafilor]

What this PR does:

Sets up unit testing with a live database.

Fixes onepanelio/core#

Special notes for your reviewer:

run make test-run to run the tests.

[rushtehrani]

Can you elaborate on the prefixes in test function names? I see:

test
Test
Test_
testClient (No _ here as opposed to the public funcs)
TestClient_

I am assuming TestClient_ are tests for methods on instances of DefaultTestClient(), and methods prefixed with testClient are for the private methods. But then looking at this line, that doesn't seem to be the case? Also should we consistently use _ for both public and private methods?

[Vafilor]

General form is Test[<Struct>]_<Method> where <struct> is optional. This format comes from Goland - if you type in func Test.... it'll provide auto complete options to this.

TestClient_ are for methods on Client struct, which is a majority of the methods in pkg.
So we have TestClient_<method_name>. Methods like these are for direct tests of a method, they should completely test a method.

To test specific cases, you have testClient methods. Format is testClient<MethodName><Condition>
e.g. testClientGetWorkflowTemplateDBEmpty tests the GetWorkflowTemplateDB method, when the there is no template - empty.

TestClientGetWorkflowTemplateDB would call this as a child method.

TestClientGetWorfklowTemplateDB(...) {
   testClientGetWorkflowTemplateDBEmpty(...)
}

In the case where we have two methods where the only name difference is case, like
GetWorkflowTemplate vs getWorkflowTemplate I've used the private word.

testClientPrivateGetWorkflowTemplate
vs
testClientGetWorkflowTemplate which is for the exported member.

[rushtehrani]

Should this be updated to match the new convention?

[Vafilor]

Yes, I'll update it.

[rushtehrani]

Getting this error when running this branch:

Exiting.

I have already ran this migration so I'm not sure why it is trying it again.

[Vafilor]

Getting this error when running this branch:

Exiting.

I have already ran this migration so I'm not sure why it is trying it again.

Are you running it in test mode, or just general build mode?

[rushtehrani]

Are you running it in test mode, or just general build mode?

Running in debug mode - not testing.

[rushtehrani]

When a test fails, the test container is not stopped and I get this error when trying to run tests:

 $ make test-run
make test-start
docker run --rm --name test-onepanel-postgres -p 5432:5432 -e POSTGRES_USER=admin -e POSTGRES_PASSWORD=tester -e POSTGRES_DB=onepanel -d  postgres:12.3
docker: Error response from daemon: Conflict. The container name "/test-onepanel-postgres" is already in use by container "f30a3914dcdf324348b13ff48bfe15cc41a7fde5c551a95d48c33e5234b2f4ce". You have to remove (or rename) that container to be able to reuse that name.
See 'docker run --help'.
make[1]: *** [test-start] Error 125
make: *** [test-run] Error 2