E2E: Improve documentation/usage

[4ydan]

Closes #783
Closes #782

Basics

• I added a line to /doc/CHANGELOG.md
• The PR is rebased with current master.
• Details of what you changed are in commit messages.
• References to issues, e.g. close #X, are in the commit messages.
• The buildserver is happy.

Checklist

• I have installed and I am using pre-commit hooks
• I fully described what my PR does in the documentation
  (not in the PR description)
• I fixed all affected documentation
• I fixed the introduction tour
• I wrote migrations in a way that they are compatible with already present data
• I fixed all affected decisions
• I added unit tests for my code
• I added code comments, logging, and assertions as appropriate
• I translated all strings visible to the user
• I mentioned every code or binary not directly written or done by me in reuse syntax
• I created left-over issues for things that are still to be done
• Code is conforming to our Architecture
• Code is conforming to our Guidelines
  (exceptions are documented)
• Code is consistent to our Design Decisions

Review

• I've tested the code
• I've read through the whole code
• Examples are well chosen and understandable

[4ydan]

May I allow

@markus2330 ?
It seems to have a problem with executing a shell script as entrypoint for the e2e docker image.

The real complication here is that I need to delete all maps from the database after a local test run and I dont have to do that in CI. So I get these two different use cases which I both need to handle somehow.

Also the entrypoint.sh is used from the top level makefile. So I really dont want to duplicate any lines of code here.

[markus2330]

It seems to have a problem with executing a shell script as entrypoint for the e2e docker image.

Which line of code has this problem? It is quite clearly indicated that something like this shouldn't be done.

The real complication here is that I need to delete all maps from the database after a local test run and I dont have to do that in CI. So I get these two different use cases which I both need to handle somehow.

Why would you need to delete all maps? You can simply require that E2E are only executed on an empty database.

Also the entrypoint.sh is used from the top level makefile. So I really dont want to duplicate any lines of code here.

Yes, I agree.

[4ydan]

Which line of code has this problem?

I cant clearly tell. I would guess it doesnt like the shell script invocation inside the dockerfile.

It is quite clearly indicated that something like this shouldn't be done.

Yes I agree, I was just not sure how "dangerous" this really is. I will try to find another way, just like the other scripts maybe.
I thought it would have been nice to have a docker entrypoint.

Why would you need to delete all maps? You can simply require that E2E are only executed on an empty database.

You need to do that everytime you rerun the e2e tests otherwise you will get wrong test results.

[markus2330]

You need to do that everytime you rerun the e2e tests otherwise you will get wrong test results.

No problem for me. Let us better keep everything simple.

[4ydan]

Let me know if anything is unclear/complicated or I have forgotten something and if you can run e2e tests locally. Thank you!

[markus2330]

Great job, both make test-e2e without Docker and "e2e.sh" with Docker now works for me. 🚀 A few minor comments, can be also fixed in a later PR.

[markus2330]

LGTM, let us merge and do a follow-up when needed.

[markus2330]

Some documentation & DATABASE_URL missing.

[markus2330]

Please feel free to readd the e2e/clean_db.py.