test: Collect client test data from E2E tests (DSP-724)

[benjamingeer]

resolves DSP-724

• Add ClientTestDataCollector class that E2E tests can use.
• Move client test data generation from routes and SharedTestDataADM into E2E tests:
  • API v2 routes:
    • ResourcesRouteV2 -> ResourcesRouteV2E2ESpec
    • OntologiesRouteV2 -> OntologyV2R2RSpec
    • ValuesRouteV2 -> ValuesRouteV2E2ESpec
    • SearchRouteV2 -> SearchRouteV2R2RSpec
    • ListsRouteV2 -> ListsRouteV2R2RSpec
  • Admin routes:
    • UsersRouteADM -> UsersADME2ESpec
    • GroupsRouteADM -> GroupsADME2ESpec
    • ProjectsRouteADM -> ProjectsADME2ESpec
    • PermissionsRouteADM -> PermissionsADME2ESpec
    • ListsRouteADM -> ListsADME2ESpec
• Change Makefile to do the following when running E2E tests:
  • Start the Redis container defined in docker-compose.yml.
  • Remove any client test data previously stored in Redis.
  • Remove any previously downloaded Zip file containing client test data.
  • After tests complete, download the client test data from Redis into a Zip file.
  • Check the contents of the the downloaded Zip file.
• Move shared test data classes from main to test.
• Update docs.

[subotic]

When you add a separate Makefile target for the generation of the client-test-data, maybe it would also make sense to add an additional Github-CI job for this target?

[benjamingeer]

 When you add a separate Makefile target for the generation of the client-test-data

I thought of that, but the problem is as I wrote above: if Redis isn't running, the E2E tests will fail, because ClientTestDataCollector will throw an exception if it fails to connect to Redis. We would need some way of telling it not to try to connect to Redis if it isn't being run by that Makefile target.

[benjamingeer]

I guess I could do it with an environment variable...

[subotic]

You could add a KnoraSetting, which could be configured through an environment variable. The default could be false, i.e., don't try to actually write to the cache. You could then test for it in the TestDataCollector implementation.

[subotic]

@benjamingeer if you need help, I could quickly add the environment variable part. Just let me now.

[subotic]

@benjamingeer @SepidehAlassi There is an e2e test, which responses should also be gathered: https://github.com/dasch-swiss/knora-api/blob/wip/DSP-724-client-test-data/webapi/src/test/scala/org/knora/webapi/e2e/HealthRouteE2ESpec.scala

[subotic]

Regarding the health route, @tobiasschweizer would like that the data goes into a system folder and not admin or v2.

[benjamingeer]

There is an e2e test, which responses should also be gathered

Let's do that in a separate PR.

[subotic]

There is an e2e test, which responses should also be gathered

Let's do that in a separate PR.

Just wanted to suggest that. There is a new Youtrack story: https://dasch.myjetbrains.com/youtrack/issue/DSP-743

[benjamingeer]

You could add a KnoraSetting, which could be configured through an environment variable. The default could be false, i.e., don't try to actually write to the cache. You could then test for it in the TestDataCollector implementation.

I implemented it in fd0d3cf, but it doesn't work: KnoraSettings never gets the value of the environment variable. Could you have a look?

[subotic]

You could add a KnoraSetting, which could be configured through an environment variable. The default could be false, i.e., don't try to actually write to the cache. You could then test for it in the TestDataCollector implementation.

I implemented it in fd0d3cf, but it doesn't work: KnoraSettings never gets the value of the environment variable. Could you have a look?

sure, will do after lunch

[subotic]

@benjamingeer the generation works now.

[benjamingeer]

the generation works now.

Excellent, thank you! Could you give me a hint about how to do this:

To use the SharedTestDataADM object in it, you would need to add a dependency in the Bazel build file which points to the Bazel package under test.

[benjamingeer]

To use the SharedTestDataADM object in it, you would need to add a dependency in the Bazel build file which points to the Bazel package under test.

OK I figured it out. I think that's everything you asked for.

[subotic]

Great, thanks for the work!

[benjamingeer]

@subotic Thanks for the review and the help!

[SepidehAlassi]

@benjamingeer I believe this had to be updated to make client-test-data, right?

[benjamingeer]

Yes, sorry, I forgot that.

[SepidehAlassi]

same here, this has to be make client-test-data, right? If so, I can update this documentation.

[benjamingeer]

Yes, thank you.