Adjust instructions for running EF integration tests #457
+45
−27
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
No New Or Fixed Issues Found |
addisonbeck
force-pushed
the
ac/addison/pm-10863-ef-integration-tests
branch
from
224b67a
to
8b5527f
Compare
Deploying contributing-docs with
|
| Latest commit: |
05d0165
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://6e13bff8.contributing-docs.pages.dev |
| Branch Preview URL: | https://ac-addison-pm-10863-ef-integ.contributing-docs.pages.dev |
addisonbeck
force-pushed
the
ac/addison/pm-10863-ef-integration-tests
branch
from
8b5527f
to
05d0165
Compare
eliykat
reviewed
Oct 23, 2024
Comment on lines
+227
to
+238
| "databases:0:type": "Postgres", | ||
| "databases:0:connectionString": "Host=localhost;Username=postgres;Password=_________;Database=ef_test", | ||
| "databases:0:enabled": "true", | ||
| "databases:1:type": "Sqlite", | ||
| "databases:1:enabled": "true", | ||
| "databases:1:connectionString": "Data Source=_________", | ||
| "databases:2:type": "MySql", | ||
| "databases:2:connectionString": "server=localhost;uid=root;pwd=_________;database=ef_test", | ||
| "databases:2:enabled": "true", | ||
| "databases:3:type": "SqlServer", | ||
| "databases:3:connectionString": "Server=localhost;Database=ef_test;User Id=SA;Password=_________;Encrypt=True;TrustServerCertificate=True;", | ||
| "databases:3:enabled": "true" |
There was a problem hiding this comment.
I suggested changing the format of these user secrets. If you do that, this will need to be updated. If you don't want to do that, then we should at least note here (maybe in a callout) that the index of each type must be maintained for the migrate script to work.
Comment on lines
+201
to
+220
| - This block is used for your primary Bitwarden database for each supported provider type. These are | ||
| what your running development server will connect to. You should already have passwords set up in | ||
| this block. | ||
| - If you do: ensure the username/password combos for each of your global database types are | ||
| applied to their siblings in the `databases` block. | ||
| - If you do not: please see the user secrets section of the server setup guide for doing this. | ||
| ``` | ||
| "sqlServer": { | ||
| "connectionString": "Server=localhost;Database=vault_dev;User Id=SA;Password=___________;Encrypt=True;TrustServerCertificate=True;" | ||
| }, | ||
| "postgreSql": { | ||
| "connectionString": "Host=localhost;Username=postgres;Password=_________;Database=vault_dev" | ||
| }, | ||
| "mySql": { | ||
| "connectionString": "server=localhost;uid=root;pwd=_________;database=vault_dev" | ||
| }, | ||
| "sqlite": { | ||
| "connectionString": "Data Source=/path/to/bitwardenServer/repository/server/dev/db/bitwarden.sqlite" | ||
| }, | ||
| ``` |
There was a problem hiding this comment.
I don't think this is required. It's already covered in the sections above so this is largely repeating information. I think you could just start with the following paragraph and it would work just as well or better.
mzieniukbw
reviewed
Nov 4, 2024
|
|
||
| You can then run just those tests from the `test/Infrastructure.IntegrationTest` folder using | ||
| `dotnet test`. | ||
| In your `server/dev/secrets.json` file find these two blocks of secrets: |
There was a problem hiding this comment.
❓ Theserver/ prefix might be confusing for some. This name is not guaranteed and we never reference it anywhere. It's almost always secrets.json.
| ``` | ||
|
|
||
| With connection strings applied to your projects: ensure your databases are all migrated using | ||
| `pwsh server/dev/migrate.ps1 --all`. Then you can run EF tests from the |
There was a problem hiding this comment.
❓ Theserver/ prefix might be confusing for some and it's not guaranteed.
Comment on lines
-224
to
-225
| You can then run just those tests from the `test/Infrastructure.IntegrationTest` folder using | ||
| `dotnet test`. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🎟️ Tracking
https://bitwarden.atlassian.net/browse/PM-10863
📔 Objective
This commit adds up to date documentation for running entity framework integration tests for
server. It has a companion PR for adding some of the mentioned functionality in bitwarden/server#4912📸 Screenshots
⏰ Reminders before review
team
🦮 Reviewer guidelines
:+1:) or similar for great changes:memo:) or ℹ️ (:information_source:) for notes or general info:question:) for questions:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmedissue and could potentially benefit from discussion
:art:) for suggestions / improvements:x:) or:warning:) for more significant problems or concerns needing attention:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt:pick:) for minor or nitpick changes