Merge pull request #5 from KemingHe/test/100-coverage/KemingHe

test(tests/*): 100%ed cov and added testing readme

Author: KemingHe

README.md

@@ -96,15 +96,16 @@ streamlit run streamlit_app.py
 Our documentation is structured to help you understand, use, and extend Strain Seer:
 
 - [Understanding 2D Strain](docs/understanding-2d-strain.md): A comprehensive guide to strain analysis fundamentals with clear labeling conventions, visual examples, and numerical calculation walkthroughs
-- [Docker Design](docs/docker-design.md): Detailed information about container deployment, multi-stage builds, security considerations, and container lifecycle management
-- [Version Management](docs/version-management.md): Guidelines for semantic versioning, version bumping process, conventional commit messages, and best practices for release management
 - [Developer Guide](docs/developer-guide.md): Detailed documentation for extending and customizing Strain Seer's core functionality, including core components, customization guides, and dependency management
+- [Testing Strategy](tests/README.md): Our approach to testing, focusing on core strain analysis algorithms and data processing while maintaining a pragmatic balance with UI testing
+- [Version Management](docs/version-management.md): Guidelines for semantic versioning, version bumping process, conventional commit messages, and best practices for release management
+- [Docker Design](docs/docker-design.md): Detailed information about container deployment, multi-stage builds, security considerations, and container lifecycle management
 
 The project also includes automated CI/CD workflows in the `.github/workflows` directory:
 
-- **Unit Tests**: Ensures code quality with pytest and coverage reporting
-- **Build Tests**: Validates Docker builds across multiple platforms (AMD64, ARM64)
-- **Docker Publish**: Automatically publishes versioned images to GitHub Container Registry when releases are created
+- [**Unit Tests**](.github/workflows/unit-test.yaml): Ensures code quality with pytest and coverage reporting
+- [**Build Tests**](.github/workflows/built-test.yaml): Validates Docker builds across multiple platforms (AMD64, ARM64)
+- [**Docker Publish**](.github/workflows/docker-publish.yaml): Automatically publishes versioned images to GitHub Container Registry when releases are created
 
 > [!NOTE]
 >
@@ -120,6 +121,8 @@ While this is primarily a tool for researchers and developers to customize for t
 4. Push to the branch
 5. Create a Pull Request
 
+Please follow our [testing strategy](tests/README.md) to ensure your changes maintain the project's quality standards. We prioritize testing core strain analysis algorithms and data processing functions, while taking a pragmatic approach to UI testing.
+
 All contributions automatically trigger our CI workflows to ensure code quality. For detailed information about the CI/CD pipeline, see the [GitHub Actions workflows documentation](.github/workflows/README.md).
 
 ## 📄 License

poetry.lock

@@ -1,6 +1,6 @@
 [project]
 name = "strain_seer"
-version = "1.0.1"
+version = "1.0.2"
 description = "A Streamlit app for 2D strain analysis using fiducial markers, designed for analyzing material deformation from image sequences."
 license = { file = "LICENSE" }
 readme = "README.md"

pyproject.toml

@@ -45,7 +45,7 @@ class FileData(TypedDict):
 # UI Configuration
 PAGE_CONFIG = {
     "page_title": "Strain Seer - 2D Strain Analysis Tool",
-    "page_icon": "📍",
+    "page_icon": "👁️",
     "layout": "wide",
 }
 

strain_analysis_ui.py

@@ -50,7 +50,7 @@
 )
 
 # Title and description
-st.title("Strain Seer - 2D Strain Analysis Tool")
+st.title("👁️ Strain Seer - 2D Strain Analysis Tool")
 
 # Main description
 st.markdown("""

streamlit_app.py

@@ -0,0 +1,65 @@
+# Testing Strategy
+
+## 🎯 Testing Priorities
+
+### 🔥 High Priority
+
+Core functionality that must be tested:
+
+- Strain analysis algorithms (point normalization, tensor calculations)
+- Data processing (regression analysis, data transformations)
+- Data export/import operations
+
+### ⚪ Low Priority
+
+UI and visual elements that we intentionally skip:
+
+- Main Streamlit app flow
+- Basic UI layout and styling
+- Visual elements (manual testing preferred)
+
+## 📚 Current Test Files
+
+### 🔬 `test_strain_analysis_core.py`
+
+Tests core strain analysis algorithms in `strain_analysis_core.py`:
+
+- Point normalization and scaling: Ensures accurate spatial measurements
+- Strain tensor calculations: Validates deformation analysis
+- Edge cases: Handles invalid inputs and boundary conditions
+
+### 📊 `test_strain_analysis_data.py`
+
+Tests data processing and visualization in `strain_analysis_data.py`:
+
+- Scientific formatting: Ensures consistent number representation
+- Regression analysis: Validates strain trend calculations
+- Data export: Verifies correct data serialization
+- Plot creation: Confirms visualization data integrity
+
+## 🛠️ Running Tests
+
+```shell
+pytest  # Run all tests
+
+pytest --cov tests/  # Run with coverage
+```
+
+## 📝 Best Practices
+
+1. **Test Independence**: Each test should be independent and not rely on other tests
+2. **Clear Test Names**: Use descriptive names that explain the expected behavior
+3. **DRY Principle**: Use fixtures and helper functions to avoid code duplication
+4. **KISS Principle**: Keep tests simple and focused on one aspect
+5. **Meaningful Assertions**: Test behavior, not implementation details
+6. **Edge Cases**: Include tests for boundary conditions and error cases
+
+## 🔄 Adding New Tests
+
+When adding new tests:
+
+1. Follow the existing test structure
+2. Use appropriate fixtures for common test data
+3. Include both positive and negative test cases
+4. Document any special considerations or assumptions
+5. Ensure tests are maintainable and readable

tests/README.md

@@ -1,6 +1,12 @@
+"""Tests for strain analysis core module."""
+
 import numpy as np
 import pytest
-from strain_analysis_core import normalize_points_by_scale, calculate_strain_tensor
+
+from strain_analysis_core import (
+    normalize_points_by_scale,
+    calculate_strain_tensor,
+)
 
 
 def test_normalize_points_by_scale():
@@ -61,3 +67,13 @@ def test_calculate_strain_tensor():
         calculate_strain_tensor(
             original, deformed, center_index=5
         )  # Invalid center index
+
+    # Test case 6: Low rank warning
+    # Create points that will result in a low rank solution
+    low_rank_original = np.array([[0, 0], [1, 0], [1, 0], [0, 0], [0.5, 0]])
+    low_rank_deformed = low_rank_original.copy()
+    low_rank_deformed[:, 0] *= 1.2  # 20% extension in x-direction
+    
+    # This should not raise an error but should trigger the rank warning
+    strain = calculate_strain_tensor(low_rank_original, low_rank_deformed)
+    assert not np.allclose(strain, np.zeros((2, 2)))  # Should still calculate strain

tests/test_strain_analysis_core.py

@@ -2,7 +2,9 @@
 
 import numpy as np
 import pandas as pd
+import pytest
 import matplotlib.pyplot as plt
+
 from strain_analysis_data import (
     format_scientific,
     calculate_regression,
@@ -11,6 +13,7 @@
     create_strain_dataframe,
     export_raw_data,
     export_analysis_results,
+    export_data,
 )
 
 
@@ -159,3 +162,10 @@ def test_export_analysis_results():
     assert isinstance(csv_str, str)
     assert "x_axis" in json_str
     assert "x_axis" in csv_str
+
+
+def test_export_data_unsupported_format():
+    """Test export_data with unsupported format."""
+    data = {"test": "data"}
+    with pytest.raises(ValueError, match="Unsupported format"):
+        export_data(data, format="invalid")