external-repos/ivatar
1
0
Fork 0
mirror of https://git.linux-kernel.at/oliver/ivatar.git synced 2025-11-11 18:56:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update test scripts and documentation for simplified OpenTelemetry approach

Browse Source 
- Update all test scripts to use OTEL_EXPORT_ENABLED instead of legacy flags
- Remove references to deprecated ENABLE_OPENTELEMETRY and OTEL_ENABLED
- Simplify run_tests_local.sh to use --exclude-tag=bluesky
- Update documentation to reflect instrumentation always enabled
- Remove legacy configuration section from README.md

All scripts now use the new approach where:
- OpenTelemetry instrumentation is always enabled
- Only data export is controlled by OTEL_EXPORT_ENABLED flag
- Cleaner configuration with single export control flag
This commit is contained in:
Oliver Falk
2025-10-17 11:00:04 +02:00
parent 2eb38445d7
commit dcdbc6b608
5 changed files with 35 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@@ -30,11 +30,6 @@ OpenTelemetry instrumentation is always enabled in ivatar. The following environ
- Example: "http://localhost:4317" (gRPC) or "http://localhost:4318" (HTTP) - Example: "http://localhost:4317" (gRPC) or "http://localhost:4318" (HTTP)
- `OTEL_PROMETHEUS_ENDPOINT`: Prometheus metrics endpoint (default: "0.0.0.0:9464") - `OTEL_PROMETHEUS_ENDPOINT`: Prometheus metrics endpoint (default: "0.0.0.0:9464")
### Legacy Configuration (Deprecated)
- `ENABLE_OPENTELEMETRY`: Legacy flag, no longer used (instrumentation always enabled)
- `OTEL_ENABLED`: Legacy flag, no longer used (instrumentation always enabled)
## Example Configurations ## Example Configurations
### Development (Export Disabled) ### Development (Export Disabled)

35
scripts/run_tests_local.sh
View File

@@ -1,27 +1,19 @@
#!/bin/bash #!/bin/bash
# Run tests locally, skipping Bluesky tests that require external API credentials # Run tests locally, skipping Bluesky tests that require external API credentials
# OpenTelemetry is disabled by default for local testing # OpenTelemetry instrumentation is always enabled, but export is disabled for local testing
echo "Running tests locally (skipping Bluesky tests, OpenTelemetry disabled)..." echo "Running tests locally (skipping Bluesky tests, OpenTelemetry export disabled)..."
echo "=======================================================================" echo "============================================================================="
# Ensure OpenTelemetry is disabled for local testing # OpenTelemetry instrumentation is always enabled, but disable export for local testing
export ENABLE_OPENTELEMETRY=false export OTEL_EXPORT_ENABLED=false
export OTEL_ENABLED=false export OTEL_SERVICE_NAME=ivatar-local
export OTEL_ENVIRONMENT=development
# Run Django tests excluding the Bluesky test file and OpenTelemetry tests # Run Django tests excluding Bluesky tests (OpenTelemetry tests are included)
python3 manage.py test \ python3 manage.py test \
ivatar.ivataraccount.test_auth \ --exclude-tag=bluesky \
ivatar.ivataraccount.test_views \ -v2
ivatar.test_auxiliary \
ivatar.test_file_security \
ivatar.test_static_pages \
ivatar.test_utils \
ivatar.test_views \
ivatar.test_views_stats \
ivatar.tools.test_views \
ivatar.test_wsgi \
-v3
echo "" echo ""
echo "To run all tests including Bluesky (requires API credentials):" echo "To run all tests including Bluesky (requires API credentials):"
@@ -30,8 +22,7 @@ echo ""
echo "To run only Bluesky tests:" echo "To run only Bluesky tests:"
echo "python3 manage.py test ivatar.ivataraccount.test_views_bluesky -v3" echo "python3 manage.py test ivatar.ivataraccount.test_views_bluesky -v3"
echo "" echo ""
echo "To run tests with OpenTelemetry enabled:" echo "To run tests with OpenTelemetry export enabled:"
echo "./run_tests_with_ot.sh" echo "OTEL_EXPORT_ENABLED=true python3 manage.py test -v2"
echo "" echo ""
echo "To run tests without OpenTelemetry (default):" echo "Note: OpenTelemetry instrumentation is always enabled. Only export is controlled by OTEL_EXPORT_ENABLED."
echo "./run_tests_no_ot.sh"

15
scripts/run_tests_no_ot.sh
View File

@@ -1,18 +1,19 @@
#!/bin/bash #!/bin/bash
# Run tests without OpenTelemetry enabled (default mode) # Run tests with OpenTelemetry instrumentation enabled but export disabled
# This is the default test mode for most users # This is the default test mode for most users
set -e set -e
echo "Running tests without OpenTelemetry (default mode)..." echo "Running tests with OpenTelemetry instrumentation (export disabled)..."
echo "=====================================================" echo "===================================================================="
# Ensure OpenTelemetry is disabled # OpenTelemetry instrumentation is always enabled, but disable export for testing
export ENABLE_OPENTELEMETRY=false export OTEL_EXPORT_ENABLED=false
export OTEL_ENABLED=false export OTEL_SERVICE_NAME=ivatar-test
export OTEL_ENVIRONMENT=test
# Run Django tests (Django will auto-discover all tests) # Run Django tests (Django will auto-discover all tests)
python3 manage.py test -v3 python3 manage.py test -v3
echo "" echo ""
echo "Tests completed successfully (OpenTelemetry disabled)" echo "Tests completed successfully (OpenTelemetry instrumentation enabled, export disabled)"

15
scripts/run_tests_with_coverage.py
View File

@@ -1,7 +1,7 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
""" """
Run tests with OpenTelemetry enabled and coverage measurement. Run tests with OpenTelemetry instrumentation and export enabled, plus coverage measurement.
This script is designed to be used with 'coverage run' command. This script is designed to be used with 'coverage run' command.
""" """
@@ -13,14 +13,13 @@ from django.test.utils import get_runner
def main(): def main():
# Enable OpenTelemetry # Enable OpenTelemetry instrumentation and export
os.environ["ENABLE_OPENTELEMETRY"] = "true" os.environ["OTEL_EXPORT_ENABLED"] = "true"
os.environ["OTEL_ENABLED"] = "true"
os.environ["OTEL_SERVICE_NAME"] = "ivatar-test" os.environ["OTEL_SERVICE_NAME"] = "ivatar-test"
os.environ["OTEL_ENVIRONMENT"] = "test" os.environ["OTEL_ENVIRONMENT"] = "test"
print("Running tests with OpenTelemetry enabled...") print("Running tests with OpenTelemetry instrumentation and export enabled...")
print("==========================================") print("====================================================================")
# Add current directory to Python path # Add current directory to Python path
sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__)))) sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
@@ -41,7 +40,9 @@ def main():
return 1 return 1
else: else:
print("") print("")
print("Tests completed successfully (OpenTelemetry enabled)") print(
"Tests completed successfully (OpenTelemetry instrumentation and export enabled)"
)
return 0 return 0

13
scripts/run_tests_with_ot.sh
View File

@@ -1,15 +1,14 @@
#!/bin/bash #!/bin/bash
# Run tests with OpenTelemetry enabled # Run tests with OpenTelemetry instrumentation and export enabled
# This is used in CI to test OpenTelemetry functionality # This is used in CI to test OpenTelemetry functionality
set -e set -e
echo "Running tests with OpenTelemetry enabled..." echo "Running tests with OpenTelemetry instrumentation and export enabled..."
echo "==========================================" echo "===================================================================="
# Enable OpenTelemetry # Enable OpenTelemetry instrumentation and export
export ENABLE_OPENTELEMETRY=true export OTEL_EXPORT_ENABLED=true
export OTEL_ENABLED=true
export OTEL_SERVICE_NAME=ivatar-test export OTEL_SERVICE_NAME=ivatar-test
export OTEL_ENVIRONMENT=test export OTEL_ENVIRONMENT=test
@@ -17,4 +16,4 @@ export OTEL_ENVIRONMENT=test
python3 manage.py test -v3 python3 manage.py test -v3
echo "" echo ""
echo "Tests completed successfully (OpenTelemetry enabled)" echo "Tests completed successfully (OpenTelemetry instrumentation and export enabled)"