change test and rename

siyuniums · siyuniums · commit 31c7804f646d · 2022-08-04T12:13:57.000-07:00
diff --git a/instrumentation/servlet/servlet-3.0/javaagent-unit-tests/src/test/java/io/opentelemetry/javaagent/instrumentation/servlet/v3_0/snippet/InjectionTest.java b/instrumentation/servlet/servlet-3.0/javaagent-unit-tests/src/test/java/io/opentelemetry/javaagent/instrumentation/servlet/v3_0/snippet/InjectionTest.java
@@ -7,8 +7,10 @@
 
 import static io.opentelemetry.javaagent.instrumentation.servlet.v3_0.snippet.TestUtil.readFile;
 import static org.assertj.core.api.AssertionsForClassTypes.assertThat;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
 
-import io.opentelemetry.javaagent.bootstrap.servlet.SnippetHolder;
+import io.opentelemetry.javaagent.bootstrap.servlet.ExperimentalSnippetHolder;
 import java.io.IOException;
 import java.io.StringWriter;
 import java.nio.charset.StandardCharsets;
@@ -21,13 +23,16 @@ class InjectionTest {
   @Test
   void testInjectionForStringContainHeadTag() throws IOException {
     String testSnippet = "\n  <script type=\"text/javascript\"> Test </script>";
-    SnippetHolder.setSnippet(testSnippet);
+    ExperimentalSnippetHolder.setSnippet(testSnippet);
     // read the originalFile
     String original = readFile("staticHtmlOrigin.html");
     // read the correct answer
     String correct = readFile("staticHtmlAfter.html");
     byte[] originalBytes = original.getBytes(StandardCharsets.UTF_8);
-    InjectionState obj = new InjectionState(StandardCharsets.UTF_8.name());
+    SnippetInjectingResponseWrapper response = mock(SnippetInjectingResponseWrapper.class);
+    when(response.isCommitted()).thenReturn(false);
+    when(response.getCharacterEncoding()).thenReturn(StandardCharsets.UTF_8.name());
+    InjectionState obj = new InjectionState(response);
 
     StringWriter writer = new StringWriter();
 
@@ -54,13 +59,16 @@ public void write(int b) throws IOException {
   @Disabled
   void testInjectionForChinese() throws IOException {
     String testSnippet = "\n  <script type=\"text/javascript\"> Test </script>";
-    SnippetHolder.setSnippet(testSnippet);
+    ExperimentalSnippetHolder.setSnippet(testSnippet);
     // read the originalFile
     String original = readFile("staticHtmlChineseOrigin.html");
     // read the correct answer
     String correct = readFile("staticHtmlChineseAfter.html");
     byte[] originalBytes = original.getBytes(StandardCharsets.UTF_8);
-    InjectionState obj = new InjectionState(StandardCharsets.UTF_8.name());
+    SnippetInjectingResponseWrapper response = mock(SnippetInjectingResponseWrapper.class);
+    when(response.isCommitted()).thenReturn(false);
+    when(response.getCharacterEncoding()).thenReturn(StandardCharsets.UTF_8.name());
+    InjectionState obj = new InjectionState(response);
 
     StringWriter writer = new StringWriter();
 
@@ -86,12 +94,15 @@ public void write(int b) throws IOException {
   @Test
   void testInjectionForStringWithoutHeadTag() throws IOException {
     String testSnippet = "\n  <script type=\"text/javascript\"> Test </script>";
-    SnippetHolder.setSnippet(testSnippet);
+    ExperimentalSnippetHolder.setSnippet(testSnippet);
     // read the originalFile
     String original = readFile("htmlWithoutHeadTag.html");
 
     byte[] originalBytes = original.getBytes(StandardCharsets.UTF_8);
-    InjectionState obj = new InjectionState(StandardCharsets.UTF_8.name());
+    SnippetInjectingResponseWrapper response = mock(SnippetInjectingResponseWrapper.class);
+    when(response.isCommitted()).thenReturn(false);
+    when(response.getCharacterEncoding()).thenReturn(StandardCharsets.UTF_8.name());
+    InjectionState obj = new InjectionState(response);
     StringWriter writer = new StringWriter();
 
     ServletOutputStream sp =
@@ -115,11 +126,14 @@ public void write(int b) throws IOException {
   @Test
   void testHalfHeadTag() throws IOException {
     String testSnippet = "\n  <script type=\"text/javascript\"> Test </script>";
-    SnippetHolder.setSnippet(testSnippet);
+    ExperimentalSnippetHolder.setSnippet(testSnippet);
     // read the original string
     String originalFirstPart = "<!DOCTYPE html>\n" + "<html lang=\"en\">\n" + "<he";
     byte[] originalFirstPartBytes = originalFirstPart.getBytes(StandardCharsets.UTF_8);
-    InjectionState obj = new InjectionState(StandardCharsets.UTF_8.name());
+    SnippetInjectingResponseWrapper response = mock(SnippetInjectingResponseWrapper.class);
+    when(response.isCommitted()).thenReturn(false);
+    when(response.getCharacterEncoding()).thenReturn(StandardCharsets.UTF_8.name());
+    InjectionState obj = new InjectionState(response);
     StringWriter writer = new StringWriter();
 
     ServletOutputStream sp =
diff --git a/instrumentation/servlet/servlet-3.0/javaagent-unit-tests/src/test/java/io/opentelemetry/javaagent/instrumentation/servlet/v3_0/snippet/SnippetInjectingResponseWrapperTest.java b/instrumentation/servlet/servlet-3.0/javaagent-unit-tests/src/test/java/io/opentelemetry/javaagent/instrumentation/servlet/v3_0/snippet/SnippetInjectingResponseWrapperTest.java
@@ -10,7 +10,7 @@
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.when;
 
-import io.opentelemetry.javaagent.bootstrap.servlet.SnippetHolder;
+import io.opentelemetry.javaagent.bootstrap.servlet.ExperimentalSnippetHolder;
 import java.io.IOException;
 import java.io.PrintWriter;
 import java.io.StringWriter;
@@ -33,7 +33,7 @@ void testInjectToTextHtml() throws IOException {
     when(response.containsHeader("content-type")).thenReturn(true);
     StringWriter writer = new StringWriter();
     when(response.getWriter()).thenReturn(new PrintWriter(writer));
-    SnippetHolder.setSnippet("\n  <script type=\"text/javascript\"> Test </script>");
+    ExperimentalSnippetHolder.setSnippet("\n  <script type=\"text/javascript\"> Test </script>");
     SnippetInjectingResponseWrapper responseWrapper = new SnippetInjectingResponseWrapper(response);
     responseWrapper.getWriter().write(original);
     responseWrapper.getWriter().flush();
@@ -58,7 +58,7 @@ void testInjectToChineseTextHtml() throws IOException {
 
     StringWriter writer = new StringWriter();
     when(response.getWriter()).thenReturn(new PrintWriter(writer));
-    SnippetHolder.setSnippet("\n  <script type=\"text/javascript\"> Test </script>");
+    ExperimentalSnippetHolder.setSnippet("\n  <script type=\"text/javascript\"> Test </script>");
     SnippetInjectingResponseWrapper responseWrapper = new SnippetInjectingResponseWrapper(response);
     responseWrapper.getWriter().write(original);
     responseWrapper.getWriter().flush();
@@ -84,7 +84,7 @@ void shouldNotInjectToTextHtml() throws IOException {
     when(response.containsHeader("content-type")).thenReturn(true);
 
     when(response.getWriter()).thenReturn(new PrintWriter(writer, true));
-    SnippetHolder.setSnippet("\n  <script type=\"text/javascript\"> Test </script>");
+    ExperimentalSnippetHolder.setSnippet("\n  <script type=\"text/javascript\"> Test </script>");
 
     SnippetInjectingResponseWrapper responseWrapper = new SnippetInjectingResponseWrapper(response);
     responseWrapper.getWriter().write(original);
@@ -110,7 +110,7 @@ void testWriteInt() throws IOException {
     StringWriter writer = new StringWriter();
     //    StringWriter correctWriter = new StringWriter();
     when(response.getWriter()).thenReturn(new PrintWriter(writer));
-    SnippetHolder.setSnippet("\n  <script type=\"text/javascript\"> Test </script>");
+    ExperimentalSnippetHolder.setSnippet("\n  <script type=\"text/javascript\"> Test </script>");
     SnippetInjectingResponseWrapper responseWrapper = new SnippetInjectingResponseWrapper(response);
     byte[] originalBytes = original.getBytes(Charset.defaultCharset().name());
     //    byte[] correctBytes = correct.getBytes(UTF_8);
@@ -142,7 +142,7 @@ void testWriteCharArray() throws IOException {
 
     StringWriter writer = new StringWriter();
     when(response.getWriter()).thenReturn(new PrintWriter(writer));
-    SnippetHolder.setSnippet("\n  <script type=\"text/javascript\"> Test </script>");
+    ExperimentalSnippetHolder.setSnippet("\n  <script type=\"text/javascript\"> Test </script>");
     SnippetInjectingResponseWrapper responseWrapper = new SnippetInjectingResponseWrapper(response);
     char[] originalChars = original.toCharArray();
     responseWrapper.getWriter().write(originalChars, 0, originalChars.length);
@@ -171,7 +171,7 @@ void testWriteWithOffset() throws IOException {
 
     StringWriter writer = new StringWriter();
     when(response.getWriter()).thenReturn(new PrintWriter(writer));
-    SnippetHolder.setSnippet("\n  <script type=\"text/javascript\"> Test </script>");
+    ExperimentalSnippetHolder.setSnippet("\n  <script type=\"text/javascript\"> Test </script>");
     SnippetInjectingResponseWrapper responseWrapper = new SnippetInjectingResponseWrapper(response);
 
     responseWrapper
diff --git a/instrumentation/servlet/servlet-3.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/servlet/v3_0/Servlet3Advice.java b/instrumentation/servlet/servlet-3.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/servlet/v3_0/Servlet3Advice.java
@@ -13,8 +13,8 @@
 import io.opentelemetry.javaagent.bootstrap.CallDepth;
 import io.opentelemetry.javaagent.bootstrap.Java8BytecodeBridge;
 import io.opentelemetry.javaagent.bootstrap.servlet.AppServerBridge;
+import io.opentelemetry.javaagent.bootstrap.servlet.ExperimentalSnippetHolder;
 import io.opentelemetry.javaagent.bootstrap.servlet.MappingResolver;
-import io.opentelemetry.javaagent.bootstrap.servlet.SnippetHolder;
 import io.opentelemetry.javaagent.instrumentation.servlet.ServletRequestContext;
 import io.opentelemetry.javaagent.instrumentation.servlet.v3_0.snippet.SnippetInjectingResponseWrapper;
 import javax.servlet.Servlet;
@@ -43,7 +43,7 @@ public static void onEnter(
     }
     HttpServletRequest httpServletRequest = (HttpServletRequest) request;
 
-    if (!SnippetHolder.getSnippet().isEmpty()
+    if (!ExperimentalSnippetHolder.getSnippet().isEmpty()
         && !((HttpServletResponse) response).containsHeader(FAKE_SNIPPET_HEADER)) {
       response = new SnippetInjectingResponseWrapper((HttpServletResponse) response);
     }
diff --git a/instrumentation/servlet/servlet-3.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/servlet/v3_0/snippet/InjectionState.java b/instrumentation/servlet/servlet-3.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/servlet/v3_0/snippet/InjectionState.java
@@ -20,11 +20,6 @@ public InjectionState(SnippetInjectingResponseWrapper wrapper) {
     this.characterEncoding = wrapper.getCharacterEncoding();
   }
 
-  public InjectionState(String characterEncoding) {
-    this.characterEncoding = characterEncoding;
-    this.wrapper = null;
-  }
-
   public int getHeadTagBytesSeen() {
     return headTagBytesSeen;
   }
diff --git a/instrumentation/servlet/servlet-3.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/servlet/v3_0/snippet/ServletOutputStreamInjectionHelper.java b/instrumentation/servlet/servlet-3.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/servlet/v3_0/snippet/ServletOutputStreamInjectionHelper.java
@@ -7,7 +7,7 @@
 
 import static java.util.logging.Level.FINE;
 
-import io.opentelemetry.javaagent.bootstrap.servlet.SnippetHolder;
+import io.opentelemetry.javaagent.bootstrap.servlet.ExperimentalSnippetHolder;
 import java.io.IOException;
 import java.io.UnsupportedEncodingException;
 import java.util.logging.Logger;
@@ -42,7 +42,7 @@ public static boolean handleWrite(
     state.setAlreadyInjected(); // set before write to avoid recursive loop
     out.write(original, off, i + 1);
     try {
-      byte[] snippetBytes = SnippetHolder.getSnippetBytes(state.getCharacterEncoding());
+      byte[] snippetBytes = ExperimentalSnippetHolder.getSnippetBytes(state.getCharacterEncoding());
       if (state.getWrapper().isCommitted()) {
         // header already set and sent, stop inject
         return false;
@@ -71,7 +71,7 @@ public static boolean handleWrite(InjectionState state, ServletOutputStream out,
     state.setAlreadyInjected(); // set before write to avoid recursive loop
     out.write(b);
     try {
-      byte[] snippetBytes = SnippetHolder.getSnippetBytes(state.getCharacterEncoding());
+      byte[] snippetBytes = ExperimentalSnippetHolder.getSnippetBytes(state.getCharacterEncoding());
       if (state.getWrapper().isCommitted()) {
         // header already set and sent, stop inject
         return false;
diff --git a/instrumentation/servlet/servlet-3.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/servlet/v3_0/snippet/SnippetInjectingResponseWrapper.java b/instrumentation/servlet/servlet-3.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/servlet/v3_0/snippet/SnippetInjectingResponseWrapper.java
@@ -8,7 +8,7 @@
 import static io.opentelemetry.javaagent.instrumentation.servlet.v3_0.snippet.Injection.initializeInjectionStateIfNeeded;
 import static java.util.logging.Level.FINE;
 
-import io.opentelemetry.javaagent.bootstrap.servlet.SnippetHolder;
+import io.opentelemetry.javaagent.bootstrap.servlet.ExperimentalSnippetHolder;
 import java.io.IOException;
 import java.io.PrintWriter;
 import java.lang.invoke.MethodHandle;
@@ -23,7 +23,7 @@
 public class SnippetInjectingResponseWrapper extends HttpServletResponseWrapper {
   private static final Logger logger = Logger.getLogger(HttpServletResponseWrapper.class.getName());
   public static final String FAKE_SNIPPET_HEADER = "FAKE_SNIPPET_HEADER";
-  private static final String SNIPPET = SnippetHolder.getSnippet();
+  private static final String SNIPPET = ExperimentalSnippetHolder.getSnippet();
   private static final int SNIPPET_LENGTH = SNIPPET.length();
   @Nullable private static final MethodHandle setContentLengthLongHandler = getMethodHandle();
 
diff --git a/instrumentation/servlet/servlet-3.0/javaagent/src/test/groovy/AbstractServlet3Test.groovy b/instrumentation/servlet/servlet-3.0/javaagent/src/test/groovy/AbstractServlet3Test.groovy
@@ -7,7 +7,7 @@ import io.opentelemetry.instrumentation.test.AgentTestTrait
 import io.opentelemetry.instrumentation.test.asserts.TraceAssert
 import io.opentelemetry.instrumentation.test.base.HttpServerTest
 import io.opentelemetry.instrumentation.testing.junit.http.ServerEndpoint
-import io.opentelemetry.javaagent.bootstrap.servlet.SnippetHolder
+import io.opentelemetry.javaagent.bootstrap.servlet.ExperimentalSnippetHolder
 import io.opentelemetry.testing.internal.armeria.common.AggregatedHttpRequest
 
 import javax.servlet.Servlet
@@ -103,7 +103,7 @@ abstract class AbstractServlet3Test<SERVER, CONTEXT> extends HttpServerTest<SERV
 
   def "snippet injection with ServletOutPutStream"() {
     setup:
-    SnippetHolder.setSnippet("\n  <script type=\"text/javascript\"> Test </script>")
+    ExperimentalSnippetHolder.setSnippet("\n  <script type=\"text/javascript\"> Test </script>")
     def request = request(HTML2, "GET")
     def response = client.execute(request).aggregate().join()
 
@@ -127,7 +127,7 @@ abstract class AbstractServlet3Test<SERVER, CONTEXT> extends HttpServerTest<SERV
 
   def "snippet injection with PrintWriter"() {
     setup:
-    SnippetHolder.setSnippet("\n  <script type=\"text/javascript\"> Test </script>")
+    ExperimentalSnippetHolder.setSnippet("\n  <script type=\"text/javascript\"> Test </script>")
     def request = request(HTML, "GET")
     def response = client.execute(request).aggregate().join()
 
diff --git a/instrumentation/servlet/servlet-common/bootstrap/src/main/java/io/opentelemetry/javaagent/bootstrap/servlet/ExperimentalSnippetHolder.java b/instrumentation/servlet/servlet-common/bootstrap/src/main/java/io/opentelemetry/javaagent/bootstrap/servlet/ExperimentalSnippetHolder.java
@@ -7,12 +7,12 @@
 
 import java.io.UnsupportedEncodingException;
 
-public class SnippetHolder {
+public class ExperimentalSnippetHolder {
 
   private static String snippet = "";
 
   public static void setSnippet(String snippet) {
-    SnippetHolder.snippet = snippet;
+    ExperimentalSnippetHolder.snippet = snippet;
   }
 
   public static String getSnippet() {

Original file line number	Diff line number	Diff line change
`@@ -20,11 +20,6 @@ public InjectionState(SnippetInjectingResponseWrapper wrapper) {`
`20`	`20`	`this.characterEncoding = wrapper.getCharacterEncoding();`
`21`	`21`	`}`
`22`	`22`
`23`		`- public InjectionState(String characterEncoding) {`
`24`		`- this.characterEncoding = characterEncoding;`
`25`		`- this.wrapper = null;`
`26`		`- }`
`27`		`-`
`28`	`23`	`public int getHeadTagBytesSeen() {`
`29`	`24`	`return headTagBytesSeen;`
`30`	`25`	`}`