feat: Web console: run the e2e tests on embedded clusters, modernize them, and cover more of the console

.github/scripts/web-checks.sh

@@ -20,7 +20,8 @@ set -x
 
 # Install node.js via maven frontend plugin (same approach as jacoco script)
 ./mvnw -B com.github.eirslett:frontend-maven-plugin:install-node-and-npm@install-node-and-npm -pl web-console/
-PATH+=:web-console/target/node/
+# Absolute, as the web console end-to-end tests run npx from another directory
+PATH+=:$(pwd)/web-console/target/node/
 
 # docs
 (cd website && npm ci)
@@ -30,12 +31,9 @@ npm run link-lint
 npm run spellcheck
 cd ..
 
-# web console
-./mvnw -B test -pl 'web-console'
+# web console (installed with the console built, for the Router of the end-to-end tests to serve)
+./mvnw -B install -pl 'web-console'
 
-# web console end-to-end test
-./.github/scripts/setup_generate_license.sh
-web-console/script/druid build
-web-console/script/druid start
-(cd web-console && npm run test-e2e)
-web-console/script/druid stop
+# web console end-to-end tests, on embedded clusters (builds the modules embedded-tests needs, not web-console again)
+./mvnw -B verify -pl 'embedded-tests,!web-console' -am -Pweb-console-tests,skip-static-checks -DskipUTs \
+  -Dmaven.javadoc.skip=true -Danimal.sniffer.skip=true -Denforcer.skip=true -Dcyclonedx.skip=true

.github/workflows/worker.yml

@@ -161,4 +161,5 @@ jobs:
             **/TEST-*.xml
             **/target/jacoco*.exec
             **/target/ci-debug/**
-            distribution/target/apache-druid-*/log/**
+            embedded-tests/target/failsafe-reports/**
+            web-console/test-results/**

embedded-tests/pom.xml

@@ -890,12 +890,12 @@
           <skip>true</skip>
         </configuration>
       </plugin>
-      <!-- Do not run Docker tests except with the docker-tests profile -->
+      <!-- Do not run Docker tests or web console tests except with the docker-tests or web-console-tests profile -->
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-surefire-plugin</artifactId>
         <configuration>
-          <excludedGroups>docker-test,perf</excludedGroups>
+          <excludedGroups>docker-test,web-console,perf</excludedGroups>
           <!-- Enable Netty 4 PARANOID leak detection in the embedded tests because this is where
                real cross-node HTTP traffic exercises the migrated HttpClient code paths (chunked
                responses, long-poll syncs, TLS, ByteBuf-bearing handlers). The Stage 1 CI workers
@@ -970,5 +970,59 @@
         </plugins>
       </build>
     </profile>
+    <profile>
+      <!-- Runs the web console end-to-end tests (Playwright specs of web-console/e2e-tests) on embedded clusters.
+           Needs the web-console module built with the console (not skipped), and npm ci run in web-console. -->
+      <id>web-console-tests</id>
+      <properties>
+        <!-- Override with -Dmaven.test.redirectTestOutputToFile=false to see the output, such as with -Dweb.console.keepAlive=true -->
+        <maven.test.redirectTestOutputToFile>true</maven.test.redirectTestOutputToFile>
+      </properties>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-surefire-plugin</artifactId>
+            <configuration>
+              <skipTests>true</skipTests>
+            </configuration>
+          </plugin>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-failsafe-plugin</artifactId>
+            <configuration>
+              <groups>web-console</groups>
+              <includes>
+                <include>*WebConsoleTest*</include>
+              </includes>
+              <systemPropertyVariables>
+                <web.console.dir>${project.basedir}/../web-console</web.console.dir>
+              </systemPropertyVariables>
+              <argLine>
+                -XX:+UseCompactObjectHeaders
+                ${jdk.strong.encapsulation.argLine}
+                -Xmx3g
+                -XX:MaxDirectMemorySize=2500m
+                -XX:+ExitOnOutOfMemoryError
+                -XX:+HeapDumpOnOutOfMemoryError
+                -Duser.language=en
+                -Dfile.encoding=UTF-8
+                -Duser.timezone=UTC
+                -Djava.util.logging.manager=org.apache.logging.log4j.jul.LogManager
+                -Daws.region=us-east-1
+              </argLine>
+            </configuration>
+            <executions>
+              <execution>
+                <goals>
+                  <goal>integration-test</goal>
+                  <goal>verify</goal>
+                </goals>
+              </execution>
+            </executions>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
   </profiles>
 </project>

embedded-tests/src/test/java/org/apache/druid/testing/embedded/compact/AutoCompactionWebConsoleTest.java

@@ -0,0 +1,35 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.druid.testing.embedded.compact;
+
+import org.apache.druid.testing.embedded.console.WebConsoleTestBase;
+import org.junit.jupiter.api.Test;
+
+/**
+ * Sets up auto-compaction from the Datasources view of the web console, and forces compaction runs from there.
+ */
+public class AutoCompactionWebConsoleTest extends WebConsoleTestBase
+{
+  @Test
+  public void testCompactionConfigAndForcedRun() throws Exception
+  {
+    runSpec("auto-compaction.spec.ts");
+  }
+}

embedded-tests/src/test/java/org/apache/druid/testing/embedded/console/WebConsoleSpecsTest.java

@@ -0,0 +1,79 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.druid.testing.embedded.console;
+
+import com.google.common.collect.Sets;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+
+import java.io.File;
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.Set;
+import java.util.TreeSet;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+/**
+ * Checks that every Playwright spec of {@code web-console/e2e-tests} is run by a {@link WebConsoleTestBase} test (the
+ * specs are passed to {@link WebConsoleTestBase#runSpec} by name), and that those tests run only specs that exist.
+ * It needs no cluster, so it runs with the unit tests rather than in the {@code web-console-tests} profile.
+ */
+public class WebConsoleSpecsTest
+{
+  private static final Pattern RUN_SPEC = Pattern.compile("runSpec\\(\\s*\"([^\"]+)\"");
+
+  @Test
+  public void testEverySpecIsRun() throws IOException
+  {
+    final Set<String> specs;
+    try (Stream<Path> files = Files.list(new File(WebConsoleTestBase.webConsoleDir(), "e2e-tests").toPath())) {
+      specs = files.map(file -> file.getFileName().toString())
+                   .filter(name -> name.endsWith(".spec.ts"))
+                   .collect(Collectors.toCollection(TreeSet::new));
+    }
+
+    final Set<String> runSpecs = new TreeSet<>();
+    try (Stream<Path> files = Files.walk(Path.of("src", "test", "java"))) {
+      for (Path file : files.filter(f -> f.getFileName().toString().endsWith("WebConsoleTest.java")).toList()) {
+        final Matcher matcher = RUN_SPEC.matcher(Files.readString(file, StandardCharsets.UTF_8));
+        while (matcher.find()) {
+          runSpecs.add(matcher.group(1));
+        }
+      }
+    }
+
+    Assertions.assertFalse(specs.isEmpty(), "Found no specs in web-console/e2e-tests");
+    Assertions.assertEquals(
+        Set.of(),
+        Sets.difference(specs, runSpecs),
+        "Specs of web-console/e2e-tests that no *WebConsoleTest runs (with runSpec)"
+    );
+    Assertions.assertEquals(
+        Set.of(),
+        Sets.difference(runSpecs, specs),
+        "Specs that a *WebConsoleTest runs, which are not in web-console/e2e-tests"
+    );
+  }
+}