Skip to content

Commit feb9db9

Browse files
gabrielfeogabrielfeo
authored
Rename environment variables to DEVELOCITY_ (#188)
Part of #184
1 parent 9175810 commit feb9db9

File tree

8 files changed

+49
-49
lines changed

8 files changed

+49
-49
lines changed

‎library/build.gradle.kts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ tasks.named<Jar>("javadocJar") {
5252
}
5353

5454
tasks.named<Test>("integrationTest") {
55-
environment("GRADLE_ENTERPRISE_API_LOG_LEVEL", "DEBUG")
55+
environment("DEVELOCITY_API_LOG_LEVEL", "DEBUG")
5656
}
5757

5858
java {

‎library/src/main/kotlin/com/gabrielfeo/develocity/api/Config.kt‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,19 @@ data class Config(
2121
* To use different SLF4J bindings, simply exclude the logback dependency.
2222
*/
2323
val logLevel: String? =
24-
env["GRADLE_ENTERPRISE_API_LOG_LEVEL"],
24+
env["DEVELOCITY_API_LOG_LEVEL"],
2525

2626
/**
2727
* Provides the URL of a Develocity API instance REST API. By default, uses
28-
* environment variable `GRADLE_ENTERPRISE_API_URL`. Must end with `/api/`.
28+
* environment variable `DEVELOCITY_API_URL`. Must end with `/api/`.
2929
*/
3030
val apiUrl: String =
31-
env["GRADLE_ENTERPRISE_API_URL"]
32-
?: error("GRADLE_ENTERPRISE_API_URL is required"),
31+
env["DEVELOCITY_API_URL"]
32+
?: error("DEVELOCITY_API_URL is required"),
3333

3434
/**
3535
* Provides the access token for a Develocity API instance. By default, uses keychain entry
36-
* `gradle-enterprise-api-token` or environment variable `GRADLE_ENTERPRISE_API_TOKEN`.
36+
* `gradle-enterprise-api-token` or environment variable `DEVELOCITY_API_TOKEN`.
3737
*/
3838
val apiToken: () -> String = {
3939
requireEnvOrKeychainToken()
@@ -53,24 +53,24 @@ data class Config(
5353

5454
/**
5555
* Maximum amount of concurrent requests allowed. Further requests will be queued. By default,
56-
* uses environment variable `GRADLE_ENTERPRISE_API_MAX_CONCURRENT_REQUESTS` or 5 (OkHttp's
56+
* uses environment variable `DEVELOCITY_API_MAX_CONCURRENT_REQUESTS` or 5 (OkHttp's
5757
* default value of [Dispatcher.maxRequestsPerHost]).
5858
*
5959
* If set, will set [Dispatcher.maxRequests] and [Dispatcher.maxRequestsPerHost] of the
6060
* internal client, overwriting what's inherited from the base client of [clientBuilder],
6161
* if any.
6262
*/
6363
val maxConcurrentRequests: Int? =
64-
env["GRADLE_ENTERPRISE_API_MAX_CONCURRENT_REQUESTS"]?.toInt(),
64+
env["DEVELOCITY_API_MAX_CONCURRENT_REQUESTS"]?.toInt(),
6565

6666
/**
6767
* Timeout for reading an API response, used for [OkHttpClient.readTimeoutMillis].
68-
* By default, uses environment variable `GRADLE_ENTERPRISE_API_READ_TIMEOUT_MILLIS`
68+
* By default, uses environment variable `DEVELOCITY_API_READ_TIMEOUT_MILLIS`
6969
* or 60_000. Keep in mind that Develocity API responses can be big and slow to send depending on
7070
* the endpoint.
7171
*/
7272
val readTimeoutMillis: Long =
73-
env["GRADLE_ENTERPRISE_API_READ_TIMEOUT_MILLIS"]?.toLong()
73+
env["DEVELOCITY_API_READ_TIMEOUT_MILLIS"]?.toLong()
7474
?: 60_000L,
7575

7676
/**
@@ -126,30 +126,30 @@ data class Config(
126126

127127
/**
128128
* Whether caching is enabled. By default, uses environment variable
129-
* `GRADLE_ENTERPRISE_API_CACHE_ENABLED` or `false`.
129+
* `DEVELOCITY_API_CACHE_ENABLED` or `false`.
130130
*/
131131
val cacheEnabled: Boolean =
132-
env["GRADLE_ENTERPRISE_API_CACHE_ENABLED"].toBoolean(),
132+
env["DEVELOCITY_API_CACHE_ENABLED"].toBoolean(),
133133

134134
/**
135-
* HTTP cache location. By default, uses environment variable `GRADLE_ENTERPRISE_API_CACHE_DIR`
135+
* HTTP cache location. By default, uses environment variable `DEVELOCITY_API_CACHE_DIR`
136136
* or the system temporary folder (`java.io.tmpdir` / develocity-api-kotlin-cache).
137137
*/
138138
val cacheDir: File =
139-
env["GRADLE_ENTERPRISE_API_CACHE_DIR"]?.let(::File)
139+
env["DEVELOCITY_API_CACHE_DIR"]?.let(::File)
140140
?: File(systemProperties["user.home"], ".develocity-api-kotlin-cache"),
141141

142142
/**
143143
* Max size of the HTTP cache. By default, uses environment variable
144-
* `GRADLE_ENTERPRISE_API_MAX_CACHE_SIZE` or ~1 GB.
144+
* `DEVELOCITY_API_MAX_CACHE_SIZE` or ~1 GB.
145145
*/
146-
val maxCacheSize: Long = env["GRADLE_ENTERPRISE_API_MAX_CACHE_SIZE"]?.toLong()
146+
val maxCacheSize: Long = env["DEVELOCITY_API_MAX_CACHE_SIZE"]?.toLong()
147147
?: 1_000_000_000L,
148148

149149
/**
150150
* Regex pattern to match API URLs that are OK to store long-term in the HTTP cache, up to
151151
* [longTermCacheMaxAge] (1y by default, max value). By default, uses environment variable
152-
* `GRADLE_ENTERPRISE_API_LONG_TERM_CACHE_URL_PATTERN` or a pattern matching:
152+
* `DEVELOCITY_API_LONG_TERM_CACHE_URL_PATTERN` or a pattern matching:
153153
* - {host}/api/builds/{id}/gradle-attributes
154154
* - {host}/api/builds/{id}/maven-attributes
155155
* - {host}/api/builds/{id}/gradle-build-cache-performance
@@ -158,7 +158,7 @@ data class Config(
158158
* Use `|` to define multiple patterns in one, e.g. `.*gradle-attributes|.*test-distribution`.
159159
*/
160160
val longTermCacheUrlPattern: Regex =
161-
env["GRADLE_ENTERPRISE_API_LONG_TERM_CACHE_URL_PATTERN"]?.toRegex()
161+
env["DEVELOCITY_API_LONG_TERM_CACHE_URL_PATTERN"]?.toRegex()
162162
?: Regex(
163163
"""
164164
.*/api/builds/[\d\w]+/(?:gradle|maven)-(?:attributes|build-cache-performance)
@@ -167,30 +167,30 @@ data class Config(
167167

168168
/**
169169
* Max age in seconds for URLs to be cached long-term (matched by [longTermCacheUrlPattern]).
170-
* By default, uses environment variable `GRADLE_ENTERPRISE_API_LONG_TERM_CACHE_MAX_AGE` or 1 year.
170+
* By default, uses environment variable `DEVELOCITY_API_LONG_TERM_CACHE_MAX_AGE` or 1 year.
171171
*/
172172
val longTermCacheMaxAge: Long =
173-
env["GRADLE_ENTERPRISE_API_SHORT_TERM_CACHE_MAX_AGE"]?.toLong()
173+
env["DEVELOCITY_API_SHORT_TERM_CACHE_MAX_AGE"]?.toLong()
174174
?: 365.days.inWholeSeconds,
175175

176176
/**
177177
* Regex pattern to match API URLs that are OK to store short-term in the HTTP cache, up to
178178
* [shortTermCacheMaxAge] (1d by default). By default, uses environment variable
179-
* `GRADLE_ENTERPRISE_API_SHORT_TERM_CACHE_URL_PATTERN` or a pattern matching:
179+
* `DEVELOCITY_API_SHORT_TERM_CACHE_URL_PATTERN` or a pattern matching:
180180
* - {host}/api/builds
181181
*
182182
* Use `|` to define multiple patterns in one, e.g. `.*gradle-attributes|.*test-distribution`.
183183
*/
184184
val shortTermCacheUrlPattern: Regex =
185-
env["GRADLE_ENTERPRISE_API_SHORT_TERM_CACHE_URL_PATTERN"]?.toRegex()
185+
env["DEVELOCITY_API_SHORT_TERM_CACHE_URL_PATTERN"]?.toRegex()
186186
?: """.*/builds(?:\?.*|\Z)""".toRegex(),
187187

188188
/**
189189
* Max age in seconds for URLs to be cached short-term (matched by [shortTermCacheUrlPattern]).
190-
* By default, uses environment variable `GRADLE_ENTERPRISE_API_SHORT_TERM_CACHE_MAX_AGE` or 1 day.
190+
* By default, uses environment variable `DEVELOCITY_API_SHORT_TERM_CACHE_MAX_AGE` or 1 day.
191191
*/
192192
val shortTermCacheMaxAge: Long =
193-
env["GRADLE_ENTERPRISE_API_SHORT_TERM_CACHE_MAX_AGE"]?.toLong()
193+
env["DEVELOCITY_API_SHORT_TERM_CACHE_MAX_AGE"]?.toLong()
194194
?: 1.days.inWholeSeconds,
195195
)
196196
}
@@ -202,6 +202,6 @@ internal fun requireEnvOrKeychainToken(): String {
202202
is KeychainResult.Error -> {}
203203
}
204204
}
205-
return env["GRADLE_ENTERPRISE_API_TOKEN"]
206-
?: error("GRADLE_ENTERPRISE_API_TOKEN is required")
205+
return env["DEVELOCITY_API_TOKEN"]
206+
?: error("DEVELOCITY_API_TOKEN is required")
207207
}

‎library/src/main/kotlin/com/gabrielfeo/develocity/api/internal/Keychain.kt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,5 +47,5 @@ internal class RealKeychain(
4747

4848
private const val KEYCHAIN_DEPRECATION_WARNING =
4949
"WARNING: passing token via macOS keychain is deprecated. Please pass it as the " +
50-
"GRADLE_ENTERPRISE_API_TOKEN environment variable instead. Keychain support will be " +
50+
"DEVELOCITY_API_TOKEN environment variable instead. Keychain support will be " +
5151
"removed in the next release. See release notes for details and alternatives."

‎library/src/test/kotlin/com/gabrielfeo/develocity/api/CacheConfigTest.kt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ class CacheConfigTest {
77

88
@BeforeTest
99
fun before() {
10-
env = FakeEnv("GRADLE_ENTERPRISE_API_URL" to "https://example.com/api/")
10+
env = FakeEnv("DEVELOCITY_API_URL" to "https://example.com/api/")
1111
systemProperties = FakeSystemProperties.macOs
1212
keychain = FakeKeychain()
1313
}

‎library/src/test/kotlin/com/gabrielfeo/develocity/api/ConfigTest.kt‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ class ConfigTest {
88

99
@BeforeTest
1010
fun before() {
11-
env = FakeEnv("GRADLE_ENTERPRISE_API_URL" to "https://example.com/api/")
11+
env = FakeEnv("DEVELOCITY_API_URL" to "https://example.com/api/")
1212
systemProperties = FakeSystemProperties.macOs
1313
keychain = FakeKeychain()
1414
}
@@ -23,26 +23,26 @@ class ConfigTest {
2323

2424
@Test
2525
fun `Given URL set in env, apiUrl is env URL`() {
26-
(env as FakeEnv)["GRADLE_ENTERPRISE_API_URL"] = "https://example.com/api/"
26+
(env as FakeEnv)["DEVELOCITY_API_URL"] = "https://example.com/api/"
2727
assertEquals("https://example.com/api/", Config().apiUrl)
2828
}
2929

3030
@Test
3131
fun `Given macOS and keychain token, keychain token used`() {
32-
(env as FakeEnv)["GRADLE_ENTERPRISE_API_TOKEN"] = "bar"
32+
(env as FakeEnv)["DEVELOCITY_API_TOKEN"] = "bar"
3333
keychain = FakeKeychain("gradle-enterprise-api-token" to "foo")
3434
assertEquals("foo", Config().apiToken())
3535
}
3636

3737
@Test
3838
fun `Given macOS but no keychain token, env token used`() {
39-
(env as FakeEnv)["GRADLE_ENTERPRISE_API_TOKEN"] = "bar"
39+
(env as FakeEnv)["DEVELOCITY_API_TOKEN"] = "bar"
4040
assertEquals("bar", Config().apiToken())
4141
}
4242

4343
@Test
4444
fun `Given Linux, keychain never tried and env token used`() {
45-
(env as FakeEnv)["GRADLE_ENTERPRISE_API_TOKEN"] = "bar"
45+
(env as FakeEnv)["DEVELOCITY_API_TOKEN"] = "bar"
4646
keychain = object : Keychain {
4747
override fun get(entry: String) =
4848
error("Error: Tried to access macOS keychain in Linux")
@@ -68,15 +68,15 @@ class ConfigTest {
6868

6969
@Test
7070
fun `maxConcurrentRequests accepts int`() {
71-
(env as FakeEnv)["GRADLE_ENTERPRISE_API_MAX_CONCURRENT_REQUESTS"] = "1"
71+
(env as FakeEnv)["DEVELOCITY_API_MAX_CONCURRENT_REQUESTS"] = "1"
7272
assertDoesNotThrow {
7373
Config().maxConcurrentRequests
7474
}
7575
}
7676

7777
@Test
7878
fun `Given timeout set in env, readTimeoutMillis returns env value`() {
79-
(env as FakeEnv)["GRADLE_ENTERPRISE_API_READ_TIMEOUT_MILLIS"] = "100000"
79+
(env as FakeEnv)["DEVELOCITY_API_READ_TIMEOUT_MILLIS"] = "100000"
8080
assertEquals(100_000L, Config().readTimeoutMillis)
8181
}
8282
}

‎library/src/test/kotlin/com/gabrielfeo/develocity/api/DevelocityApiTest.kt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ class DevelocityApiTest {
1616
val error = assertThrows<Exception> {
1717
DevelocityApi.newInstance(Config())
1818
}
19-
error.assertRootMessageContains("GRADLE_ENTERPRISE_API_URL")
19+
error.assertRootMessageContains("DEVELOCITY_API_URL")
2020
}
2121

2222
@Test
2323
fun `Fails lazily if no API token`() {
24-
env = FakeEnv("GRADLE_ENTERPRISE_API_URL" to "example-url")
24+
env = FakeEnv("DEVELOCITY_API_URL" to "example-url")
2525
keychain = FakeKeychain()
2626
systemProperties = FakeSystemProperties.linux
2727
val api = assertDoesNotThrow {
@@ -30,7 +30,7 @@ class DevelocityApiTest {
3030
val error = assertThrows<Exception> {
3131
api.buildsApi.toString()
3232
}
33-
error.assertRootMessageContains("GRADLE_ENTERPRISE_API_TOKEN")
33+
error.assertRootMessageContains("DEVELOCITY_API_TOKEN")
3434
}
3535

3636
private fun Throwable.assertRootMessageContains(text: String) {

‎library/src/test/kotlin/com/gabrielfeo/develocity/api/OkHttpClientTest.kt‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ class OkHttpClientTest {
2020
@Test
2121
fun `Given maxConcurrentRequests, sets values in Dispatcher`() {
2222
val client = buildClient(
23-
"GRADLE_ENTERPRISE_API_MAX_CONCURRENT_REQUESTS" to "123"
23+
"DEVELOCITY_API_MAX_CONCURRENT_REQUESTS" to "123"
2424
)
2525
assertEquals(123, client.dispatcher.maxRequests)
2626
assertEquals(123, client.dispatcher.maxRequestsPerHost)
@@ -42,14 +42,14 @@ class OkHttpClientTest {
4242

4343
@Test
4444
fun `Given cache enabled, configures caching`() {
45-
val client = buildClient("GRADLE_ENTERPRISE_API_CACHE_ENABLED" to "true")
45+
val client = buildClient("DEVELOCITY_API_CACHE_ENABLED" to "true")
4646
assertTrue(client.networkInterceptors.any { it is CacheEnforcingInterceptor })
4747
assertNotNull(client.cache)
4848
}
4949

5050
@Test
5151
fun `Given cache disabled, no caching or cache logging`() {
52-
val client = buildClient("GRADLE_ENTERPRISE_API_CACHE_ENABLED" to "false")
52+
val client = buildClient("DEVELOCITY_API_CACHE_ENABLED" to "false")
5353
assertTrue(client.networkInterceptors.none { it is CacheEnforcingInterceptor })
5454
assertTrue(client.interceptors.none { it is CacheHitLoggingInterceptor })
5555
assertNull(client.cache)
@@ -67,10 +67,10 @@ class OkHttpClientTest {
6767
clientBuilder: OkHttpClient.Builder? = null,
6868
): OkHttpClient {
6969
val fakeEnv = FakeEnv(*envVars)
70-
if ("GRADLE_ENTERPRISE_API_TOKEN" !in fakeEnv)
71-
fakeEnv["GRADLE_ENTERPRISE_API_TOKEN"] = "example-token"
72-
if ("GRADLE_ENTERPRISE_API_URL" !in fakeEnv)
73-
fakeEnv["GRADLE_ENTERPRISE_API_URL"] = "example-url"
70+
if ("DEVELOCITY_API_TOKEN" !in fakeEnv)
71+
fakeEnv["DEVELOCITY_API_TOKEN"] = "example-token"
72+
if ("DEVELOCITY_API_URL" !in fakeEnv)
73+
fakeEnv["DEVELOCITY_API_URL"] = "example-url"
7474
env = fakeEnv
7575
systemProperties = FakeSystemProperties.macOs
7676
keychain = FakeKeychain()

‎library/src/test/kotlin/com/gabrielfeo/develocity/api/RetrofitTest.kt‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ class RetrofitTest {
1010
@Test
1111
fun `Sets instance URL from options, stripping api segment`() {
1212
val retrofit = buildRetrofit(
13-
"GRADLE_ENTERPRISE_API_URL" to "https://example.com/api/",
13+
"DEVELOCITY_API_URL" to "https://example.com/api/",
1414
)
1515
// That's what generated classes expect
1616
assertEquals("https://example.com/", retrofit.baseUrl().toString())
@@ -20,7 +20,7 @@ class RetrofitTest {
2020
fun `Rejects invalid URL`() {
2121
assertFails {
2222
buildRetrofit(
23-
"GRADLE_ENTERPRISE_API_URL" to "https://example.com/",
23+
"DEVELOCITY_API_URL" to "https://example.com/",
2424
)
2525
}
2626
}
@@ -29,8 +29,8 @@ class RetrofitTest {
2929
vararg envVars: Pair<String, String?>,
3030
): Retrofit {
3131
val fakeEnv = FakeEnv(*envVars)
32-
if ("GRADLE_ENTERPRISE_API_TOKEN" !in fakeEnv)
33-
fakeEnv["GRADLE_ENTERPRISE_API_TOKEN"] = "example-token"
32+
if ("DEVELOCITY_API_TOKEN" !in fakeEnv)
33+
fakeEnv["DEVELOCITY_API_TOKEN"] = "example-token"
3434
env = fakeEnv
3535
systemProperties = FakeSystemProperties.macOs
3636
keychain = FakeKeychain()

0 commit comments

Comments
 (0)