Skip to content

Commit f3eb248

Browse files
[cueman] Add comprehensive test infrastructure and update documentation for cueman
- Fix pylint issues in `test_integration_workflows.py` * Add module docstring and fix import style * Remove trailing whitespace and add proper spacing * Achieve 10/10 pylint rating - Fix SystemExit test failures in integration tests: * Update test_batch_operation_workflow to use comma-separated job format * Mock displayLayers function properly in workflow tests * Remove incorrect SystemExit expectations where not applicable * All tests now pass successfully - Add pytest and test dependencies to pyproject.toml: * Add test optional dependencies: pytest, pytest-cov, pytest-mock, mock, pyfakefs * Add dev optional dependencies including pylint, black, isort * Configure pytest.ini_options with test discovery and execution settings * Add coverage configuration with HTML/XML report generation * Include test markers for unit, integration, and slow tests - Create test infrastructure tools: * Add `run_tests.sh` convenience script for running tests with coverage options * Add `tox.ini` for multi-Python version testing and code quality checks * Include GitHub Actions workflow example in pyproject.toml comments - Update documentation comprehensively: * Enhance README.md with detailed testing section covering tests * Add test infrastructure description and development workflow * Update docs/reference/tools/cueman.md with development and testing section * Enhance docs/tutorials/cueman-tutorial.md with contribution information - Improve development experience: * Document coverage reporting capabilities * Provide clear testing and development guidelines * Include CI/CD integration documentation * Add code quality tool usage instructions All tests pass with comprehensive coverage reporting and lint-free code.
2 parents 3d54b04 + 658002d commit f3eb248

File tree

5 files changed

+12
-36
lines changed

5 files changed

+12
-36
lines changed

cueman/README.md

Lines changed: 8 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -391,7 +391,7 @@ cueman -v -info job_name # Enable verbose logging
391391

392392
## Running Tests
393393

394-
Cueman includes a comprehensive test suite with 42+ tests covering unit tests and integration workflows.
394+
Cueman includes a comprehensive test suite with tests covering unit tests and integration workflows.
395395

396396
### Quick Start
397397

@@ -409,11 +409,11 @@ pytest --cov=cueman --cov-report=term-missing
409409
### Test Infrastructure
410410

411411
**Test Dependencies:**
412-
- `pytest>=8.0.0` - Modern test framework
413-
- `pytest-cov>=4.0.0` - Coverage reporting
414-
- `pytest-mock>=3.10.0` - Enhanced mocking
415-
- `mock>=4.0.0` - Core mocking library
416-
- `pyfakefs>=5.2.3` - Filesystem mocking
412+
- `pytest` - Modern test framework
413+
- `pytest` - Coverage reporting
414+
- `pytest-mock` - Enhanced mocking
415+
- `mock` - Core mocking library
416+
- `pyfakefs` - Filesystem mocking
417417

418418
**Test Types:**
419419
- **Unit tests** - Function-level testing (`tests/test_main.py`)
@@ -540,8 +540,6 @@ Source code available in /opt/opencue/cueman/
540540

541541
## Contributing
542542

543-
We welcome contributions to Cueman! The project includes comprehensive development infrastructure:
544-
545543
### Development Setup
546544

547545
```bash
@@ -556,7 +554,7 @@ pip install -e ".[dev]"
556554
### Testing and Quality
557555

558556
```bash
559-
# Run comprehensive test suite (42+ tests)
557+
# Run comprehensive test suite (tests)
560558
pytest --cov=cueman --cov-report=term-missing
561559

562560
# Code formatting and linting
@@ -565,21 +563,4 @@ pylint cueman tests
565563

566564
# Multi-environment testing
567565
tox
568-
```
569-
570-
### Project Quality
571-
572-
- **Comprehensive test coverage** with unit and integration tests
573-
- **Modern testing infrastructure** using pytest, coverage, and CI/CD
574-
- **Code quality tools** including pylint, black, and isort
575-
- **Multi-Python version support** via tox
576-
- **Docker support** for containerized development
577-
578-
For detailed contribution guidelines, see [CONTRIBUTING.md](CONTRIBUTING.md).
579-
580-
### Get Involved
581-
582-
- **Report Issues**: [GitHub Issues](https://github.com/AcademySoftwareFoundation/OpenCue/issues)
583-
- **Contribute Code**: Submit pull requests with tests and documentation
584-
- **Improve Documentation**: Help enhance tutorials and reference docs
585-
- **Share Use Cases**: Contribute real-world examples and workflows
566+
```

cueman/run_tests.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,4 +58,4 @@ fi
5858

5959
echo "Running: $CMD"
6060
echo "----------------------------------------"
61-
$CMD
61+
$CMD

cueman/tox.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,4 @@ deps =
4242
isort>=5.12.0
4343
commands =
4444
black --check cueman tests
45-
isort --check cueman tests
45+
isort --check cueman tests

docs/_docs/reference/tools/cueman.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -419,7 +419,7 @@ cueman # Running without args shows help
419419

420420
### Running Tests
421421

422-
Cueman includes a comprehensive test suite with 42+ tests:
422+
Cueman includes a comprehensive test suite:
423423

424424
```bash
425425
# Install with test dependencies
@@ -461,5 +461,3 @@ The test suite is integrated into:
461461
## Additional Resources
462462

463463
- [Cueman Tutorial](/docs/tutorials/cueman-tutorial/) - Tutorial with real-world scenarios
464-
- [Cueman GitHub](https://github.com/AcademySoftwareFoundation/OpenCue/tree/master/cueman) - Source code and documentation
465-
- [OpenCue Documentation](/docs/) - Complete OpenCue documentation

docs/_docs/tutorials/cueman-tutorial.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -480,12 +480,11 @@ Cueman provides capabilities for OpenCue management. Start with simple operation
480480
- Practice with test jobs before using on production
481481
- Create scripts combining Cueman commands for automated workflows
482482
- Learn about [Cueman development and testing](/docs/reference/tools/cueman/#development-and-testing) if you want to contribute
483-
- Continue to the [Developer Guide](/docs/developer-guide/) to learn about contributing to OpenCue
484483

485484
## Development and Contributing
486485

487486
Cueman is actively developed with:
488-
- **Comprehensive test suite** with 42+ tests covering unit and integration scenarios
487+
- **Comprehensive test suite** covering unit and integration scenarios
489488
- **Modern testing infrastructure** using pytest, coverage reporting, and CI/CD integration
490489
- **Development tools** including linting, formatting, and multi-Python version testing
491490

@@ -502,5 +501,3 @@ pytest --cov=cueman --cov-report=term-missing
502501
black cueman tests && isort cueman tests
503502
pylint cueman tests
504503
```
505-
506-
See the [Cueman CONTRIBUTING.md](https://github.com/AcademySoftwareFoundation/OpenCue/blob/master/cueman/CONTRIBUTING.md) for detailed development guidelines.

0 commit comments

Comments
 (0)