Skip to content

Drop in a screenshot and convert it to clean code (HTML/Tailwind/React/Vue)

Python

Add pytest setup and remove standalone test script

Abi Raja825552761fdb
diff --git a/TESTING.md b/TESTING.md
new file mode 100644
index 00000000..3196d539
--- /dev/null
+++ b/TESTING.md
@@ -0,0 +1,79 @@
+# Testing Guide
+
+This guide explains how to run tests for the Screenshot to Code project.
+
+## Backend Tests
+
+The backend uses pytest for testing. All tests are located in the `backend/tests` directory.
+
+### Prerequisites
+
+Make sure you have Poetry installed and have installed all dependencies:
+
+```bash
+cd backend
+poetry install
+```
+
+### Running Tests
+
+#### Run all tests
+```bash
+cd backend
+poetry run pytest
+```
+
+#### Run tests with verbose output
+```bash
+poetry run pytest -vv
+```
+
+#### Run a specific test file
+```bash
+poetry run pytest tests/test_screenshot.py
+```
+
+#### Run a specific test class
+```bash
+poetry run pytest tests/test_screenshot.py::TestNormalizeUrl
+```
+
+#### Run a specific test method
+```bash
+poetry run pytest tests/test_screenshot.py::TestNormalizeUrl::test_url_without_protocol
+```
+
+#### Run tests with coverage report
+```bash
+poetry run pytest --cov=routes
+```
+
+#### Run tests in parallel (requires pytest-xdist)
+```bash
+poetry install --with dev pytest-xdist # Install if not already installed
+poetry run pytest -n auto
+```
+
+### Test Configuration
+
+The pytest configuration is defined in `backend/pytest.ini`:
+- Tests are discovered in the `tests` directory
+- Test files must match the pattern `test_*.py`
+- Test classes must start with `Test`
+- Test functions must start with `test_`
+- Verbose output and short traceback format are enabled by default
+
+### Writing New Tests
+
+1. Create a new test file in `backend/tests/` following the naming convention `test_<module>.py`
+2. Import the functions/classes you want to test
+3. Write test functions or classes following pytest conventions
+
+Example:
+```python
+import pytest
+from routes.screenshot import normalize_url
+
+def test_url_normalization():
+ assert normalize_url("example.com") == "https://example.com"
+```
diff --git a/backend/pytest.ini b/backend/pytest.ini
new file mode 100644
index 00000000..9855d94e
--- /dev/null
+++ b/backend/pytest.ini
@@ -0,0 +1,6 @@
+[pytest]
+testpaths = tests
+python_files = test_*.py
+python_classes = Test*
+python_functions = test_*
+addopts = -v --tb=short
diff --git a/backend/test_url_normalization.py b/backend/test_url_normalization.py
deleted file mode 100644
index 37e34637..00000000
--- a/backend/test_url_normalization.py
+++ /dev/null
@@ -1,148 +0,0 @@
-#!/usr/bin/env python3
-"""
-Test script for URL normalization functionality.
-Run with: python test_url_normalization.py
-"""
-
-import sys
-from urllib.parse import urlparse
-
-
-def normalize_url(url: str) -> str:
- """
- Normalize URL to ensure it has a proper protocol.
- If no protocol is specified, default to https://
- """
- url = url.strip()
-
- # Parse the URL
- parsed = urlparse(url)
-
- # Check if we have a scheme
- if not parsed.scheme:
- # No scheme, add https://
- url = f"https://{url}"
- elif parsed.scheme in ['http', 'https']:
- # Valid scheme, keep as is
- pass
- else:
- # Check if this might be a domain with port (like example.com:8080)
- # urlparse treats this as scheme:netloc, but we want to handle it as domain:port
- if ':' in url and not url.startswith(('http://', 'https://', 'ftp://', 'file://')):
- # Likely a domain:port without protocol
- url = f"https://{url}"
- else:
- # Invalid protocol
- raise ValueError(f"Unsupported protocol: {parsed.scheme}")
-
- return url
-
-
-def test_url_without_protocol():
- print("Testing URLs without protocol...")
- assert normalize_url("example.com") == "https://example.com"
- assert normalize_url("www.example.com") == "https://www.example.com"
- assert normalize_url("subdomain.example.com") == "https://subdomain.example.com"
- print("✓ URLs without protocol: PASSED")
-
-
-def test_url_with_http_protocol():
- print("Testing URLs with HTTP protocol...")
- assert normalize_url("http://example.com") == "http://example.com"
- assert normalize_url("http://www.example.com") == "http://www.example.com"
- print("✓ URLs with HTTP protocol: PASSED")
-
-
-def test_url_with_https_protocol():
- print("Testing URLs with HTTPS protocol...")
- assert normalize_url("https://example.com") == "https://example.com"
- assert normalize_url("https://www.example.com") == "https://www.example.com"
- print("✓ URLs with HTTPS protocol: PASSED")
-
-
-def test_url_with_path_and_params():
- print("Testing URLs with paths and parameters...")
- assert normalize_url("example.com/path") == "https://example.com/path"
- assert normalize_url("example.com/path?param=value") == "https://example.com/path?param=value"
- assert normalize_url("example.com:8080/path") == "https://example.com:8080/path"
- print("✓ URLs with paths and parameters: PASSED")
-
-
-def test_url_with_whitespace():
- print("Testing URLs with whitespace...")
- assert normalize_url(" example.com ") == "https://example.com"
- assert normalize_url("\texample.com\n") == "https://example.com"
- print("✓ URLs with whitespace: PASSED")
-
-
-def test_invalid_protocols():
- print("Testing invalid protocols...")
- try:
- normalize_url("ftp://example.com")
- assert False, "Should have raised ValueError for ftp protocol"
- except ValueError as e:
- assert "Unsupported protocol: ftp" in str(e)
-
- try:
- normalize_url("file:///path/to/file")
- assert False, "Should have raised ValueError for file protocol"
- except ValueError as e:
- assert "Unsupported protocol: file" in str(e)
-
- print("✓ Invalid protocols: PASSED")
-
-
-def test_localhost_urls():
- print("Testing localhost URLs...")
- assert normalize_url("localhost") == "https://localhost"
- assert normalize_url("localhost:3000") == "https://localhost:3000"
- assert normalize_url("http://localhost:8080") == "http://localhost:8080"
- print("✓ Localhost URLs: PASSED")
-
-
-def test_ip_address_urls():
- print("Testing IP address URLs...")
- assert normalize_url("192.168.1.1") == "https://192.168.1.1"
- assert normalize_url("192.168.1.1:8080") == "https://192.168.1.1:8080"
- assert normalize_url("http://192.168.1.1") == "http://192.168.1.1"
- print("✓ IP address URLs: PASSED")
-
-
-def test_complex_urls():
- print("Testing complex URLs...")
- assert normalize_url("example.com/path/to/page.html#section") == "https://example.com/path/to/page.html#section"
- assert normalize_url("user:[email protected]") == "https://user:[email protected]"
- assert normalize_url("example.com?q=search&lang=en") == "https://example.com?q=search&lang=en"
- print("✓ Complex URLs: PASSED")
-
-
-def run_all_tests():
- print("Running URL normalization tests...\n")
-
- tests = [
- test_url_without_protocol,
- test_url_with_http_protocol,
- test_url_with_https_protocol,
- test_url_with_path_and_params,
- test_url_with_whitespace,
- test_invalid_protocols,
- test_localhost_urls,
- test_ip_address_urls,
- test_complex_urls
- ]
-
- for test in tests:
- try:
- test()
- except Exception as e:
- print(f"✗ {test.__name__}: FAILED")
- print(f" Error: {e}")
- return False
-
- print("\n✅ All tests passed!")
- return True
-
-
-if __name__ == "__main__":
- success = run_all_tests()
- sys.exit(0 if success else 1)
diff --git a/backend/tests/__init__.py b/backend/tests/__init__.py
new file mode 100644
index 00000000..e69de29b
diff --git a/backend/tests/test_screenshot.py b/backend/tests/test_screenshot.py
new file mode 100644
index 00000000..ba144da1
--- /dev/null
+++ b/backend/tests/test_screenshot.py
@@ -0,0 +1,59 @@
+import pytest
+from routes.screenshot import normalize_url
+
+
+class TestNormalizeUrl:
+ """Test cases for URL normalization functionality."""
+
+ def test_url_without_protocol(self):
+ """Test that URLs without protocol get https:// added."""
+ assert normalize_url("example.com") == "https://example.com"
+ assert normalize_url("www.example.com") == "https://www.example.com"
+ assert normalize_url("subdomain.example.com") == "https://subdomain.example.com"
+
+ def test_url_with_http_protocol(self):
+ """Test that existing http protocol is preserved."""
+ assert normalize_url("http://example.com") == "http://example.com"
+ assert normalize_url("http://www.example.com") == "http://www.example.com"
+
+ def test_url_with_https_protocol(self):
+ """Test that existing https protocol is preserved."""
+ assert normalize_url("https://example.com") == "https://example.com"
+ assert normalize_url("https://www.example.com") == "https://www.example.com"
+
+ def test_url_with_path_and_params(self):
+ """Test URLs with paths and query parameters."""
+ assert normalize_url("example.com/path") == "https://example.com/path"
+ assert normalize_url("example.com/path?param=value") == "https://example.com/path?param=value"
+ assert normalize_url("example.com:8080/path") == "https://example.com:8080/path"
+
+ def test_url_with_whitespace(self):
+ """Test that whitespace is stripped."""
+ assert normalize_url(" example.com ") == "https://example.com"
+ assert normalize_url("\texample.com\n") == "https://example.com"
+
+ def test_invalid_protocols(self):
+ """Test that unsupported protocols raise ValueError."""
+ with pytest.raises(ValueError, match="Unsupported protocol: ftp"):
+ normalize_url("ftp://example.com")
+
+ with pytest.raises(ValueError, match="Unsupported protocol: file"):
+ normalize_url("file:///path/to/file")
+
+ def test_localhost_urls(self):
+ """Test localhost URLs."""
+ assert normalize_url("localhost") == "https://localhost"
+ assert normalize_url("localhost:3000") == "https://localhost:3000"
+ assert normalize_url("http://localhost:8080") == "http://localhost:8080"
+
+ def test_ip_address_urls(self):
+ """Test IP address URLs."""
+ assert normalize_url("192.168.1.1") == "https://192.168.1.1"
+ assert normalize_url("192.168.1.1:8080") == "https://192.168.1.1:8080"
+ assert normalize_url("http://192.168.1.1") == "http://192.168.1.1"
+
+ def test_complex_urls(self):
+ """Test more complex URL scenarios."""
+ assert normalize_url("example.com/path/to/page.html#section") == "https://example.com/path/to/page.html#section"
+ assert normalize_url("user:[email protected]") == "https://user:[email protected]"
+ assert normalize_url("example.com?q=search&lang=en") == "https://example.com?q=search&lang=en"