solr icon indicating copy to clipboard operation
solr copied to clipboard

Deprecate snapshotscli.sh in favour of bin/solr sub commands.

Open epugh opened this issue 1 year ago • 2 comments

https://issues.apache.org/jira/browse/SOLR-17180

Description

Migrating some commands that are nested in the rather unknown snapshotscli.sh into bin/solr as commands.

Solution

Leave the old code alone, copy the logic into the new code. Deprecate the old code on 9.x, and remove from 10.

Tests

Bats test and manual testing.

Checklist

Please review the following and check all that apply:

  • [x ] I have reviewed the guidelines for How to Contribute and my code conforms to the standards described there to the best of my ability.
  • [ x] I have created a Jira issue and added the issue ID to my pull request title.
  • [ x] I have given Solr maintainers access to contribute to my PR branch. (optional but recommended)
  • [ x] I have developed this patch against the main branch.
  • [ x] I have run ./gradlew check.
  • [ x] I have added tests for my changes.
  • [ ] I have added documentation for the Reference Guide

epugh avatar Apr 01 '24 13:04 epugh

Okay, at this point I might need some help, as I want to move the remaining shell script that is HDFS specific into the hdfs module in it's own /bin and need maybe some gradle magic to bring it into the distribution. Then this can be merged!

epugh avatar May 12 '24 14:05 epugh

Going to try and get this to done this week.

epugh avatar Jun 19 '24 17:06 epugh

Should we update documentation too and add any missing information, or should this be handled in a separate ticket instead?

Looking forward to the HDFS related tests, since I am also curious how it is done.

It's very nice to see a unified pattern on all CLI classes. And the change of using unified zk host, solr url, help and verbose looks very promising for the future. :)

We should add the docs in this one (cause if you don't , they never get added !). As far as the HDFS related tests, honestly I don't think i personally have the energy to figure it out.. I'm going to email the dev and user lists looking for folks to manually test this... I feel like some bats tests should set up an hdfs + solr? Or maybe wrap it in Docker/Docker Compose?

epugh avatar Aug 10 '24 17:08 epugh

Okay, pending all the tests passing, I think this is ready for review and potentially merging!!!

epugh avatar Aug 10 '24 18:08 epugh

Great job adding documentation on this one. That's a very useful addition to the referene guide. 👍

malliaridis avatar Aug 23 '24 21:08 malliaridis

Great job adding documentation on this one. That's a very useful addition to the referene guide. 👍

I appreciate it! I did it partly because you called it out!

epugh avatar Aug 23 '24 21:08 epugh

I would love a bot that would jsut delete code that wasn't documented ;-)

epugh avatar Aug 23 '24 21:08 epugh