Skip to content

bagerard/flake8-test-name

Folders and files

NameName
Last commit message
Last commit date
Dec 6, 2023
Mar 18, 2021
Mar 16, 2021
Oct 3, 2023
Mar 14, 2021
Mar 14, 2021
Mar 14, 2021
Oct 3, 2023
Oct 3, 2023
Jan 25, 2023
Aug 12, 2023
Aug 28, 2022
Mar 18, 2021
Mar 18, 2021
Jan 25, 2023

Repository files navigation

Test Name function validator (Flake8 plugin)

Build status Coverage Status

An extension for Flake8 to make sure that test function name follows a given convention

Plugin for Flake8

When both Flake8 and flake8-test-name are installed, the plugin will show up when displaying the version of flake8:

$ flake8 --version
3.6.0 (flake8-test-name: 0.1.2, […]

Operation

The hook assumes that your:

  • test files are matching test_.*.py
  • test functions are starting with test_

Any function matching these 2 conditions will be validated against your custom validator

Parameters

This module can be configured in 2 ways. First option is a regex using --test-func-name-validator-regex:

$ flake8 myproject/tests/sample.py --test-func-name-validator-regex="test_funky_convention_.*" --select=TN101

>> myproject/tests/sample.py:14:1: TN101 test function name does not match the convention (test_invalid_method_sample)

Second option is with a python module containing a method named test_function_name_validator. Assuming you have a funky_validator.py file with the following content:

def test_function_name_validator(func_name: str):
    return func_name.startswith("test_funkyconvention")

You can then configure it using --test-func-name-validator-module:

$ flake8 myproject/tests/sample.py --test-func-name-validator-module=./funky_validator.py --select=TN101

>> myproject/tests/sample.py:14:1: TN101 test function name does not match the convention (test_invalid_method_sample)

Error codes

This plugin is using the following error codes:

Code | Error
TN101 TN101 test function name does not match the convention

Changes

0.1.6 - 2023-10-03

  • fix in options parser for flake8 > 6.0

0.1.5 - 2021-03-21

  • minor refactoring and doc improvement

0.1.1 - 2021-03-19

  • Initial release