-
Notifications
You must be signed in to change notification settings - Fork 40.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve Docker API 5xx error messages
This commit improves the error messages returned by the Spring Boot build plugins when a 5xx status code is returned from the Docker API while attempting to build an image. If the error response has contents containing a JSON structure with a "message" key, the value associated with that key will be included in the exception message and in the build plugin output error. Fixes gh-21515
- Loading branch information
1 parent
1486ce5
commit 2925326
Showing
7 changed files
with
202 additions
and
25 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
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
50 changes: 50 additions & 0 deletions
50
...m/src/main/java/org/springframework/boot/buildpack/platform/docker/transport/Message.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,50 @@ | ||
/* | ||
* 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.buildpack.platform.docker.transport; | ||
|
||
import com.fasterxml.jackson.annotation.JsonCreator; | ||
import com.fasterxml.jackson.annotation.JsonProperty; | ||
|
||
/** | ||
* A message returned from the Docker API. | ||
* | ||
* @author Scott Frederick | ||
* @since 2.3.1 | ||
*/ | ||
public class Message { | ||
|
||
private final String message; | ||
|
||
@JsonCreator | ||
Message(@JsonProperty("message") String message) { | ||
this.message = message; | ||
} | ||
|
||
/** | ||
* Return the message contained in the response. | ||
* @return the message | ||
*/ | ||
public String getMessage() { | ||
return this.message; | ||
} | ||
|
||
@Override | ||
public String toString() { | ||
return this.message; | ||
} | ||
|
||
} |
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
44 changes: 44 additions & 0 deletions
44
.../test/java/org/springframework/boot/buildpack/platform/docker/transport/MessageTests.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,44 @@ | ||
/* | ||
* 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.buildpack.platform.docker.transport; | ||
|
||
import org.junit.jupiter.api.Test; | ||
|
||
import org.springframework.boot.buildpack.platform.json.AbstractJsonTests; | ||
|
||
import static org.assertj.core.api.Assertions.assertThat; | ||
|
||
/** | ||
* Tests for {@link Message}. | ||
* | ||
* @author Scott Frederick | ||
*/ | ||
class MessageTests extends AbstractJsonTests { | ||
|
||
@Test | ||
void readValueDeserializesJson() throws Exception { | ||
Message message = getObjectMapper().readValue(getContent("message.json"), Message.class); | ||
assertThat(message.getMessage()).isEqualTo("test message"); | ||
} | ||
|
||
@Test | ||
void toStringHasErrorDetails() throws Exception { | ||
Message errors = getObjectMapper().readValue(getContent("message.json"), Message.class); | ||
assertThat(errors.toString()).isEqualTo("test message"); | ||
} | ||
|
||
} |
3 changes: 3 additions & 0 deletions
3
.../test/resources/org/springframework/boot/buildpack/platform/docker/transport/message.json
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,3 @@ | ||
{ | ||
"message": "test message" | ||
} |