Added api keys from default build file #12816

jnchin314 · 2025-03-24T20:38:28Z

Closes #12803
Added api keys from BuildInfo where applicable for the fetcher tests. Needed to do proper mocking for the ImporterPrefereces.getApiKey($IMPORTER_NAME)

CompositeSearchBasedFetcher updated with proper mocks as well to use api keys for the different fetchers.

Mandatory checks

I own the copyright of the code submitted and I license it under the MIT license
[/] Change in CHANGELOG.md described in a way that is understandable for the average user (if change is visible to the user)
[/] Tests created for changes (if applicable)
Manually tested changed features in running JabRef (always required)
[/] Screenshots added in PR description (if change is visible to the user)
[/] Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
[/] Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

updated CompositeSearchBasedFetcher as well to use api keys where applicable

trag-bot · 2025-03-24T20:42:12Z

src/test/java/org/jabref/logic/importer/fetcher/CompositeSearchBasedFetcherTest.java

@@ -72,12 +78,16 @@ void performSearchOnEmptyQuery(Set<SearchBasedFetcher> fetchers) throws Exceptio
            "Fetchers: {arguments}")
    @MethodSource("performSearchParameters")
    void performSearchOnNonEmptyQuery(Set<SearchBasedFetcher> fetchers) throws Exception {
+        List fetcherNames = fetchers.stream().map(fetcher-> fetcher.getName()).collect(Collectors.toUnmodifiableList());


Lambda expression has unnecessary parentheses and arrow syntax could be replaced with method reference: fetcher::getName for better readability.

If you use IntelliJ IDEA, it should propose you these changes, and you can just click on hint

jabref-machine · 2025-03-24T20:43:22Z

Your code currently does not meet JabRef's code guidelines. We use Checkstyle to identify issues. Please carefully follow the setup guide for the codestyle. Afterwards, please run checkstyle locally and fix the issues.

In case of issues with the import order, double check that you activated Auto Import. You can trigger fixing imports by pressing Ctrl+Alt+O to trigger Optimize Imports.

…ij properly

src/test/java/org/jabref/logic/importer/fetcher/IEEETest.java

changed to use optional variable where applicable

trag-bot · 2025-03-25T18:12:12Z

@trag-bot didn't find any issues in the code! ✅✨

koppor · 2025-03-28T07:20:09Z

JabRef CI uses (tests-fetchers.yml):

env:
  SpringerNatureAPIKey: ${{ secrets.SPRINGERNATUREAPIKEY_FOR_TESTS }}
  AstrophysicsDataSystemAPIKey: ${{ secrets.AstrophysicsDataSystemAPIKey_FOR_TESTS }}
  IEEEAPIKey: ${{ secrets.IEEEAPIKey_FOR_TESTS }}
  BiodiversityHeritageApiKey: ${{ secrets.BiodiversityHeritageApiKey_FOR_TESTS}}

This is put into build.properties - see build.gradle:

"ieeeAPIKey": System.getenv('IEEEAPIKey') ? System.getenv('IEEEAPIKey') : '',

Which seems to be read by org.jabref.logic.util.BuildInfo#BuildInfo().

Thus, reading that in fetcher tests seems to be right.

Action point: Refine https://devdocs.jabref.org/code-howtos/fetchers.html#background-on-embedding-the-keys-in-jabref with a paragraph of the CI setup.

koppor · 2025-03-28T07:20:18Z

I wonder why the fetcher tests worked before - haha

koppor · 2025-03-28T07:21:04Z

src/test/java/org/jabref/logic/importer/fetcher/ScienceDirectTest.java

@@ -25,10 +26,11 @@ class ScienceDirectTest {
    private final ImporterPreferences importerPreferences = mock(ImporterPreferences.class);
    private ScienceDirect finder;
    private BibEntry entry;
-


Do not remove empty lines separating blocks.

koppor · 2025-03-28T07:22:01Z

src/test/java/org/jabref/logic/importer/fetcher/CompositeSearchBasedFetcherTest.java

+        ObservableList<String> observableList = FXCollections.observableArrayList(fetcherNames);
+        when(importerPreferences.getCatalogs()).thenReturn(observableList);


Merge these two lines - the name obsevableList is not good.

koppor · 2025-03-28T07:22:16Z

src/test/java/org/jabref/logic/importer/fetcher/CompositeSearchBasedFetcherTest.java

@@ -72,12 +79,16 @@ void performSearchOnEmptyQuery(Set<SearchBasedFetcher> fetchers) throws Exceptio
            "Fetchers: {arguments}")
    @MethodSource("performSearchParameters")
    void performSearchOnNonEmptyQuery(Set<SearchBasedFetcher> fetchers) throws Exception {
+        List fetcherNames = fetchers.stream().map(WebFetcher::getName).collect(Collectors.toUnmodifiableList());


Just use .toList() instead of .collect...

koppor · 2025-03-28T07:23:33Z

src/test/java/org/jabref/logic/importer/fetcher/CompositeSearchBasedFetcherTest.java

@@ -101,7 +112,15 @@ void performSearchOnNonEmptyQuery(Set<SearchBasedFetcher> fetchers) throws Excep
    static Stream<Arguments> performSearchParameters() {
        ImportFormatPreferences importFormatPreferences = mock(ImportFormatPreferences.class, Answers.RETURNS_DEEP_STUBS);
        ImporterPreferences importerPreferences = mock(ImporterPreferences.class);
+        BuildInfo buildInfo = new BuildInfo();
        when(importerPreferences.getApiKeys()).thenReturn(FXCollections.emptyObservableSet());


Maybe remove this line to cause an error when an unknown key is retrieved? To catch errors early when a new fetcher is added.

I'm not sure what you mean by this comment. If I remove it the parameterized tests will start failing.

Should i create a whole new set of tests?

koppor · 2025-03-28T07:25:26Z

src/test/java/org/jabref/logic/importer/fetcher/CompositeSearchBasedFetcherTest.java

        CompositeSearchBasedFetcher compositeFetcher = new CompositeSearchBasedFetcher(fetchers, importerPreferences, Integer.MAX_VALUE);
        FieldPreferences fieldPreferences = mock(FieldPreferences.class);
        when(fieldPreferences.getNonWrappableFields()).thenReturn(FXCollections.observableArrayList());
        ImportCleanup cleanup = ImportCleanup.targeting(BibDatabaseMode.BIBTEX, fieldPreferences);

        List<BibEntry> compositeResult = compositeFetcher.performSearch("quantum");
+        compositeResult.forEach(cleanup::doPostCleanup);


This is OK for consistency reasons

Added api keys from default build file

246d6d2

updated CompositeSearchBasedFetcher as well to use api keys where applicable

jnchin314 mentioned this pull request Mar 24, 2025

Update Tests with fetchers to use assumeTrue() #12803

Open

trag-bot bot reviewed Mar 24, 2025

View reviewed changes

Updating after running manually checkstyle. it did not run via intell…

f8cef6f

…ij properly

InAnYan reviewed Mar 25, 2025

View reviewed changes

src/test/java/org/jabref/logic/importer/fetcher/IEEETest.java Outdated Show resolved Hide resolved

Updating with PR suggestions - fixed to use method reference

7704cce

changed to use optional variable where applicable

koppor reviewed Mar 28, 2025

View reviewed changes

koppor requested changes Mar 28, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added api keys from default build file #12816

Added api keys from default build file #12816

jnchin314 commented Mar 24, 2025

trag-bot bot Mar 24, 2025

InAnYan Mar 25, 2025

jabref-machine commented Mar 24, 2025

trag-bot bot commented Mar 25, 2025

koppor commented Mar 28, 2025

koppor commented Mar 28, 2025

koppor Mar 28, 2025

koppor Mar 28, 2025

koppor Mar 28, 2025

koppor Mar 28, 2025

jnchin314 Mar 29, 2025

koppor Mar 28, 2025

		ObservableList<String> observableList = FXCollections.observableArrayList(fetcherNames);
		when(importerPreferences.getCatalogs()).thenReturn(observableList);

Added api keys from default build file #12816

Are you sure you want to change the base?

Added api keys from default build file #12816

Conversation

jnchin314 commented Mar 24, 2025

Mandatory checks

trag-bot bot Mar 24, 2025

Choose a reason for hiding this comment

InAnYan Mar 25, 2025

Choose a reason for hiding this comment

jabref-machine commented Mar 24, 2025

trag-bot bot commented Mar 25, 2025

koppor commented Mar 28, 2025

koppor commented Mar 28, 2025

koppor Mar 28, 2025

Choose a reason for hiding this comment

koppor Mar 28, 2025

Choose a reason for hiding this comment

koppor Mar 28, 2025

Choose a reason for hiding this comment

koppor Mar 28, 2025

Choose a reason for hiding this comment

jnchin314 Mar 29, 2025

Choose a reason for hiding this comment

koppor Mar 28, 2025

Choose a reason for hiding this comment