Back to Repositories

Testing YAML Loading Implementation in PR-Agent

This test suite validates YAML loading functionality in the pr-agent repository, focusing on handling both valid and invalid YAML structures with custom error handling and parsing logic.

Test Coverage Overview

The test suite provides comprehensive coverage of YAML loading scenarios:

Valid YAML string parsing with simple key-value pairs
Complex nested YAML structures with mixed data types
Invalid YAML handling with malformed content
Error case validation using pytest’s exception handling

Implementation Analysis

The testing approach utilizes pytest’s fixture and assertion mechanisms to validate YAML parsing functionality. The implementation leverages yaml.safe_load with custom error handling through the load_yaml utility function, ensuring robust YAML processing across different input scenarios.

Technical Details

Testing Framework: pytest
Primary Dependencies: PyYAML
Key Classes: TestLoadYaml
Exception Handling: yaml.scanner.ScannerError

Best Practices Demonstrated

The test suite exemplifies several testing best practices:

Isolated test cases for different scenarios
Explicit exception testing
Clear test method naming
Comprehensive assertion checks
Well-structured test data examples

codium-ai/pr-agent

tests/unittest/test_load_yaml.py

            

# Generated by CodiumAI

import pytest
import yaml
from yaml.scanner import ScannerError

from pr_agent.algo.utils import load_yaml


class TestLoadYaml:
    #  Tests that load_yaml loads a valid YAML string
    def test_load_valid_yaml(self):
        yaml_str = 'name: John Smith
age: 35'
        expected_output = {'name': 'John Smith', 'age': 35}
        assert load_yaml(yaml_str) == expected_output

    def test_load_invalid_yaml1(self):
        yaml_str = \
'''\
PR Analysis:
  Main theme: Enhancing the `/describe` command prompt by adding title and description
  Type of PR: Enhancement
  Relevant tests: No
  Focused PR: Yes, the PR is focused on enhancing the `/describe` command prompt.

PR Feedback:
  General suggestions: The PR seems to be well-structured and focused on a specific enhancement. However, it would be beneficial to add tests to ensure the new feature works as expected.
  Code feedback:
    - relevant file: pr_agent/settings/pr_description_prompts.toml
      suggestion: Consider using a more descriptive variable name than 'user' for the command prompt. A more descriptive name would make the code more readable and maintainable. [medium]
      relevant line: user="""PR Info: aaa
  Security concerns: No'''
        with pytest.raises(ScannerError):
            yaml.safe_load(yaml_str)

        expected_output = {'PR Analysis': {'Main theme': 'Enhancing the `/describe` command prompt by adding title and description', 'Type of PR': 'Enhancement', 'Relevant tests': False, 'Focused PR': 'Yes, the PR is focused on enhancing the `/describe` command prompt.'}, 'PR Feedback': {'General suggestions': 'The PR seems to be well-structured and focused on a specific enhancement. However, it would be beneficial to add tests to ensure the new feature works as expected.', 'Code feedback': [{'relevant file': 'pr_agent/settings/pr_description_prompts.toml
', 'suggestion': "Consider using a more descriptive variable name than 'user' for the command prompt. A more descriptive name would make the code more readable and maintainable. [medium]", 'relevant line': 'user="""PR Info: aaa
'}], 'Security concerns': False}}
        assert load_yaml(yaml_str) == expected_output

    def test_load_invalid_yaml2(self):
        yaml_str = '''\
- relevant file: src/app.py:
  suggestion content: The print statement is outside inside the if __name__ ==: \
'''
        with pytest.raises(ScannerError):
            yaml.safe_load(yaml_str)

        expected_output = [{'relevant file': 'src/app.py:
', 'suggestion content': 'The print statement is outside inside the if __name__ ==:'}]
        assert load_yaml(yaml_str) == expected_output