Migrate Solr tests from SolrJettyTestBase to using SolrJettyTestRule

solr/core/src/test/org/apache/solr/TestCustomCoreProperties.java

@@ -36,7 +36,7 @@
  */
 public class TestCustomCoreProperties extends SolrTestCaseJ4 {
 
-  @ClassRule public static SolrJettyTestRule solrClientTestRule = new SolrJettyTestRule();
+  @ClassRule public static SolrJettyTestRule solrTestRule = new SolrJettyTestRule();
 
   // TODO these properties files don't work with configsets
 
@@ -49,7 +49,6 @@ public static void beforeClass() throws Exception {
 
     Files.createDirectories(confDir);
 
-    Files.copy(SolrTestCaseJ4.TEST_HOME().resolve("solr.xml"), homeDir.resolve("solr.xml"));
     String src_dir = TEST_HOME() + "/collection1/conf";
     Files.copy(Path.of(src_dir, "schema-tiny.xml"), confDir.resolve("schema.xml"));
     Files.copy(
@@ -79,7 +78,7 @@ public static void beforeClass() throws Exception {
       nodeProperties.setProperty("solr.data.dir", createTempDir().toRealPath().toString());
     }
 
-    solrClientTestRule.startSolr(homeDir, nodeProperties, JettyConfig.builder().build());
+    solrTestRule.startSolr(homeDir, nodeProperties, JettyConfig.builder().build());
   }
 
   @Test
@@ -88,7 +87,7 @@ public void testSimple() throws Exception {
         params(
             "q", "*:*",
             "echoParams", "all");
-    QueryResponse res = solrClientTestRule.getSolrClient("collection1").query(params);
+    QueryResponse res = solrTestRule.getSolrClient("collection1").query(params);
     assertEquals(0, res.getResults().getNumFound());
 
     NamedList<?> echoedParams = (NamedList<?>) res.getHeader().get("params");

solr/core/src/test/org/apache/solr/TestTolerantSearch.java

@@ -21,7 +21,6 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.StandardCopyOption;
-import org.apache.commons.io.FileUtils;
 import org.apache.solr.client.solrj.SolrClient;
 import org.apache.solr.client.solrj.SolrServerException;
 import org.apache.solr.client.solrj.request.CoreAdminRequest;
@@ -34,49 +33,62 @@
 import org.apache.solr.request.SolrQueryRequest;
 import org.apache.solr.response.JavaBinResponseWriter;
 import org.apache.solr.response.SolrQueryResponse;
+import org.apache.solr.util.SolrJettyTestRule;
 import org.junit.AfterClass;
 import org.junit.BeforeClass;
+import org.junit.ClassRule;
 
-public class TestTolerantSearch extends SolrJettyTestBase {
+public class TestTolerantSearch extends SolrTestCaseJ4 {
+
+  @ClassRule public static SolrJettyTestRule solrTestRule = new SolrJettyTestRule();
 
   private static SolrClient collection1;
   private static SolrClient collection2;
   private static String shard1;
   private static String shard2;
 
   private static Path createSolrHome() throws Exception {
-    Path workDir = createTempDir();
-    setupJettyTestHome(workDir, "collection1");
+    Path workDir = createTempDir().toRealPath();
+
+    // Copy solr.xml
     Files.copy(
-        Path.of(SolrTestCaseJ4.TEST_HOME() + "/collection1/conf/solrconfig-tolerant-search.xml"),
-        workDir.resolve("collection1").resolve("conf").resolve("solrconfig.xml"),
+        SolrTestCaseJ4.TEST_PATH().resolve("solr.xml"),
+        workDir.resolve("solr.xml"),
         StandardCopyOption.REPLACE_EXISTING);
-    FileUtils.copyDirectory(
-        workDir.resolve("collection1").toFile(), workDir.resolve("collection2").toFile());
+
+    // Set up collection1 with minimal config + tolerant search solrconfig
+    Path collection1Dir = workDir.resolve("collection1");
+    copyMinConf(collection1Dir, "name=collection1\n", "solrconfig-tolerant-search.xml");
+
+    // Set up configset for CoreAdminRequest.Create (reuse the same config)
+    Path configSetDir = workDir.resolve("configsets").resolve("collection1");
+    copyMinConf(configSetDir, null, "solrconfig-tolerant-search.xml");
+
     return workDir;
   }
 
   @BeforeClass
   public static void createThings() throws Exception {
     systemSetPropertyEnableUrlAllowList(false);
     Path solrHome = createSolrHome();
-    createAndStartJetty(solrHome);
-    String url = getBaseUrl();
-    collection1 = getHttpSolrClient(url, "collection1");
-    collection2 = getHttpSolrClient(url, "collection2");
+    solrTestRule.startSolr(solrHome);
 
-    String urlCollection1 = getBaseUrl() + "/" + "collection1";
-    String urlCollection2 = getBaseUrl() + "/" + "collection2";
+    collection1 = solrTestRule.getSolrClient("collection1");
+
+    String urlCollection1 = solrTestRule.getBaseUrl() + "/" + "collection1";
+    String urlCollection2 = solrTestRule.getBaseUrl() + "/" + "collection2";
     shard1 = urlCollection1.replaceAll("https?://", "");
     shard2 = urlCollection2.replaceAll("https?://", "");
 
     // create second core
-    try (SolrClient nodeClient = getHttpSolrClient(url)) {
-      CoreAdminRequest.Create req = new CoreAdminRequest.Create();
-      req.setCoreName("collection2");
-      req.setConfigSet("collection1");
-      nodeClient.request(req);
-    }
+    SolrClient nodeClient = solrTestRule.getSolrClient();
+    CoreAdminRequest.Create req = new CoreAdminRequest.Create();
+    req.setCoreName("collection2");
+    req.setConfigSet("collection1");
+    nodeClient.request(req);
+
+    // Now get the client for collection2 after it's been created
+    collection2 = solrTestRule.getSolrClient("collection2");
 
     SolrInputDocument doc = new SolrInputDocument();
     doc.setField("id", "1");
@@ -100,14 +112,8 @@ public static void createThings() throws Exception {
 
   @AfterClass
   public static void destroyThings() throws Exception {
-    if (null != collection1) {
-      collection1.close();
-      collection1 = null;
-    }
-    if (null != collection2) {
-      collection2.close();
-      collection2 = null;
-    }
+    collection1 = null;
+    collection2 = null;
     resetExceptionIgnores();
     systemClearPropertySolrEnableUrlAllowList();
   }

solr/core/src/test/org/apache/solr/core/TestConfigSetImmutable.java

@@ -61,7 +61,7 @@ public void before() throws Exception {
 
   @After
   public void after() throws Exception {
-    solrClientTestRule.reset();
+    solrTestRule.reset();
 
     if (restTestHarness != null) {
       restTestHarness.close();

solr/core/src/test/org/apache/solr/core/TestSolrConfigHandler.java

@@ -140,7 +140,7 @@ public void before() throws Exception {
 
   @After
   public void after() throws Exception {
-    solrClientTestRule.reset();
+    solrTestRule.reset();
 
     if (restTestHarness != null) {
       restTestHarness.close();

solr/core/src/test/org/apache/solr/handler/TestHttpRequestId.java

@@ -26,7 +26,7 @@
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.TimeoutException;
 import org.apache.logging.log4j.core.LogEvent;
-import org.apache.solr.SolrJettyTestBase;
+import org.apache.solr.SolrTestCaseJ4;
 import org.apache.solr.client.solrj.jetty.HttpJettySolrClient;
 import org.apache.solr.client.solrj.request.SolrPing;
 import org.apache.solr.common.util.ExecutorUtil;
@@ -35,16 +35,20 @@
 import org.apache.solr.common.util.SuppressForbidden;
 import org.apache.solr.util.LogLevel;
 import org.apache.solr.util.LogListener;
+import org.apache.solr.util.SolrJettyTestRule;
 import org.junit.BeforeClass;
+import org.junit.ClassRule;
 import org.junit.Test;
 import org.slf4j.MDC;
 
 @LogLevel("org.apache.solr.client.solrj.jetty.HttpJettySolrClient=DEBUG")
-public class TestHttpRequestId extends SolrJettyTestBase {
+public class TestHttpRequestId extends SolrTestCaseJ4 {
+
+  @ClassRule public static SolrJettyTestRule solrTestRule = new SolrJettyTestRule();
 
   @BeforeClass
   public static void beforeTest() throws Exception {
-    createAndStartJetty(legacyExampleCollection1SolrHome());
+    solrTestRule.startSolr(createTempDir());
   }
 
   @Test
@@ -95,7 +99,7 @@ private void setupClientAndRun(
               false);
       CompletableFuture<NamedList<Object>> cf;
       try (var client =
-          new HttpJettySolrClient.Builder(getBaseUrl())
+          new HttpJettySolrClient.Builder(solrTestRule.getBaseUrl())
               .withDefaultCollection(collection)
               .withExecutor(commExecutor)
               .build()) {

solr/core/src/test/org/apache/solr/handler/TestReplicationHandlerBackup.java

@@ -38,7 +38,6 @@
 import org.apache.lucene.store.NIOFSDirectory;
 import org.apache.lucene.tests.util.LuceneTestCase;
 import org.apache.lucene.tests.util.TestUtil;
-import org.apache.solr.SolrJettyTestBase;
 import org.apache.solr.SolrTestCaseJ4;
 import org.apache.solr.client.solrj.SolrClient;
 import org.apache.solr.client.solrj.apache.HttpSolrClient;
@@ -53,7 +52,7 @@
 // Backups do checksum validation against a footer value not present in 'SimpleText'
 @LuceneTestCase.SuppressCodecs({"SimpleText"})
 @SolrTestCaseJ4.SuppressSSL // Currently, unknown why SSL does not work with this test
-public class TestReplicationHandlerBackup extends SolrJettyTestBase {
+public class TestReplicationHandlerBackup extends SolrTestCaseJ4 {
 
   JettySolrRunner leaderJetty;
   ReplicationTestHelper.SolrInstance leader = null;
@@ -78,9 +77,8 @@ private static JettySolrRunner createAndStartJetty(ReplicationTestHelper.SolrIns
     return jetty;
   }
 
-  private static SolrClient createNewSolrClient(int port) {
-    final String baseUrl = buildUrl(port);
-    return new HttpSolrClient.Builder(baseUrl)
+  private static SolrClient createNewSolrClient(JettySolrRunner jetty) {
+    return new HttpSolrClient.Builder(jetty.getBaseUrl().toString())
         .withConnectionTimeout(15000, TimeUnit.MILLISECONDS)
         .withSocketTimeout(60000, TimeUnit.MILLISECONDS)
         .build();
@@ -102,7 +100,7 @@ public void setUp() throws Exception {
     leader.copyConfigFile(CONF_DIR.resolve(configFile).toString(), "solrconfig.xml");
 
     leaderJetty = createAndStartJetty(leader);
-    leaderClient = createNewSolrClient(leaderJetty.getLocalPort());
+    leaderClient = createNewSolrClient(leaderJetty);
     docsSeed = random().nextLong();
   }
 
@@ -247,7 +245,7 @@ private void testDeleteNamedBackup(String[] backupNames) throws Exception {
   public static void runBackupCommand(JettySolrRunner leaderJetty, String cmd, String params)
       throws IOException {
     String leaderUrl =
-        buildUrl(leaderJetty.getLocalPort())
+        leaderJetty.getBaseUrl().toString()
             + "/"
             + DEFAULT_TEST_CORENAME
             + ReplicationHandler.PATH

solr/core/src/test/org/apache/solr/handler/TestRestoreCore.java

@@ -27,7 +27,6 @@
 import org.apache.lucene.index.IndexFileNames;
 import org.apache.lucene.tests.util.LuceneTestCase;
 import org.apache.lucene.tests.util.TestUtil;
-import org.apache.solr.SolrJettyTestBase;
 import org.apache.solr.SolrTestCaseJ4;
 import org.apache.solr.client.solrj.SolrClient;
 import org.apache.solr.client.solrj.apache.HttpSolrClient;
@@ -41,7 +40,7 @@
 @SolrTestCaseJ4.SuppressSSL // Currently, unknown why SSL does not work with this test
 // Backups do checksum validation against a footer value not present in 'SimpleText'
 @LuceneTestCase.SuppressCodecs("SimpleText")
-public class TestRestoreCore extends SolrJettyTestBase {
+public class TestRestoreCore extends SolrTestCaseJ4 {
 
   JettySolrRunner leaderJetty;
   ReplicationTestHelper.SolrInstance leader = null;

solr/core/src/test/org/apache/solr/handler/TestStressIncrementalBackup.java

@@ -52,8 +52,7 @@ public void beforeTest() throws Exception {
     backupPath = createTempDir(getTestClass().getSimpleName() + "_backups");
     System.setProperty("solr.security.allow.paths", backupPath.toString());
 
-    // NOTE: we don't actually care about using SolrCloud, but we want to use SolrClient and I can't
-    // bring myself to deal with the nonsense that is SolrJettyTestBase.
+    // NOTE: we don't actually care about using SolrCloud, but we want to use SolrClient.
 
     // We do however explicitly want a fresh "cluster" every time a test is run
     configureCluster(1).addConfig("conf1", configset("cloud-minimal")).configure();

solr/core/src/test/org/apache/solr/handler/TestStressThreadBackup.java

@@ -89,8 +89,7 @@ public static void afterClass() {
   public void beforeTest() throws Exception {
     backupDir = createTempDir(getTestClass().getSimpleName() + "_backups");
 
-    // NOTE: we don't actually care about using SolrCloud, but we want to use SolrClient and I can't
-    // bring myself to deal with the nonsense that is SolrJettyTestBase.
+    // NOTE: we don't actually care about using SolrCloud, but we want to use SolrClient
 
     // We do however explicitly want a fresh "cluster" every time a test is run
     configureCluster(1)

solr/core/src/test/org/apache/solr/handler/admin/ShowFileRequestHandlerTest.java

@@ -20,7 +20,7 @@
 import java.io.InputStream;
 import java.util.Set;
 import java.util.concurrent.atomic.AtomicBoolean;
-import org.apache.solr.SolrJettyTestBase;
+import org.apache.solr.SolrTestCaseJ4;
 import org.apache.solr.client.solrj.SolrClient;
 import org.apache.solr.client.solrj.SolrRequest;
 import org.apache.solr.client.solrj.SolrRequest.SolrRequestType;
@@ -38,18 +38,18 @@
 import org.apache.solr.request.SolrQueryRequest;
 import org.apache.solr.request.SolrRequestHandler;
 import org.apache.solr.response.SolrQueryResponse;
+import org.apache.solr.util.SolrJettyTestRule;
 import org.junit.BeforeClass;
+import org.junit.ClassRule;
 
-/**
- * Extend SolrJettyTestBase because the SOLR-2535 bug only manifested itself when the {@link
- * org.apache.solr.servlet.SolrDispatchFilter} is used, which isn't for embedded Solr use.
- */
-public class ShowFileRequestHandlerTest extends SolrJettyTestBase {
+public class ShowFileRequestHandlerTest extends SolrTestCaseJ4 {
+
+  @ClassRule public static SolrJettyTestRule solrTestRule = new SolrJettyTestRule();
 
   @BeforeClass
   public static void beforeTest() throws Exception {
     initCore("solrconfig.xml", "schema.xml");
-    createAndStartJetty(legacyExampleCollection1SolrHome());
+    solrTestRule.startSolr(legacyExampleCollection1SolrHome());
   }
 
   private GenericSolrRequest createShowFileRequest(SolrParams params) {
@@ -59,7 +59,7 @@ private GenericSolrRequest createShowFileRequest(SolrParams params) {
   }
 
   public void test404ViaHttp() {
-    SolrClient client = getSolrClient();
+    SolrClient client = solrTestRule.getSolrClient();
     var request = createShowFileRequest(params("file", "does-not-exist-404.txt"));
     SolrException e = expectThrows(SolrException.class, () -> request.process(client));
     assertEquals(404, e.code());
@@ -82,18 +82,14 @@ public void test404Locally() {
   }
 
   public void testDirList() throws SolrServerException, IOException {
-    SolrClient client = getSolrClient();
-    // assertQ(req("qt", "/admin/file")); TODO file bug that SolrJettyTestBase extends
-    // SolrTestCaseJ4
+    SolrClient client = solrTestRule.getSolrClient();
     var request = createShowFileRequest(new ModifiableSolrParams());
     var resp = request.process(client);
     assertTrue(((NamedList) resp.getResponse().get("files")).size() > 0); // some files
   }
 
   public void testGetRawFile() throws SolrServerException, IOException {
-    SolrClient client = getSolrClient();
-    // assertQ(req("qt", "/admin/file"));
-    // TODO file bug that SolrJettyTestBase extends SolrTestCaseJ4
+    SolrClient client = solrTestRule.getSolrClient();
     var request = createShowFileRequest(params("file", "managed-schema.xml"));
     final AtomicBoolean readFile = new AtomicBoolean();
     request.setResponseParser(
@@ -146,7 +142,7 @@ public void testContentTypeHtmlDefault() {
   }
 
   public void testIllegalContentType() throws SolrServerException, IOException {
-    SolrClient client = getSolrClient();
+    SolrClient client = solrTestRule.getSolrClient();
     var request =
         createShowFileRequest(params("file", "managed-schema", "contentType", "not/known"));
     request.setResponseParser(new InputStreamResponseParser("xml"));
@@ -155,7 +151,7 @@ public void testIllegalContentType() throws SolrServerException, IOException {
   }
 
   public void testAbsoluteFilename() throws SolrServerException, IOException {
-    SolrClient client = getSolrClient();
+    SolrClient client = solrTestRule.getSolrClient();
     final var request =
         createShowFileRequest(
             params("file", "/etc/passwd", "contentType", "text/plain; charset=utf-8"));
@@ -165,7 +161,7 @@ public void testAbsoluteFilename() throws SolrServerException, IOException {
   }
 
   public void testEscapeConfDir() throws SolrServerException, IOException {
-    SolrClient client = getSolrClient();
+    SolrClient client = solrTestRule.getSolrClient();
     final var request =
         createShowFileRequest(
             params("file", "../../solr.xml", "contentType", "application/xml; charset=utf-8"));
@@ -175,7 +171,7 @@ public void testEscapeConfDir() throws SolrServerException, IOException {
   }
 
   public void testPathTraversalFilename() throws SolrServerException, IOException {
-    SolrClient client = getSolrClient();
+    SolrClient client = solrTestRule.getSolrClient();
     final var request =
         createShowFileRequest(
             params(