Merge branch 'main' into renovate/config-no-service

open-telemetry · Aug 15, 2023 · c661ec5 · c661ec5
2 parents abb36e1 + 46089e2
commit c661ec5
Show file tree

Hide file tree

Showing 16 changed files with 147 additions and 149 deletions.
diff --git a/.github/workflows/build-images.yml b/.github/workflows/build-images.yml
@@ -58,9 +58,6 @@ jobs:
           - file: ./src/loadgenerator/Dockerfile
             tag_suffix: loadgenerator
             context: ./
-          - file: ./src/otelcollector/Dockerfile
-            tag_suffix: otelcollector
-            context: ./
           - file: ./src/paymentservice/Dockerfile
             tag_suffix: paymentservice
             context: ./

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -45,6 +45,8 @@ release.
   ([#935](https://github.com/open-telemetry/opentelemetry-demo/pull/935))
 * [cartservice] update service to .NET 7
   ([#942](https://github.com/open-telemetry/opentelemetry-demo/pull/942))
+* [tests] Add trace-based testing examples
+  ([#877](https://github.com/open-telemetry/opentelemetry-demo/pull/877))
 * Introduce minimal mode to run demo
   ([#872](https://github.com/open-telemetry/opentelemetry-demo/pull/872))
 * [frontendproxy]Envoy expose a route for the collector to route frontend spans
@@ -63,10 +65,10 @@ release.
   ([#988](https://github.com/open-telemetry/opentelemetry-demo/pull/988))
 * [FraudDetectionService] Updated Kotlin version and OTel dependencies
   ([#987](https://github.com/open-telemetry/opentelemetry-demo/pull/987))
-* [otelcol] Use the collector builder to produce otelcol docker image
-  ([#944](https://github.com/open-telemetry/opentelemetry-demo/pull/944))
 * [quoteservice] update php dependencies
   ([#994](https://github.com/open-telemetry/opentelemetry-demo/issues/994))
+* [tests] Update trace-based tests run script
+  ([#1018](https://github.com/open-telemetry/opentelemetry-demo/pull/1018))
 * [PaymentService] Update node to LTS version and bump deps
   ([#1029](https://github.com/open-telemetry/opentelemetry-demo/issues/1029))
 

diff --git a/Makefile b/Makefile
@@ -97,7 +97,7 @@ run-tests:
 	docker compose run traceBasedTests
 
 run-tracetesting:
-	docker compose run traceBasedTests
+	docker compose run traceBasedTests ${SERVICES_TO_TEST}
 
 .PHONY: generate-protobuf
 generate-protobuf:

diff --git a/README.md b/README.md
@@ -67,8 +67,8 @@ keeping it up to date for you.
 ## Contributing
 
 To get involved with the project see our [CONTRIBUTING](CONTRIBUTING.md)
-documentation. Our [SIG Calls](CONTRIBUTING.md#join-a-sig-call) are Mondays at
-8:15 AM PST and anyone is welcome.
+documentation. Our [SIG Calls](CONTRIBUTING.md#join-a-sig-call) are every other
+Monday at 8:30 AM PST and anyone is welcome.
 
 ## Project leadership
 

diff --git a/docker-compose.minimal.yml b/docker-compose.minimal.yml
@@ -501,13 +501,8 @@ services:
 
   # OpenTelemetry Collector
   otelcol:
-    image: ${IMAGE_NAME}:${IMAGE_VERSION}-otelcol
+    image: otel/opentelemetry-collector-contrib:0.82.0
     container_name: otel-col
-    build:
-      context: ./
-      dockerfile: ./src/otelcollector/Dockerfile
-      cache_from:
-        - ${IMAGE_NAME}:${IMAGE_VERSION}-otelcol
     deploy:
       resources:
         limits:

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -645,13 +645,8 @@ services:
 
   # OpenTelemetry Collector
   otelcol:
-    image: ${IMAGE_NAME}:${IMAGE_VERSION}-otelcol
+    image: otel/opentelemetry-collector-contrib:0.82.0
     container_name: otel-col
-    build:
-      context: ./
-      dockerfile: ./src/otelcollector/Dockerfile
-      cache_from:
-        - ${IMAGE_NAME}:${IMAGE_VERSION}-otelcol
     deploy:
       resources:
         limits:

diff --git a/renovate.json → renovate.json5 b/renovate.json → renovate.json5
@@ -109,6 +109,12 @@
       "matchPaths": ["src/shippingservice"],
       "groupName": "shippingservice",
       "assigneesFromCodeOwners": true
+    },
+    {
+      // intentionally using Java 11 in some examples
+      // not using matchUpdateTypes "major", because renovate wants to bump "11-jre" to "11.0.19_7-jre"
+      "matchPackageNames": ["eclipse-temurin"],
+      "enabled": false
     }
   ]
 }
diff --git a/src/cartservice/cartservice.sln b/src/cartservice/cartservice.sln
@@ -1,48 +1,48 @@
-
-Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio 15
-VisualStudioVersion = 15.0.26124.0
-MinimumVisualStudioVersion = 15.0.26124.0
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "cartservice", "src\cartservice.csproj", "{2348C29F-E8D3-4955-916D-D609CBC97FCB}"
-EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "cartservice.tests", "tests\cartservice.tests.csproj", "{59825342-CE64-4AFA-8744-781692C0811B}"
-EndProject
-Global
-	GlobalSection(SolutionConfigurationPlatforms) = preSolution
-		Debug|Any CPU = Debug|Any CPU
-		Debug|x64 = Debug|x64
-		Debug|x86 = Debug|x86
-		Release|Any CPU = Release|Any CPU
-		Release|x64 = Release|x64
-		Release|x86 = Release|x86
-	EndGlobalSection
-	GlobalSection(SolutionProperties) = preSolution
-		HideSolutionNode = FALSE
-	EndGlobalSection
-	GlobalSection(ProjectConfigurationPlatforms) = postSolution
-		{2348C29F-E8D3-4955-916D-D609CBC97FCB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{2348C29F-E8D3-4955-916D-D609CBC97FCB}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{2348C29F-E8D3-4955-916D-D609CBC97FCB}.Debug|x64.ActiveCfg = Debug|Any CPU
-		{2348C29F-E8D3-4955-916D-D609CBC97FCB}.Debug|x64.Build.0 = Debug|Any CPU
-		{2348C29F-E8D3-4955-916D-D609CBC97FCB}.Debug|x86.ActiveCfg = Debug|Any CPU
-		{2348C29F-E8D3-4955-916D-D609CBC97FCB}.Debug|x86.Build.0 = Debug|Any CPU
-		{2348C29F-E8D3-4955-916D-D609CBC97FCB}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{2348C29F-E8D3-4955-916D-D609CBC97FCB}.Release|Any CPU.Build.0 = Release|Any CPU
-		{2348C29F-E8D3-4955-916D-D609CBC97FCB}.Release|x64.ActiveCfg = Release|Any CPU
-		{2348C29F-E8D3-4955-916D-D609CBC97FCB}.Release|x64.Build.0 = Release|Any CPU
-		{2348C29F-E8D3-4955-916D-D609CBC97FCB}.Release|x86.ActiveCfg = Release|Any CPU
-		{2348C29F-E8D3-4955-916D-D609CBC97FCB}.Release|x86.Build.0 = Release|Any CPU
-		{59825342-CE64-4AFA-8744-781692C0811B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{59825342-CE64-4AFA-8744-781692C0811B}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{59825342-CE64-4AFA-8744-781692C0811B}.Debug|x64.ActiveCfg = Debug|Any CPU
-		{59825342-CE64-4AFA-8744-781692C0811B}.Debug|x64.Build.0 = Debug|Any CPU
-		{59825342-CE64-4AFA-8744-781692C0811B}.Debug|x86.ActiveCfg = Debug|Any CPU
-		{59825342-CE64-4AFA-8744-781692C0811B}.Debug|x86.Build.0 = Debug|Any CPU
-		{59825342-CE64-4AFA-8744-781692C0811B}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{59825342-CE64-4AFA-8744-781692C0811B}.Release|Any CPU.Build.0 = Release|Any CPU
-		{59825342-CE64-4AFA-8744-781692C0811B}.Release|x64.ActiveCfg = Release|Any CPU
-		{59825342-CE64-4AFA-8744-781692C0811B}.Release|x64.Build.0 = Release|Any CPU
-		{59825342-CE64-4AFA-8744-781692C0811B}.Release|x86.ActiveCfg = Release|Any CPU
-		{59825342-CE64-4AFA-8744-781692C0811B}.Release|x86.Build.0 = Release|Any CPU
-	EndGlobalSection
-EndGlobal
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio 15
+VisualStudioVersion = 15.0.26124.0
+MinimumVisualStudioVersion = 15.0.26124.0
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "cartservice", "src\cartservice.csproj", "{2348C29F-E8D3-4955-916D-D609CBC97FCB}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "cartservice.tests", "tests\cartservice.tests.csproj", "{59825342-CE64-4AFA-8744-781692C0811B}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Debug|x64 = Debug|x64
+		Debug|x86 = Debug|x86
+		Release|Any CPU = Release|Any CPU
+		Release|x64 = Release|x64
+		Release|x86 = Release|x86
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{2348C29F-E8D3-4955-916D-D609CBC97FCB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{2348C29F-E8D3-4955-916D-D609CBC97FCB}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{2348C29F-E8D3-4955-916D-D609CBC97FCB}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{2348C29F-E8D3-4955-916D-D609CBC97FCB}.Debug|x64.Build.0 = Debug|Any CPU
+		{2348C29F-E8D3-4955-916D-D609CBC97FCB}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{2348C29F-E8D3-4955-916D-D609CBC97FCB}.Debug|x86.Build.0 = Debug|Any CPU
+		{2348C29F-E8D3-4955-916D-D609CBC97FCB}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{2348C29F-E8D3-4955-916D-D609CBC97FCB}.Release|Any CPU.Build.0 = Release|Any CPU
+		{2348C29F-E8D3-4955-916D-D609CBC97FCB}.Release|x64.ActiveCfg = Release|Any CPU
+		{2348C29F-E8D3-4955-916D-D609CBC97FCB}.Release|x64.Build.0 = Release|Any CPU
+		{2348C29F-E8D3-4955-916D-D609CBC97FCB}.Release|x86.ActiveCfg = Release|Any CPU
+		{2348C29F-E8D3-4955-916D-D609CBC97FCB}.Release|x86.Build.0 = Release|Any CPU
+		{59825342-CE64-4AFA-8744-781692C0811B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{59825342-CE64-4AFA-8744-781692C0811B}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{59825342-CE64-4AFA-8744-781692C0811B}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{59825342-CE64-4AFA-8744-781692C0811B}.Debug|x64.Build.0 = Debug|Any CPU
+		{59825342-CE64-4AFA-8744-781692C0811B}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{59825342-CE64-4AFA-8744-781692C0811B}.Debug|x86.Build.0 = Debug|Any CPU
+		{59825342-CE64-4AFA-8744-781692C0811B}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{59825342-CE64-4AFA-8744-781692C0811B}.Release|Any CPU.Build.0 = Release|Any CPU
+		{59825342-CE64-4AFA-8744-781692C0811B}.Release|x64.ActiveCfg = Release|Any CPU
+		{59825342-CE64-4AFA-8744-781692C0811B}.Release|x64.Build.0 = Release|Any CPU
+		{59825342-CE64-4AFA-8744-781692C0811B}.Release|x86.ActiveCfg = Release|Any CPU
+		{59825342-CE64-4AFA-8744-781692C0811B}.Release|x86.Build.0 = Release|Any CPU
+	EndGlobalSection
+EndGlobal
diff --git a/src/frontend/package-lock.json b/src/frontend/package-lock.json
diff --git a/src/frontend/package.json b/src/frontend/package.json
@@ -40,7 +40,7 @@
     "react-dom": "18.2.0",
     "react-query": "3.39.3",
     "sharp": "0.30.7",
-    "styled-components": "5.3.5",
+    "styled-components": "5.3.11",
     "ts-proto": "1.118.0",
     "uuid": "8.3.2"
   },

diff --git a/src/otelcollector/Dockerfile b/src/otelcollector/Dockerfile
diff --git a/src/otelcollector/manifest.yml b/src/otelcollector/manifest.yml
diff --git a/src/quoteservice/Dockerfile b/src/quoteservice/Dockerfile
@@ -2,7 +2,7 @@
 # SPDX-License-Identifier: Apache-2.0
 
 
-FROM composer:2.4 AS build
+FROM composer:2.5 AS build
 
 WORKDIR /tmp/
 COPY ./src/quoteservice/composer.json .

diff --git a/test/README.md b/test/README.md
@@ -1,7 +1,49 @@
 # Service Testing
 
-Testing gRPC services as black boxes.
+There are two ways to test the service APIs in the OpenTelemetry Demo:
+
+1. Using black box-testing, calling gRPC services
+and validating their direct response
+2. Using Trace-based tests, calling both HTTP and
+gRPC services and validating their direct response as well as
+the distributed traces they generate
+
+## Testing gRPC services as black boxes
+
+To run the entire test suite as a black box, run the command:
+
+```sh
+docker compose run integrationTests
+```
+
+If you want to run tests for a specific service, run:
 
 1. Start the services you want to test with `docker compose up --build <service>`
-1. Run `npm install`
-1. Run `npm test` or `npx ava --match='<pattern>'` to match test names
+2. Run `npm install`
+3. Run `npm test` or `npx ava --match='<pattern>'` to match test names
+
+## Testing services with Trace-based tests
+
+To run the entire test suite of trace-based tests, run the command:
+
+```sh
+make run-tracetesting
+#or
+docker compose run traceBasedTests
+```
+
+To run tests for specific services, pass the name of the service as a
+parameter (using the folder names located [here](./tracetesting/)):
+
+```sh
+make run-tracetesting SERVICES_TO_TEST="service-1 service-2 ..."
+#or
+docker compose run traceBasedTests "service-1 service-2 ..."
+```
+
+For instance, if you need to run the tests for `ad-service` and
+`payment-service`, you can run them with:
+
+```sh
+make run-tracetesting SERVICES_TO_TEST="ad-service payment-service"
+```
diff --git a/test/tracetesting/Dockerfile b/test/tracetesting/Dockerfile
@@ -14,4 +14,4 @@ COPY ./pb ./pb
 
 WORKDIR /app/test/tracetesting
 
-CMD ["/bin/sh", "/app/test/tracetesting/run.bash"]
+ENTRYPOINT ["/bin/bash", "/app/test/tracetesting/run.bash"]