Add integration testing for latency instrumentation

Adds a thorough integration test which tests latency instrumentation by querying a resource which makes a downstream call to itself, recording timing info along the way. This timing info is checked for completeness and consistency. RB=1745931 G=sf-reviewers R=fcapponi,ssheng,crzhang,bsoetarm,dmessink A=kbalasub,crzhang,bsoetarm
linkedin · Dec 10, 2019 · 6fc9d37 · 6fc9d37
1 parent 67c7ebd
commit 6fc9d37
Show file tree

Hide file tree

Showing 15 changed files with 933 additions and 23 deletions.
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,5 +1,11 @@
-28.0.13
--------
+28.1.1
+------
+
+28.1.0
+------
+(RB=1745931)
+Add integration testing for latency instrumentation
+
 (RB=1745924)
 Add instrumentation timing markers for projection mask application
 

diff --git a/gradle.properties b/gradle.properties
@@ -1,4 +1,4 @@
-version=28.0.12
+version=28.1.0
 sonatypeUsername=please_set_in_home_dir_if_uploading_to_maven_central
 sonatypePassword=please_set_in_home_dir_if_uploading_to_maven_central
 org.gradle.configureondemand=true

diff --git a/.../com.linkedin.restli.examples.instrumentation.client.latencyInstrumentation.restspec.json b/.../com.linkedin.restli.examples.instrumentation.client.latencyInstrumentation.restspec.json
@@ -0,0 +1,30 @@
+{
+  "name" : "latencyInstrumentation",
+  "namespace" : "com.linkedin.restli.examples.instrumentation.client",
+  "path" : "/latencyInstrumentation",
+  "schema" : "com.linkedin.restli.examples.instrumentation.api.InstrumentationControl",
+  "doc" : "Resource used for testing framework latency instrumentation.\n\n The integration test using this resource queries {@link #create(InstrumentationControl)} (the \"upstream endpoint\"),\n which queries {@link #batchPartialUpdate(BatchPatchRequest)} (the \"downstream endpoint\"). The \"upstream endpoint\"\n collects all the client-side timing data after the downstream call has completed and packs it into the original\n server-side request context so that the integration test has access to all of it.\n\n The input entity itself indicates to the resource whether to use streaming or rest, whether to throw an exception at\n both endpoints, whether to use scatter-gather for the downstream request, and what its own hostname is so it can make\n the circular downstream request. The \"upstream endpoint\" sets a special header so that the integration test knows\n which request to analyze, this is done to avoid analyzing the protocol version fetch request.\n\ngenerated from: com.linkedin.restli.examples.instrumentation.server.LatencyInstrumentationResource",
+  "collection" : {
+    "identifier" : {
+      "name" : "latencyInstrumentationId",
+      "type" : "long"
+    },
+    "supports" : [ "batch_partial_update", "create" ],
+    "methods" : [ {
+      "annotations" : {
+        "returnEntity" : { }
+      },
+      "method" : "create",
+      "doc" : "This is the \"upstream endpoint\" which is queried directly by the integration test.\n This endpoint makes a call to {@link #batchPartialUpdate(BatchPatchRequest)} (the \"downstream endpoint\"),\n then packs all the client-side timing data into the original server-side request context."
+    }, {
+      "annotations" : {
+        "returnEntity" : { }
+      },
+      "method" : "batch_partial_update",
+      "doc" : "This is the \"downstream endpoint\", queried by {@link #create(InstrumentationControl)} (the \"upstream endpoint\")."
+    } ],
+    "entity" : {
+      "path" : "/latencyInstrumentation/{latencyInstrumentationId}"
+    }
+  }
+}
diff --git a/...main/pegasus/com/linkedin/restli/examples/instrumentation/api/InstrumentationControl.pdsc b/...main/pegasus/com/linkedin/restli/examples/instrumentation/api/InstrumentationControl.pdsc
@@ -0,0 +1,28 @@
+{
+  "type" : "record",
+  "name" : "InstrumentationControl",
+  "namespace" : "com.linkedin.restli.examples.instrumentation.api",
+  "doc" : "A record containing control information for latency instrumentation testing.",
+  "fields" : [
+    {
+      "name" : "serviceUriPrefix",
+      "type" : "string",
+      "doc" : "URI prefix of the service running the instrumentation resource."
+    },
+    {
+      "name" : "useStreaming",
+      "type" : "boolean",
+      "doc" : "Whether the resource should use streaming for its downstream service calls."
+    },
+    {
+      "name" : "forceException",
+      "type" : "boolean",
+      "doc" : "Whether the resource should throw service exceptions."
+    },
+    {
+      "name" : "useScatterGather",
+      "type" : "boolean",
+      "doc" : "Whether the resource should use scatter-gather for its downstream service calls."
+    }
+  ]
+}
diff --git a/...main/snapshot/com.linkedin.restli.examples.greetings.client.chainedTyperefs.snapshot.json b/...main/snapshot/com.linkedin.restli.examples.greetings.client.chainedTyperefs.snapshot.json
@@ -40,17 +40,17 @@
       }
     },
     "java" : {
-      "coercerClass" : "com.linkedin.restli.examples.custom.types.CustomNonNegativeLongCoercer",
-      "class" : "com.linkedin.restli.examples.custom.types.CustomNonNegativeLong"
+      "class" : "com.linkedin.restli.examples.custom.types.CustomNonNegativeLong",
+      "coercerClass" : "com.linkedin.restli.examples.custom.types.CustomNonNegativeLongCoercer"
     }
   }, {
     "type" : "typeref",
     "name" : "DateRef",
     "namespace" : "com.linkedin.restli.examples.typeref.api",
     "ref" : "long",
     "java" : {
-      "coercerClass" : "com.linkedin.restli.examples.custom.types.DateCoercer",
-      "class" : "java.util.Date"
+      "class" : "java.util.Date",
+      "coercerClass" : "com.linkedin.restli.examples.custom.types.DateCoercer"
     }
   } ],
   "schema" : {

diff --git a/...src/main/snapshot/com.linkedin.restli.examples.greetings.client.customTypes.snapshot.json b/...src/main/snapshot/com.linkedin.restli.examples.greetings.client.customTypes.snapshot.json
@@ -33,8 +33,8 @@
     "namespace" : "com.linkedin.restli.examples.typeref.api",
     "ref" : "int",
     "java" : {
-      "coercerClass" : "com.linkedin.restli.examples.custom.types.CalendarCoercer",
-      "class" : "java.util.Calendar"
+      "class" : "java.util.Calendar",
+      "coercerClass" : "com.linkedin.restli.examples.custom.types.CalendarCoercer"
     }
   }, {
     "type" : "typeref",
@@ -50,17 +50,17 @@
     "namespace" : "com.linkedin.restli.examples.typeref.api",
     "ref" : "long",
     "java" : {
-      "coercerClass" : "com.linkedin.restli.examples.custom.types.DateCoercer",
-      "class" : "java.util.Date"
+      "class" : "java.util.Date",
+      "coercerClass" : "com.linkedin.restli.examples.custom.types.DateCoercer"
     }
   }, {
     "type" : "typeref",
     "name" : "IPAddressSimple",
     "namespace" : "com.linkedin.restli.examples.typeref.api",
     "ref" : "bytes",
     "java" : {
-      "coercerClass" : "com.linkedin.restli.examples.custom.types.IPAddressSimpleCoercer",
-      "class" : "java.net.InetAddress"
+      "class" : "java.net.InetAddress",
+      "coercerClass" : "com.linkedin.restli.examples.custom.types.IPAddressSimpleCoercer"
     }
   } ],
   "schema" : {

diff --git a/...rc/main/snapshot/com.linkedin.restli.examples.greetings.client.customTypes3.snapshot.json b/...rc/main/snapshot/com.linkedin.restli.examples.greetings.client.customTypes3.snapshot.json
@@ -41,8 +41,8 @@
     "namespace" : "com.linkedin.restli.examples.typeref.api",
     "ref" : "long",
     "java" : {
-      "coercerClass" : "com.linkedin.restli.examples.custom.types.DateCoercer",
-      "class" : "java.util.Date"
+      "class" : "java.util.Date",
+      "coercerClass" : "com.linkedin.restli.examples.custom.types.DateCoercer"
     }
   } ],
   "schema" : {

diff --git a/....restli.examples.greetings.client.typerefCustomDoubleAssociationKeyResource.snapshot.json b/....restli.examples.greetings.client.typerefCustomDoubleAssociationKeyResource.snapshot.json
@@ -41,8 +41,8 @@
     "namespace" : "com.linkedin.restli.examples.typeref.api",
     "ref" : "string",
     "java" : {
-      "coercerClass" : "com.linkedin.restli.examples.custom.types.UriCoercer",
-      "class" : "java.net.URI"
+      "class" : "java.net.URI",
+      "coercerClass" : "com.linkedin.restli.examples.custom.types.UriCoercer"
     }
   } ],
   "schema" : {

diff --git a/.../com.linkedin.restli.examples.instrumentation.client.latencyInstrumentation.snapshot.json b/.../com.linkedin.restli.examples.instrumentation.client.latencyInstrumentation.snapshot.json
@@ -0,0 +1,55 @@
+{
+  "models" : [ {
+    "type" : "record",
+    "name" : "InstrumentationControl",
+    "namespace" : "com.linkedin.restli.examples.instrumentation.api",
+    "doc" : "A record containing control information for latency instrumentation testing.",
+    "fields" : [ {
+      "name" : "serviceUriPrefix",
+      "type" : "string",
+      "doc" : "URI prefix of the service running the instrumentation resource."
+    }, {
+      "name" : "useStreaming",
+      "type" : "boolean",
+      "doc" : "Whether the resource should use streaming for its downstream service calls."
+    }, {
+      "name" : "forceException",
+      "type" : "boolean",
+      "doc" : "Whether the resource should throw service exceptions."
+    }, {
+      "name" : "useScatterGather",
+      "type" : "boolean",
+      "doc" : "Whether the resource should use scatter-gather for its downstream service calls."
+    } ]
+  } ],
+  "schema" : {
+    "name" : "latencyInstrumentation",
+    "namespace" : "com.linkedin.restli.examples.instrumentation.client",
+    "path" : "/latencyInstrumentation",
+    "schema" : "com.linkedin.restli.examples.instrumentation.api.InstrumentationControl",
+    "doc" : "Resource used for testing framework latency instrumentation.\n\n The integration test using this resource queries {@link #create(InstrumentationControl)} (the \"upstream endpoint\"),\n which queries {@link #batchPartialUpdate(BatchPatchRequest)} (the \"downstream endpoint\"). The \"upstream endpoint\"\n collects all the client-side timing data after the downstream call has completed and packs it into the original\n server-side request context so that the integration test has access to all of it.\n\n The input entity itself indicates to the resource whether to use streaming or rest, whether to throw an exception at\n both endpoints, whether to use scatter-gather for the downstream request, and what its own hostname is so it can make\n the circular downstream request. The \"upstream endpoint\" sets a special header so that the integration test knows\n which request to analyze, this is done to avoid analyzing the protocol version fetch request.\n\ngenerated from: com.linkedin.restli.examples.instrumentation.server.LatencyInstrumentationResource",
+    "collection" : {
+      "identifier" : {
+        "name" : "latencyInstrumentationId",
+        "type" : "long"
+      },
+      "supports" : [ "batch_partial_update", "create" ],
+      "methods" : [ {
+        "annotations" : {
+          "returnEntity" : { }
+        },
+        "method" : "create",
+        "doc" : "This is the \"upstream endpoint\" which is queried directly by the integration test.\n This endpoint makes a call to {@link #batchPartialUpdate(BatchPatchRequest)} (the \"downstream endpoint\"),\n then packs all the client-side timing data into the original server-side request context."
+      }, {
+        "annotations" : {
+          "returnEntity" : { }
+        },
+        "method" : "batch_partial_update",
+        "doc" : "This is the \"downstream endpoint\", queried by {@link #create(InstrumentationControl)} (the \"upstream endpoint\")."
+      } ],
+      "entity" : {
+        "path" : "/latencyInstrumentation/{latencyInstrumentationId}"
+      }
+    }
+  }
+}
diff --git a/...t-api/src/main/snapshot/com.linkedin.restli.examples.typeref.client.typeref.snapshot.json b/...t-api/src/main/snapshot/com.linkedin.restli.examples.typeref.client.typeref.snapshot.json
@@ -22,8 +22,8 @@
       }
     },
     "java" : {
-      "coercerClass" : "com.linkedin.restli.examples.custom.types.CustomNonNegativeLongCoercer",
-      "class" : "com.linkedin.restli.examples.custom.types.CustomNonNegativeLong"
+      "class" : "com.linkedin.restli.examples.custom.types.CustomNonNegativeLong",
+      "coercerClass" : "com.linkedin.restli.examples.custom.types.CustomNonNegativeLongCoercer"
     }
   }, {
     "type" : "typeref",

diff --git a/restli-int-test-server/build.gradle b/restli-int-test-server/build.gradle
@@ -7,6 +7,7 @@ apply plugin: 'java'
 dependencies {
   compile project(':restli-int-test-api')
   compile project(path: ':restli-int-test-api', configuration: 'dataTemplate')
+  compile project(path: ':restli-int-test-api', configuration: 'restClient')
   compile project(':restli-server-standalone') // for task startServerStandaloneLauncher
   compile project(':data')
   compile project(':data-testutils')
@@ -118,6 +119,7 @@ clean.dependsOn(cleanGenerateGreetings)
 // Generate IDLs for ACL, Groups, and Greetings.
 pegasus.main.idlOptions.addIdlItem(['com.linkedin.restli.examples.groups.server'])
 pegasus.main.idlOptions.addIdlItem(['com.linkedin.restli.examples.greetings.server'])
+pegasus.main.idlOptions.addIdlItem(['com.linkedin.restli.examples.instrumentation.server'])
 pegasus.main.idlOptions.addIdlItem(['com.linkedin.restli.examples.typeref.server'])
 pegasus.test.idlOptions.addIdlItem(['com.linkedin.restli.restspec'])
 

diff --git a/restli-int-test-server/src/main/java/com/linkedin/restli/examples/RestLiIntTestServer.java b/restli-int-test-server/src/main/java/com/linkedin/restli/examples/RestLiIntTestServer.java
@@ -62,6 +62,7 @@ public class RestLiIntTestServer
   public static final String[] RESOURCE_PACKAGE_NAMES = {
       "com.linkedin.restli.examples.groups.server.rest.impl",
       "com.linkedin.restli.examples.greetings.server",
+      "com.linkedin.restli.examples.instrumentation.server",
       "com.linkedin.restli.examples.typeref.server"  };
 
   public static void main(String[] args) throws IOException