Apache Solr open-source search software
SOLR-15728 Clean up remains of "utils" tool in SolrCLI (#392)
Jan Høydahlc7592dce46d9
diff --git a/solr/bin/solr.cmd b/solr/bin/solr.cmdindex 652595ad6f3..5de6db54a66 100755--- a/solr/bin/solr.cmd+++ b/solr/bin/solr.cmd@@ -1518,19 +1518,6 @@ goto doneorg.apache.solr.util.SolrCLI versiongoto done-:run_utils-set "TOOL_CMD=%~1"-set q="-q"-IF "%verbose%"=="1" set q=""-"%JAVA%" %SOLR_SSL_OPTS% %SOLR_ZK_CREDS_AND_ACLS% -Dsolr.install.dir="%SOLR_TIP%" ^- -Dlog4j.configurationFile="file:///%DEFAULT_SERVER_DIR%\resources\log4j2-console.xml" ^- -classpath "%DEFAULT_SERVER_DIR%\solr-webapp\webapp\WEB-INF\lib\*;%DEFAULT_SERVER_DIR%\lib\ext\*" ^- org.apache.solr.util.SolrCLI utils -s "%DEFAULT_SERVER_DIR%" -l "%SOLR_LOGS_DIR%" %q:"=% %TOOL_CMD%-if errorlevel 1 (- exit /b 1-)-goto done-:parse_create_argsIF [%1]==[] goto run_createIF "%1"=="-V" goto set_create_verbosediff --git a/solr/core/src/java/org/apache/solr/util/SolrCLI.java b/solr/core/src/java/org/apache/solr/util/SolrCLI.javaindex ddaa7b525a1..8e70493b9b2 100755--- a/solr/core/src/java/org/apache/solr/util/SolrCLI.java+++ b/solr/core/src/java/org/apache/solr/util/SolrCLI.java@@ -384,8 +384,6 @@ public class SolrCLI implements CLIO {return new ZkMkrootTool();else if ("assert".equals(toolType))return new AssertTool();- else if ("utils".equals(toolType))- return new UtilsTool();else if ("auth".equals(toolType))return new AuthTool();else if ("export".equals(toolType))@@ -4169,91 +4167,4 @@ public class SolrCLI implements CLIO {@Overrideprotected void runImpl(CommandLine cli) throws Exception {}}-- public static class UtilsTool extends ToolBase {- private Path serverPath;- private Path logsPath;- private boolean beQuiet;-- public UtilsTool() { this(CLIO.getOutStream()); }- public UtilsTool(PrintStream stdout) { super(stdout); }-- public String getName() {- return "utils";- }-- public Option[] getOptions() {- return new Option[]{- Option.builder("s")- .argName("path")- .hasArg()- .desc("Path to server dir. Required if logs path is relative.")- .build(),- Option.builder("l")- .argName("path")- .hasArg()- .desc("Path to logs dir. If relative, also provide server dir with -s.")- .build(),- Option.builder("q")- .desc("Be quiet, don't print to stdout, only return exit codes.")- .build()- };- }-- @Override- public int runTool(CommandLine cli) throws Exception {- if (cli.getOptions().length == 0 || cli.getArgs().length > 0 || cli.hasOption("h")) {- new HelpFormatter().printHelp("bin/solr utils [OPTIONS]", getToolOptions(this));- return 1;- }- if (cli.hasOption("s")) {- serverPath = Paths.get(cli.getOptionValue("s"));- }- if (cli.hasOption("l")) {- logsPath = Paths.get(cli.getOptionValue("l"));- }- if (cli.hasOption("q")) {- beQuiet = cli.hasOption("q");- }- return 0;- }--- // Private methods to follow-- private void out(String message) {- if (!beQuiet) {- stdout.print(message + "\n");- }- }-- private void prepareLogsPath() throws Exception {- if (logsPath == null) {- throw new Exception("Command requires the -l <log-directory> option");- }- if (!logsPath.isAbsolute()) {- if (serverPath != null && serverPath.isAbsolute() && Files.exists(serverPath)) {- logsPath = serverPath.resolve(logsPath);- } else {- throw new Exception("Logs directory must be an absolute path, or -s must be supplied.");- }- }- }-- @Override- protected void runImpl(CommandLine cli) throws Exception {- }-- public void setLogPath(Path logsPath) {- this.logsPath = logsPath;- }-- public void setServerPath(Path serverPath) {- this.serverPath = serverPath;- }-- public void setQuiet(boolean shouldPrintStdout) {- this.beQuiet = shouldPrintStdout;- }- } // end UtilsTool class}diff --git a/solr/core/src/test/org/apache/solr/util/UtilsToolTest.java b/solr/core/src/test/org/apache/solr/util/UtilsToolTest.javadeleted file mode 100644index ee4bb940494..00000000000--- a/solr/core/src/test/org/apache/solr/util/UtilsToolTest.java+++ /dev/null@@ -1,206 +0,0 @@-/*- * 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.solr.util;--import java.io.IOException;-import java.nio.file.Files;-import java.nio.file.Path;-import java.nio.file.attribute.FileTime;-import java.time.Instant;-import java.time.Period;-import java.util.Arrays;-import java.util.List;-import java.util.stream.Collectors;--import org.apache.commons.cli.CommandLine;-import org.apache.solr.SolrTestCaseJ4;-import org.junit.After;-import org.junit.Before;-import org.junit.Test;--import static org.apache.solr.util.SolrCLI.findTool;-import static org.apache.solr.util.SolrCLI.parseCmdLine;--/**- * Unit test for SolrCLI's UtilsTool- */-public class UtilsToolTest extends SolrTestCaseJ4 {-- private Path dir;- private SolrCLI.UtilsTool tool;- private List<String> files = Arrays.asList(- "solr.log",- "solr.log.1",- "solr.log.2",- "solr.log.3",- "solr.log.9",- "solr.log.10",- "solr.log.11",- "solr_log_20160102",- "solr_log_20160304",- "solr-8983-console.log",- "solr_gc_log_20160102",- "solr_gcnotremove",- "solr_gc.log",- "solr_gc.log.0",- "solr_gc.log.0.current",- "solr_gc_log_2");-- @Before- public void setUp() throws Exception {- super.setUp();- dir = createTempDir("Utils Tool Test").toAbsolutePath();- files.forEach(f -> {- try {- Files.createFile(dir.resolve(f));- } catch (IOException e) {- fail("Error when creating temporary file " + dir.resolve(f));- }- });- }-- @After- public void tearDown() throws Exception {- super.tearDown();- if (null != dir) {- org.apache.commons.io.FileUtils.deleteDirectory(dir.toFile());- dir = null;- }- }-- @Test- public void testEmptyAndQuiet() throws Exception {- String[] args = {"utils", "-remove_old_solr_logs", "7",- "-rotate_solr_logs", "9",- "-archive_gc_logs",- "-archive_console_logs",- "-q",- "-l", dir.toString()};- assertEquals(0, runTool(args));- }-- @Test- public void testNonexisting() throws Exception {- String nonexisting = dir.resolve("non-existing").toString();- String[] args = {"utils", "-remove_old_solr_logs", "7",- "-rotate_solr_logs", "9",- "-archive_gc_logs",- "-archive_console_logs",- "-l", nonexisting};- assertEquals(0, runTool(args));- }-- @Test- public void testRemoveOldSolrLogs() throws Exception {- String[] args = {"utils", "-remove_old_solr_logs", "1", "-l", dir.toString()};- assertEquals(files.size(), fileCount());- assertEquals(0, runTool(args));- assertEquals(files.size(), fileCount()); // No logs older than 1 day- Files.setLastModifiedTime(dir.resolve("solr_log_20160102"), FileTime.from(Instant.now().minus(Period.ofDays(2))));- assertEquals(0, runTool(args));- assertEquals(files.size()-1, fileCount()); // One logs older than 1 day- Files.setLastModifiedTime(dir.resolve("solr_log_20160304"), FileTime.from(Instant.now().minus(Period.ofDays(3))));- assertEquals(0, runTool(args));- assertEquals(files.size()-2, fileCount()); // Two logs older than 1 day- }-- @Test- public void testRelativePath() throws Exception {-- // NOTE...- //- // some filesystems have coarse granularity for last modified attribute (ie: multiple milliseconds)- // which means if the test runs very quickly after the creation / setLastMod of these file,- // then "setLastMod(X days ago)" may be equal to (or even greater that) "now - X days" causing- // "-remove_old_solr_logs X" to ignore them.- // so make sure we use at least "setLastMod(X+1 days ago)"-- Files.setLastModifiedTime(dir.resolve("solr_log_20160102"),- FileTime.from(Instant.now().minus(Period.ofDays(1))));- Files.setLastModifiedTime(dir.resolve("solr_log_20160304"),- FileTime.from(Instant.now().minus(Period.ofDays(2))));-- String[] args = {"utils", "-remove_old_solr_logs", "0", "-l", dir.getFileName().toString(), "-s", dir.getParent().toString()};- assertEquals(files.size(), fileCount());- assertEquals(0, runTool(args));- assertEquals(files.size()-2, fileCount());- }-- @Test- public void testRelativePathError() throws Exception {- String[] args = {"utils", "-remove_old_solr_logs", "0", "-l", dir.getFileName().toString()};- try {- runTool(args);- } catch (Exception e) {- return;- }- fail("Should have thrown exception if using relative path without -s");- }-- @Test- public void testRemoveOldGcLogs() throws Exception {- String[] args = {"utils", "-archive_gc_logs", "-l", dir.toString()};- assertEquals(files.size(), fileCount());- assertEquals(0, runTool(args));- assertEquals(files.size()-5, fileCount());- assertFalse(listFiles().contains("solr_gc_log_2"));- assertTrue(Files.exists(dir.resolve("archived").resolve("solr_gc_log_2")));- assertEquals(0, runTool(args));- assertFalse(Files.exists(dir.resolve("archived").resolve("solr_gc_log_2")));- }-- @Test- public void testArchiveConsoleLogs() throws Exception {- String[] args = {"utils", "-archive_console_logs", "-l", dir.toString()};- assertEquals(files.size(), fileCount());- assertEquals(0, runTool(args));- assertEquals(files.size()-1, fileCount());- assertFalse(listFiles().contains("solr-8983-console.log"));- assertTrue(Files.exists(dir.resolve("archived").resolve("solr-8983-console.log")));- assertEquals(0, runTool(args));- assertFalse(Files.exists(dir.resolve("archived").resolve("solr-8983-console.log")));- }-- @Test- public void testRotateSolrLogs() throws Exception {- String[] args = {"utils", "-rotate_solr_logs", "9", "-l", dir.toString()};- assertEquals(files.size(), fileCount());- assertTrue(listFiles().contains("solr.log"));- assertEquals(0, runTool(args));- assertEquals(files.size()-3, fileCount());- assertTrue(listFiles().contains("solr.log.4"));- assertFalse(listFiles().contains("solr.log"));- assertFalse(listFiles().contains("solr.log.9"));- assertFalse(listFiles().contains("solr.log.10"));- assertFalse(listFiles().contains("solr.log.11"));- }-- private List<String> listFiles() throws IOException {- return Files.find(dir, 1, (p, a) -> a.isRegularFile()).map(p -> p.getFileName().toString()).collect(Collectors.toList());- }-- private long fileCount() throws IOException {- return listFiles().size();- }-- private int runTool(String[] args) throws Exception {- SolrCLI.Tool tool = findTool(args);- CommandLine cli = parseCmdLine(args, tool.getOptions());- return tool.runTool(cli);- }-}