Added tests, including for auto-instrumentation.

Author: michaelsafyan

opentelemetry-configurator-gcp/pyproject.toml

@@ -15,7 +15,7 @@ dependencies = [
 ]
 
 [project.entry-points.opentelemetry_configurator]
-gcp = "opentelemetry.configurator.gcp:GcpConfigurator"
+gcp = "opentelemetry.configurator.gcp:OpenTelemetryGcpConfigurator"
 
 [tool.hatch.build.targets.sdist]
 include = ["*.py"]

opentelemetry-configurator-gcp/src/opentelemetry/configurator/gcp/configurator.py

@@ -35,7 +35,7 @@ def __init__(
         self._resource_detector_enabled = _bool_with_flag_default(
             resource_detector_enabled, is_resource_detector_enabled)
 
-    def configure(self):
+    def configure(self, **kwargs):
         resource = get_resource(include_gcp_detector=self._resource_detector_enabled)
         if self._metrics_exporter_enabled:
             configure_metrics_exporter(resource=resource)

opentelemetry-configurator-gcp/tests/run_with_autoinstrumentation.py

@@ -0,0 +1,47 @@
+#! /usr/bin/env python3
+
+import sys
+
+from opentelemetry import trace as otel_trace
+from opentelemetry import metrics as otel_metrics
+from opentelemetry import _logs as otel_logs
+
+
+def is_tracer_noop():
+    tracer = otel_trace.get_tracer(__name__)
+    if isinstance(tracer, otel_trace.ProxyTracer):
+        tracer = getattr(tracer, '_tracer')
+    return isinstance(tracer, otel_trace.NoOpTracer)
+
+
+def is_metrics_noop():
+   return isinstance(otel_metrics.get_meter_provider(), otel_metrics.NoOpMeterProvider)
+
+
+def is_logging_noop():
+    return isinstance(otel_logs.get_logger_provider(), otel_logs.NoOpLoggerProvider)        
+
+
+def main():
+    signals_to_noop_checker = {
+        'trace': is_tracer_noop,
+        'metrics': is_metrics_noop,
+        'logs': is_logging_noop,
+    }
+    noop_signals = []
+    for signal_name, noop_tester_func in signals_to_noop_checker.items():
+        is_noop = noop_tester_func()
+        print(f'Signal "{signal_name}" is no-op?: {is_noop}')
+        if is_noop:
+            noop_signals.append(signal_name)
+    if not noop_signals:
+        print('All signals successfully configured.')
+        return
+    noop_count = len(noop_signals)
+    total_count = len(signals_to_noop_checker)
+    print(f'{noop_count}/{total_count} signals not configured: {noop_signals}')
+    sys.exit(1)
+
+
+if __name__ == '__main__':
+    main()

opentelemetry-configurator-gcp/tests/test_automatic.py

@@ -0,0 +1,13 @@
+#!/usr/bin/env python3
+
+import subprocess
+import unittest
+
+class AutomaticInstrumentationTestCase(unittest.TestCase):
+
+    def test_works_with_auto_instrumentation(self):
+        subprocess.run("./test_automatic.sh", shell=True, check=True, capture_output=True)
+
+
+if __name__ == '__main__':
+    unittest.main()

opentelemetry-configurator-gcp/tests/test_automatic.sh

@@ -0,0 +1,32 @@
+#! /bin/bash
+
+set -o pipefail
+
+SCRIPT_DIR=$(cd $(dirname ${BASH_SOURCE:-0}); pwd)
+PROJECT_DIR=$(readlink -f "${SCRIPT_DIR}/..")
+TESTS_DIR="${PROJECT_DIR}/tests"
+TEST_ENV="${PROJECT_DIR}/.test/.venv-auto"
+
+function main() {
+    if [ ! -d "${TEST_ENV}" ] ; then
+      mkdir -p "${TEST_ENV}" || exit 1
+    fi
+    if [ ! -d "${TEST_ENV}/bin" ] ; then
+      python3 -m venv "${TEST_ENV}" || exit 1
+    fi
+
+    source "${TEST_ENV}/bin/activate" || exit 1
+    pip install -r "${TESTS_DIR}/requirements.txt" || exit 1
+ 
+    cd "${PROJECT_DIR}" || exit 1
+    make install || exit 1
+    pip install opentelemetry-instrumentation || exit 1
+    pip install opentelemetry-distro || exit 1
+
+    opentelemetry-instrument \
+      --configurator=gcp \
+      python \
+      "${TESTS_DIR}/run_with_autoinstrumentation.py" || exit $?
+}
+
+main

opentelemetry-configurator-gcp/tests/test_manual_all_enabled.py

@@ -0,0 +1,22 @@
+#!./run_with_env.sh
+import unittest
+
+import sys
+sys.path.append('../src')
+
+from opentelemetry.configurator.gcp import OpenTelemetryGcpConfigurator
+
+class ManualTestWithAllOptionsEnabled(unittest.TestCase):
+
+    def test_does_not_crash(self):
+        configurator = OpenTelemetryGcpConfigurator(
+            metrics_exporter_enabled=True,
+            logs_exporter_enabled=True,
+            traces_exporter_enabled=True,
+            resource_detector_enabled=True,
+        )
+        configurator.configure()
+
+
+if __name__ == '__main__':
+    unittest.main()

opentelemetry-configurator-gcp/tests/test_manual_logging_only.py

@@ -0,0 +1,21 @@
+#!./run_with_env.sh
+import unittest
+
+import sys
+sys.path.append('../src')
+
+from opentelemetry.configurator.gcp import OpenTelemetryGcpConfigurator
+
+class ManualTestLoggingOnly(unittest.TestCase):
+
+    def test_does_not_crash(self):
+        configurator = OpenTelemetryGcpConfigurator(
+            metrics_exporter_enabled=False,
+            logs_exporter_enabled=True,
+            traces_exporter_enabled=False,
+        )
+        configurator.configure()
+
+
+if __name__ == '__main__':
+    unittest.main()

opentelemetry-configurator-gcp/tests/test_manual_metrics_only.py

@@ -0,0 +1,21 @@
+#!./run_with_env.sh
+import unittest
+
+import sys
+sys.path.append('../src')
+
+from opentelemetry.configurator.gcp import OpenTelemetryGcpConfigurator
+
+class ManualTestMetricsOnly(unittest.TestCase):
+
+    def test_does_not_crash(self):
+        configurator = OpenTelemetryGcpConfigurator(
+            metrics_exporter_enabled=True,
+            logs_exporter_enabled=False,
+            traces_exporter_enabled=False,
+        )
+        configurator.configure()
+
+
+if __name__ == '__main__':
+    unittest.main()

opentelemetry-configurator-gcp/tests/test_manual_resource_off.py

@@ -0,0 +1,19 @@
+#!./run_with_env.sh
+import unittest
+
+import sys
+sys.path.append('../src')
+
+from opentelemetry.configurator.gcp import OpenTelemetryGcpConfigurator
+
+class ManualTestResourceOff(unittest.TestCase):
+
+    def test_does_not_crash(self):
+        configurator = OpenTelemetryGcpConfigurator(
+            resource_detector_enabled=False,
+        )
+        configurator.configure()
+
+
+if __name__ == '__main__':
+    unittest.main()

opentelemetry-configurator-gcp/tests/test_manual_resource_on.py

@@ -0,0 +1,19 @@
+#!./run_with_env.sh
+import unittest
+
+import sys
+sys.path.append('../src')
+
+from opentelemetry.configurator.gcp import OpenTelemetryGcpConfigurator
+
+class ManualTestResourceOff(unittest.TestCase):
+
+    def test_does_not_crash(self):
+        configurator = OpenTelemetryGcpConfigurator(
+            resource_detector_enabled=True,
+        )
+        configurator.configure()
+
+
+if __name__ == '__main__':
+    unittest.main()