StegX Testing Suite

This document provides comprehensive documentation for the StegX testing suite, including setup instructions, test categories, and guidelines for running and extending tests.

Table of Contents

1. Overview
2. Test Directory Structure
3. Setup and Installation
4. Running Tests
5. Test Categories
6. Extending the Test Suite
7. CI/CD Integration
8. Kali Linux Considerations
9. Troubleshooting
10. Contributing

Overview

The StegX testing suite is designed to ensure the reliability, security, and performance of the StegX steganography tool. It includes:

• Unit tests for individual components
• Integration tests for component interactions
• System tests for end-to-end functionality
• Performance tests for resource usage and scalability
• Security tests for cryptographic robustness and vulnerability assessment

Test Directory Structure

tests/
├── __init__.py
├── conftest.py 
├── requirements.txt                   
├── resources/                     
│   ├── images/                    
│   │   ├── valid/                
│   │   └── invalid/               
│   └── files/                    
├── unit/                        
│   ├── __init__.py
│   ├── test_steganography.py      
│   ├── test_crypto.py           
│   └── test_utils.py            
├── integration/               
│   ├── __init__.py
│   └── test_encode_flow.py     
├── system/                       
│   ├── __init__.py
│   └── test_cli.py               
├── performance/                  
│   ├── __init__.py
│   └── test_performance.py       
└── security/                      
    ├── __init__.py
    └── test_security.py                      

Setup and Installation

Prerequisites

• Python 3.8 or higher
• pip package manager
• Kali Linux (recommended for security tests)

Installation

1. Clone the StegX repository:

   git clone https://github.com/Delta-Sec/StegX.git
   cd StegX
   

2. Install StegX and test dependencies:

   pip install -e .
   pip install -r tests/requirements.txt
   

Test Dependencies

The following packages are required for testing:

• pytest
• pytest-cov
• pillow
• numpy
• matplotlib
• memory_profiler (optional, for memory tests)
• hypothesis (optional, for property-based tests)

Running Tests

Running All Tests

pytest tests/

Running Specific Test Categories

pytest tests/unit/

pytest tests/integration/

pytest tests/system/

pytest tests/performance/

pytest tests/security/

Running Specific Test Files

pytest tests/unit/test_steganography.py

pytest tests/system/test_cli.py

Running Tests with Coverage

pytest --cov=stegx_core tests/

pytest --cov=stegx_core --cov-report=html tests/

Test Categories

Unit Tests

Unit tests verify the correctness of individual functions and classes in isolation. They focus on:

• Input validation
• Expected outputs
• Error handling
• Edge cases

See Test Case Explanations for detailed explanations of each unit test.

Integration Tests

Integration tests verify that different components work correctly together. They test:

• Data flow between components
• Component interactions
• End-to-end workflows

System Tests

System tests verify the behavior of the complete application from a user's perspective. They test:

• CLI functionality
• Command-line arguments
• Exit codes and error messages
• End-to-end workflows

Performance Tests

Performance tests measure the efficiency and resource usage of the application. They test:

• Execution time with different file sizes
• Memory usage
• Compression effectiveness
• Scalability with large inputs

Security Tests

Security tests verify the cryptographic robustness and vulnerability resistance of the application. They test:

• Password strength impact
• Cryptographic implementation
• Tamper resistance
• Steganalysis resistance
• Input validation and sanitization

Extending the Test Suite

Adding New Test Cases

1. Identify the appropriate test category and file
2. Follow the existing test patterns
3. Use pytest fixtures for setup and teardown
4. Document the purpose of the test
5. Update test_case_explanations.md with details

Creating New Test Resources

1. Add images to tests/resources/images/
2. Add files to hide in tests/resources/files/
3. Document any special properties of the resources

Adding New Test Categories

1. Create a new directory under tests/
2. Add an __init__.py file
3. Create test files following the naming convention test_*.py
4. Update this README with the new category

CI/CD Integration

GitHub Actions

A sample GitHub Actions workflow is provided in .github/workflows/tests.yml. It:

• Runs on Kali Linux
• Executes all test categories
• Generates coverage reports
• Performs security scans

Jenkins

For Jenkins integration, use the provided Jenkinsfile which:

• Builds a Kali Linux Docker container
• Runs the test suite
• Archives test results and coverage reports

Kali Linux Considerations

StegX is designed for use in Kali Linux environments, which introduces specific testing considerations:

• Security Focus: Tests must verify resistance to common attack vectors
• Tool Integration: Tests should verify compatibility with other Kali tools
• Privilege Handling: Tests must verify behavior with different privilege levels
• Forensic Artifacts: Tests should verify minimal forensic footprint

See Coverage And Kali Considerations for detailed guidance.

Troubleshooting

Common Issues

• Image libraries not found: Install Pillow dependencies

  apt-get install libjpeg-dev zlib1g-dev
  

• Permission errors in Kali: Run with appropriate privileges

  sudo -E pytest tests/security/
  

• Memory errors with large files: Increase available memory or use smaller test files

Getting Help

If you encounter issues not covered here:

1. Check the StegX documentation
2. Open an issue on the GitHub repository
3. Contact to us

Contributing

Contributions to the test suite are welcome! Please:

1. Follow the existing code style
2. Add appropriate documentation
3. Ensure all tests pass
4. Submit a pull request

For major changes, please open an issue first to discuss your proposed changes.

---

This testing suite documentation was last updated on June 12, 2025.