Add end to end test suits. (microsoft#116)

* update library version - update gradle plugin version

init end2end tests

add end2end test suits

* comment out mandatory parame for testing

* assert end2end tests is running by failing it

* clean up

* wait 10 seconds for sidecar to be fully up

* remove unused files

Author: kaibocai

.github/workflows/build-validation.yml

@@ -43,6 +43,9 @@ jobs:
       # TODO: Move the sidecar into a central image repository
     - name: Initialize Durable Task Sidecar
       run: docker run --name durabletask-sidecar -p 4001:4001 --env 'DURABLETASK_SIDECAR_LOGLEVEL=Debug' -d kaibocai/durabletask-sidecar:latest start --backend Emulator
+#    wait for 10 seconds, so sidecar container can be fully up, this will avoid intermittent failing issues for integration tests causing by failed to connect to sidecar
+    - name: Wait for 10 seconds
+      run: sleep 10
     - name: Integration Tests with Gradle
       uses: gradle/gradle-build-action@bc3340afc5e3cc44f2321809ac090d731c13c514
       with:
@@ -58,7 +61,7 @@ jobs:
         name: Package
         path: client/build/libs
 
-  functions:
+  functions-e2e-tests:
 
     needs: build
     runs-on: ubuntu-latest
@@ -81,9 +84,15 @@ jobs:
         with:
           arguments: azureFunctionsPackage
         continue-on-error: true
-      - name: Download azure functions java library # TODO: Remove this step once gradle plugin is updated
-        run: |
-          wget -P samples-azure-functions/build/azure-functions/azure-functions-sample/lib/ "https://repo.maven.apache.org/maven2/com/microsoft/azure/functions/azure-functions-java-library/2.2.0/azure-functions-java-library-2.2.0.jar" --show-progress
-      - name: Run azure functions test
-        run: samples-azure-functions/e2e-test.ps1 -DockerfilePath samples-azure-functions/Dockerfile -HttpStartPath api/StartOrchestration
+      - name: Setup azure functions runtime
+        run: samples-azure-functions/e2e-test-setup.ps1 -DockerfilePath samples-azure-functions/Dockerfile
         shell: pwsh
+      - name: End to End Tests with Gradle
+        uses: gradle/gradle-build-action@bc3340afc5e3cc44f2321809ac090d731c13c514
+        with:
+          arguments: endToEndTest
+      - name: Archive test report
+        uses: actions/upload-artifact@v2
+        with:
+          name: Integration test report
+          path: client/build/reports/tests/endToEndTest

azurefunctions/build.gradle

@@ -17,7 +17,7 @@ repositories {
 
 dependencies {
     api project(':client')
-    implementation group: 'com.microsoft.azure.functions', name: 'azure-functions-java-library', version: '2.2.0'
+    implementation group: 'com.microsoft.azure.functions', name: 'azure-functions-java-library', version: '3.0.0'
     implementation "com.google.protobuf:protobuf-java:${protocVersion}"
     compileOnly "com.microsoft.azure.functions:azure-functions-java-spi:1.0.0"
 }

client/src/test/java/com/microsoft/durabletask/IntegrationTests.java

@@ -7,7 +7,6 @@
 import java.util.*;
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.TimeoutException;
-import java.util.concurrent.ExecutionException;
 import java.util.stream.Collectors;
 import java.util.stream.IntStream;
 import java.util.stream.Stream;

samples-azure-functions/Dockerfile

@@ -1,7 +1,5 @@
 FROM mcr.microsoft.com/azure-functions/java:4-java11
 
-RUN rm /azure-functions-host/workers/java/azure-functions-java-worker.jar
-COPY samples-azure-functions/azure-functions-java-worker-2.7.0.jar /azure-functions-host/workers/java/azure-functions-java-worker.jar
 COPY samples-azure-functions/build/azure-functions/azure-functions-sample/ /home/site/wwwroot/
 ENV AzureWebJobsScriptRoot=/home/site/wwwroot \
     AzureFunctionsJobHost__Logging__Console__IsEnabled=true

samples-azure-functions/build.gradle

@@ -1,5 +1,5 @@
 plugins {
-    id "com.microsoft.azure.azurefunctions" version "1.9.0"
+    id "com.microsoft.azure.azurefunctions" version "1.11.1"
 }
 apply plugin: 'java'
 apply plugin: "com.microsoft.azure.azurefunctions"
@@ -19,17 +19,27 @@ dependencies {
     implementation project(':client')
     implementation project(':azurefunctions')
 
-    implementation 'com.microsoft.azure.functions:azure-functions-java-library:2.2.0'
+    implementation 'com.microsoft.azure.functions:azure-functions-java-library:3.0.0'
     testImplementation 'org.junit.jupiter:junit-jupiter:5.6.2'
-    testImplementation 'org.mockito:mockito-core:3.3.3'
-    runtimeOnly "io.grpc:grpc-netty-shaded:1.38.0"
+    testImplementation 'io.rest-assured:rest-assured:5.3.0'
+    testImplementation 'io.rest-assured:json-path:5.3.0'
+
 }
 
 sourceCompatibility = '1.8'
 targetCompatibility = '1.8'
 
 compileJava.options.encoding = 'UTF-8'
 
+task endToEndTest(type: Test) {
+    useJUnitPlatform {
+        includeTags 'e2e'
+    }
+    dependsOn build
+    testLogging.showStandardStreams = true
+}
+
+
 azurefunctions {
     resourceGroup = 'java-functions-group'
     appName = 'azure-functions-sample'

samples-azure-functions/e2e-test-setup.ps1

@@ -0,0 +1,42 @@
+# Installing PowerShell: https://docs.microsoft.com/powershell/scripting/install/installing-powershell
+
+param(
+	[Parameter(Mandatory=$true)]
+	[string]$DockerfilePath,
+    [string]$ImageName="dfapp",
+	[string]$ContainerName="app",
+	[switch]$NoSetup=$false,
+	[switch]$NoValidation=$false,
+	[string]$AzuriteVersion="3.20.1",
+	[int]$Sleep=30
+)
+
+$ErrorActionPreference = "Stop"
+
+if ($NoSetup -eq $false) {
+	# Build the docker image first, since that's the most critical step
+	Write-Host "Building sample app Docker container from '$DockerfilePath'..." -ForegroundColor Yellow
+	docker build -f $DockerfilePath -t $ImageName --progress plain .
+
+	# Next, download and start the Azurite emulator Docker image
+	Write-Host "Pulling down the mcr.microsoft.com/azure-storage/azurite:$AzuriteVersion image..." -ForegroundColor Yellow
+	docker pull "mcr.microsoft.com/azure-storage/azurite:${AzuriteVersion}"
+
+	Write-Host "Starting Azurite storage emulator using default ports..." -ForegroundColor Yellow
+	docker run --name 'azurite' -p 10000:10000 -p 10001:10001 -p 10002:10002 -d "mcr.microsoft.com/azure-storage/azurite:${AzuriteVersion}"
+
+	# Finally, start up the smoke test container, which will connect to the Azurite container
+	docker run --name $ContainerName -p 8080:80 -it --add-host=host.docker.internal:host-gateway -d `
+		--env 'AzureWebJobsStorage=UseDevelopmentStorage=true;DevelopmentStorageProxyUri=http://host.docker.internal' `
+		--env 'WEBSITE_HOSTNAME=localhost:8080' `
+		$ImageName
+}
+
+if ($sleep -gt  0) {
+	# The container needs a bit more time before it can start receiving requests
+	Write-Host "Sleeping for $Sleep seconds to let the container finish initializing..." -ForegroundColor Yellow
+	Start-Sleep -Seconds $Sleep
+}
+
+# Check to see what containers are running
+docker ps

samples-azure-functions/e2e-test.ps1

@@ -0,0 +1,39 @@
+package com.functions;
+
+import io.restassured.path.json.JsonPath;
+import io.restassured.response.Response;
+import org.junit.jupiter.api.Order;
+import org.junit.jupiter.api.Tag;
+import org.junit.jupiter.api.Test;
+
+import static io.restassured.RestAssured.get;
+import static io.restassured.RestAssured.post;
+import static org.junit.jupiter.api.Assertions.*;
+
+@Tag("e2e")
+public class EndToEndTests {
+    private static final String hostHealthPingPath = "/admin/host/ping";
+    private static final String startOrchestrationPath = "/api/StartOrchestration";
+
+    @Order(1)
+    @Test
+    public void setupHost() {
+        post(hostHealthPingPath).then().statusCode(200);
+    }
+
+    @Test
+    public void basicChain() throws InterruptedException {
+        Response response = post(startOrchestrationPath);
+        JsonPath jsonPath = response.jsonPath();
+        String statusQueryGetUri = jsonPath.get("statusQueryGetUri");
+        String runTimeStatus = null;
+        for (int i = 0; i < 15; i++) {
+            Response statusResponse = get(statusQueryGetUri);
+            runTimeStatus = statusResponse.jsonPath().get("runtimeStatus");
+            if (!"Completed".equals(runTimeStatus)) {
+                Thread.sleep(1000);
+            } else break;
+        }
+        assertEquals("Completed", runTimeStatus);
+    }
+}