-
Notifications
You must be signed in to change notification settings - Fork 773
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add OTLP exporter integration test (#1671)
* Add OTLP exporter integration test * Fix typo * Move DelegatingTestExporter to shared location * Fix build * Fix build part 2 * Fix build part 3 - third time's the charm right? * Fix build part 4 - third time's not the charm. * Fix TargetFrameworks for OTLP exporter project and add explanation * Set switch allowing for insecure GrpcChannel for netcoreapp3.1 * Learning to spell is a life-long process Co-authored-by: Cijo Thomas <[email protected]>
- Loading branch information
1 parent
3bb0445
commit 2385904
Showing
9 changed files
with
252 additions
and
3 deletions.
There are no files selected for viewing
This file contains 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
22 changes: 21 additions & 1 deletion
22
...emetry.Exporter.OpenTelemetryProtocol/OpenTelemetry.Exporter.OpenTelemetryProtocol.csproj
This file contains 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
17 changes: 17 additions & 0 deletions
17
test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests/Dockerfile
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # Create a container for running the OpenTelemetry Collector integration tests. | ||
| # This should be run from the root of the repo: | ||
| # docker build --file test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests/Dockerfile | ||
|
|
||
| ARG SDK_VERSION=3.1 | ||
| FROM mcr.microsoft.com/dotnet/core/sdk:${SDK_VERSION} AS build | ||
| ARG PUBLISH_CONFIGURATION=Release | ||
| ARG PUBLISH_FRAMEWORK=netcoreapp3.1 | ||
| WORKDIR /repo | ||
| COPY . ./ | ||
| WORKDIR "/repo/test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests" | ||
| RUN dotnet publish "OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests.csproj" -c "${PUBLISH_CONFIGURATION}" -f "${PUBLISH_FRAMEWORK}" -o /drop -p:IntegrationBuild=true -p:TARGET_FRAMEWORK=${PUBLISH_FRAMEWORK} | ||
|
|
||
| FROM mcr.microsoft.com/dotnet/core/sdk:${SDK_VERSION} AS final | ||
| WORKDIR /test | ||
| COPY --from=build /drop . | ||
| ENTRYPOINT ["dotnet", "vstest", "OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests.dll"] |
70 changes: 70 additions & 0 deletions
70
test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests/IntegrationTests.cs
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| // <copyright file="IntegrationTests.cs" company="OpenTelemetry Authors"> | ||
| // Copyright The OpenTelemetry Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // </copyright> | ||
|
|
||
| using System; | ||
| using System.Diagnostics; | ||
| using OpenTelemetry.Tests; | ||
| using OpenTelemetry.Trace; | ||
| using Xunit; | ||
|
|
||
| namespace OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests | ||
| { | ||
| public class IntegrationTests | ||
| { | ||
| private const string CollectorEndpointEnvVarName = "OTEL_EXPORTER_OTLP_ENDPOINT"; | ||
| private static readonly string CollectorEndpoint = SkipUnlessEnvVarFoundFactAttribute.GetEnvironmentVariable(CollectorEndpointEnvVarName); | ||
|
|
||
| [Trait("CategoryName", "CollectorIntegrationTests")] | ||
| [SkipUnlessEnvVarFoundFact(CollectorEndpointEnvVarName)] | ||
| public void ExportResultIsSuccess() | ||
| { | ||
| #if NETCOREAPP3_1 | ||
| // Adding the OtlpExporter creates a GrpcChannel. | ||
| // This switch must be set before creating a GrpcChannel/HttpClient when calling an insecure gRPC service. | ||
| // See: https://docs.microsoft.com/aspnet/core/grpc/troubleshoot#call-insecure-grpc-services-with-net-core-client | ||
| AppContext.SetSwitch("System.Net.Http.SocketsHttpHandler.Http2UnencryptedSupport", true); | ||
| #endif | ||
|
|
||
| var exporterOptions = new OtlpExporterOptions | ||
| { | ||
| #if NETCOREAPP3_1 || NET5_0 | ||
| Endpoint = new System.Uri($"http://{CollectorEndpoint}"), | ||
| #else | ||
| Endpoint = CollectorEndpoint, | ||
| #endif | ||
| }; | ||
|
|
||
| var otlpExporter = new OtlpExporter(exporterOptions); | ||
| var delegatingExporter = new DelegatingTestExporter<Activity>(otlpExporter); | ||
| var exportActivityProcessor = new SimpleActivityExportProcessor(delegatingExporter); | ||
|
|
||
| var activitySourceName = "otlp.collector.test"; | ||
|
|
||
| var builder = Sdk.CreateTracerProviderBuilder() | ||
| .AddSource(activitySourceName) | ||
| .AddProcessor(exportActivityProcessor); | ||
|
|
||
| using var tracerProvider = builder.Build(); | ||
|
|
||
| var source = new ActivitySource(activitySourceName); | ||
| var activity = source.StartActivity("Test Activity"); | ||
| activity?.Stop(); | ||
|
|
||
| Assert.Single(delegatingExporter.ExportResults); | ||
| Assert.Equal(ExportResult.Success, delegatingExporter.ExportResults[0]); | ||
| } | ||
| } | ||
| } |
This file contains 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
20 changes: 20 additions & 0 deletions
20
test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests/config.yaml
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| # This is a configuration file for the OpenTelemetry Collector intended to be | ||
| # used in conjunction with the OTLP Exporter integration tests. | ||
| # | ||
| # For more information about the OpenTelemetry Collector see: | ||
| # https://github.com/open-telemetry/opentelemetry-collector | ||
| # | ||
| receivers: | ||
| otlp: | ||
| protocols: | ||
| grpc: | ||
|
|
||
| exporters: | ||
| logging: | ||
| loglevel: debug | ||
|
|
||
| service: | ||
| pipelines: | ||
| traces: | ||
| receivers: [otlp] | ||
| exporters: [logging] |
24 changes: 24 additions & 0 deletions
24
test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests/docker-compose.yml
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| # Starts an OpenTelemetry Collector and then runs the OTLP exporter integration tests. | ||
| # This should be run from the root of the repo: | ||
| # docker-compose --file=test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests/docker-compose.yml --project-directory=. up --exit-code-from=tests --build | ||
|
|
||
| version: '3.7' | ||
|
|
||
| services: | ||
| otel-collector: | ||
| image: otel/opentelemetry-collector | ||
| volumes: | ||
| - ./test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests:/cfg | ||
| command: --config=/cfg/config.yaml | ||
| ports: | ||
| - "55680:55680" | ||
|
|
||
| tests: | ||
| build: | ||
| context: . | ||
| dockerfile: ./test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests/Dockerfile | ||
| command: --TestCaseFilter:CategoryName=CollectorIntegrationTests | ||
| environment: | ||
| - OTEL_EXPORTER_OTLP_ENDPOINT=otel-collector:55680 | ||
| depends_on: | ||
| - otel-collector |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| // <copyright file="DelegatingTestExporter.cs" company="OpenTelemetry Authors"> | ||
| // Copyright The OpenTelemetry Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // </copyright> | ||
|
|
||
| using System.Collections.Generic; | ||
|
|
||
| namespace OpenTelemetry.Tests | ||
| { | ||
| public class DelegatingTestExporter<T> : BaseExporter<T> | ||
| where T : class | ||
| { | ||
| public List<ExportResult> ExportResults = new List<ExportResult>(); | ||
|
|
||
| private readonly BaseExporter<T> exporter; | ||
|
|
||
| public DelegatingTestExporter(BaseExporter<T> exporter) | ||
| { | ||
| this.exporter = exporter; | ||
| } | ||
|
|
||
| public override ExportResult Export(in Batch<T> batch) | ||
| { | ||
| var result = this.exporter.Export(batch); | ||
| this.ExportResults.Add(result); | ||
| return result; | ||
| } | ||
| } | ||
| } |
44 changes: 44 additions & 0 deletions
44
test/OpenTelemetry.Tests/Shared/SkipUnlessEnvVarFoundFactAttribute.cs
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| // <copyright file="SkipUnlessEnvVarFoundFactAttribute.cs" company="OpenTelemetry Authors"> | ||
| // Copyright The OpenTelemetry Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // </copyright> | ||
|
|
||
| using System; | ||
| using Xunit; | ||
|
|
||
| namespace OpenTelemetry.Tests | ||
| { | ||
| internal class SkipUnlessEnvVarFoundFactAttribute : FactAttribute | ||
| { | ||
| public SkipUnlessEnvVarFoundFactAttribute(string environmentVariable) | ||
| { | ||
| if (string.IsNullOrEmpty(GetEnvironmentVariable(environmentVariable))) | ||
| { | ||
| this.Skip = $"Skipped because {environmentVariable} environment variable was not configured."; | ||
| } | ||
| } | ||
|
|
||
| public static string GetEnvironmentVariable(string environmentVariableName) | ||
| { | ||
| string environmentVariableValue = Environment.GetEnvironmentVariable(environmentVariableName, EnvironmentVariableTarget.Process); | ||
|
|
||
| if (string.IsNullOrEmpty(environmentVariableValue)) | ||
| { | ||
| environmentVariableValue = Environment.GetEnvironmentVariable(environmentVariableName, EnvironmentVariableTarget.Machine); | ||
| } | ||
|
|
||
| return environmentVariableValue; | ||
| } | ||
| } | ||
| } |