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.

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

Update WS testing coding standards doc #12213

Merged
merged 13 commits into from
Jan 14, 2025

Conversation

MeriemMechri
Copy link
Contributor

Resolves JIRA [number]

Overall changes

Update WS testing coding standards doc

Code changes

None.

Testing

N/A

Helpful Links

https://confluence.dev.bbc.co.uk/display/NEWSWORLDSERVICE/WS+-+Automation+strategy

docs/Test-Strategy-Info.mdx Outdated Show resolved Hide resolved
docs/Test-Strategy-Info.mdx Outdated Show resolved Hide resolved
docs/Test-Strategy-Info.mdx Outdated Show resolved Hide resolved
docs/Test-Strategy-Info.mdx Outdated Show resolved Hide resolved
docs/Test-Strategy-Info.mdx Outdated Show resolved Hide resolved
docs/Test-Strategy-Info.mdx Outdated Show resolved Hide resolved
docs/Test-Strategy-Info.mdx Outdated Show resolved Hide resolved
docs/Test-Strategy-Info.mdx Outdated Show resolved Hide resolved
docs/Test-Strategy-Info.mdx Outdated Show resolved Hide resolved
docs/Test-Strategy-Info.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

@karinathomasbbc karinathomasbbc left a comment

Choose a reason for hiding this comment

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

A few more small things. Let's also have a look at the heading levels to decide the best layout of the document

docs/Test-Strategy-Info.mdx Outdated Show resolved Hide resolved
docs/Test-Strategy-Info.mdx Outdated Show resolved Hide resolved
The rule of thumb is that we should avoid writing an end to end test if there is an alternative to validating the functionality. The alternative can be a combination of layers, for example, an integration test combined with an API test (which doesn’t exist right now) can be enough to reach the same confidence as an e2e test with less cost.

### Puma approach
Adopting the [PUMA](https://confluence.dev.bbc.co.uk/display/podtest/PUMA) approach can provide a framework to decide if a proposed test genuinely meets the definition of an E2E. According to PUMA, an E2E test should:
Copy link
Contributor

Choose a reason for hiding this comment

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

This is an internal confluence link - can we link to a public source? Or is it OK to do this - let's get a second opinion from @andrewscfc

Copy link
Contributor

Choose a reason for hiding this comment

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

I would like to use a link from the web rather than an internal confluence page if possible - can we try to find one?

docs/Test-Strategy-Info.mdx Outdated Show resolved Hide resolved
docs/Test-Strategy-Info.mdx Outdated Show resolved Hide resolved
docs/Test-Strategy-Info.mdx Outdated Show resolved Hide resolved
docs/Test-Strategy-Info.mdx Outdated Show resolved Hide resolved
The rule of thumb is that we should avoid writing an end to end test if there is an alternative to validating the functionality. The alternative can be a combination of layers, for example, an integration test combined with an API test (which doesn’t exist right now) can be enough to reach the same confidence as an e2e test with less cost.

### Puma approach
Adopting the [PUMA](https://confluence.dev.bbc.co.uk/display/podtest/PUMA) approach can provide a framework to decide if a proposed test genuinely meets the definition of an E2E. According to PUMA, an E2E test should:
Copy link
Contributor

Choose a reason for hiding this comment

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

I would like to use a link from the web rather than an internal confluence page if possible - can we try to find one?

docs/Test-Strategy-Info.mdx Outdated Show resolved Hide resolved
docs/Test-Strategy-Info.mdx Outdated Show resolved Hide resolved
docs/Test-Strategy-Info.mdx Outdated Show resolved Hide resolved
docs/Test-Strategy-Info.mdx Outdated Show resolved Hide resolved
@MeriemMechri MeriemMechri merged commit a6fd5db into latest Jan 14, 2025
11 checks passed
@MeriemMechri MeriemMechri deleted the update-ws-testing-coding-standards-doc branch January 14, 2025 10:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants