Add whale tag mockup for local testing #35
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Implements a Docker-based whale tag simulator that allows developers to test
`ceti whaletag` commands locally without physical hardware. This enables faster
development iteration and automated testing of whale tag data download workflows.
Features:
- Alpine Linux container (~12 MB) with SSH server and test data
- Bridge network mode (default) - works out of the box
- Macvlan mode (advanced) - for LAN discovery testing
- Automated pytest integration with custom marker to exclude tests by default
- Sample test files (audio .raw/.flac, sensors CSV) mimicking real whale tag data
Changes:
- Add Dockerfile.whaletag: Alpine-based image with openssh-server and dhcpcd
- Add docker-compose.whaletag.yml: Container orchestration with network mode support
- Add scripts/init-whaletag.sh: Container initialization (user setup, test data, SSH)
- Add .env.whaletag: Configuration file with three network mode options
- Add tests/test_whaletag_integration.py: 6 integration tests for SSH, SFTP, hostname
- Add pytest.ini: Configure @pytest.mark.whaletag marker to exclude tests by default
- Update Makefile: Add whaletag-up, whaletag-down, whaletag-clean, test-whaletag targets
- Update README.md: Add whale tag simulator quick start guide
- Add docs/TESTING.md: Comprehensive testing documentation
Usage:
make whaletag-up
CONTAINER_IP=$(docker inspect -f '{{range.NetworkSettings.Networks}}{{.IPAddress}}{{end}}' wt-b827eb123456)
ceti whaletag -t $CONTAINER_IP
make whaletag-down
Testing:
make test-whaletag # Automated tests
pytest -m whaletag # Run whale tag tests only
pytest # Default - excludes whale tag tests
Network modes:
- Bridge (default): Container gets Docker IP, accessible from host
- Host: Container shares host network (may conflict with SSH port 22)
- Macvlan (advanced): Container gets real LAN IP via DHCP, discoverable by other machines
Limitations:
- Network discovery (ceti whaletag -l) only works in macvlan mode
- Bridge mode requires direct connection via IP (ceti whaletag -t <IP>)
- Macvlan mode requires manual network interface configuration
Related issue: Enables local development and CI/CD testing without physical whale tags
claymore666
changed the title
Enhances whale tag Docker mockup to generate realistic test data matching whale-tag-embedded source code structure for accurate testing. Changes: - Generate realistic data structure based on whale-tag-embedded source: - Audio: epoch_ms naming (FLAC/raw) - CSV: Single + multi-file datasets with counters - Metadata: timestamped config/tag_info files - Logs: 800k line syslog - False positives: swap/, lost+found/ - Add backup/restore system for quick recovery after cleanup tests - Add Python syslog generator for fast data creation - Add sudo support for cleanup command (ceti whaletag -ct) - Expand tests from 6 to 17 (SFTP, permissions, backup/restore) Total mockup: ~510MB, Image: ~52MB
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #22
Summary
Implements a Docker-based whale tag mockup that allows developers to test
ceti whaletagcommands locally without physical hardware. This enables faster development iteration and automated testing of whale tag data download workflows.Features
ceti whaletag -ctin ~10 secondsUsage
Testing
All 17 whale tag integration tests pass:
Run with:
make test-whaletagDocumentation
See docs/TESTING.md for complete documentation.