Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document how to access the database for a homeserver after Complement runs #165

Closed
wants to merge 3 commits into from
Closed

Document how to access the database for a homeserver after Complement runs #165

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3952efd
Document how to access the database for a homeserver after Complement…
MadLittleMods Jul 16, 2021
a6e79b9
Move to step by step based db access
MadLittleMods Jul 16, 2021
039c675
Merge branch 'master' into madlittlemods/doc-access-database
MadLittleMods Jul 20, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions ONBOARDING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,18 @@ It can be useful to view the output of a test in Element to better debug somethi
1. Now you can visit http://localhost:7080/ and register a new user and explore the rooms from the test output


### Access database for homeserver after Complement test runs

If you're curious what the database looks like after you run some tests, here are some steps to get you going in Synapse:

1. In your test comment out `defer deployment.Destroy(t)` and replace with `defer time.Sleep(2 * time.Hour)` to keep the homeserver running after the tests complete
1. Start the Complement tests
1. Find the name of the container, `docker ps -f name=complement_` (this will filter for just the Compelement related Docker containers)
1. Access the container replacing the name with what you found in the previous step: `docker exec -it complement_1_hs_with_application_service.hs1_2 /bin/bash`
1. Install sqlite (database driver), `apt-get update && apt-get install -y sqlite3`
1. Then run `sqlite3` and open the database `.open /conf/homeserver.db` (this db path comes from the Synapse homeserver.yaml)


### What do I need to know if I'm coming from sytest?

Sytest has a concept of a `fixture` to configure the homeserver or test in a particular way, these are replaced with a `Blueprint` in Complement.
Expand Down