From 7b0f65322de469f19d03769dbf1853c6a708d583 Mon Sep 17 00:00:00 2001 From: Praveena G Date: Wed, 24 May 2017 15:54:59 +0100 Subject: [PATCH] print environment variables usage as part of help --- .../neo4j/commandline/admin/CommandUsage.java | 1 + .../org/neo4j/commandline/admin/Usage.java | 4 ++-- .../neo4j/commandline/admin/UsageTest.java | 19 ++++++++++++------- 3 files changed, 15 insertions(+), 9 deletions(-) diff --git a/community/command-line/src/main/java/org/neo4j/commandline/admin/CommandUsage.java b/community/command-line/src/main/java/org/neo4j/commandline/admin/CommandUsage.java index 4dab44215a399..eef40b6a1151c 100644 --- a/community/command-line/src/main/java/org/neo4j/commandline/admin/CommandUsage.java +++ b/community/command-line/src/main/java/org/neo4j/commandline/admin/CommandUsage.java @@ -45,6 +45,7 @@ void printDetailed( Consumer output ) output.accept( Arguments.rightColumnFormatted( left, arguments.usage(), left.length() + 1 ) ); } output.accept( "" ); + Usage.printEnvironmentVariables( output ); output.accept( command.allArguments().description( command.description() ) ); } } diff --git a/community/command-line/src/main/java/org/neo4j/commandline/admin/Usage.java b/community/command-line/src/main/java/org/neo4j/commandline/admin/Usage.java index 50dc0f6faf49a..4123efcec95b2 100644 --- a/community/command-line/src/main/java/org/neo4j/commandline/admin/Usage.java +++ b/community/command-line/src/main/java/org/neo4j/commandline/admin/Usage.java @@ -52,7 +52,6 @@ public void print( Consumer output ) output.accept( "Manage your Neo4j instance." ); output.accept( "" ); - output.accept( "environment variables:" ); printEnvironmentVariables( output ); output.accept( "available commands:" ); @@ -62,8 +61,9 @@ public void print( Consumer output ) output.accept( format( "Use %s help for more details.", scriptName ) ); } - private void printEnvironmentVariables( Consumer output ) + static void printEnvironmentVariables( Consumer output ) { + output.accept( "environment variables:" ); output.accept( " NEO4J_CONF Path to directory which contains neo4j.conf." ); output.accept( " NEO4J_DEBUG Set to anything to enable debug output." ); output.accept( " NEO4J_HOME Neo4j home directory." ); diff --git a/community/command-line/src/test/java/org/neo4j/commandline/admin/UsageTest.java b/community/command-line/src/test/java/org/neo4j/commandline/admin/UsageTest.java index 30f0a77aa593d..b5b1befff03bf 100644 --- a/community/command-line/src/test/java/org/neo4j/commandline/admin/UsageTest.java +++ b/community/command-line/src/test/java/org/neo4j/commandline/admin/UsageTest.java @@ -19,16 +19,16 @@ */ package org.neo4j.commandline.admin; +import java.util.Collections; +import java.util.function.Consumer; +import javax.annotation.Nonnull; + import org.junit.Before; import org.junit.Test; import org.mockito.InOrder; import org.mockito.Mock; import org.mockito.MockitoAnnotations; -import java.util.Collections; -import java.util.function.Consumer; -import javax.annotation.Nonnull; - import org.neo4j.commandline.arguments.Arguments; import static org.mockito.Mockito.inOrder; @@ -50,17 +50,22 @@ public void setUp() public void shouldPrintUsageForACommand() throws Exception { // given - AdminCommand.Provider commandProvier = mockCommand( "bam", "A summary", AdminCommandSection.general() ); - AdminCommand.Provider[] commands = new AdminCommand.Provider[]{commandProvier}; + AdminCommand.Provider commandProvider = mockCommand( "bam", "A summary", AdminCommandSection.general() ); + AdminCommand.Provider[] commands = new AdminCommand.Provider[]{commandProvider}; final Usage usage = new Usage( "neo4j-admin", new CannedLocator( commands ) ); // when - usage.printUsageForCommand( commandProvier, out ); + usage.printUsageForCommand( commandProvider, out ); // then InOrder ordered = inOrder( out ); ordered.verify( out ).accept( "usage: neo4j-admin bam " ); ordered.verify( out ).accept( "" ); + ordered.verify( out ).accept( "environment variables:" ); + ordered.verify( out ).accept( " NEO4J_CONF Path to directory which contains neo4j.conf." ); + ordered.verify( out ).accept( " NEO4J_DEBUG Set to anything to enable debug output." ); + ordered.verify( out ).accept( " NEO4J_HOME Neo4j home directory." ); + ordered.verify( out ).accept( "" ); ordered.verify( out ).accept( "description" ); }