ghtest package

Submodules

• ghtest.analyze_tests module
  • get_codes()
  • print_scan()
  • print_suggestion()
  • print_test_summary()
  • print_tests()
• ghtest.cassette_sanitizer module
  • main()
  • sanitize_cassette_data()
  • sanitize_file()
  • sanitize_paths()
• ghtest.cli module
  • main()
• ghtest.core module
  • create_tests()
• ghtest.coverage_analysis module
  • BranchAnalyzer
    • BranchAnalyzer.check_branch()
    • BranchAnalyzer.is_block_covered()
    • BranchAnalyzer.visit_If()
    • BranchAnalyzer.visit_While()
  • analyze_file_coverage()
• ghtest.create_tests_workflow module
  • create_tests()
  • workflow()
• ghtest.param_suggestor module
  • CrudScenario
    • CrudScenario.identifier
    • CrudScenario.note
    • CrudScenario.resource
    • CrudScenario.steps
  • ScenarioStep
    • ScenarioStep.cleanup
    • ScenarioStep.description
    • ScenarioStep.expect
    • ScenarioStep.filepath
    • ScenarioStep.module
    • ScenarioStep.params
    • ScenarioStep.qualname
  • SuggestedFunctionTests
    • SuggestedFunctionTests.docstring
    • SuggestedFunctionTests.filepath
    • SuggestedFunctionTests.module
    • SuggestedFunctionTests.param_sets
    • SuggestedFunctionTests.qualname
    • SuggestedFunctionTests.scenario
  • suggest_params()
• ghtest.scanner module
  • FunctionInfo
    • FunctionInfo.crud_resource
    • FunctionInfo.crud_role
    • FunctionInfo.docstring
    • FunctionInfo.filepath
    • FunctionInfo.import_object()
    • FunctionInfo.lineno
    • FunctionInfo.module
    • FunctionInfo.module_call_values
    • FunctionInfo.module_functions
    • FunctionInfo.module_globals
    • FunctionInfo.module_param_values
    • FunctionInfo.parameter_usage_values
    • FunctionInfo.parameters
    • FunctionInfo.qualname
    • FunctionInfo.returns
    • FunctionInfo.sample_calls
    • FunctionInfo.unused_parameters
  • ParameterInfo
    • ParameterInfo.annotation
    • ParameterInfo.default
    • ParameterInfo.default_value
    • ParameterInfo.kind
    • ParameterInfo.name
  • scan_python_functions()
• ghtest.test_utils module
  • CaseTestResult
    • CaseTestResult.cassette_path
    • CaseTestResult.exception
    • CaseTestResult.file_reads
    • CaseTestResult.file_writes
    • CaseTestResult.params
    • CaseTestResult.printed
    • CaseTestResult.return_summary
    • CaseTestResult.return_value
    • CaseTestResult.target
    • CaseTestResult.volatile_return_fields
  • RunTestWithCassette
    • RunTestWithCassette.cases
    • RunTestWithCassette.cassette_path
  • assert_return_summary()
  • call_with_capture()
  • execute_function()
  • import_function()
• ghtest.tests_creator module
  • CrudScenario
    • CrudScenario.identifier
    • CrudScenario.note
    • CrudScenario.resource
    • CrudScenario.steps
  • GeneratedTest
    • GeneratedTest.cassette_path
    • GeneratedTest.source
    • GeneratedTest.test_callable
  • ScenarioStep
    • ScenarioStep.cleanup
    • ScenarioStep.description
    • ScenarioStep.expect
    • ScenarioStep.filepath
    • ScenarioStep.module
    • ScenarioStep.params
    • ScenarioStep.qualname
  • SuggestedFunctionTests
    • SuggestedFunctionTests.docstring
    • SuggestedFunctionTests.filepath
    • SuggestedFunctionTests.module
    • SuggestedFunctionTests.param_sets
    • SuggestedFunctionTests.qualname
    • SuggestedFunctionTests.scenario
  • make_test_function()
• ghtest.tests_writer module
  • TestArtifact
    • TestArtifact.run
    • TestArtifact.suggestion
  • write_test_modules()

Module contents

ghtest.make_test(suggestion: SuggestedFunctionTests, cassette_dir: str, record_mode: str = 'once', volatile_response_fields: Sequence[str] | None = None) → GeneratedTest

ghtest.print_test_summary(cassette_dir='testdata_tests/cassettes', test_dir='testdata_tests', src_dir='testdata', data_dir='data', test_objects_dir='testdata_test_objects', refresh=False, vb=0)

Print tests statistics like tested functions, request return codes etc.

Parameters:

• cassette_dir (str) – folder with vcr cassettes

• test_dir (str) – folder with tests

• src_dir (str) – folder with source under test

• data_dir (str) – data folder within tests to ignore

• test_objects_dir (str) – folder with test objects

• refresh (bool) – create tests before showing detailed stats, else try to load from disk

• vb (int) – detail level

Returns:

None

Side Effects:

prints to stdout

ghtest.scan(root: str) → List[FunctionInfo]

Recursively scan a folder for Python functions (including methods in classes).

Returns a list of FunctionInfo objects with module name, qualified name, source file path, parameters, return annotation, and docstring.

ghtest.suggest(func: FunctionInfo, test_functions: List[FunctionInfo] | None = None, *, literal_only: bool = False, coverage_data: Any | None = None) → SuggestedFunctionTests

Suggest parameter sets for tests of a single FunctionInfo.

Uses three sources, in order of preference: 1) Existing test functions (from a tests folder) that call the function. 2) A minimal set using only required parameters (skipping self/cls). 3) Additional sets where defaulted parameters are given alternative values.

test_functions should be the scanner results from the tests directory.

ghtest.write_module(artifacts: Sequence[TestArtifact], output_dir: str, *, max_cases_per_module: int = 10, inline_char_limit: int = 160, include_scenarios: bool = True, include_return_summary: bool = True, exception_assertion: Literal['message', 'type', 'presence', 'none'] = 'type') → TestWriterResult

ghtest.write_tests(src_dir, test_dir, cassette_dir)