SOLR-18150: Add SolrBackend abstraction for test/benchmark deployments#4214
Merged
dsmiley merged 11 commits intoapache:mainfrom Mar 29, 2026
Merged
SOLR-18150: Add SolrBackend abstraction for test/benchmark deployments#4214dsmiley merged 11 commits intoapache:mainfrom
dsmiley merged 11 commits intoapache:mainfrom
Conversation
- Created SolrBackend interface to abstract over different Solr deployment types - Added implementations: - EmbeddedSolrBackend: in-process CoreContainer/EmbeddedSolrServer - RemoteSolrBackend: CloudSolrClient connecting to remote SolrCloud cluster - JettySolrRunner: HTTP/Jetty + EmbeddedSolrServer - MiniSolrCloudCluster: embedded multi-node SolrCloud Key features: - Unified API for collection/configSet management across deployment types - Methods throw SolrServerException & IOException - hasConfigSet/hasCollection methods for existence checking - createCollection/uploadConfigSet for resource creation - getBaseUrl(Random) returns URL of a node (random for cloud deployments) - dumpMetrics/dumpCoreInfo for diagnostics Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
dsmiley
commented
Mar 13, 2026
|
|
||
| /** "Mini" SolrCloud cluster to be used for testing */ | ||
| public class MiniSolrCloudCluster { | ||
| public class MiniSolrCloudCluster implements SolrBackend { |
Contributor
Author
There was a problem hiding this comment.
it's a pretty natural fit to implement directly here
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.apache.solr.cloud; |
Contributor
Author
There was a problem hiding this comment.
put into cloud package as it assumes SolrCloud
| * | ||
| * <p>Data is persisted in the given {@code solrHome} directory. | ||
| */ | ||
| public class EmbeddedSolrBackend implements SolrBackend { |
Contributor
Author
There was a problem hiding this comment.
EmbeddedSolrServer cannot implement SolrBackend directly because the latter is in solr-core and SolrBackend is in test-framework
| * @since solr 1.3 | ||
| */ | ||
| public class JettySolrRunner { | ||
| public class JettySolrRunner implements SolrBackend { |
Contributor
Author
There was a problem hiding this comment.
this ended up being slightly awkward to implement directly. An alternative could be a new method asSolrBackend
dsmiley
commented
Mar 14, 2026
| * this client and is responsible for closing it. Callers that want a long-lived client should | ||
| * cache it themselves. | ||
| */ | ||
| SolrClient newClient(String collection); // nocommit or newSolrClient ? |
Contributor
Author
There was a problem hiding this comment.
nocommit; seeking feedback
Contributor
Author
There was a problem hiding this comment.
went with newSolrClient
| * this backend is {@link #close()}d. A {@link CloudSolrClient} should be returned if possible. | ||
| * nocommit | ||
| */ | ||
| SolrClient getAdminClient(); // nocommit or "getNodeClient" or getSolrClient ? |
Contributor
Author
There was a problem hiding this comment.
nocommit; seeking feedback
Contributor
Author
There was a problem hiding this comment.
went with getSolrClient, thus using the same name as in MiniSolrCloudCluster
MiniSolrCloudCluster: * optimize/cleanup configSet methods * reorg methods
github-actions
bot
added
documentation
Contributor
Author
|
Planning to merge ~Tuesday night |
# Conflicts: # solr/benchmark/src/java/org/apache/solr/bench/MiniClusterState.java
Contributor
Author
|
At the last minute I found it convenient for JettySolrRunner to manage a HttpJettySolrClient to be returned when getSolrClient() is called. This is useful, even if code isn't calling JSR as a "backend". For example if a test needs a Jetty HttpClient, it can get it easily from there. |
dsmiley
added a commit
that referenced
this pull request
Mar 30, 2026
#4214) SOLR-18150: Add SolrBackend abstraction for test/benchmark deployments Created SolrBackend interface to abstract over different Solr deployment types (embedded, remote, Jetty, MiniSolrCloudCluster) with a unified API for collection/configSet management, diagnostics, and node URL access. JettySolrRunner now manages a HttpJettySolrClient instance, get via getSolrClient. This PR only introduces the abstraction; follow-on PRs will add callers in benchmarks and tests. Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Key features:
https://issues.apache.org/jira/browse/SOLR-18150
This PR only introduces the abstraction but no callers. Follow-on is to do so with benchmarks & tests separately. I have WIP for the benchmark side already.