fix: Test coverage script should ignore generated code in the .mdx package.

hessjcg · hessjcg · commit fbea9238635e · 2025-09-16T18:00:19.000-06:00
diff --git a/.kokoro/check_coverage.sh b/.kokoro/check_coverage.sh
@@ -16,8 +16,23 @@
 # `-e` enables the script to automatically fail when a command fails
 set -e
 
-export CUR_COVER=$(cat core/target/site/jacoco/index.html | grep -o 'Total[^%]*' | sed 's/<.*>//; s/Total//')
-echo "Current Coverage is $CUR_COVER%"
+# Calculate total coverage, skipping the generated protobuf file.
+# The CSV file generated by Jacoco has the test coverage for each. We use AWK to process this CSV file.
+# here's what the AWK program means:
+#
+#     NR > 1 &&                                   Skip the first line, it only has field names
+#       $3 != "com.google.cloud.sql.core.mdx"     Skip any line for class in the protobuf generated package 'mdx'
+#     { covered += $6; total += $6+$5; }          For each line add a running sum of covered lines and total lines
+#     END { printf "%2.f", covered/total * 100}'  At the end, print out the coverage percentage, no decimals
+#
+
+CUR_COVER=$( awk -F,  \
+  'NR > 1 && $3 != "com.google.cloud.sql.core.mdx" { covered += $6; total += $6+$5; } END { printf "%2.f", covered/total * 100}' \
+  < "core/target/site/jacoco/jacoco.csv")
+
 if [ "$CUR_COVER" -lt 75  ]; then
+  echo "FAIL: Current Coverage is $CUR_COVER%, less than the required 75%"
   exit 1;
+else
+  echo "PASS: Current Coverage is $CUR_COVER%"
 fi
diff --git a/build.sh b/build.sh
@@ -30,13 +30,13 @@ function clean() {
 }
 
 ## build - Builds the project without running tests.
-function test() {
+function build() {
    mvn install -DskipTests=true
 }
 
 ## test - Runs local unit tests.
 function test() {
-  mvn install
+  mvn -P coverage test
 }
 
 ## e2e - Runs end-to-end integration tests.
diff --git a/core/src/main/java/com/google/cloud/sql/core/MdxSocket.java b/core/src/main/java/com/google/cloud/sql/core/MdxSocket.java
@@ -46,7 +46,7 @@ class MdxSocket extends SSLSocket {
   private final AtomicBoolean firstWriteAttempted = new AtomicBoolean(false);
   private final AtomicBoolean firstReadAttempted = new AtomicBoolean(false);
   private final AtomicReference<MetadataExchange.MetadataExchangeResponse> response =
-      new AtomicReference();
+      new AtomicReference<>();
   private final MetadataExchange.MetadataExchangeRequest.ClientProtocolType clientProtocolType;
 
   MdxSocket(
@@ -61,6 +61,10 @@ class MdxSocket extends SSLSocket {
     this.clientProtocolType = clientProtocolType;
   }
 
+  MetadataExchange.MetadataExchangeResponse getMdxResponse() {
+    return response.get();
+  }
+
   void sendMdxIfFirstWrite() throws IOException {
     if (firstWriteAttempted.compareAndSet(false, true)) {
       protocolHandler.sendMdx(out, this.clientProtocolType);
diff --git a/core/src/test/java/com/google/cloud/sql/core/ProtocolHandlerTest.java b/core/src/test/java/com/google/cloud/sql/core/ProtocolHandlerTest.java
@@ -29,6 +29,7 @@
 import java.net.InetAddress;
 import java.net.ServerSocket;
 import java.net.Socket;
+import java.net.SocketException;
 import java.nio.charset.StandardCharsets;
 import java.security.KeyPair;
 import java.security.KeyPairGenerator;
@@ -55,6 +56,21 @@
 
 public class ProtocolHandlerTest {
 
+  public static final byte[] SERVER_DATA = "hello".getBytes(StandardCharsets.UTF_8);
+  public static final byte[] CLIENT_DATA = "from client".getBytes(StandardCharsets.UTF_8);
+  public static final byte[] MDX_REQUEST_DATA;
+  public static final byte[] WANT_FULL_REQUEST_BYTES;
+
+  static {
+    byte[] wantClientMessage = CLIENT_DATA;
+    MDX_REQUEST_DATA = wantRequestBytes();
+    byte[] wantRequest = new byte[wantClientMessage.length + MDX_REQUEST_DATA.length];
+    System.arraycopy(MDX_REQUEST_DATA, 0, wantRequest, 0, MDX_REQUEST_DATA.length);
+    System.arraycopy(
+        wantClientMessage, 0, wantRequest, MDX_REQUEST_DATA.length, wantClientMessage.length);
+    WANT_FULL_REQUEST_BYTES = wantRequest;
+  }
+
   @Test
   public void testSendMdx() throws IOException {
     ByteArrayOutputStream out = new ByteArrayOutputStream();
@@ -85,35 +101,42 @@ public void testReadMdx_WithMdxResponse() throws IOException {
   public void testMdxSocket_clientWritesFirst_noMdxResponse() throws Exception {
     // 1. The client connects, writes to the server, sending an MDX request,
     //    reads from the server but receives no MDX response
+    AtomicReference<byte[]> requestBytes = new AtomicReference<>();
 
     // Setup SSL server that expects an MDX request, but does not send an MDX response.
     SslServer server =
         new SslServer(
             (in, out) -> {
               // Server reads the client's MDX request.
-              byte[] req = new byte[wantRequestBytes().length];
+              byte[] req = new byte[CLIENT_DATA.length];
               new DataInputStream(in).readFully(req);
-              assertThat(req).isEqualTo(wantRequestBytes());
+              requestBytes.set(req);
 
               // Server writes a non-MDX response.
               out.write("hello".getBytes(StandardCharsets.UTF_8));
+              out.flush();
             });
     SslServer.SslServerParams p = server.start();
 
     // Setup client socket
-    Socket socket = new ProtocolHandler("ua").connect(p.getSocket(), "tls");
+    MdxSocket socket = new ProtocolHandler("ua").connect(p.getSocket(), "tls");
 
     // Client writes, which should trigger the MDX exchange.
-    socket.getOutputStream().write("from client".getBytes(StandardCharsets.UTF_8));
+    socket.getOutputStream().write(CLIENT_DATA);
+    socket.getOutputStream().flush();
 
     // The server should not have sent an MDX response, so the client should
     // read the raw "hello" from the server.
     byte[] fromServer = new byte[5];
     new DataInputStream(socket.getInputStream()).readFully(fromServer);
-    assertThat(fromServer).isEqualTo("hello".getBytes(StandardCharsets.UTF_8));
+    while (requestBytes.get() == null) {
+      Thread.sleep(10);
+    }
 
     socket.close();
     server.stop();
+    assertThat(fromServer).isEqualTo(SERVER_DATA);
+    assertThat(socket.getMdxResponse()).isNull();
   }
 
   @Test
@@ -127,35 +150,42 @@ public void testMdxSocket_clientWritesFirst_receivesMdxResponse() throws Excepti
         new SslServer(
             (in, out) -> {
               // Server reads the client's MDX request.
-              byte[] req = new byte[wantRequestBytes().length];
+              byte[] req = new byte[WANT_FULL_REQUEST_BYTES.length];
               new DataInputStream(in).readFully(req);
               requestBytes.set(req);
               // Server writes an MDX response.
               out.write(wantResponseBytes("hello".getBytes(StandardCharsets.UTF_8)));
+              out.flush();
             });
 
     SslServer.SslServerParams p = server.start();
 
     // Setup client socket
-    Socket socket = new ProtocolHandler("ua").connect(p.getSocket(), "tls");
+    MdxSocket socket = new ProtocolHandler("ua").connect(p.getSocket(), "tls");
 
     // Client writes, which should trigger the MDX exchange.
-    socket.getOutputStream().write("from client".getBytes(StandardCharsets.UTF_8));
+    socket.getOutputStream().write(CLIENT_DATA);
+    socket.getOutputStream().flush();
 
     // The server should have sent an MDX response, so the client should
     // read the "hello" from the server.
     byte[] fromServer = new byte[5];
     new DataInputStream(socket.getInputStream()).readFully(fromServer);
-    assertThat(fromServer).isEqualTo("hello".getBytes(StandardCharsets.UTF_8));
-
-    assertThat(requestBytes.get()).isEqualTo(wantRequestBytes());
+    while (requestBytes.get() == null) {
+      Thread.sleep(10);
+    }
 
     socket.close();
     server.stop();
+
+    assertThat(fromServer).isEqualTo("hello".getBytes(StandardCharsets.UTF_8));
+    assertThat(requestBytes.get()).isEqualTo(WANT_FULL_REQUEST_BYTES);
+    assertThat(socket.getMdxResponse()).isNotNull();
   }
 
   @Test
   public void testMdxSocket_clientReadsFirst_noMdxResponse() throws Exception {
+
     // 3. The client connects, reads from the server but receives no MDX response,
     //    then writes to the server, sending an MDX request
     AtomicReference<byte[]> requestBytes = new AtomicReference<>();
@@ -166,36 +196,43 @@ public void testMdxSocket_clientReadsFirst_noMdxResponse() throws Exception {
             (in, out) -> {
               // Server writes a non-MDX response.
               out.write("hello".getBytes(StandardCharsets.UTF_8));
+              out.flush();
 
               // Server reads the client's MDX request.
-              byte[] req = new byte[wantRequestBytes().length];
+              byte[] req = new byte[WANT_FULL_REQUEST_BYTES.length];
               new DataInputStream(in).readFully(req);
               requestBytes.set(req);
             });
     SslServer.SslServerParams p = server.start();
 
     // Setup client socket
-    Socket socket = new ProtocolHandler("ua").connect(p.getSocket(), "tls");
+    MdxSocket socket = new ProtocolHandler("ua").connect(p.getSocket(), "tls");
 
     // The server should not have sent an MDX response, so the client should
     // read the raw "hello" from the server.
     byte[] fromServer = new byte[5];
     new DataInputStream(socket.getInputStream()).readFully(fromServer);
-    assertThat(fromServer).isEqualTo("hello".getBytes(StandardCharsets.UTF_8));
-    assertThat(requestBytes.get()).isNull();
 
     // Client writes, which should trigger the MDX exchange.
-    socket.getOutputStream().write("from client".getBytes(StandardCharsets.UTF_8));
+    socket.getOutputStream().write(CLIENT_DATA);
+    socket.getOutputStream().flush();
+    while (requestBytes.get() == null) {
+      Thread.sleep(10);
+    }
 
     socket.close();
     server.stop();
+
+    assertThat(fromServer).isEqualTo("hello".getBytes(StandardCharsets.UTF_8));
+    assertThat(requestBytes.get()).isEqualTo(WANT_FULL_REQUEST_BYTES);
+    assertThat(socket.getMdxResponse()).isNull();
   }
 
   @Test
-  public void testMdxSocket_clientReadsFirst_receivesMdxResponse() throws Exception {
-    // 4. The client connects, reads from the server and receives an MDX response,
+  public void testMdxSocket_clientReadsFirst_receivesMdxResponse_writesMdxRequest()
+      throws Exception {
+    // 4. The client connects, reads from the server and receives no MDX response,
     //    then writes to the server, sending an MDX request
-
     AtomicReference<byte[]> requestBytes = new AtomicReference<>();
 
     // Setup SSL server that expects an MDX request and sends an MDX response.
@@ -204,32 +241,39 @@ public void testMdxSocket_clientReadsFirst_receivesMdxResponse() throws Exceptio
             (in, out) -> {
               // Server writes a non-MDX response.
               out.write("hello".getBytes(StandardCharsets.UTF_8));
+              out.flush();
 
               // Server reads the client's MDX request.
-              byte[] req = new byte[wantRequestBytes().length];
+              byte[] req = new byte[WANT_FULL_REQUEST_BYTES.length];
               new DataInputStream(in).readFully(req);
               requestBytes.set(req);
             });
     SslServer.SslServerParams p = server.start();
 
     // Setup client socket
-    Socket socket = new ProtocolHandler("ua").connect(p.getSocket(), "tls");
+    MdxSocket socket = new ProtocolHandler("ua").connect(p.getSocket(), "tls");
 
-    // The server should have sent an MDX response, so the client should
+    // The server should not send MDX response, so the client should
     // read the "hello" from the server.
     byte[] fromServer = new byte[5];
     new DataInputStream(socket.getInputStream()).readFully(fromServer);
-    assertThat(fromServer).isEqualTo("hello".getBytes(StandardCharsets.UTF_8));
 
     // Client writes, which should trigger the MDX exchange.
-    socket.getOutputStream().write("from client".getBytes(StandardCharsets.UTF_8));
-    assertThat(requestBytes.get()).isNull();
+    socket.getOutputStream().write(CLIENT_DATA);
+    socket.getOutputStream().flush();
+    while (requestBytes.get() == null) {
+      Thread.sleep(10);
+    }
 
     socket.close();
     server.stop();
+
+    assertThat(fromServer).isEqualTo("hello".getBytes(StandardCharsets.UTF_8));
+    assertThat(requestBytes.get()).isEqualTo(WANT_FULL_REQUEST_BYTES);
+    assertThat(socket.getMdxResponse()).isNull();
   }
 
-  private static byte[] wantRequestBytes() throws IOException {
+  private static byte[] wantRequestBytes() {
     ByteArrayOutputStream wantOut = new ByteArrayOutputStream();
     MetadataExchange.MetadataExchangeRequest req =
         MetadataExchange.MetadataExchangeRequest.newBuilder()
@@ -238,39 +282,46 @@ private static byte[] wantRequestBytes() throws IOException {
             .build();
     int size = req.getSerializedSize();
 
-    // Write the protocoal header
-    wantOut.write("CSQLMDEX".getBytes(StandardCharsets.UTF_8));
-    // Write the uint32 size
-    wantOut.write((size >>> 24) & 0xFF);
-    wantOut.write((size >>> 16) & 0xFF);
-    wantOut.write((size >>> 8) & 0xFF);
-    wantOut.write(size & 0xFF);
-    // Write the protobuf
-    req.writeTo(wantOut);
-    wantOut.flush();
+    try {
+      // Write the protocoal header
+      wantOut.write("CSQLMDEX".getBytes(StandardCharsets.UTF_8));
+      // Write the uint32 size
+      wantOut.write((byte) ((size >>> 24) & 0xFF));
+      wantOut.write((byte) ((size >>> 16) & 0xFF));
+      wantOut.write((byte) ((size >>> 8) & 0xFF));
+      wantOut.write((byte) (size & 0xFF));
+      // Write the protobuf
+      req.writeTo(wantOut);
+    } catch (IOException e) {
+      throw new RuntimeException(e);
+    }
+
     return wantOut.toByteArray();
   }
 
-  private static byte[] wantResponseBytes(byte[] data) throws IOException {
+  private static byte[] wantResponseBytes(byte[] data) {
     ByteArrayOutputStream wantOut = new ByteArrayOutputStream();
     MetadataExchange.MetadataExchangeResponse res =
         MetadataExchange.MetadataExchangeResponse.newBuilder()
             .setResponseStatusCode(MetadataExchange.MetadataExchangeResponse.ResponseStatusCode.OK)
             .build();
-
     int size = res.getSerializedSize();
 
-    // Write the protocoal header
-    wantOut.write("CSQLMDEX".getBytes(StandardCharsets.UTF_8));
-    // Write the uint32 size
-    wantOut.write((size >>> 24) & 0xFF);
-    wantOut.write((size >>> 16) & 0xFF);
-    wantOut.write((size >>> 8) & 0xFF);
-    wantOut.write(size & 0xFF);
-    // Write the protobuf
-    res.writeTo(wantOut);
-    wantOut.write(data);
-    wantOut.flush();
+    try {
+      // Write the protocoal header
+      wantOut.write("CSQLMDEX".getBytes(StandardCharsets.UTF_8));
+      // Write the uint32 size
+      wantOut.write((size >>> 24) & 0xFF);
+      wantOut.write((size >>> 16) & 0xFF);
+      wantOut.write((size >>> 8) & 0xFF);
+      wantOut.write(size & 0xFF);
+      // Write the protobuf
+      res.writeTo(wantOut);
+      wantOut.write(data);
+      wantOut.flush();
+    } catch (IOException e) {
+      throw new RuntimeException(e);
+    }
     return wantOut.toByteArray();
   }
 
@@ -312,6 +363,8 @@ private SslServerParams start() throws Exception {
                     }
                     handler.accept(s.getInputStream(), s.getOutputStream());
                   }
+                } catch (SocketException e) {
+                  // do nothing, we don't care if the socket was closed.
                 } catch (Exception e) {
                   throw new RuntimeException(e);
                 }

Original file line number	Diff line number	Diff line change
`@@ -30,13 +30,13 @@ function clean() {`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`## build - Builds the project without running tests.`
`33`		`-function test() {`
	`33`	`+function build() {`
`34`	`34`	`mvn install -DskipTests=true`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`## test - Runs local unit tests.`
`38`	`38`	`function test() {`
`39`		`- mvn install`
	`39`	`+ mvn -P coverage test`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`## e2e - Runs end-to-end integration tests.`