##// END OF EJS Templates
api: use consistent way to extract users, repos, repo groups and user groups by id or name....
api: use consistent way to extract users, repos, repo groups and user groups by id or name. - makes usage of Number vs String to differenciate if we pick objec ID or it's name this will allow easy fetching of objects by either id or it's name, including numeric string name - fixes #5230

File last commit:

r1:854a839a default
r1530:1efcb4ee default
Show More
naming-conventions.rst
29 lines | 689 B | text/x-rst | RstLexer

Naming conventions

We found so far a few patterns emerging in our py.test fixtures. The naming conventions for those are documented on this page.

Utilities - _util

Used for fixtures which are used to ensure that the pre-conditions of the test are met. Usually it does not matter so much for the test how they achieve this. Most utilities will clean up automatically after themselves.

Use the suffix _util.

Page objects - {route_name}_page

Used as abstractions of pages.

Use the suffix _page and if possible use the route name as the prefix.