Skip to content

Commit 497fcd7

Browse files
LinusDietzLinusDietz
authored
Move Springer key to environment (#6139)
1 parent 99183e1 commit 497fcd7

File tree

17 files changed

+63
-75
lines changed

17 files changed

+63
-75
lines changed

‎.github/workflows/deployment.yml

+20-17
Original file line numberDiff line numberDiff line change
@@ -15,28 +15,31 @@ on:
1515
- 'src/test/**'
1616
- 'README.md'
1717

18+
env:
19+
SpringerNatureAPIKey: ${{ secrets.SpringerNatureAPIKey }}
20+
1821
jobs:
1922
build:
2023
strategy:
2124
fail-fast: false
2225
matrix:
2326
os: [ubuntu-latest, windows-latest, macOS-latest]
2427
include:
25-
- os: ubuntu-latest
26-
displayName: linux
27-
jpackageDownload: https://download.java.net/java/early_access/jdk14/34/GPL/openjdk-14-ea+34_linux-x64_bin.tar.gz
28-
jdk14Path: /jdk-14
29-
archivePortable: tar -c -C build/distribution JabRef | pigz --rsyncable > build/distribution/JabRef-portable_linux.tar.gz && rm -R build/distribution/JabRef
30-
- os: windows-latest
31-
displayName: windows
32-
jpackageDownload: https://download.java.net/java/early_access/jdk14/34/GPL/openjdk-14-ea+34_windows-x64_bin.zip
33-
jdk14Path: /jdk-14
34-
archivePortable: 7z a -r build/distribution/JabRef-portable_windows.zip ./build/distribution/JabRef && rm -R build/distribution/JabRef
35-
- os: macOS-latest
36-
displayName: macOS
37-
jpackageDownload: https://download.java.net/java/early_access/jdk14/34/GPL/openjdk-14-ea+34_osx-x64_bin.tar.gz
38-
jdk14Path: /jdk-14.jdk/Contents/Home
39-
archivePortable: brew install pigz && tar -c -C build/distribution JabRef.app | pigz --rsyncable > build/distribution/JabRef-portable_macos.tar.gz && rm -R build/distribution/JabRef.app
28+
- os: ubuntu-latest
29+
displayName: linux
30+
jpackageDownload: https://download.java.net/java/early_access/jdk14/34/GPL/openjdk-14-ea+34_linux-x64_bin.tar.gz
31+
jdk14Path: /jdk-14
32+
archivePortable: tar -c -C build/distribution JabRef | pigz --rsyncable > build/distribution/JabRef-portable_linux.tar.gz && rm -R build/distribution/JabRef
33+
- os: windows-latest
34+
displayName: windows
35+
jpackageDownload: https://download.java.net/java/early_access/jdk14/34/GPL/openjdk-14-ea+34_windows-x64_bin.zip
36+
jdk14Path: /jdk-14
37+
archivePortable: 7z a -r build/distribution/JabRef-portable_windows.zip ./build/distribution/JabRef && rm -R build/distribution/JabRef
38+
- os: macOS-latest
39+
displayName: macOS
40+
jpackageDownload: https://download.java.net/java/early_access/jdk14/34/GPL/openjdk-14-ea+34_osx-x64_bin.tar.gz
41+
jdk14Path: /jdk-14.jdk/Contents/Home
42+
archivePortable: brew install pigz && tar -c -C build/distribution JabRef.app | pigz --rsyncable > build/distribution/JabRef-portable_macos.tar.gz && rm -R build/distribution/JabRef.app
4043

4144
runs-on: ${{ matrix.os }}
4245
name: Create installer and portable version for ${{ matrix.displayName }}
@@ -49,7 +52,7 @@ jobs:
4952
- name: Install GitVersion
5053
uses: gittools/actions/gitversion/setup@v0.9.1
5154
with:
52-
versionSpec: '5.1.3'
55+
versionSpec: '5.1.3'
5356
- name: Run GitVersion
5457
id: gitversion
5558
uses: gittools/actions/gitversion/execute@v0.9.1
@@ -127,7 +130,7 @@ jobs:
127130
- name: Install GitVersion
128131
uses: gittools/actions/gitversion/setup@v0.9.1
129132
with:
130-
versionSpec: '5.1.3'
133+
versionSpec: '5.1.3'
131134
- name: Run GitVersion
132135
id: gitversion
133136
uses: gittools/actions/gitversion/execute@v0.9.1

‎.github/workflows/tests-fetchers.yml

+3
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ on:
2121
# run on each Wednesday
2222
- cron: '2 3 * * 3'
2323

24+
env:
25+
SpringerNatureAPIKey: ${{ secrets.SpringerNatureAPIKey }}
26+
2427
jobs:
2528
fetchertests:
2629
name: Fetcher tests

‎.github/workflows/tests-oracle.yml

+3
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ on:
1818
# run on each Wednesday
1919
- cron: '2 3 * * 3'
2020

21+
env:
22+
SpringerNatureAPIKey: ${{ secrets.SpringerNatureAPIKey }}
23+
2124
jobs:
2225
oracletests:
2326
name: Oracle tests

‎.github/workflows/tests.yml

+3
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ on:
77
pull_request:
88
# always run on pull requests
99

10+
env:
11+
SpringerNatureAPIKey: ${{ secrets.SpringerNatureAPIKey }}
12+
1013
jobs:
1114
checkstyle:
1215
name: Checkstyle

‎build.gradle

+1
Original file line numberDiff line numberDiff line change
@@ -284,6 +284,7 @@ processResources {
284284
"authors": new File('AUTHORS').readLines().findAll { !it.startsWith("#") }.join(", "),
285285
"developers": new File('DEVELOPERS').readLines().findAll { !it.startsWith("#") }.join(", "),
286286
"azureInstrumentationKey": System.getenv('AzureInstrumentationKey'),
287+
"springerNatureAPIKey": System.getenv('SpringerNatureAPIKey'),
287288
"minRequiredJavaVersion": minRequiredJavaVersion,
288289
"allowJava9": allowJava9
289290

‎src/main/java/org/jabref/Globals.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -113,10 +113,10 @@ private static void stopTelemetryClient() {
113113

114114
private static void startTelemetryClient() {
115115
TelemetryConfiguration telemetryConfiguration = TelemetryConfiguration.getActive();
116-
telemetryConfiguration.setInstrumentationKey(Globals.BUILD_INFO.getAzureInstrumentationKey());
116+
telemetryConfiguration.setInstrumentationKey(Globals.BUILD_INFO.azureInstrumentationKey);
117117
telemetryConfiguration.setTrackingIsDisabled(!Globals.prefs.shouldCollectTelemetry());
118118
telemetryClient = new TelemetryClient(telemetryConfiguration);
119-
telemetryClient.getContext().getProperties().put("JabRef version", Globals.BUILD_INFO.getVersion().toString());
119+
telemetryClient.getContext().getProperties().put("JabRef version", Globals.BUILD_INFO.version.toString());
120120
telemetryClient.getContext().getProperties().put("Java version", StandardSystemProperty.JAVA_VERSION.value());
121121
telemetryClient.getContext().getUser().setId(Globals.prefs.getOrCreateUserId());
122122
telemetryClient.getContext().getSession().setId(UUID.randomUUID().toString());

‎src/main/java/org/jabref/JabRefGUI.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ public JabRefGUI(Stage mainStage, List<ParserResult> databases, boolean isBlank)
5151
mainFrame = new JabRefFrame(mainStage);
5252

5353
openWindow(mainStage);
54-
new VersionWorker(Globals.BUILD_INFO.getVersion(), Globals.prefs.getVersionPreferences().getIgnoredVersion(), mainFrame.getDialogService(), Globals.TASK_EXECUTOR)
54+
new VersionWorker(Globals.BUILD_INFO.version, Globals.prefs.getVersionPreferences().getIgnoredVersion(), mainFrame.getDialogService(), Globals.TASK_EXECUTOR)
5555
.checkForNewVersionDelayed();
5656
}
5757

‎src/main/java/org/jabref/JabRefMain.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -109,19 +109,19 @@ private static void ensureCorrectJavaVersion() {
109109
// Check if we are running an acceptable version of Java
110110
final BuildInfo buildInfo = Globals.BUILD_INFO;
111111
JavaVersion checker = new JavaVersion();
112-
final boolean java9Fail = !buildInfo.isAllowJava9() && checker.isJava9();
113-
final boolean versionFail = !checker.isAtLeast(buildInfo.getMinRequiredJavaVersion());
112+
final boolean java9Fail = !buildInfo.allowJava9 && checker.isJava9();
113+
final boolean versionFail = !checker.isAtLeast(buildInfo.minRequiredJavaVersion);
114114

115115
if (java9Fail || versionFail) {
116116
StringBuilder versionError = new StringBuilder(
117117
Localization.lang("Your current Java version (%0) is not supported. Please install version %1 or higher.",
118118
checker.getJavaVersion(),
119-
buildInfo.getMinRequiredJavaVersion()));
119+
buildInfo.minRequiredJavaVersion));
120120

121121
versionError.append("\n");
122122
versionError.append(Localization.lang("Your Java Runtime Environment is located at %0.", checker.getJavaInstallationDirectory()));
123123

124-
if (!buildInfo.isAllowJava9()) {
124+
if (!buildInfo.allowJava9) {
125125
versionError.append("\n");
126126
versionError.append(Localization.lang("Note that currently, JabRef does not run with Java 9."));
127127
}

‎src/main/java/org/jabref/cli/JabRefCLI.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ public static void printUsage() {
255255
}
256256

257257
private String getVersionInfo() {
258-
return String.format("JabRef %s", Globals.BUILD_INFO.getVersion());
258+
return String.format("JabRef %s", Globals.BUILD_INFO.version);
259259
}
260260

261261
public List<String> getLeftOver() {

‎src/main/java/org/jabref/gui/entryeditor/RelatedArticlesTab.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ private StackPane getRelatedArticlesPane(BibEntry entry) {
6161
progress.setMaxSize(100, 100);
6262

6363
MrDLibFetcher fetcher = new MrDLibFetcher(Globals.prefs.get(JabRefPreferences.LANGUAGE),
64-
Globals.BUILD_INFO.getVersion());
64+
Globals.BUILD_INFO.version);
6565
BackgroundTask
6666
.wrap(() -> fetcher.performSearch(entry))
6767
.onRunning(() -> progress.setVisible(true))

‎src/main/java/org/jabref/gui/errorconsole/ErrorConsoleViewModel.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ public void clearLog() {
9292
public void reportIssue() {
9393
try {
9494
// System info
95-
String systemInfo = String.format("JabRef %s%n%s %s %s %nJava %s", buildInfo.getVersion(), BuildInfo.OS,
95+
String systemInfo = String.format("JabRef %s%n%s %s %s %nJava %s", buildInfo.version, BuildInfo.OS,
9696
BuildInfo.OS_VERSION, BuildInfo.OS_ARCH, BuildInfo.JAVA_VERSION);
9797
// Steps to reproduce
9898
String howToReproduce = "Steps to reproduce:\n\n1. ...\n2. ...\n3. ...";

‎src/main/java/org/jabref/gui/help/AboutDialogViewModel.java

+5-5
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ public class AboutDialogViewModel extends AbstractViewModel {
4343
public AboutDialogViewModel(DialogService dialogService, ClipBoardManager clipBoardManager, BuildInfo buildInfo) {
4444
this.dialogService = Objects.requireNonNull(dialogService);
4545
this.clipBoardManager = Objects.requireNonNull(clipBoardManager);
46-
String[] version = buildInfo.getVersion().getFullVersion().split("--");
46+
String[] version = buildInfo.version.getFullVersion().split("--");
4747
heading.set("JabRef " + version[0]);
4848

4949
if (version.length == 1) {
@@ -54,11 +54,11 @@ public AboutDialogViewModel(DialogService dialogService, ClipBoardManager clipBo
5454
Collectors.joining("--"));
5555
developmentVersion.set(dev);
5656
}
57-
developers.set(buildInfo.getDevelopers());
58-
authors.set(buildInfo.getAuthors());
57+
developers.set(buildInfo.developers);
58+
authors.set(buildInfo.authors);
5959
license.set(Localization.lang("License") + ":");
60-
changelogUrl = buildInfo.getVersion().getChangelogUrl();
61-
versionInfo = String.format("JabRef %s%n%s %s %s %nJava %s", buildInfo.getVersion(), BuildInfo.OS,
60+
changelogUrl = buildInfo.version.getChangelogUrl();
61+
versionInfo = String.format("JabRef %s%n%s %s %s %nJava %s", buildInfo.version, BuildInfo.OS,
6262
BuildInfo.OS_VERSION, BuildInfo.OS_ARCH, BuildInfo.JAVA_VERSION);
6363
}
6464

‎src/main/java/org/jabref/gui/help/SearchForUpdateAction.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ public SearchForUpdateAction(BuildInfo buildInfo, VersionPreferences versionPref
2222

2323
@Override
2424
public void execute() {
25-
new VersionWorker(buildInfo.getVersion(), versionPreferences.getIgnoredVersion(), dialogService, taskExecutor)
25+
new VersionWorker(buildInfo.version, versionPreferences.getIgnoredVersion(), dialogService, taskExecutor)
2626
.checkForNewVersionAsync();
2727
}
2828
}

‎src/main/java/org/jabref/logic/importer/fetcher/SpringerFetcher.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
import org.jabref.logic.importer.FetcherException;
1515
import org.jabref.logic.importer.Parser;
1616
import org.jabref.logic.importer.SearchBasedParserFetcher;
17+
import org.jabref.logic.util.BuildInfo;
1718
import org.jabref.logic.util.OS;
1819
import org.jabref.model.entry.BibEntry;
1920
import org.jabref.model.entry.LinkedFile;
@@ -38,7 +39,7 @@ public class SpringerFetcher implements SearchBasedParserFetcher {
3839
private static final Logger LOGGER = LoggerFactory.getLogger(SpringerFetcher.class);
3940

4041
private static final String API_URL = "http://api.springernature.com/meta/v1/json";
41-
private static final String API_KEY = "a98b4a55181ffcd27259bea45edad12e";
42+
private static final String API_KEY = new BuildInfo().springerNatureAPIKey;
4243

4344
/**
4445
* Convert a JSONObject obtained from http://api.springer.com/metadata/json to a BibEntry

‎src/main/java/org/jabref/logic/util/BuildInfo.java

+10-37
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
import java.util.Locale;
88
import java.util.Properties;
99

10-
public class BuildInfo {
10+
public final class BuildInfo {
1111

1212
public static final String UNKNOWN_VERSION = "*unknown*";
1313

@@ -16,14 +16,14 @@ public class BuildInfo {
1616
public static final String OS_ARCH = System.getProperty("os.arch", UNKNOWN_VERSION).toLowerCase(Locale.ROOT);
1717
public static final String JAVA_VERSION = System.getProperty("java.version", UNKNOWN_VERSION).toLowerCase(Locale.ROOT);
1818

19-
private final Version version;
20-
private final String authors;
21-
private final String developers;
22-
private final String year;
23-
private final String azureInstrumentationKey;
24-
private final String minRequiredJavaVersion;
25-
private final boolean allowJava9;
26-
19+
public final Version version;
20+
public final String authors;
21+
public final String developers;
22+
public final String year;
23+
public final String azureInstrumentationKey;
24+
public final String springerNatureAPIKey;
25+
public final String minRequiredJavaVersion;
26+
public final boolean allowJava9;
2727

2828
public BuildInfo() {
2929
this("/build.properties");
@@ -47,35 +47,8 @@ public BuildInfo(String path) {
4747
year = properties.getProperty("year", "");
4848
developers = properties.getProperty("developers", "");
4949
azureInstrumentationKey = properties.getProperty("azureInstrumentationKey", "");
50+
springerNatureAPIKey = properties.getProperty("springerNatureAPIKey", "");
5051
minRequiredJavaVersion = properties.getProperty("minRequiredJavaVersion", "1.8");
5152
allowJava9 = "true".equals(properties.getProperty("allowJava9", ""));
5253
}
53-
54-
public Version getVersion() {
55-
return version;
56-
}
57-
58-
public String getAuthors() {
59-
return authors;
60-
}
61-
62-
public String getDevelopers() {
63-
return developers;
64-
}
65-
66-
public String getYear() {
67-
return year;
68-
}
69-
70-
public String getAzureInstrumentationKey() {
71-
return azureInstrumentationKey;
72-
}
73-
74-
public String getMinRequiredJavaVersion() {
75-
return minRequiredJavaVersion;
76-
}
77-
78-
public boolean isAllowJava9() {
79-
return allowJava9;
80-
}
8154
}

‎src/main/resources/build.properties

+1
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,6 @@ year=${year}
33
authors=${authors}
44
developers=${developers}
55
azureInstrumentationKey=${azureInstrumentationKey}
6+
springerNatureAPIKey=${springerNatureAPIKey}
67
minRequiredJavaVersion = ${minRequiredJavaVersion}
78
allowJava9 = ${allowJava9}

‎src/test/java/org/jabref/logic/util/BuildInfoTest.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,19 @@ public class BuildInfoTest {
1111
@Test
1212
public void testDefaults() {
1313
BuildInfo buildInfo = new BuildInfo("asdf");
14-
assertEquals("*unknown*", buildInfo.getVersion().getFullVersion());
14+
assertEquals("*unknown*", buildInfo.version.getFullVersion());
1515
}
1616

1717
@Test
1818
public void testFileImport() {
1919
BuildInfo buildInfo = new BuildInfo("/org/jabref/util/build.properties");
20-
assertEquals("42", buildInfo.getVersion().getFullVersion());
20+
assertEquals("42", buildInfo.version.getFullVersion());
2121
}
2222

2323
@Test
2424
public void azureInstrumentationKeyIsNotEmpty() {
2525
BuildInfo buildInfo = new BuildInfo();
26-
assertNotNull(buildInfo.getAzureInstrumentationKey());
27-
assertNotEquals("", buildInfo.getAzureInstrumentationKey());
26+
assertNotNull(buildInfo.azureInstrumentationKey);
27+
assertNotEquals("", buildInfo.azureInstrumentationKey);
2828
}
2929
}

0 commit comments

Comments
 (0)