feat: Adding vendor and vendor information in header

gax-java/gax/src/main/java/com/google/api/gax/core/GaxProperties.java

@@ -29,10 +29,9 @@
  */
 package com.google.api.gax.core;
 
-import static org.graalvm.nativeimage.ImageInfo.PROPERTY_IMAGE_CODE_KEY;
-import static org.graalvm.nativeimage.ImageInfo.PROPERTY_IMAGE_CODE_VALUE_RUNTIME;
-
 import com.google.api.core.InternalApi;
+import com.google.common.annotations.VisibleForTesting;
+import com.google.common.base.Strings;
 import java.io.IOException;
 import java.io.InputStream;
 import java.util.Properties;
@@ -84,12 +83,6 @@ public static String getLibraryVersion(Class<?> libraryClass, String propertyNam
 
   /** Returns the version of the running JVM */
   public static String getJavaVersion() {
-    // When running the application as a native image, append `-graalvm` to the
-    // version.
-    String imageCode = System.getProperty(PROPERTY_IMAGE_CODE_KEY);
-    if (imageCode != null && imageCode.equals(PROPERTY_IMAGE_CODE_VALUE_RUNTIME)) {
-      return System.getProperty("java.version") + "-graalvm";
-    }
     return JAVA_VERSION;
   }
 
@@ -98,8 +91,26 @@ public static String getGaxVersion() {
     return GAX_VERSION;
   }
 
-  /** Returns the current runtime version */
-  private static String getRuntimeVersion() {
-    return System.getProperty("java.version");
+  /**
+   * Returns the current runtime version. For GraalVM the values in this method will be fetched at
+   * build time and the values should not differ from the runtime (executable)
+   */
+  @VisibleForTesting
+  static String getRuntimeVersion() {
+    String javaRuntimeInformation = System.getProperty("java.version", "null");
+
+    // append the vendor information to the java-version if vendor is present.
+    String vendor = System.getProperty("java.vendor");
+    if (!Strings.isNullOrEmpty(vendor)) {
+      javaRuntimeInformation = String.format("%s__%s", javaRuntimeInformation, vendor);
+      // appends the vendor version information to the java-version if vendor version is present.
+      String vendorVersion = System.getProperty("java.vendor.version");
+      if (!Strings.isNullOrEmpty(vendorVersion)) {
+        javaRuntimeInformation = String.format("%s__%s", javaRuntimeInformation, vendorVersion);
+      }
+    }
+    // replacing all characters that are not numbers, letters, underscores, periods, or backslashes
+    // with hyphens.
+    return javaRuntimeInformation.replaceAll("[^0-9a-zA-Z_\\\\.]", "-");
   }
 }

gax-java/gax/src/test/java/com/google/api/gax/core/GaxPropertiesTest.java

@@ -29,11 +29,12 @@
  */
 package com.google.api.gax.core;
 
-import static org.graalvm.nativeimage.ImageInfo.PROPERTY_IMAGE_CODE_KEY;
-import static org.graalvm.nativeimage.ImageInfo.PROPERTY_IMAGE_CODE_VALUE_RUNTIME;
+import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertTrue;
 
+import com.google.common.base.Strings;
 import java.util.regex.Pattern;
+import org.junit.After;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.junit.runners.JUnit4;
@@ -57,10 +58,94 @@ public void testGaxVersion() {
     }
   }
 
+  private static String originalJavaVersion = System.getProperty("java.version");
+  private static String originalJavaVendor = System.getProperty("java.vendor");
+  private static String originalJavaVendorVersion = System.getProperty("java.vendor.version");
+
+  @After
+  public void cleanup() {
+    if (Strings.isNullOrEmpty(originalJavaVersion)) {
+      System.clearProperty("java.version");
+    } else {
+      System.setProperty("java.version", originalJavaVersion);
+    }
+
+    if (Strings.isNullOrEmpty(originalJavaVendor)) {
+      System.clearProperty("java.vendor");
+    } else {
+      System.setProperty("java.vendor", originalJavaVendor);
+    }
+
+    if (Strings.isNullOrEmpty(originalJavaVendorVersion)) {
+      System.clearProperty("java.vendor.version");
+    } else {
+      System.setProperty("java.vendor.version", originalJavaVendorVersion);
+    }
+  }
+
+  @Test
+  public void testGetJavaRuntimeInfo_graalVM() {
+
+    System.setProperty("java.version", "17.0.3");
+    System.setProperty("java.vendor", "GraalVM Community");
+    System.setProperty("java.vendor.version", "GraalVM CE 22.1.0");
+
+    String runtimeInfo = GaxProperties.getRuntimeVersion();
+    assertEquals("17.0.3__GraalVM-Community__GraalVM-CE-22.1.0", runtimeInfo);
+  }
+
+  @Test
+  public void testGetJavaRuntimeInfo_temurin() {
+    System.setProperty("java.version", "11.0.19");
+    System.setProperty("java.vendor", "Eclipse Adoptium");
+    System.setProperty("java.vendor.version", "Temurin-11.0.19+7");
+
+    String runtimeInfo = GaxProperties.getRuntimeVersion();
+    assertEquals("11.0.19__Eclipse-Adoptium__Temurin-11.0.19-7", runtimeInfo);
+  }
+
+  @Test
+  public void testGetJavaRuntimeInfo_coretto() {
+    System.setProperty("java.version", "11.0.19");
+    System.setProperty("java.vendor", "Amazon.com Inc.");
+    System.setProperty("java.vendor.version", "Corretto-11.0.19.7.1");
+
+    String runtimeInfo = GaxProperties.getRuntimeVersion();
+    assertEquals("11.0.19__Amazon.com-Inc.__Corretto-11.0.19.7.1", runtimeInfo);
+  }
+
   @Test
-  public void testGetVersion_nativeImage() {
-    System.setProperty(PROPERTY_IMAGE_CODE_KEY, PROPERTY_IMAGE_CODE_VALUE_RUNTIME);
-    String javaVersion = GaxProperties.getJavaVersion();
-    assertTrue(javaVersion.endsWith("-graalvm"));
+  public void testGetJavaRuntimeInfo_oracle() {
+    System.setProperty("java.version", "20.0.1");
+    System.setProperty("java.vendor", "Oracle Corporation");
+    // case where java.vendor.version is null
+    System.clearProperty("java.vendor.version");
+
+    String runtimeInfo = GaxProperties.getRuntimeVersion();
+    assertEquals("20.0.1__Oracle-Corporation", runtimeInfo);
+  }
+
+  @Test
+  public void testGetJavaRuntimeInfo_nullVendorVersion() {
+    System.setProperty("java.version", "20.0.1");
+    // case where java.vendor and java.vendor.version is null
+    System.clearProperty("java.vendor");
+    System.clearProperty("java.vendor.version");
+
+    String runtimeInfo = GaxProperties.getRuntimeVersion();
+    assertEquals("20.0.1", runtimeInfo);
+  }
+
+  @Test
+  public void testGetJavaRuntimeInfo_nullJavaVersion() {
+    // We don't expect this case to happen, however we don't want the method to fail when it really
+    // happens.
+    System.clearProperty("java.version");
+    // case where java.vendor and java.vendor.version is null
+    System.setProperty("java.vendor", "oracle");
+    System.setProperty("java.vendor.version", "20.0.1");
+
+    String runtimeInfo = GaxProperties.getRuntimeVersion();
+    assertEquals("null__oracle__20.0.1", runtimeInfo);
   }
 }