Add comprehensive testing framework and YAML validator

- Create universal activity_yaml_validator.py for validating activity configurations
- Add validation for metadata operations (metadata_add, metadata_remove, metadata_feedback_filter, etc.)
- Validate terminal steps cannot have questions or buckets
- Check Python syntax in processing_script and pre_script blocks
- Validate YAML structure, transitions, and logic flow
- Add 17 comprehensive unit tests with 100% pass rate
- Include test fixtures for validation testing
- Support both CLI and programmatic usage
This commit is contained in:
Russell Ballestrini 2025-08-10 15:46:55 -04:00
parent 25c694584a
commit 292265b5bb
3 changed files with 1233 additions and 0 deletions

90
tests/fixtures/test_invalid.yaml vendored Normal file
View file

@ -0,0 +1,90 @@
default_max_attempts_per_step: "invalid" # Should be integer
tokens_for_ai_rubric: 123 # Should be string
sections:
- section_id: "section_1"
title: "Test Section"
steps:
- step_id: "step_1"
title: "Valid Step"
content_blocks:
- "This is a valid step."
- step_id: "step_2"
title: "Question Step"
question: "What do you want to do?"
tokens_for_ai: |
Categorize the response.
feedback_tokens_for_ai: |
Provide feedback.
buckets:
- valid_response
- invalid_response
transitions:
valid_response:
content_blocks:
- "Good response!"
metadata_add:
test_key: "value"
metadata_feedback_filter:
- user_response
- result
next_section_and_step: "section_1:step_3"
invalid_response:
content_blocks:
- "Try again."
metadata_remove: ["temp_data", "old_value"]
next_section_and_step: "section_1:step_2"
unused_bucket: # This should trigger a warning
content_blocks:
- "This transition is unused"
- step_id: "step_3"
title: "Final Step With Question" # This should be an ERROR - final steps can't have questions
question: "This is invalid for a final step"
buckets:
- some_bucket # This should be an ERROR - final steps shouldn't have buckets
transitions:
some_bucket:
content_blocks:
- "Done"
# No next_section_and_step - this makes it a terminal step
- step_4 # Missing step_id field - ERROR
title: "Invalid Step Structure"
# Missing either content_blocks or question - ERROR
- step_id: "step_5"
title: "Python Syntax Error Step"
question: "Test question"
pre_script: |
# This has a syntax error
if True
print("missing colon")
processing_script: |
# This has an empty else block
if condition:
do_something()
else:
# This will trigger a warning about empty else block
buckets:
- test_bucket
transitions:
test_bucket:
run_processing_script: "not_boolean" # Should be boolean
metadata_clear: "not_boolean" # Should be boolean
metadata_feedback_filter: "not_list" # Should be list
metadata_remove: 123 # Should be string or list
next_section_and_step: "invalid_format" # Should be section:step format
- section_id: "section_1" # Duplicate section_id - ERROR
title: "Duplicate Section"
steps:
- step_id: "duplicate_step"
title: "Test"
content_blocks: "not_a_list" # Should be list
- step_id: "duplicate_step" # Duplicate step_id - ERROR
title: "Another Duplicate"
content_blocks:
- 123 # Should be string

View file

@ -0,0 +1,554 @@
#!/usr/bin/env python3
"""
Unit tests for the activity_yaml_validator.py module.
Tests all validation features including:
- YAML syntax validation
- Structure validation
- Metadata operations validation
- Python code validation
- Logic flow validation
- Terminal step validation
"""
import unittest
import tempfile
import os
import sys
from pathlib import Path
# Add parent directory to path to import the validator
sys.path.insert(0, str(Path(__file__).parent.parent.parent))
from activity_yaml_validator import ActivityYAMLValidator, ValidationError
class TestActivityYAMLValidator(unittest.TestCase):
"""Test cases for ActivityYAMLValidator"""
def setUp(self):
"""Set up test fixtures"""
self.validator = ActivityYAMLValidator()
def create_temp_yaml(self, content: str) -> str:
"""Create a temporary YAML file with given content"""
with tempfile.NamedTemporaryFile(mode='w', suffix='.yaml', delete=False) as f:
f.write(content)
return f.name
def tearDown(self):
"""Clean up any temporary files"""
# Clean up is handled by tempfile
pass
def test_valid_yaml_passes(self):
"""Test that a valid YAML file passes validation"""
valid_yaml = """
default_max_attempts_per_step: 3
tokens_for_ai_rubric: "Test rubric"
sections:
- section_id: "section_1"
title: "Test Section"
steps:
- step_id: "step_1"
title: "Question Step"
question: "What do you want?"
tokens_for_ai: "Categorize response"
feedback_tokens_for_ai: "Provide feedback"
buckets:
- valid
- invalid
transitions:
valid:
content_blocks:
- "Great!"
next_section_and_step: "section_1:step_2"
invalid:
content_blocks:
- "Try again"
next_section_and_step: "section_1:step_1"
- step_id: "step_2"
title: "Final Step"
content_blocks:
- "All done!"
"""
temp_file = self.create_temp_yaml(valid_yaml)
try:
is_valid, errors, warnings = self.validator.validate_file(temp_file)
self.assertTrue(is_valid)
self.assertEqual(len(errors), 0)
finally:
os.unlink(temp_file)
def test_yaml_syntax_error(self):
"""Test that YAML syntax errors are caught"""
invalid_yaml = """
sections:
- section_id: "test"
title: "Test"
steps:
- step_id: "step1"
title: "Test Step"
content_blocks:
- "Test"
invalid_key: [unclosed list
"""
temp_file = self.create_temp_yaml(invalid_yaml)
try:
is_valid, errors, warnings = self.validator.validate_file(temp_file)
self.assertFalse(is_valid)
self.assertGreater(len(errors), 0)
self.assertIn("YAML syntax error", errors[0])
finally:
os.unlink(temp_file)
def test_missing_required_fields(self):
"""Test that missing required fields are caught"""
missing_sections = """
default_max_attempts_per_step: 3
"""
temp_file = self.create_temp_yaml(missing_sections)
try:
is_valid, errors, warnings = self.validator.validate_file(temp_file)
self.assertFalse(is_valid)
self.assertIn("Missing required field: sections", errors)
finally:
os.unlink(temp_file)
def test_invalid_field_types(self):
"""Test that invalid field types are caught"""
invalid_types = """
default_max_attempts_per_step: "should_be_integer"
tokens_for_ai_rubric: 123
sections:
- section_id: "test"
title: "Test"
steps: "should_be_list"
"""
temp_file = self.create_temp_yaml(invalid_types)
try:
is_valid, errors, warnings = self.validator.validate_file(temp_file)
self.assertFalse(is_valid)
self.assertTrue(any("must be a positive integer" in error for error in errors))
self.assertTrue(any("must be a string" in error for error in errors))
finally:
os.unlink(temp_file)
def test_duplicate_ids(self):
"""Test that duplicate section and step IDs are caught"""
duplicate_ids = """
sections:
- section_id: "duplicate"
title: "First Section"
steps:
- step_id: "step_duplicate"
title: "First Step"
content_blocks:
- "Content"
- step_id: "step_duplicate"
title: "Second Step"
content_blocks:
- "More content"
- section_id: "duplicate"
title: "Second Section"
steps:
- step_id: "step_1"
title: "Step"
content_blocks:
- "Content"
"""
temp_file = self.create_temp_yaml(duplicate_ids)
try:
is_valid, errors, warnings = self.validator.validate_file(temp_file)
self.assertFalse(is_valid)
self.assertTrue(any("Duplicate section_id" in error for error in errors))
self.assertTrue(any("Duplicate step_id" in error for error in errors))
finally:
os.unlink(temp_file)
def test_terminal_step_validation(self):
"""Test that terminal steps cannot have questions or buckets"""
terminal_with_question = """
sections:
- section_id: "section_1"
title: "Test"
steps:
- step_id: "terminal_step"
title: "Final Step"
question: "This is invalid"
buckets:
- some_bucket
transitions:
some_bucket:
content_blocks:
- "Done"
# No next_section_and_step makes this terminal
"""
temp_file = self.create_temp_yaml(terminal_with_question)
try:
is_valid, errors, warnings = self.validator.validate_file(temp_file)
self.assertFalse(is_valid)
self.assertTrue(any("Final/terminal steps cannot have questions" in error for error in errors))
self.assertTrue(any("Final/terminal steps should not have buckets" in error for error in errors))
finally:
os.unlink(temp_file)
def test_metadata_operations_validation(self):
"""Test validation of metadata operations"""
metadata_test = """
sections:
- section_id: "section_1"
title: "Test"
steps:
- step_id: "step_1"
title: "Test Step"
question: "Test?"
buckets:
- test
transitions:
test:
metadata_clear: "should_be_boolean"
metadata_feedback_filter: "should_be_list"
metadata_remove: 123
metadata_add: "should_be_dict"
next_section_and_step: "section_1:step_2"
- step_id: "step_2"
title: "Final"
content_blocks:
- "Done"
"""
temp_file = self.create_temp_yaml(metadata_test)
try:
is_valid, errors, warnings = self.validator.validate_file(temp_file)
self.assertFalse(is_valid)
self.assertTrue(any("metadata_clear' must be boolean" in error for error in errors))
self.assertTrue(any("metadata_feedback_filter' must be a list" in error for error in errors))
self.assertTrue(any("metadata_remove' must be a string or list of strings" in error for error in errors))
self.assertTrue(any("metadata_add' must be a dictionary" in error for error in errors))
finally:
os.unlink(temp_file)
def test_valid_metadata_operations(self):
"""Test that valid metadata operations pass"""
valid_metadata = """
sections:
- section_id: "section_1"
title: "Test"
steps:
- step_id: "step_1"
title: "Test Step"
question: "Test?"
feedback_tokens_for_ai: "Provide feedback"
buckets:
- test
transitions:
test:
metadata_clear: true
metadata_feedback_filter:
- "field1"
- "field2"
metadata_remove: "single_field"
metadata_add:
new_field: "value"
next_section_and_step: "section_1:step_2"
- step_id: "step_2"
title: "Test Step 2"
question: "Another test?"
buckets:
- test2
transitions:
test2:
metadata_remove:
- "field1"
- "field2"
next_section_and_step: "section_1:step_3"
- step_id: "step_3"
title: "Final"
content_blocks:
- "Done"
"""
temp_file = self.create_temp_yaml(valid_metadata)
try:
is_valid, errors, warnings = self.validator.validate_file(temp_file)
self.assertTrue(is_valid)
self.assertEqual(len(errors), 0)
finally:
os.unlink(temp_file)
def test_python_syntax_validation(self):
"""Test that Python syntax errors in scripts are caught"""
python_syntax_error = """
sections:
- section_id: "section_1"
title: "Test"
steps:
- step_id: "step_1"
title: "Test Step"
question: "Test?"
pre_script: |
if True # Missing colon
print("error")
processing_script: |
def invalid_function(
# Missing closing parenthesis
pass
buckets:
- test
transitions:
test:
next_section_and_step: "section_1:step_2"
- step_id: "step_2"
title: "Final"
content_blocks:
- "Done"
"""
temp_file = self.create_temp_yaml(python_syntax_error)
try:
is_valid, errors, warnings = self.validator.validate_file(temp_file)
self.assertFalse(is_valid)
self.assertTrue(any("Python syntax error" in error for error in errors))
finally:
os.unlink(temp_file)
def test_invalid_transitions(self):
"""Test validation of transition references"""
invalid_transitions = """
sections:
- section_id: "section_1"
title: "Test"
steps:
- step_id: "step_1"
title: "Test Step"
question: "Test?"
buckets:
- valid_bucket
- another_bucket
transitions:
valid_bucket:
next_section_and_step: "nonexistent_section:step_1"
another_bucket:
next_section_and_step: "invalid_format"
unused_transition:
content_blocks:
- "This transition has no corresponding bucket"
"""
temp_file = self.create_temp_yaml(invalid_transitions)
try:
is_valid, errors, warnings = self.validator.validate_file(temp_file)
self.assertFalse(is_valid)
# Should have errors for invalid transition targets and missing transitions
self.assertTrue(any("Invalid transition target" in error for error in errors))
self.assertTrue(any("must be in format 'section_id:step_id'" in error for error in errors))
# Should have warnings for unused transitions
self.assertTrue(any("Unused transition" in warning for warning in warnings))
finally:
os.unlink(temp_file)
def test_metadata_feedback_filter_warning(self):
"""Test warning when metadata_feedback_filter used without feedback_tokens_for_ai"""
metadata_filter_no_feedback = """
sections:
- section_id: "section_1"
title: "Test"
steps:
- step_id: "step_1"
title: "Test Step"
question: "Test?"
buckets:
- test
transitions:
test:
metadata_feedback_filter:
- "field1"
next_section_and_step: "section_1:step_2"
- step_id: "step_2"
title: "Final"
content_blocks:
- "Done"
"""
temp_file = self.create_temp_yaml(metadata_filter_no_feedback)
try:
is_valid, errors, warnings = self.validator.validate_file(temp_file)
self.assertTrue(is_valid) # Should be valid but with warning
self.assertTrue(any("metadata_feedback_filter used but no feedback_tokens_for_ai" in warning for warning in warnings))
finally:
os.unlink(temp_file)
def test_pre_script_warning(self):
"""Test warning when pre_script used without question"""
pre_script_no_question = """
sections:
- section_id: "section_1"
title: "Test"
steps:
- step_id: "step_1"
title: "Test Step"
content_blocks:
- "Content"
pre_script: |
print("This is unusual without a question")
"""
temp_file = self.create_temp_yaml(pre_script_no_question)
try:
is_valid, errors, warnings = self.validator.validate_file(temp_file)
self.assertTrue(is_valid) # Should be valid but with warning
self.assertTrue(any("pre_script typically used with question steps" in warning for warning in warnings))
finally:
os.unlink(temp_file)
def test_empty_else_block_detection(self):
"""Test detection of empty else blocks in Python code"""
empty_else_block = """
sections:
- section_id: "section_1"
title: "Test"
steps:
- step_id: "step_1"
title: "Test Step"
question: "Test?"
processing_script: |
if condition:
do_something()
else:
# Only comments here, should trigger error
buckets:
- test
transitions:
test:
next_section_and_step: "section_1:step_2"
- step_id: "step_2"
title: "Final"
content_blocks:
- "Done"
"""
temp_file = self.create_temp_yaml(empty_else_block)
try:
is_valid, errors, warnings = self.validator.validate_file(temp_file)
# This should detect the empty else block
self.assertTrue(any("'else:' block contains only comments" in error for error in errors))
finally:
os.unlink(temp_file)
def test_content_blocks_validation(self):
"""Test validation of content_blocks structure"""
invalid_content_blocks = """
sections:
- section_id: "section_1"
title: "Test"
steps:
- step_id: "step_1"
title: "Test Step"
content_blocks: "should_be_list"
- step_id: "step_2"
title: "Another Test"
content_blocks:
- "Valid string"
- 123 # Should be string
- "Another valid string"
"""
temp_file = self.create_temp_yaml(invalid_content_blocks)
try:
is_valid, errors, warnings = self.validator.validate_file(temp_file)
self.assertFalse(is_valid)
self.assertTrue(any("content_blocks must be a list" in error for error in errors))
self.assertTrue(any("must be a string" in error for error in errors))
finally:
os.unlink(temp_file)
def test_transition_fields_validation(self):
"""Test validation of various transition fields"""
invalid_transition_fields = """
sections:
- section_id: "section_1"
title: "Test"
steps:
- step_id: "step_1"
title: "Test Step"
question: "Test?"
buckets:
- test
transitions:
test:
run_processing_script: "should_be_boolean"
ai_feedback: "should_be_dict"
content_blocks: "should_be_list"
next_section_and_step: "section_1:step_2"
- step_id: "step_2"
title: "Another Test"
question: "Test?"
buckets:
- test2
transitions:
test2:
ai_feedback:
tokens_for_ai: 123 # Should be string
content_blocks:
- "Valid"
- 456 # Should be string
next_section_and_step: "section_1:step_3"
- step_id: "step_3"
title: "Final"
content_blocks:
- "Done"
"""
temp_file = self.create_temp_yaml(invalid_transition_fields)
try:
is_valid, errors, warnings = self.validator.validate_file(temp_file)
self.assertFalse(is_valid)
self.assertTrue(any("run_processing_script' must be boolean" in error for error in errors))
self.assertTrue(any("ai_feedback' must be a dictionary" in error for error in errors))
self.assertTrue(any("tokens_for_ai must be a string" in error for error in errors))
self.assertTrue(any("content_blocks' must be a list" in error for error in errors))
finally:
os.unlink(temp_file)
def test_using_existing_failing_fixture(self):
"""Test using the existing failing fixture we created"""
fixture_path = "tests/fixtures/test_invalid.yaml"
if os.path.exists(fixture_path):
is_valid, errors, warnings = self.validator.validate_file(fixture_path)
self.assertFalse(is_valid)
self.assertGreater(len(errors), 0)
# Should catch the YAML syntax error we know is in there
self.assertTrue(any("YAML syntax error" in error for error in errors))
def test_cli_integration(self):
"""Test the command line interface"""
import subprocess
import sys
# Test with valid battleship YAML
result = subprocess.run([
sys.executable, "activity_yaml_validator.py",
"research/activity29-battleship.yaml"
], capture_output=True, text=True, cwd=".")
# Should succeed (exit code 0) despite warnings
self.assertEqual(result.returncode, 0)
self.assertIn("valid", result.stdout.lower())
# Test with --strict flag (warnings become errors)
result = subprocess.run([
sys.executable, "activity_yaml_validator.py",
"research/activity29-battleship.yaml", "--strict"
], capture_output=True, text=True, cwd=".")
# Should fail (exit code 1) because warnings become errors in strict mode
self.assertEqual(result.returncode, 1)
if __name__ == '__main__':
# Run the tests
unittest.main(verbosity=2)