Automatically format the code (#12023)

* Add a script to format the code in the project

Currently, this only handles Java, but later revisions can
be extended to cover other languages (and the build files)
too.

* Run the format script

---------

Co-authored-by: Diego Molina <[email protected]>

Author: shs96c

java/maven_deps.bzl

@@ -24,6 +24,7 @@ def selenium_java_deps():
             "com.google.auto:auto-common:1.2.1",
             "com.google.auto.service:auto-service:1.0.1",
             "com.google.auto.service:auto-service-annotations:1.0.1",
+            "com.google.googlejavaformat:google-java-format:jar:1.17.0",
             "com.graphql-java:graphql-java:20.2",
             "com.graphql-java:java-dataloader:3.2.0",
             "io.grpc:grpc-context:1.55.1",

java/maven_install.json

@@ -136,6 +136,13 @@
       },
       "version": "2.11.0"
     },
+    "com.google.googlejavaformat:google-java-format": {
+      "shasums": {
+        "jar": "631ba54c39f6c20df027dc1420736df2e5e43c581880efdd1e46ddb4ce050e3e",
+        "sources": "75db73d4bc603e30ee28d2109dee973bf26dfc065499e18e086ddf90e1e90d6e"
+      },
+      "version": "1.17.0"
+    },
     "com.google.guava:failureaccess": {
       "shasums": {
         "jar": "a171ee4c734dd2da837e4b16be9df4661afab72a41adaf31eb84dfdaf936ca26",
@@ -1143,6 +1150,9 @@
     "com.google.auto:auto-common": [
       "com.google.guava:guava"
     ],
+    "com.google.googlejavaformat:google-java-format": [
+      "com.google.guava:guava"
+    ],
     "com.google.guava:guava": [
       "com.google.code.findbugs:jsr305",
       "com.google.errorprone:error_prone_annotations",
@@ -1848,6 +1858,13 @@
       "com.google.errorprone.annotations",
       "com.google.errorprone.annotations.concurrent"
     ],
+    "com.google.googlejavaformat:google-java-format": [
+      "com.google.googlejavaformat",
+      "com.google.googlejavaformat.java",
+      "com.google.googlejavaformat.java.filer",
+      "com.google.googlejavaformat.java.java17",
+      "com.google.googlejavaformat.java.javadoc"
+    ],
     "com.google.guava:failureaccess": [
       "com.google.common.util.concurrent.internal"
     ],
@@ -3637,6 +3654,8 @@
       "com.google.code.gson:gson:jar:sources",
       "com.google.errorprone:error_prone_annotations",
       "com.google.errorprone:error_prone_annotations:jar:sources",
+      "com.google.googlejavaformat:google-java-format",
+      "com.google.googlejavaformat:google-java-format:jar:sources",
       "com.google.guava:failureaccess",
       "com.google.guava:failureaccess:jar:sources",
       "com.google.guava:guava",
@@ -3954,6 +3973,8 @@
       "com.google.code.gson:gson:jar:sources",
       "com.google.errorprone:error_prone_annotations",
       "com.google.errorprone:error_prone_annotations:jar:sources",
+      "com.google.googlejavaformat:google-java-format",
+      "com.google.googlejavaformat:google-java-format:jar:sources",
       "com.google.guava:failureaccess",
       "com.google.guava:failureaccess:jar:sources",
       "com.google.guava:guava",

java/src/dev/selenium/tools/javadoc/JavadocJarMaker.java

@@ -17,14 +17,9 @@
 
 package dev.selenium.tools.javadoc;
 
-import com.github.bazelbuild.rules_jvm_external.zip.StableZipEntry;
-import org.openqa.selenium.io.TemporaryFilesystem;
+import static java.nio.charset.StandardCharsets.UTF_8;
 
-import javax.tools.DocumentationTool;
-import javax.tools.JavaFileObject;
-import javax.tools.StandardJavaFileManager;
-import javax.tools.StandardLocation;
-import javax.tools.ToolProvider;
+import com.github.bazelbuild.rules_jvm_external.zip.StableZipEntry;
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
@@ -46,8 +41,12 @@
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipInputStream;
 import java.util.zip.ZipOutputStream;
-
-import static java.nio.charset.StandardCharsets.UTF_8;
+import javax.tools.DocumentationTool;
+import javax.tools.JavaFileObject;
+import javax.tools.StandardJavaFileManager;
+import javax.tools.StandardLocation;
+import javax.tools.ToolProvider;
+import org.openqa.selenium.io.TemporaryFilesystem;
 
 public class JavadocJarMaker {
 
@@ -76,11 +75,13 @@ public static void main(String[] args) throws IOException {
     }
 
     if (sourceJars.isEmpty()) {
-      throw new IllegalArgumentException("At least one input just must be specified via the --in flag");
+      throw new IllegalArgumentException(
+          "At least one input just must be specified via the --in flag");
     }
 
     if (out == null) {
-      throw new IllegalArgumentException("The output jar location must be specified via the --out flag");
+      throw new IllegalArgumentException(
+          "The output jar location must be specified via the --out flag");
     }
 
     TemporaryFilesystem tmpFS = TemporaryFilesystem.getDefaultTmpFS();
@@ -89,22 +90,26 @@ public static void main(String[] args) throws IOException {
     tempDirs.add(dir);
 
     DocumentationTool tool = ToolProvider.getSystemDocumentationTool();
-    try (StandardJavaFileManager fileManager = tool.getStandardFileManager(null, Locale.getDefault(), UTF_8)) {
+    try (StandardJavaFileManager fileManager =
+        tool.getStandardFileManager(null, Locale.getDefault(), UTF_8)) {
       fileManager.setLocation(DocumentationTool.Location.DOCUMENTATION_OUTPUT, List.of(dir));
-      fileManager.setLocation(StandardLocation.CLASS_PATH, classpath.stream().map(Path::toFile).collect(Collectors.toSet()));
+      fileManager.setLocation(
+          StandardLocation.CLASS_PATH,
+          classpath.stream().map(Path::toFile).collect(Collectors.toSet()));
 
       Set<JavaFileObject> sources = new HashSet<>();
       Set<String> topLevelPackages = new HashSet<>();
 
       File unpackTo = tmpFS.createTempDir("unpacked-sources", "");
       tempDirs.add(unpackTo);
       Set<String> fileNames = new HashSet<>();
-      readSourceFiles(unpackTo.toPath(), fileManager, sourceJars, sources, topLevelPackages, fileNames);
+      readSourceFiles(
+          unpackTo.toPath(), fileManager, sourceJars, sources, topLevelPackages, fileNames);
 
       // True if we're just exporting a set of modules
       if (sources.isEmpty()) {
         try (OutputStream os = Files.newOutputStream(out);
-             ZipOutputStream zos = new ZipOutputStream(os)) {
+            ZipOutputStream zos = new ZipOutputStream(os)) {
           // It's enough to just create the thing
         }
         return;
@@ -113,10 +118,21 @@ public static void main(String[] args) throws IOException {
       List<String> options = new ArrayList<>();
       if (!classpath.isEmpty()) {
         options.add("-cp");
-        options.add(classpath.stream().map(String::valueOf).collect(Collectors.joining(File.pathSeparator)));
+        options.add(
+            classpath.stream()
+                .map(String::valueOf)
+                .collect(Collectors.joining(File.pathSeparator)));
       }
-      options.addAll(List.of("-html5", "--frames", "-notimestamp", "-use", "-quiet", "-Xdoclint:-missing", "-encoding", "UTF8"));
-
+      options.addAll(
+          List.of(
+              "-html5",
+              "--frames",
+              "-notimestamp",
+              "-use",
+              "-quiet",
+              "-Xdoclint:-missing",
+              "-encoding",
+              "UTF8"));
 
       File outputTo = tmpFS.createTempDir("output-dir", "");
       tempDirs.add(outputTo);
@@ -127,7 +143,8 @@ public static void main(String[] args) throws IOException {
       sources.forEach(obj -> options.add(obj.getName()));
 
       Writer writer = new StringWriter();
-      DocumentationTool.DocumentationTask task = tool.getTask(writer, fileManager, null, null, options, sources);
+      DocumentationTool.DocumentationTask task =
+          tool.getTask(writer, fileManager, null, null, options, sources);
       Boolean result = task.call();
       if (result == null || !result) {
         System.err.println("javadoc " + String.join(" ", options));
@@ -136,46 +153,48 @@ public static void main(String[] args) throws IOException {
       }
 
       try (OutputStream os = Files.newOutputStream(out);
-           ZipOutputStream zos = new ZipOutputStream(os);
-           Stream<Path> walk = Files.walk(outputToPath)) {
+          ZipOutputStream zos = new ZipOutputStream(os);
+          Stream<Path> walk = Files.walk(outputToPath)) {
         walk.sorted(Comparator.naturalOrder())
-          .forEachOrdered(path -> {
-            if (path.equals(outputToPath)) {
-              return;
-            }
-
-            try {
-              if (Files.isDirectory(path)) {
-                String name = outputToPath.relativize(path) + "/";
-                ZipEntry entry = new StableZipEntry(name);
-                zos.putNextEntry(entry);
-                zos.closeEntry();
-              } else {
-                String name = outputToPath.relativize(path).toString();
-                ZipEntry entry = new StableZipEntry(name);
-                zos.putNextEntry(entry);
-                try (InputStream is = Files.newInputStream(path)) {
-                  is.transferTo(zos);
-                }
-                zos.closeEntry();
-              }
-            } catch (IOException e) {
-              throw new UncheckedIOException(e);
-            }
-          });
+            .forEachOrdered(
+                path -> {
+                  if (path.equals(outputToPath)) {
+                    return;
+                  }
+
+                  try {
+                    if (Files.isDirectory(path)) {
+                      String name = outputToPath.relativize(path) + "/";
+                      ZipEntry entry = new StableZipEntry(name);
+                      zos.putNextEntry(entry);
+                      zos.closeEntry();
+                    } else {
+                      String name = outputToPath.relativize(path).toString();
+                      ZipEntry entry = new StableZipEntry(name);
+                      zos.putNextEntry(entry);
+                      try (InputStream is = Files.newInputStream(path)) {
+                        is.transferTo(zos);
+                      }
+                      zos.closeEntry();
+                    }
+                  } catch (IOException e) {
+                    throw new UncheckedIOException(e);
+                  }
+                });
       }
     }
 
     tempDirs.forEach(tmpFS::deleteTempDir);
   }
 
   private static void readSourceFiles(
-    Path unpackTo,
-    StandardJavaFileManager fileManager,
-    Set<Path> sourceJars,
-    Set<JavaFileObject> sources,
-    Set<String> topLevelPackages,
-    Set<String> fileNames) throws IOException {
+      Path unpackTo,
+      StandardJavaFileManager fileManager,
+      Set<Path> sourceJars,
+      Set<JavaFileObject> sources,
+      Set<String> topLevelPackages,
+      Set<String> fileNames)
+      throws IOException {
 
     for (Path jar : sourceJars) {
       if (!Files.exists(jar)) {

java/src/dev/selenium/tools/modules/ModuleGenerator.java

@@ -17,6 +17,13 @@
 
 package dev.selenium.tools.modules;
 
+import static com.github.javaparser.ParseStart.COMPILATION_UNIT;
+import static net.bytebuddy.jar.asm.Opcodes.ACC_MANDATED;
+import static net.bytebuddy.jar.asm.Opcodes.ACC_MODULE;
+import static net.bytebuddy.jar.asm.Opcodes.ACC_OPEN;
+import static net.bytebuddy.jar.asm.Opcodes.ACC_TRANSITIVE;
+import static net.bytebuddy.jar.asm.Opcodes.ASM9;
+
 import com.github.bazelbuild.rules_jvm_external.zip.StableZipEntry;
 import com.github.javaparser.JavaParser;
 import com.github.javaparser.ParseResult;
@@ -34,14 +41,6 @@
 import com.github.javaparser.ast.modules.ModuleRequiresDirective;
 import com.github.javaparser.ast.modules.ModuleUsesDirective;
 import com.github.javaparser.ast.visitor.VoidVisitorAdapter;
-import net.bytebuddy.jar.asm.ClassReader;
-import net.bytebuddy.jar.asm.ClassVisitor;
-import net.bytebuddy.jar.asm.ClassWriter;
-import net.bytebuddy.jar.asm.MethodVisitor;
-import net.bytebuddy.jar.asm.ModuleVisitor;
-import net.bytebuddy.jar.asm.Type;
-import org.openqa.selenium.io.TemporaryFilesystem;
-
 import java.io.ByteArrayOutputStream;
 import java.io.File;
 import java.io.IOException;
@@ -80,13 +79,13 @@
 import java.util.stream.Stream;
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipOutputStream;
-
-import static com.github.javaparser.ParseStart.COMPILATION_UNIT;
-import static net.bytebuddy.jar.asm.Opcodes.ACC_MANDATED;
-import static net.bytebuddy.jar.asm.Opcodes.ACC_MODULE;
-import static net.bytebuddy.jar.asm.Opcodes.ACC_OPEN;
-import static net.bytebuddy.jar.asm.Opcodes.ACC_TRANSITIVE;
-import static net.bytebuddy.jar.asm.Opcodes.ASM9;
+import net.bytebuddy.jar.asm.ClassReader;
+import net.bytebuddy.jar.asm.ClassVisitor;
+import net.bytebuddy.jar.asm.ClassWriter;
+import net.bytebuddy.jar.asm.MethodVisitor;
+import net.bytebuddy.jar.asm.ModuleVisitor;
+import net.bytebuddy.jar.asm.Type;
+import org.openqa.selenium.io.TemporaryFilesystem;
 
 public class ModuleGenerator {
 

java/src/org/openqa/selenium/AcceptedW3CCapabilityKeys.java

@@ -23,22 +23,23 @@
 
 public class AcceptedW3CCapabilityKeys implements Predicate<String> {
 
-  private static final Predicate<String> ACCEPTED_W3C_PATTERNS = Stream.of(
-      "^[\\w-]+:.*$",
-      "^acceptInsecureCerts$",
-      "^browserName$",
-      "^browserVersion$",
-      "^platformName$",
-      "^pageLoadStrategy$",
-      "^proxy$",
-      "^setWindowRect$",
-      "^strictFileInteractability$",
-      "^timeouts$",
-      "^unhandledPromptBehavior$",
-      "^webSocketUrl$")  // from webdriver-bidi
-    .map(Pattern::compile)
-    .map(Pattern::asPredicate)
-    .reduce(identity -> false, Predicate::or);
+  private static final Predicate<String> ACCEPTED_W3C_PATTERNS =
+      Stream.of(
+              "^[\\w-]+:.*$",
+              "^acceptInsecureCerts$",
+              "^browserName$",
+              "^browserVersion$",
+              "^platformName$",
+              "^pageLoadStrategy$",
+              "^proxy$",
+              "^setWindowRect$",
+              "^strictFileInteractability$",
+              "^timeouts$",
+              "^unhandledPromptBehavior$",
+              "^webSocketUrl$") // from webdriver-bidi
+          .map(Pattern::compile)
+          .map(Pattern::asPredicate)
+          .reduce(identity -> false, Predicate::or);
 
   @Override
   public boolean test(String capabilityName) {