Skip to content

Add doc tests #8242

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Dec 1, 2021
Merged

Add doc tests #8242

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d82bede
Add test case mirroring our documentation
koppor Nov 14, 2021
a50db0a
Add more test cases
koppor Nov 14, 2021
f190b95
Enable RegEx search
koppor Nov 14, 2021
2543252
Merge remote-tracking branch 'origin/main' into add-doc-tests
koppor Nov 23, 2021
7cc9abb
Disable non-working tests
koppor Nov 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions src/test/java/org/jabref/model/search/rules/GrammarBasedSearchRuleTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
import org.jabref.model.entry.field.StandardField;
import org.jabref.model.entry.types.StandardEntryType;

import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;

import static org.junit.jupiter.api.Assertions.assertFalse;
Expand Down Expand Up @@ -34,6 +35,62 @@ void applyRuleDoesNotMatchSingleTermWithRegex() {
assertFalse(searchRule.applyRule(query, makeBibtexEntry()));
}

@Test
void searchRuleOfDocumentationMatches() {
GrammarBasedSearchRule searchRule = new GrammarBasedSearchRule(EnumSet.of(SearchRules.SearchFlags.REGULAR_EXPRESSION));

String query = "(author = miller or title|keywords = \"image processing\") and not author = brown";
assertTrue(searchRule.validateSearchStrings(query));
assertTrue(searchRule.applyRule(query, new BibEntry()
.withCitationKey("key")
.withField(StandardField.KEYWORDS, "image processing")));
assertFalse(searchRule.applyRule(query, new BibEntry()
.withCitationKey("key")
.withField(StandardField.AUTHOR, "Sam Brown")
.withField(StandardField.KEYWORDS, "image processing")));
}

@Disabled
@Test
void searchForAnyFieldWorks() {
GrammarBasedSearchRule searchRule = new GrammarBasedSearchRule(EnumSet.of(SearchRules.SearchFlags.REGULAR_EXPRESSION));

String query = "anyfield:fruit";
assertTrue(searchRule.validateSearchStrings(query));
assertTrue(searchRule.applyRule(query, new BibEntry()
.withField(StandardField.KEYWORDS, "fruit")));
}

@Disabled
@Test
void searchForAnyKeywordWorks() {
GrammarBasedSearchRule searchRule = new GrammarBasedSearchRule(EnumSet.of(SearchRules.SearchFlags.REGULAR_EXPRESSION));

String query = "anykeyword:apple";
assertTrue(searchRule.validateSearchStrings(query));
assertTrue(searchRule.applyRule(query, new BibEntry()
.withField(StandardField.KEYWORDS, "apple")));
assertFalse(searchRule.applyRule(query, new BibEntry()
.withField(StandardField.KEYWORDS, "pineapple")));
}

@Test
void searchForCitationKeyWorks() {
GrammarBasedSearchRule searchRule = new GrammarBasedSearchRule(EnumSet.noneOf(SearchRules.SearchFlags.class));
String query = "citationkey==miller2005";
assertTrue(searchRule.validateSearchStrings(query));
assertTrue(searchRule.applyRule(query, new BibEntry()
.withCitationKey("miller2005")));
}

@Test
void searchForThesisEntryTypeWorks() {
GrammarBasedSearchRule searchRule = new GrammarBasedSearchRule(EnumSet.noneOf(SearchRules.SearchFlags.class));
String query = "entrytype=thesis";
assertTrue(searchRule.validateSearchStrings(query));
assertTrue(searchRule.applyRule(query, new BibEntry(StandardEntryType.PhdThesis)));
}

public BibEntry makeBibtexEntry() {
return new BibEntry(StandardEntryType.InCollection)
.withCitationKey("shields01")
Expand Down