-
-
Notifications
You must be signed in to change notification settings - Fork 2.9k
Export footer only for commands that support --output #13277
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
070jhz
wants to merge
6
commits into
JabRef:main
Choose a base branch
from
070jhz:task-13275
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
69f5487
Closes #13275 : export footer only for commands that support --output
070jhz b8e87bd
change applyUsageFooters() visibility from private to package-private
070jhz f01c4af
initial HelpOutputTest to verify footer visibility in CLI help
070jhz fa1fea8
refactor test to cover all commands dynamically
070jhz 390f8e9
refine HelpOutputTest to check usageMessage footer directly
070jhz cca9642
Merge branch 'main' into task-13275
koppor File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
package org.jabref; | ||
|
||
import javafx.collections.FXCollections; | ||
|
||
import org.jabref.cli.ArgumentProcessor; | ||
import org.jabref.logic.exporter.ExportPreferences; | ||
import org.jabref.logic.importer.ImportFormatPreferences; | ||
import org.jabref.logic.importer.ImporterPreferences; | ||
import org.jabref.logic.importer.WebFetchers; | ||
import org.jabref.logic.preferences.CliPreferences; | ||
import org.jabref.model.entry.BibEntryTypesManager; | ||
|
||
import org.junit.jupiter.api.BeforeEach; | ||
import org.junit.jupiter.api.Test; | ||
import org.mockito.Answers; | ||
import picocli.CommandLine; | ||
|
||
import static org.junit.jupiter.api.Assertions.assertFalse; | ||
import static org.junit.jupiter.api.Assertions.assertTrue; | ||
import static org.mockito.Mockito.mock; | ||
import static org.mockito.Mockito.when; | ||
|
||
public class HelpOutputTest { | ||
|
||
private CliPreferences preferences; | ||
private BibEntryTypesManager entryTypesManager; | ||
private CommandLine cmd; | ||
|
||
@BeforeEach | ||
public void setUp() { | ||
preferences = mock(CliPreferences.class, Answers.RETURNS_DEEP_STUBS); | ||
entryTypesManager = mock(BibEntryTypesManager.class); | ||
|
||
ImporterPreferences importerPreferences = mock(ImporterPreferences.class, Answers.RETURNS_DEEP_STUBS); | ||
ExportPreferences exportPreferences = mock(ExportPreferences.class, Answers.RETURNS_DEEP_STUBS); | ||
ImportFormatPreferences importFormatPreferences = mock(ImportFormatPreferences.class, Answers.RETURNS_DEEP_STUBS); | ||
|
||
when(preferences.getImporterPreferences()).thenReturn(importerPreferences); | ||
when(preferences.getExportPreferences()).thenReturn(exportPreferences); | ||
when(preferences.getImportFormatPreferences()).thenReturn(importFormatPreferences); | ||
|
||
when(exportPreferences.getCustomExporters()).thenReturn(FXCollections.emptyObservableList()); | ||
koppor marked this conversation as resolved.
Show resolved
Hide resolved
|
||
when(importerPreferences.getCustomImporters()).thenReturn(FXCollections.emptyObservableSet()); | ||
koppor marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
ArgumentProcessor argumentProcessor = new ArgumentProcessor(preferences, entryTypesManager); | ||
cmd = new CommandLine(argumentProcessor); | ||
|
||
JabKit.applyUsageFooters( | ||
cmd, | ||
ArgumentProcessor.getAvailableImportFormats(preferences), | ||
ArgumentProcessor.getAvailableExportFormats(preferences), | ||
WebFetchers.getSearchBasedFetchers(preferences.getImportFormatPreferences(), preferences.getImporterPreferences()) | ||
); | ||
} | ||
|
||
@Test | ||
public void testExportFormatsFooterShownForOutputCommands() { | ||
String help = cmd.getSubcommands().get("search").getUsageMessage(); | ||
assertTrue(help.contains("Available export formats"), | ||
"'Available export formats' should appear in 'search' command help"); | ||
070jhz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} | ||
|
||
@Test | ||
public void testExportFormatsFooterNotShownForCommandsWithoutOutput() { | ||
String help = cmd.getSubcommands().get("check-consistency").getUsageMessage(); | ||
assertFalse(help.contains("Available export formats"), | ||
"'Available export formats' should NOT appear in 'check-consistency' command help"); | ||
070jhz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} | ||
} |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add @VisibleForTesting