Skip to content

fix: update HttpRequest#getVersion to use stable logic #919

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
chingor13 merged 1 commit into from
Dec 17, 2019
Merged

fix: update HttpRequest#getVersion to use stable logic #919

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 10 additions & 12 deletions google-http-client/src/main/java/com/google/api/client/http/HttpRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1224,19 +1224,17 @@ private static void addSpanAttribute(Span span, String key, String value) {
}

private static String getVersion() {
String version = HttpRequest.class.getPackage().getImplementationVersion();
// in a non-packaged environment (local), there's no implementation version to read
if (version == null) {
// fall back to reading from a properties file - note this value is expected to be cached
try (InputStream inputStream = HttpRequest.class.getResourceAsStream("/google-http-client.properties")) {
if (inputStream != null) {
Properties properties = new Properties();
properties.load(inputStream);
version = properties.getProperty("google-http-client.version");
}
} catch (IOException e) {
// ignore
// attempt to read the library's version from a properties file generated during the build
// this value should be read and cached for later use
String version = "unknown-version";
try (InputStream inputStream = HttpRequest.class.getResourceAsStream("/google-http-client.properties")) {
if (inputStream != null) {
final Properties properties = new Properties();
properties.load(inputStream);
version = properties.getProperty("google-http-client.version");
}
} catch (IOException e) {
// ignore
}
return version;
}
Expand Down
17 changes: 12 additions & 5 deletions google-http-client/src/test/java/com/google/api/client/http/HttpRequestTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,6 @@
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Lists;

import java.util.regex.Pattern;
import junit.framework.TestCase;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.util.Arrays;
Expand All @@ -45,7 +41,8 @@
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import java.util.logging.Level;

import java.util.regex.Pattern;
import junit.framework.TestCase;
import org.junit.Assert;

/**
Expand Down Expand Up @@ -1267,4 +1264,14 @@ public void testExecute_curlLoggerWithContentEncoding() throws Exception {
}
assertTrue(found);
}

public void testVersion_matchesAcceptablePatterns() throws Exception {
String acceptableVersionPattern =
"unknown-version|(?:\\d+\\.\\d+\\.\\d+(?:-.*?)?(?:-SNAPSHOT)?)";
String version = HttpRequest.VERSION;
assertTrue(
String.format("the loaded version '%s' did not match the acceptable pattern", version),
version.matches(acceptableVersionPattern)
);
}
}