Add integration tests

[camille-bouvy-frequenz]

This PR adds integration test for the API client, service, as well as handel. These tests are performed by creating, updating & deleting orders on the simulation database.

As discussed in the latest team meeting, these tests were originally written with the goal of automatising everything. As a consequence, some of them might not be the most coherent: for instance test_list_public_trades() just verifies that the returned list isn’t null. It doesn’t check for the correctness of the output at all. These tests might thus have to be split into system tests (that would be performed manually), and integration test. 

Additionally, I think that having these tests run by the CI is not the most appropriate (especially given that they depend on other components than just the client).

So please suggest alternatives & improvements, & let's make a next level robust, efficient and awesome test suite!😎

[camille-bouvy-frequenz]

As mentioned in slack, the tests are currently not passing because the API_KEY seems like it's not recognised. It's however in the Github secrets, and I'm not sure what the problem is.

[matthias-wende-frequenz]

One tiny comment. I'll continue my review tomorrow.

[matthias-wende-frequenz]

Just one comment. Otherwise this looks good to me!

[nhatcher-frequenz]

Hi @camille-bouvy-frequenz ,

This is impressive! This is going to make us feel a lot safer of the whole product.
My most important thought:

• I don't think we should run these tests in the CI just yet. Maybe in the future a subset of these tests can run automatically. The reason is that we can run the test in parallel. So two PRs will write each others tests. Running those manually is not a huge deal because you can understand what's going on and run then again. So basically we are adding a step we don't really have so far, QA. Some human being needs to smoke tests that everything works as expected after each deployment (or right before the release)

• I think it would be a good idea to "mark" the order and trades we create on each test run or even test case. An idea is to use the tag, but we might use something else.

I think we can merge this PR with these tests and start adding test cases!
Many, many thanks!

[camille-bouvy-frequenz]

As discussed in the office I created a new workflow for these integration tests instead of having them ran by the CI. They will now be ran every time there is a new release, and can be ran manually from Github (by going into Actions --> Electricity-Trading-API-Integration-Tests --> Run workflow).

[camille-bouvy-frequenz]

With regards to the tags I tried adding tag="api-integration-test" but I get an error from the service @nhatcher-frequenz :

FAILED integration_tests/test_api.py::test_list_gridpool_trades - grpc.aio._call.AioRpcError: <AioRpcError of RPC that terminated with:
        status = StatusCode.ABORTED
        details = "Failed to start transaction. Error: Query Error: error returned from database: duplicate key value violates unique constraint "tag_unique_index""
        debug_error_string = "UNKNOWN:Error received from peer  {created_time:"2024-10-16T17:31:24.654862+02:00", grpc_status:10, grpc_message:"Failed to start transaction. Error: Query Error: error returned from database: duplicate key value violates unique constraint \"tag_unique_index\""}"
>

[camille-bouvy-frequenz]

Fixed the tag now that the changes were made in the service.

[nhatcher-frequenz]

With regards to the tags I tried adding tag="api-integration-test" but I get an error from the service

Forgot to mention but this should be fixed now.

[nhatcher-frequenz]

LGTM!

[nhatcher-frequenz]

I didn't know about anext, my Python is getting Rusty.