Files
skill-seekers-reference/tests/test_utilities.py
Joseph Magly 0d0eda7149 feat(utils): add retry utilities with exponential backoff (#208)
Add retry_with_backoff() and retry_with_backoff_async() for network operations.

Features:
- Configurable max attempts (default: 3)
- Exponential backoff with configurable base delay
- Operation name for meaningful log messages
- Both sync and async versions

Addresses E2.6: Add retry logic for network failures

Co-authored-by: Joseph Magly <1159087+jmagly@users.noreply.github.com>
2025-12-21 22:31:38 +03:00

339 lines
12 KiB
Python

#!/usr/bin/env python3
"""
Tests for cli/utils.py utility functions
"""
import unittest
import tempfile
import os
import zipfile
from pathlib import Path
import sys
from skill_seekers.cli.utils import (
has_api_key,
get_api_key,
get_upload_url,
format_file_size,
validate_skill_directory,
validate_zip_file,
print_upload_instructions,
retry_with_backoff,
retry_with_backoff_async
)
class TestAPIKeyFunctions(unittest.TestCase):
"""Test API key utility functions"""
def setUp(self):
"""Store original API key state"""
self.original_api_key = os.environ.get('ANTHROPIC_API_KEY')
def tearDown(self):
"""Restore original API key state"""
if self.original_api_key:
os.environ['ANTHROPIC_API_KEY'] = self.original_api_key
elif 'ANTHROPIC_API_KEY' in os.environ:
del os.environ['ANTHROPIC_API_KEY']
def test_has_api_key_when_set(self):
"""Test has_api_key returns True when key is set"""
os.environ['ANTHROPIC_API_KEY'] = 'sk-ant-test-key'
self.assertTrue(has_api_key())
def test_has_api_key_when_not_set(self):
"""Test has_api_key returns False when key is not set"""
if 'ANTHROPIC_API_KEY' in os.environ:
del os.environ['ANTHROPIC_API_KEY']
self.assertFalse(has_api_key())
def test_has_api_key_when_empty_string(self):
"""Test has_api_key returns False when key is empty string"""
os.environ['ANTHROPIC_API_KEY'] = ''
self.assertFalse(has_api_key())
def test_has_api_key_when_whitespace_only(self):
"""Test has_api_key returns False when key is whitespace"""
os.environ['ANTHROPIC_API_KEY'] = ' '
self.assertFalse(has_api_key())
def test_get_api_key_returns_key(self):
"""Test get_api_key returns the actual key"""
os.environ['ANTHROPIC_API_KEY'] = 'sk-ant-test-key'
self.assertEqual(get_api_key(), 'sk-ant-test-key')
def test_get_api_key_returns_none_when_not_set(self):
"""Test get_api_key returns None when not set"""
if 'ANTHROPIC_API_KEY' in os.environ:
del os.environ['ANTHROPIC_API_KEY']
self.assertIsNone(get_api_key())
def test_get_api_key_strips_whitespace(self):
"""Test get_api_key strips whitespace from key"""
os.environ['ANTHROPIC_API_KEY'] = ' sk-ant-test-key '
self.assertEqual(get_api_key(), 'sk-ant-test-key')
class TestGetUploadURL(unittest.TestCase):
"""Test get_upload_url function"""
def test_get_upload_url_returns_correct_url(self):
"""Test get_upload_url returns the correct Claude skills URL"""
url = get_upload_url()
self.assertEqual(url, "https://claude.ai/skills")
def test_get_upload_url_returns_string(self):
"""Test get_upload_url returns a string"""
url = get_upload_url()
self.assertIsInstance(url, str)
class TestFormatFileSize(unittest.TestCase):
"""Test format_file_size function"""
def test_format_bytes_below_1kb(self):
"""Test formatting bytes below 1 KB"""
self.assertEqual(format_file_size(500), "500 bytes")
self.assertEqual(format_file_size(1023), "1023 bytes")
def test_format_kilobytes(self):
"""Test formatting KB sizes"""
self.assertEqual(format_file_size(1024), "1.0 KB")
self.assertEqual(format_file_size(1536), "1.5 KB")
self.assertEqual(format_file_size(10240), "10.0 KB")
def test_format_megabytes(self):
"""Test formatting MB sizes"""
self.assertEqual(format_file_size(1048576), "1.0 MB")
self.assertEqual(format_file_size(1572864), "1.5 MB")
self.assertEqual(format_file_size(10485760), "10.0 MB")
def test_format_zero_bytes(self):
"""Test formatting zero bytes"""
self.assertEqual(format_file_size(0), "0 bytes")
def test_format_large_files(self):
"""Test formatting large file sizes"""
# 100 MB
self.assertEqual(format_file_size(104857600), "100.0 MB")
# 1 GB (still shows as MB)
self.assertEqual(format_file_size(1073741824), "1024.0 MB")
class TestValidateSkillDirectory(unittest.TestCase):
"""Test validate_skill_directory function"""
def test_valid_skill_directory(self):
"""Test validation of valid skill directory"""
with tempfile.TemporaryDirectory() as tmpdir:
skill_dir = Path(tmpdir) / "test-skill"
skill_dir.mkdir()
(skill_dir / "SKILL.md").write_text("# Test Skill")
is_valid, error = validate_skill_directory(skill_dir)
self.assertTrue(is_valid)
self.assertIsNone(error)
def test_nonexistent_directory(self):
"""Test validation of nonexistent directory"""
is_valid, error = validate_skill_directory("/nonexistent/path")
self.assertFalse(is_valid)
self.assertIn("not found", error.lower())
def test_file_instead_of_directory(self):
"""Test validation when path is a file"""
with tempfile.NamedTemporaryFile() as tmpfile:
is_valid, error = validate_skill_directory(tmpfile.name)
self.assertFalse(is_valid)
self.assertIn("not a directory", error.lower())
def test_directory_without_skill_md(self):
"""Test validation of directory without SKILL.md"""
with tempfile.TemporaryDirectory() as tmpdir:
is_valid, error = validate_skill_directory(tmpdir)
self.assertFalse(is_valid)
self.assertIn("SKILL.md not found", error)
class TestValidateZipFile(unittest.TestCase):
"""Test validate_zip_file function"""
def test_valid_zip_file(self):
"""Test validation of valid .zip file"""
with tempfile.TemporaryDirectory() as tmpdir:
zip_path = Path(tmpdir) / "test-skill.zip"
# Create a real zip file
with zipfile.ZipFile(zip_path, 'w') as zf:
zf.writestr("SKILL.md", "# Test")
is_valid, error = validate_zip_file(zip_path)
self.assertTrue(is_valid)
self.assertIsNone(error)
def test_nonexistent_file(self):
"""Test validation of nonexistent file"""
is_valid, error = validate_zip_file("/nonexistent/file.zip")
self.assertFalse(is_valid)
self.assertIn("not found", error.lower())
def test_directory_instead_of_file(self):
"""Test validation when path is a directory"""
with tempfile.TemporaryDirectory() as tmpdir:
is_valid, error = validate_zip_file(tmpdir)
self.assertFalse(is_valid)
self.assertIn("not a file", error.lower())
def test_wrong_extension(self):
"""Test validation of file with wrong extension"""
with tempfile.NamedTemporaryFile(suffix='.txt') as tmpfile:
is_valid, error = validate_zip_file(tmpfile.name)
self.assertFalse(is_valid)
self.assertIn("not a .zip file", error.lower())
class TestPrintUploadInstructions(unittest.TestCase):
"""Test print_upload_instructions function"""
def test_print_upload_instructions_runs(self):
"""Test that print_upload_instructions executes without error"""
with tempfile.TemporaryDirectory() as tmpdir:
zip_path = Path(tmpdir) / "test.zip"
zip_path.write_text("")
# Should not raise exception
try:
print_upload_instructions(zip_path)
except Exception as e:
self.fail(f"print_upload_instructions raised {e}")
def test_print_upload_instructions_accepts_string_path(self):
"""Test print_upload_instructions accepts string path"""
with tempfile.TemporaryDirectory() as tmpdir:
zip_path = str(Path(tmpdir) / "test.zip")
Path(zip_path).write_text("")
try:
print_upload_instructions(zip_path)
except Exception as e:
self.fail(f"print_upload_instructions raised {e}")
class TestRetryWithBackoff(unittest.TestCase):
"""Test retry_with_backoff function"""
def test_successful_operation_first_try(self):
"""Test operation that succeeds on first try"""
call_count = 0
def operation():
nonlocal call_count
call_count += 1
return "success"
result = retry_with_backoff(operation, max_attempts=3)
self.assertEqual(result, "success")
self.assertEqual(call_count, 1)
def test_successful_operation_after_retry(self):
"""Test operation that fails once then succeeds"""
call_count = 0
def operation():
nonlocal call_count
call_count += 1
if call_count < 2:
raise ConnectionError("Temporary failure")
return "success"
result = retry_with_backoff(operation, max_attempts=3, base_delay=0.01)
self.assertEqual(result, "success")
self.assertEqual(call_count, 2)
def test_all_retries_fail(self):
"""Test operation that fails all retries"""
call_count = 0
def operation():
nonlocal call_count
call_count += 1
raise ConnectionError("Persistent failure")
with self.assertRaises(ConnectionError):
retry_with_backoff(operation, max_attempts=3, base_delay=0.01)
self.assertEqual(call_count, 3)
def test_exponential_backoff_timing(self):
"""Test that delays follow exponential pattern"""
import time
call_times = []
def operation():
call_times.append(time.time())
if len(call_times) < 3:
raise ConnectionError("Fail")
return "success"
retry_with_backoff(operation, max_attempts=3, base_delay=0.1)
# Check that delays are increasing (exponential)
# First delay: ~0.1s, Second delay: ~0.2s
delay1 = call_times[1] - call_times[0]
delay2 = call_times[2] - call_times[1]
self.assertGreater(delay1, 0.05) # First delay at least base_delay/2
self.assertGreater(delay2, delay1 * 1.5) # Second should be ~2x first
class TestRetryWithBackoffAsync(unittest.TestCase):
"""Test retry_with_backoff_async function"""
def test_async_successful_operation(self):
"""Test async operation that succeeds"""
import asyncio
async def operation():
return "async success"
result = asyncio.run(
retry_with_backoff_async(operation, max_attempts=3)
)
self.assertEqual(result, "async success")
def test_async_retry_then_success(self):
"""Test async operation that fails then succeeds"""
import asyncio
call_count = 0
async def operation():
nonlocal call_count
call_count += 1
if call_count < 2:
raise ConnectionError("Async failure")
return "async success"
result = asyncio.run(
retry_with_backoff_async(operation, max_attempts=3, base_delay=0.01)
)
self.assertEqual(result, "async success")
self.assertEqual(call_count, 2)
def test_async_all_retries_fail(self):
"""Test async operation that fails all retries"""
import asyncio
async def operation():
raise ConnectionError("Persistent async failure")
with self.assertRaises(ConnectionError):
asyncio.run(
retry_with_backoff_async(operation, max_attempts=2, base_delay=0.01)
)
if __name__ == '__main__':
unittest.main()