Skip to content

Commit e13f42c

Browse files
cjihrigcjihrig
committed
test(opentelemetry-configuration): simplify management of environment variables
The ConfigProvider tests were deleting a number of environment variables after every test, and this logic was duplicated in a few places. This is a bit error prone. The tests seem to pass with a clean process.env provided to each test, and Mocha's afterEach() hook is inherited, so the logic can be simplified a good bit while maintaining semantics.
1 parent a26422d commit e13f42c

File tree

3 files changed

+11
-110
lines changed

3 files changed

+11
-110
lines changed

‎CHANGELOG.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ For notes on migrating to 2.x / 0.200.x see [the upgrade guide](doc/upgrade-to-2
3030
### :house: Internal
3131

3232
* test(shim-opentracing): add comparison thresholds in flaky assertions [#5974](https://github.com/open-telemetry/opentelemetry-js/pull/5974) @cjihrig
33-
* test(exporter-jaeger): clean up OTEL_EXPORTER_JAEGER_AGENT_PORT between tests [#xxxx](https://github.com/open-telemetry/opentelemetry-js/pull/xxxx) @cjihrig
33+
* test(exporter-jaeger): clean up OTEL_EXPORTER_JAEGER_AGENT_PORT between tests [#6003](https://github.com/open-telemetry/opentelemetry-js/pull/6003) @cjihrig
3434

3535
## 2.1.0
3636

‎experimental/CHANGELOG.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ For notes on migrating to 2.x / 0.200.x see [the upgrade guide](doc/upgrade-to-2
2424

2525
### :house: Internal
2626

27+
* test(opentelemetry-configuration): simplify management of environment variables [#6004](https://github.com/open-telemetry/opentelemetry-js/pull/6004) @cjihrig
28+
2729
## 0.206.0
2830

2931
### :rocket: Features

‎experimental/packages/opentelemetry-configuration/test/ConfigProvider.test.ts‎

Lines changed: 8 additions & 109 deletions
Original file line numberDiff line numberDiff line change
@@ -353,61 +353,15 @@ const defaultConfigFromFileWithEnvVariables: Configuration = {
353353
};
354354

355355
describe('ConfigProvider', function () {
356-
describe('get values from environment variables', function () {
357-
afterEach(function () {
358-
delete process.env.OTEL_SDK_DISABLED;
359-
delete process.env.OTEL_LOG_LEVEL;
360-
delete process.env.OTEL_NODE_RESOURCE_DETECTORS;
361-
delete process.env.OTEL_RESOURCE_ATTRIBUTES;
362-
delete process.env.OTEL_SERVICE_NAME;
363-
delete process.env.OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT;
364-
delete process.env.OTEL_ATTRIBUTE_COUNT_LIMIT;
365-
delete process.env.OTEL_PROPAGATORS;
366-
delete process.env.OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT;
367-
delete process.env.OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT;
368-
delete process.env.OTEL_SPAN_EVENT_COUNT_LIMIT;
369-
delete process.env.OTEL_SPAN_LINK_COUNT_LIMIT;
370-
delete process.env.OTEL_EVENT_ATTRIBUTE_COUNT_LIMIT;
371-
delete process.env.OTEL_LINK_ATTRIBUTE_COUNT_LIMIT;
372-
delete process.env.OTEL_BSP_SCHEDULE_DELAY;
373-
delete process.env.OTEL_BSP_EXPORT_TIMEOUT;
374-
delete process.env.OTEL_BSP_MAX_QUEUE_SIZE;
375-
delete process.env.OTEL_BSP_MAX_EXPORT_BATCH_SIZE;
376-
delete process.env.OTEL_EXPORTER_OTLP_TRACES_ENDPOINT;
377-
delete process.env.OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE;
378-
delete process.env.OTEL_EXPORTER_OTLP_TRACES_CLIENT_KEY;
379-
delete process.env.OTEL_EXPORTER_OTLP_TRACES_CLIENT_CERTIFICATE;
380-
delete process.env.OTEL_EXPORTER_OTLP_TRACES_COMPRESSION;
381-
delete process.env.OTEL_EXPORTER_OTLP_TRACES_TIMEOUT;
382-
delete process.env.OTEL_EXPORTER_OTLP_TRACES_HEADERS;
383-
delete process.env.OTEL_METRIC_EXPORT_INTERVAL;
384-
delete process.env.OTEL_METRIC_EXPORT_TIMEOUT;
385-
delete process.env.OTEL_EXPORTER_OTLP_METRICS_ENDPOINT;
386-
delete process.env.OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE;
387-
delete process.env.OTEL_EXPORTER_OTLP_METRICS_CLIENT_KEY;
388-
delete process.env.OTEL_EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE;
389-
delete process.env.OTEL_EXPORTER_OTLP_METRICS_COMPRESSION;
390-
delete process.env.OTEL_EXPORTER_OTLP_METRICS_TIMEOUT;
391-
delete process.env.OTEL_EXPORTER_OTLP_METRICS_HEADERS;
392-
delete process.env.OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE;
393-
delete process.env
394-
.OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION;
395-
delete process.env.OTEL_METRICS_EXEMPLAR_FILTER;
396-
delete process.env.OTEL_LOGRECORD_ATTRIBUTE_VALUE_LENGTH_LIMIT;
397-
delete process.env.OTEL_LOGRECORD_ATTRIBUTE_COUNT_LIMIT;
398-
delete process.env.OTEL_BLRP_SCHEDULE_DELAY;
399-
delete process.env.OTEL_BLRP_EXPORT_TIMEOUT;
400-
delete process.env.OTEL_BLRP_MAX_QUEUE_SIZE;
401-
delete process.env.OTEL_BLRP_MAX_EXPORT_BATCH_SIZE;
402-
delete process.env.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT;
403-
delete process.env.OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE;
404-
delete process.env.OTEL_EXPORTER_OTLP_LOGS_CLIENT_KEY;
405-
delete process.env.OTEL_EXPORTER_OTLP_LOGS_CLIENT_CERTIFICATE;
406-
delete process.env.OTEL_EXPORTER_OTLP_LOGS_COMPRESSION;
407-
delete process.env.OTEL_EXPORTER_OTLP_LOGS_TIMEOUT;
408-
delete process.env.OTEL_EXPORTER_OTLP_LOGS_HEADERS;
409-
});
356+
before(function () {
357+
process.env = {};
358+
});
359+
360+
afterEach(function () {
361+
process.env = {};
362+
});
410363

364+
describe('get values from environment variables', function () {
411365
it('should initialize config with default values', function () {
412366
const configProvider = createConfigProvider();
413367
assert.deepStrictEqual(
@@ -706,61 +660,6 @@ describe('ConfigProvider', function () {
706660
});
707661

708662
describe('get values from config file', function () {
709-
afterEach(function () {
710-
delete process.env.OTEL_EXPERIMENTAL_CONFIG_FILE;
711-
delete process.env.OTEL_NODE_RESOURCE_DETECTORS;
712-
delete process.env.OTEL_SDK_DISABLED;
713-
delete process.env.OTEL_LOG_LEVEL;
714-
delete process.env.OTEL_SERVICE_NAME;
715-
delete process.env.OTEL_RESOURCE_ATTRIBUTES;
716-
delete process.env.OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT;
717-
delete process.env.OTEL_ATTRIBUTE_COUNT_LIMIT;
718-
delete process.env.OTEL_PROPAGATORS;
719-
delete process.env.OTEL_BSP_SCHEDULE_DELAY;
720-
delete process.env.OTEL_BSP_EXPORT_TIMEOUT;
721-
delete process.env.OTEL_BSP_MAX_QUEUE_SIZE;
722-
delete process.env.OTEL_BSP_MAX_EXPORT_BATCH_SIZE;
723-
delete process.env.OTEL_EXPORTER_OTLP_TRACES_ENDPOINT;
724-
delete process.env.OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE;
725-
delete process.env.OTEL_EXPORTER_OTLP_TRACES_CLIENT_KEY;
726-
delete process.env.OTEL_EXPORTER_OTLP_TRACES_CLIENT_CERTIFICATE;
727-
delete process.env.OTEL_EXPORTER_OTLP_TRACES_COMPRESSION;
728-
delete process.env.OTEL_EXPORTER_OTLP_TRACES_TIMEOUT;
729-
delete process.env.OTEL_EXPORTER_OTLP_TRACES_HEADERS;
730-
delete process.env.OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT;
731-
delete process.env.OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT;
732-
delete process.env.OTEL_SPAN_EVENT_COUNT_LIMIT;
733-
delete process.env.OTEL_SPAN_LINK_COUNT_LIMIT;
734-
delete process.env.OTEL_EVENT_ATTRIBUTE_COUNT_LIMIT;
735-
delete process.env.OTEL_LINK_ATTRIBUTE_COUNT_LIMIT;
736-
delete process.env.OTEL_METRIC_EXPORT_INTERVAL;
737-
delete process.env.OTEL_METRIC_EXPORT_TIMEOUT;
738-
delete process.env.OTEL_EXPORTER_OTLP_METRICS_ENDPOINT;
739-
delete process.env.OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE;
740-
delete process.env.OTEL_EXPORTER_OTLP_METRICS_CLIENT_KEY;
741-
delete process.env.OTEL_EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE;
742-
delete process.env.OTEL_EXPORTER_OTLP_METRICS_COMPRESSION;
743-
delete process.env.OTEL_EXPORTER_OTLP_METRICS_TIMEOUT;
744-
delete process.env.OTEL_EXPORTER_OTLP_METRICS_HEADERS;
745-
delete process.env.OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE;
746-
delete process.env
747-
.OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION;
748-
delete process.env.OTEL_METRICS_EXEMPLAR_FILTER;
749-
delete process.env.OTEL_BLRP_SCHEDULE_DELAY;
750-
delete process.env.OTEL_BLRP_EXPORT_TIMEOUT;
751-
delete process.env.OTEL_BLRP_MAX_QUEUE_SIZE;
752-
delete process.env.OTEL_BLRP_MAX_EXPORT_BATCH_SIZE;
753-
delete process.env.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT;
754-
delete process.env.OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE;
755-
delete process.env.OTEL_EXPORTER_OTLP_LOGS_CLIENT_KEY;
756-
delete process.env.OTEL_EXPORTER_OTLP_LOGS_CLIENT_CERTIFICATE;
757-
delete process.env.OTEL_EXPORTER_OTLP_LOGS_COMPRESSION;
758-
delete process.env.OTEL_EXPORTER_OTLP_LOGS_TIMEOUT;
759-
delete process.env.OTEL_EXPORTER_OTLP_LOGS_HEADERS;
760-
delete process.env.OTEL_LOGRECORD_ATTRIBUTE_VALUE_LENGTH_LIMIT;
761-
delete process.env.OTEL_LOGRECORD_ATTRIBUTE_COUNT_LIMIT;
762-
});
763-
764663
it('should initialize config with default values from valid config file', function () {
765664
process.env.OTEL_EXPERIMENTAL_CONFIG_FILE =
766665
'test/fixtures/kitchen-sink.yaml';

0 commit comments

Comments
 (0)