Come up with a way to detect if someone is not using the POM pattern in e2e tests and notify them.

[desi]

What is this about?

As part of the Engineering Technical sync the following question was asked: Is there a way to detect if someone is adding an e2e test that isn't using POM and should be?

This issue is a place holder for us to think about and discuss possibilities here.

Scenario

No response

Design

Potential approaches:

• QA should write possible reusable functions to make them easily adaptable by developers.
• When performing code reviews, check that the POM design pattern has been followed and implemented and this could be included in the review checklist.
• Encourage peer programming sessions for individuals who have not followed or need help following the pattern.
• Promote team wise training sessions and walkthroughs with clear expectations for writing test scenarios.
• Implement linting rules to enforce coding standards, with custom rules to detect deviations from the POM pattern, and integrate these as CI checks to flag tests that do not follow the POM pattern.

Technical Details

No response

Threat Modeling Framework

No response

Acceptance Criteria

No response

Stakeholder review needed before the work gets merged

• [X] Engineering (needed in most cases)
• [ ] Design
• [ ] Product
• [ ] QA (automation tests are required to pass before merging PRs but not all changes are covered by automation tests - please review if QA is needed beyond automation tests)
• [ ] Security
• [ ] Legal
• [ ] Marketing
• [ ] Management (please specify)
• [ ] Other (please specify)

References

No response

[gauthierpetetin]

Discussed with team during refinement:

• We should add linting rules to check that E2E tests specs import 'page' classes.
• Linting rules (or script) should make the pipeline fail for new files without POM.
• Linting rules should only trigger a warning and not make the pipeline fail, for existing files without POM.