Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This commit improves the validation of URLs provided in the property 'spring.redis.url' used to auto-configure a Spring Data Redis connection. In particular, only the URL schemes 'redis://' and 'rediss://' are allowed, and any other scheme will result in a configuration error. A failure analyzer is also provided to improve diagnostics for common mis-configurations detected by this validation. Fixes gh-21999
- Loading branch information
1 parent
d84aeef
commit 1e2176b
Showing
6 changed files
with
204 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
46 changes: 46 additions & 0 deletions
46
.../main/java/org/springframework/boot/autoconfigure/data/redis/RedisUrlSyntaxException.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
/* | ||
* Copyright 2012-2020 the original author or authors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* https://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package org.springframework.boot.autoconfigure.data.redis; | ||
|
||
/** | ||
* Exception thrown when a Redis URL is malformed or invalid. | ||
* | ||
* @author Scott Frederick | ||
*/ | ||
class RedisUrlSyntaxException extends RuntimeException { | ||
|
||
private final String url; | ||
|
||
RedisUrlSyntaxException(String url, Exception cause) { | ||
super(buildMessage(url), cause); | ||
this.url = url; | ||
} | ||
|
||
RedisUrlSyntaxException(String url) { | ||
super(buildMessage(url)); | ||
this.url = url; | ||
} | ||
|
||
String getUrl() { | ||
return this.url; | ||
} | ||
|
||
private static String buildMessage(String url) { | ||
return "Invalid Redis URL '" + url + "'"; | ||
} | ||
|
||
} |
68 changes: 68 additions & 0 deletions
68
...java/org/springframework/boot/autoconfigure/data/redis/RedisUrlSyntaxFailureAnalyzer.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
/* | ||
* Copyright 2012-2020 the original author or authors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* https://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package org.springframework.boot.autoconfigure.data.redis; | ||
|
||
import java.net.URI; | ||
import java.net.URISyntaxException; | ||
|
||
import org.springframework.boot.diagnostics.AbstractFailureAnalyzer; | ||
import org.springframework.boot.diagnostics.FailureAnalysis; | ||
|
||
/** | ||
* A {@code FailureAnalyzer} that performs analysis of failures caused by a | ||
* {@link RedisUrlSyntaxException}. | ||
* | ||
* @author Scott Frederick | ||
*/ | ||
class RedisUrlSyntaxFailureAnalyzer extends AbstractFailureAnalyzer<RedisUrlSyntaxException> { | ||
|
||
@Override | ||
protected FailureAnalysis analyze(Throwable rootFailure, RedisUrlSyntaxException cause) { | ||
try { | ||
URI uri = new URI(cause.getUrl()); | ||
if ("redis-sentinel".equals(uri.getScheme())) { | ||
return new FailureAnalysis(getUnsupportedSchemeDescription(cause.getUrl(), uri.getScheme()), | ||
"Use spring.redis.sentinel properties instead of spring.redis.url to configure Redis sentinel addresses.", | ||
cause); | ||
} | ||
if ("redis-socket".equals(uri.getScheme())) { | ||
return new FailureAnalysis(getUnsupportedSchemeDescription(cause.getUrl(), uri.getScheme()), | ||
"Configure the appropriate Spring Data Redis connection beans directly instead of setting the property 'spring.redis.url'.", | ||
cause); | ||
} | ||
if (!"redis".equals(uri.getScheme()) && !"rediss".equals(uri.getScheme())) { | ||
return new FailureAnalysis(getUnsupportedSchemeDescription(cause.getUrl(), uri.getScheme()), | ||
"Use the scheme 'redis://` for insecure or `rediss://` for secure Redis standalone configuration.", | ||
cause); | ||
} | ||
} | ||
catch (URISyntaxException ex) { | ||
// fall through to default description and action | ||
} | ||
return new FailureAnalysis(getDefaultDescription(cause.getUrl()), | ||
"Review the value of the property 'spring.redis.url'.", cause); | ||
} | ||
|
||
private String getDefaultDescription(String url) { | ||
return "The URL '" + url + "' is not valid for configuring Spring Data Redis. "; | ||
} | ||
|
||
private String getUnsupportedSchemeDescription(String url, String scheme) { | ||
return getDefaultDescription(url) + "The scheme '" + scheme + "' is not supported."; | ||
} | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
69 changes: 69 additions & 0 deletions
69
...org/springframework/boot/autoconfigure/data/redis/RedisUrlSyntaxFailureAnalyzerTests.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
/* | ||
* Copyright 2012-2020 the original author or authors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* https://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package org.springframework.boot.autoconfigure.data.redis; | ||
|
||
import org.junit.jupiter.api.Test; | ||
|
||
import org.springframework.boot.diagnostics.FailureAnalysis; | ||
|
||
import static org.assertj.core.api.Assertions.assertThat; | ||
|
||
/** | ||
* Tests for {@link RedisUrlSyntaxFailureAnalyzer}. | ||
* | ||
* @author Scott Frederick | ||
*/ | ||
class RedisUrlSyntaxFailureAnalyzerTests { | ||
|
||
@Test | ||
void analyzeInvalidUrlSyntax() { | ||
RedisUrlSyntaxException exception = new RedisUrlSyntaxException("redis://invalid"); | ||
FailureAnalysis analysis = new RedisUrlSyntaxFailureAnalyzer().analyze(exception); | ||
assertThat(analysis.getDescription()).contains("The URL 'redis://invalid' is not valid"); | ||
assertThat(analysis.getAction()).contains("Review the value of the property 'spring.redis.url'"); | ||
} | ||
|
||
@Test | ||
void analyzeRedisHttpUrl() { | ||
RedisUrlSyntaxException exception = new RedisUrlSyntaxException("http://127.0.0.1:26379/mymaster"); | ||
FailureAnalysis analysis = new RedisUrlSyntaxFailureAnalyzer().analyze(exception); | ||
assertThat(analysis.getDescription()).contains("The URL 'http://127.0.0.1:26379/mymaster' is not valid") | ||
.contains("The scheme 'http' is not supported"); | ||
assertThat(analysis.getAction()).contains("Use the scheme 'redis://` for insecure or `rediss://` for secure"); | ||
} | ||
|
||
@Test | ||
void analyzeRedisSentinelUrl() { | ||
RedisUrlSyntaxException exception = new RedisUrlSyntaxException( | ||
"redis-sentinel://username:password@127.0.0.1:26379,127.0.0.1:26380/mymaster"); | ||
FailureAnalysis analysis = new RedisUrlSyntaxFailureAnalyzer().analyze(exception); | ||
assertThat(analysis.getDescription()).contains( | ||
"The URL 'redis-sentinel://username:password@127.0.0.1:26379,127.0.0.1:26380/mymaster' is not valid") | ||
.contains("The scheme 'redis-sentinel' is not supported"); | ||
assertThat(analysis.getAction()).contains("Use spring.redis.sentinel properties"); | ||
} | ||
|
||
@Test | ||
void analyzeRedisSocketUrl() { | ||
RedisUrlSyntaxException exception = new RedisUrlSyntaxException("redis-socket:///redis/redis.sock"); | ||
FailureAnalysis analysis = new RedisUrlSyntaxFailureAnalyzer().analyze(exception); | ||
assertThat(analysis.getDescription()).contains("The URL 'redis-socket:///redis/redis.sock' is not valid") | ||
.contains("The scheme 'redis-socket' is not supported"); | ||
assertThat(analysis.getAction()).contains("Configure the appropriate Spring Data Redis connection beans"); | ||
} | ||
|
||
} |