-
Notifications
You must be signed in to change notification settings - Fork 9
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.
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
docs: Describe how to test against a local Reference Implementation #194
Open
lukehesluke
wants to merge
3
commits into
master
Choose a base branch
from
feature/docs-describe-local-ref-impl-testing
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -23,14 +23,31 @@ When code is committed, the documentation generator is automatically run. This p | |||||
|
||||||
## Reference Implementation | ||||||
|
||||||
The OpenActive Test Suite is developed against a reference implementation, [OpenActive.Server.NET](https://github.com/openactive/OpenActive.Server.NET/). | ||||||
The OpenActive Test Suite is developed against a Reference Implementation, [OpenActive.Server.NET](https://github.com/openactive/OpenActive.Server.NET/). | ||||||
|
||||||
The CI checks that the Test Suite passes for the reference implementation. Therefore, the approach for adding each new test is to work on both: | ||||||
### CI | ||||||
|
||||||
The CI checks that the Test Suite passes for the Reference Implementation. When adding a new test, it is possible that the Reference Implementation has not yet implemented the functionality that the new test tests. | ||||||
|
||||||
Therefore, when adding a new test that requires work to the Test Suite and the Reference Implementation, the approach is to work on them both: | ||||||
|
||||||
- Reference Implementation: The implementation of the feature that's being tested. | ||||||
- Test Suite: The test itself. | ||||||
|
||||||
Any new feature that affects test coverage must be developed in a `coverage/*` branch in both reposities, in order for the CI to automatically run both feature branches against each other. | ||||||
Use a `coverage/*` branch in both repositories with the same name (e.g. `coverage/amend-order-quote`) in order for the CI to automatically run both branches against each other. | ||||||
|
||||||
### Local testing | ||||||
|
||||||
It is often helpful to run the tests against a local copy of the Reference Implementation. In order to do this: | ||||||
|
||||||
1. Run the Reference Implementation (`Examples/BookingSystem.AspNetCore` in [OpenActive.Server.NET](https://github.com/openactive/OpenActive.Server.NET/)) locally. | ||||||
2. Update `datasetSiteUrl` in your local broker config (packages/openactive-broker-microservice/config/local.json) to point to the local Reference Implementation's `/openactive` URL e.g. (ports are assigned randomly by .NET, so yours will differ from this example) | ||||||
```json | ||||||
"datasetSiteUrl": "http://localhost:55603/openactive" | ||||||
``` | ||||||
3. Update `sellers` in your local integration tests config (packages/openactive-integration-tests/config/local.json) to reflect the local seller URLs. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
as it's not always obvious what local.json is from a cursory glance |
||||||
|
||||||
The broker and tests should now run against your local copy of the Reference Implementation. | ||||||
|
||||||
## Pull Request Process | ||||||
|
||||||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
as it's not always obvious what local.json is from a cursory glance
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@nickevansuk What is
./#local-configuration
supposed to point to?