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

tests: meaningful names to validation tests #588

Merged
merged 1 commit into from
Apr 12, 2024

Commits on Apr 12, 2024

  1. tests: add meaningful names to validation tests

    When packaging cyclonedx-python-lib for a Linux distribution, it’s
    pretty common that some JSON validation tests fail. [1]
    
    Due to the large number of combinations and the fact that these tests
    are consecutively numbered, it has been tedious to figure out which
    tests are exactly failing and why. This in turn makes it difficult to
    decide which tests to disable or report upstream.
    
    Append meaningful names to validation tests so that instead of e.g.:
    
        […]::TestJsonValidator::test_validate_no_none_001
        […]::TestJsonValidator::test_validate_no_none_002
        […]::TestJsonValidator::test_validate_no_none_003
        […]::TestJsonValidator::test_validate_no_none_004
        […]::TestJsonValidator::test_validate_no_none_005
        […]::TestJsonValidator::test_validate_no_none_006
        […]::TestJsonValidator::test_validate_no_none_007
        […]::TestJsonValidator::test_validate_no_none_008
    
    the tests are named:
    
        […]::TestJsonValidator::test_validate_no_none_001_valid_component_swid_1_6
        […]::TestJsonValidator::test_validate_no_none_002_valid_machine_learning_considerations_env_1_6
        […]::TestJsonValidator::test_validate_no_none_003_valid_metadata_tool_1_6
        […]::TestJsonValidator::test_validate_no_none_004_valid_patch_1_6
        […]::TestJsonValidator::test_validate_no_none_005_valid_empty_components_1_6
        […]::TestJsonValidator::test_validate_no_none_006_valid_properties_1_6
        […]::TestJsonValidator::test_validate_no_none_007_valid_service_1_6
        […]::TestJsonValidator::test_validate_no_none_008_valid_metadata_author_1_6
    
    [1]: https://aur.archlinux.org/cgit/aur.git/diff/PKGBUILD?h=python-cyclonedx-lib&id=9c6ae556874a633a521407a77a9a85bb31da2047
    
    Signed-off-by: Claudia <claui@users.noreply.github.com>
    claui committed Apr 12, 2024
    Configuration menu
    Copy the full SHA
    4311702 View commit details
    Browse the repository at this point in the history