rhodecode-enterprise-ce Files · docs/contributing/testing/naming-conventions.rst

auth: Implement __str__ on plugin base class...

auth: Implement __str__ on plugin base class This way some error messages will look nicer, since they are based on the __str__ of the plugin instance. Using the plugin_id will give the user (and us in the support case) the exact pointer to the affected plugins.

marcink - - Load All Authors

File last commit:

r1:854a839a default


                r197:e6c6abfa

default

Download file

             naming-conventions.rst
        
                    29 lines
            
             | 689 B
            
                | text/x-rst
            
             |
                RstLexer
            
             / docs / contributing / testing / naming-conventions.rst
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        marcink
    
project: added all source files and assets

              r1
            
      ====================

       Naming conventions

      ====================

      Fixtures

      ========

      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.

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

marcink project: added all source files and assets	r1
		====================
		Naming conventions
		====================


		Fixtures
		========

		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.