Skip to content
This repository has been archived by the owner on Jul 26, 2024. It is now read-only.

docs: Add test & debugging doc #451

Merged
merged 12 commits into from
Oct 24, 2022
Merged

docs: Add test & debugging doc #451

merged 12 commits into from
Oct 24, 2022

Conversation

jrconlin
Copy link
Member

@jrconlin jrconlin commented Sep 13, 2022

Add doc describing using contract testing for local debugging.
CONSVC-1974

@jrconlin jrconlin requested a review from a team September 13, 2022 15:32
@Trinaa
Copy link
Collaborator

Trinaa commented Sep 15, 2022

@jrconlin

As discussed, I attempted merged TESTING.MD with the contract test READMEs. Let me know your thoughts on the 'Local Execution and Debugging' sections.

I'm still pondering about adding instructions for running contract tests individually and maybe to add a 'Local Execution and Debugging' section to the client README

@Trinaa Trinaa marked this pull request as ready for review September 23, 2022 20:47
@Trinaa Trinaa requested a review from a team as a code owner September 23, 2022 20:47
test-engineering/contract-tests/client/README.md Outdated Show resolved Hide resolved
test-engineering/contract-tests/client/README.md Outdated Show resolved Hide resolved
@jrconlin jrconlin requested a review from pjenvey October 4, 2022 19:13
Copy link
Member

@pjenvey pjenvey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry I missed this one last week, looks good otherwise


```sh
curl -v \
-H "UserAgent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:10.0) Gecko/20100101 Firefox/91.0'" \
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or there's also -A (which I rarely use)

Suggested change
-H "UserAgent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:10.0) Gecko/20100101 Firefox/91.0'" \
-H "User-Agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:10.0) Gecko/20100101 Firefox/91.0'" \

@pjenvey pjenvey requested a review from tiftran October 7, 2022 00:34
@Trinaa Trinaa requested a review from pjenvey October 7, 2022 14:00
Copy link
Contributor

@tiftran tiftran left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!


To run the contract tests locally, execute the following from the repository root:

**Build Contile Docker Image**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you for documenting this 🙂 now my newbie docker self can stop editing docker-compose and accidentally commit it now 🙃

@jrconlin jrconlin merged commit 22a62ce into main Oct 24, 2022
@jrconlin jrconlin deleted the test/docs branch October 24, 2022 16:05
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants