chore: installation of test packages in eachdist (open-telemetry#794)

toumorokoshi · web-flow · commit 731f57784a9d · 2020-06-10T16:14:33.000-07:00
eachdist.py did not support the installation of test packages,
(as defined by the extra_requires:test package group). As a
result, test packages were being added to dev-requirements.txt

By having eachdist.py develop install test packages, and moving
develop/test package definitions to the individual instrumentations,
it is easier to determine which packages require which dependencies
for testing purposes, and enables support for existing dependencies
that follow the extra_requires:test pattern.
diff --git a/dev-requirements.txt b/dev-requirements.txt
@@ -8,6 +8,4 @@ sphinx-rtd-theme~=0.4
 sphinx-autodoc-typehints~=1.10.2
 pytest!=5.2.3
 pytest-cov>=2.8
-readme-renderer~=24.0
-httpretty~=1.0
-opentracing~=2.2.0
+readme-renderer~=24.0
diff --git a/docs/examples/opentelemetry-example-app/setup.py b/docs/examples/opentelemetry-example-app/setup.py
@@ -43,6 +43,7 @@
         "requests",
         "protobuf~=3.11",
     ],
+    extras_require={"test": []},
     license="Apache-2.0",
     package_dir={"": "src"},
     packages=setuptools.find_namespace_packages(where="src"),
diff --git a/ext/opentelemetry-exporter-cloud-monitoring/setup.cfg b/ext/opentelemetry-exporter-cloud-monitoring/setup.cfg
@@ -45,4 +45,7 @@ install_requires =
     google-cloud-monitoring
 
 [options.packages.find]
-where = src
+where = src
+
+[options.extras_require]
+test =
diff --git a/ext/opentelemetry-exporter-cloud-trace/setup.cfg b/ext/opentelemetry-exporter-cloud-trace/setup.cfg
@@ -45,3 +45,6 @@ install_requires =
 
 [options.packages.find]
 where = src
+
+[options.extras_require]
+test =
diff --git a/ext/opentelemetry-ext-aiohttp-client/setup.cfg b/ext/opentelemetry-ext-aiohttp-client/setup.cfg
@@ -45,3 +45,6 @@ install_requires =
 
 [options.packages.find]
 where = src
+
+[options.extras_require]
+test =
diff --git a/ext/opentelemetry-ext-datadog/setup.cfg b/ext/opentelemetry-ext-datadog/setup.cfg
@@ -45,3 +45,6 @@ install_requires =
 
 [options.packages.find]
 where = src
+
+[options.extras_require]
+test =
diff --git a/ext/opentelemetry-ext-jaeger/setup.cfg b/ext/opentelemetry-ext-jaeger/setup.cfg
@@ -46,3 +46,6 @@ install_requires =
 
 [options.packages.find]
 where = src
+
+[options.extras_require]
+test =
diff --git a/ext/opentelemetry-ext-opencensusexporter/setup.cfg b/ext/opentelemetry-ext-opencensusexporter/setup.cfg
@@ -48,3 +48,6 @@ install_requires =
 
 [options.packages.find]
 where = src
+
+[options.extras_require]
+test =
diff --git a/ext/opentelemetry-ext-opentracing-shim/setup.cfg b/ext/opentelemetry-ext-opentracing-shim/setup.cfg
@@ -47,6 +47,7 @@ install_requires =
 [options.extras_require]
 test =
     opentelemetry-test == 0.9.dev0
+    opentracing ~= 2.2.0
 
 [options.packages.find]
 where = src
diff --git a/ext/opentelemetry-ext-prometheus/setup.cfg b/ext/opentelemetry-ext-prometheus/setup.cfg
@@ -46,3 +46,6 @@ install_requires =
 
 [options.packages.find]
 where = src
+
+[options.extras_require]
+test =
diff --git a/ext/opentelemetry-ext-zipkin/setup.cfg b/ext/opentelemetry-ext-zipkin/setup.cfg
@@ -46,3 +46,6 @@ install_requires =
 
 [options.packages.find]
 where = src
+
+[options.extras_require]
+test =
diff --git a/opentelemetry-api/setup.cfg b/opentelemetry-api/setup.cfg
@@ -57,3 +57,6 @@ opentelemetry_meter_provider =
     default_meter_provider = opentelemetry.metrics:DefaultMeterProvider
 opentelemetry_tracer_provider =
     default_tracer_provider = opentelemetry.trace:DefaultTracerProvider
+
+[options.extras_require]
+test =
diff --git a/opentelemetry-instrumentation/setup.cfg b/opentelemetry-instrumentation/setup.cfg
@@ -52,3 +52,6 @@ where = src
 console_scripts =
     opentelemetry-instrument = opentelemetry.instrumentation.auto_instrumentation:run
     opentelemetry-bootstrap = opentelemetry.instrumentation.bootstrap:run
+
+[options.extras_require]
+test =
diff --git a/opentelemetry-proto/setup.cfg b/opentelemetry-proto/setup.cfg
@@ -46,3 +46,6 @@ install_requires =
 
 [options.packages.find]
 where = src
+
+[options.extras_require]
+test =
diff --git a/opentelemetry-sdk/setup.cfg b/opentelemetry-sdk/setup.cfg
@@ -52,3 +52,6 @@ opentelemetry_meter_provider =
     sdk_meter_provider = opentelemetry.sdk.metrics:MeterProvider
 opentelemetry_tracer_provider =
     sdk_tracer_provider = opentelemetry.sdk.trace:TracerProvider
+
+[options.extras_require]
+test =
diff --git a/scripts/eachdist.py b/scripts/eachdist.py
@@ -205,6 +205,7 @@ def setup_instparser(instparser):
 
     setup_instparser(instparser)
     instparser.add_argument("--editable", "-e", action="store_true")
+    instparser.add_argument("--with-test-deps", action="store_true")
     instparser.add_argument("--with-dev-deps", action="store_true")
     instparser.add_argument("--eager-upgrades", action="store_true")
 
@@ -214,7 +215,10 @@ def setup_instparser(instparser):
     )
     setup_instparser(devparser)
     devparser.set_defaults(
-        editable=True, with_dev_deps=True, eager_upgrades=True
+        editable=True,
+        with_dev_deps=True,
+        eager_upgrades=True,
+        with_test_deps=True,
     )
 
     lintparser = subparsers.add_parser(
@@ -424,7 +428,16 @@ def install_args(args):
             check=True,
         )
 
-    allfmt = "-e 'file://{}'" if args.editable else "'file://{}'"
+    allfmt = "-e 'file://{}" if args.editable else "'file://{}"
+    # packages should provide an extra_requires that is named
+    # 'test', to denote test dependencies.
+    extras = []
+    if args.with_test_deps:
+        extras.append("test")
+    if extras:
+        allfmt += "[{}]".format(",".join(extras))
+    # note the trailing single quote, to close the quote opened above.
+    allfmt += "'"
     execute_args(
         parse_subargs(
             args,
