// License: GPL. For details, see LICENSE file. package org.openstreetmap.josm.tools; import static org.junit.jupiter.api.Assertions.assertEquals; import java.io.IOException; import java.net.HttpURLConnection; import java.net.SocketException; import java.net.URL; import java.net.UnknownHostException; import java.util.TimeZone; import java.util.function.Supplier; import java.util.stream.Stream; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.Arguments; import org.junit.jupiter.params.provider.MethodSource; import org.openstreetmap.josm.io.ChangesetClosedException; import org.openstreetmap.josm.io.IllegalDataException; import org.openstreetmap.josm.io.MissingOAuthAccessTokenException; import org.openstreetmap.josm.io.OfflineAccessException; import org.openstreetmap.josm.io.OsmApi; import org.openstreetmap.josm.io.OsmApiException; import org.openstreetmap.josm.io.OsmApiInitializationException; import org.openstreetmap.josm.io.auth.CredentialsManager; import org.openstreetmap.josm.testutils.annotations.BasicPreferences; import org.openstreetmap.josm.tools.date.DateUtils; import org.openstreetmap.josm.tools.date.DateUtilsTest; /** * Unit tests of {@link ExceptionUtil} class. */ @BasicPreferences @org.openstreetmap.josm.testutils.annotations.OsmApi(org.openstreetmap.josm.testutils.annotations.OsmApi.APIType.FAKE) class ExceptionUtilTest { private static String baseUrl; private static String serverUrl; private static String host; private static String user; /** * Setup test. * @throws Exception in case of error */ @BeforeEach public void setUp() throws Exception { OsmApi api = OsmApi.getOsmApi(); baseUrl = api.getBaseUrl(); serverUrl = api.getServerUrl(); host = new URL(serverUrl).getHost(); user = CredentialsManager.getInstance().getUsername(); DateUtils.PROP_ISO_DATES.put(Boolean.TRUE); } static Stream testExplainBadRequest() { return Stream.of( Arguments.of((Supplier) () -> "The OSM server '"+baseUrl+"' reported a bad request.
", new OsmApiException("")), Arguments.of((Supplier) () -> "The OSM server '"+baseUrl+"' reported a bad request.

"+ "Error message(untranslated): header", new OsmApiException(HttpURLConnection.HTTP_BAD_REQUEST, "header", "")), Arguments.of((Supplier) () -> "The OSM server '"+baseUrl+"' reported a bad request.

"+ "Error message(untranslated): header", new OsmApiException(HttpURLConnection.HTTP_BAD_REQUEST, "header", "", "invalid_url")), Arguments.of((Supplier) () -> "The OSM server '"+host+"' reported a bad request.

"+ "Error message(untranslated): header", (Supplier) () -> new OsmApiException(HttpURLConnection.HTTP_BAD_REQUEST, "header", "", baseUrl)), Arguments.of((Supplier) () -> "The OSM server '"+baseUrl+"' reported a bad request.

"+ "The area you tried to download is too big or your request was too large.
"+ "Either request a smaller area or use an export file provided by the OSM community." + "

Downloading a smaller area is recommended!" + "

Advanced users can use one of the following options:
", new OsmApiException(HttpURLConnection.HTTP_BAD_REQUEST, "The maximum bbox", "")), Arguments.of((Supplier) () -> "The OSM server '"+baseUrl+"' reported a bad request.

"+ "The area you tried to download is too big or your request was too large.
"+ "Either request a smaller area or use an export file provided by the OSM community." + "

Downloading a smaller area is recommended!" + "

Advanced users can use one of the following options:
", new OsmApiException(HttpURLConnection.HTTP_BAD_REQUEST, "You requested too many nodes", "")) ); } /** * Test of {@link ExceptionUtil#explainBadRequest} method. */ @ParameterizedTest(name = "{1}") @MethodSource @SuppressWarnings("unchecked") void testExplainBadRequest(Supplier message, Object exception) { assertEquals(message.get(), ExceptionUtil.explainBadRequest( exception instanceof Supplier ? ((Supplier) exception).get() : (OsmApiException) exception )); } /** * Test of {@link ExceptionUtil#explainBandwidthLimitExceeded} method. */ @Test void testExplainBandwidthLimitExceeded() { assertEquals("Communication with the OSM server '"+baseUrl+"'failed. "+ "The server replied
the following error code and the following error message:
"+ "Error code: 0
Error message (untranslated): no error message available", ExceptionUtil.explainBandwidthLimitExceeded(new OsmApiException(""))); } /** * Test of {@link ExceptionUtil#explainChangesetClosedException} method. */ @Test void testExplainChangesetClosedException() { assertEquals("Failed to upload to changeset 0
because it has already been closed on ?.", ExceptionUtil.explainChangesetClosedException(new ChangesetClosedException(""))); assertEquals("Failed to upload to changeset 1
because it has already been closed on 2016-01-01 00:00:00.", ExceptionUtil.explainChangesetClosedException(new ChangesetClosedException(1, DateUtils.parseInstant("2016-01-01"), null))); } /** * Test of {@link ExceptionUtil#explainClientTimeout} method. */ @Test void testExplainClientTimeout() { assertEquals("Communication with the OSM server '"+baseUrl+"' timed out. Please retry later.", ExceptionUtil.explainClientTimeout(new OsmApiException(""))); } /** * Test of {@link ExceptionUtil#explainConflict} method. */ @Test void testExplainConflict() { int code = HttpURLConnection.HTTP_CONFLICT; assertEquals("The server reported that it has detected a conflict.", ExceptionUtil.explainConflict(new OsmApiException(""))); assertEquals("The server reported that it has detected a conflict.
Error message (untranslated):
header", ExceptionUtil.explainConflict(new OsmApiException(code, "header", ""))); assertEquals("Closing of changeset 1 failed
because it has already been closed.", ExceptionUtil.explainConflict(new OsmApiException(code, "The changeset 1 was closed at xxx", ""))); assertEquals("Closing of changeset 1 failed
because it has already been closed on 2016-01-01 12:34:56.", ExceptionUtil.explainConflict(new OsmApiException(code, "The changeset 1 was closed at 2016-01-01 12:34:56 UTC", ""))); DateUtilsTest.setTimeZone(TimeZone.getTimeZone("Europe/Berlin")); TimeZone.setDefault(TimeZone.getTimeZone("Europe/Berlin")); assertEquals("Closing of changeset 1 failed
because it has already been closed on 2016-01-01 13:34:56.", ExceptionUtil.explainConflict(new OsmApiException(code, "The changeset 1 was closed at 2016-01-01 12:34:56 UTC", ""))); } /** * Test of {@link ExceptionUtil#explainException} method. */ @Test void testExplainException() { assertEquals("ResponseCode=0", ExceptionUtil.explainException(new OsmApiException(""))); assertEquals("java.lang.Exception: ", ExceptionUtil.explainException(new Exception(""))); assertEquals("java.lang.Exception", ExceptionUtil.explainException(new Exception(null, null))); assertEquals("test", ExceptionUtil.explainException(new Exception("test"))); } /** * Test of {@link ExceptionUtil#explainFailedAuthorisation} method. */ @Test void testExplainFailedAuthorisation() { assertEquals("Authorisation at the OSM server failed.
The server reported the following error:
"+ "'The server replied an error with code 0.'", ExceptionUtil.explainFailedAuthorisation(new OsmApiException(""))); assertEquals("Authorisation at the OSM server failed.
The server reported the following error:
"+ "'header (Code=403)'", ExceptionUtil.explainFailedAuthorisation(new OsmApiException(HttpURLConnection.HTTP_FORBIDDEN, "header", null))); assertEquals("Authorisation at the OSM server failed.
The server reported the following error:"+ "
'header. body (Code=403)'", ExceptionUtil.explainFailedAuthorisation(new OsmApiException(HttpURLConnection.HTTP_FORBIDDEN, "header", "body"))); assertEquals("Authorisation at the OSM server failed.
The server reported the following error:"+ "
'header_body (Code=403)'", ExceptionUtil.explainFailedAuthorisation(new OsmApiException(HttpURLConnection.HTTP_FORBIDDEN, "header_body", "header_body"))); assertEquals("Authorisation at the OSM server failed.
The server reported the following error:
"+ "'body (Code=403)'", ExceptionUtil.explainFailedAuthorisation(new OsmApiException(HttpURLConnection.HTTP_FORBIDDEN, null, "body"))); } /** * Test of {@link ExceptionUtil#explainFailedOAuthAuthorisation} method. */ @Test void testExplainFailedOAuthAuthorisation() { assertEquals("Authorisation at the OSM server with the OAuth token 'null' failed.
"+ "The token is not authorised to access the protected resource
'unknown'.
"+ "Please launch the preferences dialog and retrieve another OAuth token.", ExceptionUtil.explainFailedOAuthAuthorisation(new OsmApiException(""))); assertEquals("Authorisation at the OSM server with the OAuth token 'null' failed.
"+ "The token is not authorised to access the protected resource
'"+baseUrl+"'.
"+ "Please launch the preferences dialog and retrieve another OAuth token.", ExceptionUtil.explainFailedOAuthAuthorisation(new OsmApiException(HttpURLConnection.HTTP_FORBIDDEN, "", "", baseUrl))); } /** * Test of {@link ExceptionUtil#explainFailedBasicAuthentication} method. */ @Test void testExplainFailedBasicAuthentication() { assertEquals("Authentication at the OSM server with the username '"+user+"' failed.
"+ "Please check the username and the password in the JOSM preferences.", ExceptionUtil.explainFailedBasicAuthentication(new OsmApiException(""))); } /** * Test of {@link ExceptionUtil#explainFailedOAuthAuthentication} method. */ @Test void testExplainFailedOAuthAuthentication() { assertEquals("Authentication at the OSM server with the OAuth token 'null' failed.
"+ "Please launch the preferences dialog and retrieve another OAuth token.", ExceptionUtil.explainFailedOAuthAuthentication(new OsmApiException(""))); } /** * Test of {@link ExceptionUtil#explainGenericOsmApiException} method. */ @Test void testExplainGenericOsmApiException() { assertEquals("Communication with the OSM server '"+baseUrl+"'failed. The server replied
"+ "the following error code and the following error message:
Error code: 0
"+ "Error message (untranslated): no error message available", ExceptionUtil.explainGenericOsmApiException(new OsmApiException(""))); assertEquals("Communication with the OSM server '"+baseUrl+"'failed. The server replied
"+ "the following error code and the following error message:
Error code: 500
"+ "Error message (untranslated): header", ExceptionUtil.explainGenericOsmApiException(new OsmApiException(HttpURLConnection.HTTP_INTERNAL_ERROR, "header", null))); assertEquals("Communication with the OSM server '"+baseUrl+"'failed. The server replied
"+ "the following error code and the following error message:
Error code: 500
"+ "Error message (untranslated): body", ExceptionUtil.explainGenericOsmApiException(new OsmApiException(HttpURLConnection.HTTP_INTERNAL_ERROR, null, "body"))); } /** * Test of {@link ExceptionUtil#explainGoneForUnknownPrimitive} method. */ @Test void testExplainGoneForUnknownPrimitive() { assertEquals("The server reports that an object is deleted.
"+ "Uploading failed if you tried to update or delete this object.
"+ "Downloading failed if you tried to download this object.

"+ "The error message is:
ResponseCode=0", ExceptionUtil.explainGoneForUnknownPrimitive(new OsmApiException(""))); } /** * Test of {@link ExceptionUtil#explainInternalServerError} method. */ @Test void testExplainInternalServerError() { assertEquals("The OSM server
'"+baseUrl+"'
reported an internal server error.
"+ "This is most likely a temporary problem. Please try again later.", ExceptionUtil.explainInternalServerError(new OsmApiException(""))); } /** * Test of {@link ExceptionUtil#explainMissingOAuthAccessTokenException} method. */ @Test void testExplainMissingOAuthAccessTokenException() { assertEquals("Failed to authenticate at the OSM server 'http://fake.xxx/api'.
"+ "You are using OAuth to authenticate but currently there is no
OAuth Access Token configured.
"+ "Please open the Preferences Dialog and generate or enter an Access Token.", ExceptionUtil.explainMissingOAuthAccessTokenException(new MissingOAuthAccessTokenException())); } /** * Test of {@link ExceptionUtil#explainNestedIllegalDataException} method. */ @Test void testExplainNestedIllegalDataException() { assertEquals("Failed to download data. Its format is either unsupported, ill-formed, and/or inconsistent.

"+ "Details (untranslated): null", ExceptionUtil.explainNestedIllegalDataException(new OsmApiException(""))); assertEquals("Failed to download data. Its format is either unsupported, ill-formed, and/or inconsistent.

"+ "Details (untranslated): test", ExceptionUtil.explainNestedIllegalDataException(new OsmApiException(new IllegalDataException("test")))); } /** * Test of {@link ExceptionUtil#explainNestedIOException} method. */ @Test void testExplainNestedIOException() { assertEquals("Failed to upload data to or download data from
'"+baseUrl+"'
"+ "due to a problem with transferring data.
Details (untranslated): null", ExceptionUtil.explainNestedIOException(new OsmApiException(""))); assertEquals("Failed to upload data to or download data from
'"+baseUrl+"'
"+ "due to a problem with transferring data.
Details (untranslated): test", ExceptionUtil.explainNestedIOException(new OsmApiException(new IOException("test")))); } /** * Test of {@link ExceptionUtil#explainNestedSocketException} method. */ @Test void testExplainNestedSocketException() { assertEquals("Failed to open a connection to the remote server
'"+baseUrl+"'.
"+ "Please check your internet connection.", ExceptionUtil.explainNestedSocketException(new OsmApiException(""))); } /** * Test of {@link ExceptionUtil#explainNestedUnknownHostException} method. */ @Test void testExplainNestedUnknownHostException() { assertEquals("Failed to open a connection to the remote server
'"+baseUrl+"'.
"+ "Host name '"+host+"' could not be resolved.
"+ "Please check the API URL in your preferences and your internet connection.", ExceptionUtil.explainNestedUnknownHostException(new OsmApiException(""))); } /** * Test of {@link ExceptionUtil#explainNotFound} method. */ @Test void testExplainNotFound() { assertEquals("The OSM server '"+baseUrl+"' does not know about an object
"+ "you tried to read, update, or delete. Either the respective object
"+ "does not exist on the server or you are using an invalid URL to access
"+ "it. Please carefully check the server's address '"+baseUrl+"' for typos.", ExceptionUtil.explainNotFound(new OsmApiException(""))); } /** * Test of {@link ExceptionUtil#explainOfflineAccessException} method. */ @Test void testExplainOfflineAccessException() { assertEquals("Failed to download data.

Details: null", ExceptionUtil.explainOfflineAccessException(new OsmApiException(""))); assertEquals("Failed to download data.

Details: test", ExceptionUtil.explainOfflineAccessException(new OsmApiException(new OfflineAccessException("test")))); } /** * Test of {@link ExceptionUtil#explainOsmApiInitializationException} method. */ @Test void testExplainOsmApiInitializationException() { assertEquals("Failed to initialize communication with the OSM server "+serverUrl+".
"+ "Check the server URL in your preferences and your internet connection.", ExceptionUtil.explainOsmApiInitializationException(new OsmApiInitializationException(""))); } /** * Test of {@link ExceptionUtil#explainOsmTransferException} method. */ @Test void testExplainOsmTransferException() { assertEquals("Failed to open a connection to the remote server
'"+baseUrl+"'
"+ "for security reasons. This is most likely because you are running
"+ "in an applet and because you did not load your applet from '"+host+"'.", ExceptionUtil.explainOsmTransferException(new OsmApiException(new SecurityException("test")))); assertEquals("Failed to open a connection to the remote server
'"+baseUrl+"'.
"+ "Please check your internet connection.", ExceptionUtil.explainOsmTransferException(new OsmApiException(new SocketException("test")))); assertEquals("Failed to open a connection to the remote server
'"+baseUrl+"'.
"+ "Host name '"+host+"' could not be resolved.
"+ "Please check the API URL in your preferences and your internet connection.", ExceptionUtil.explainOsmTransferException(new OsmApiException(new UnknownHostException("test")))); assertEquals("Failed to upload data to or download data from
'"+baseUrl+"'
"+ "due to a problem with transferring data.
Details (untranslated): test", ExceptionUtil.explainOsmTransferException(new OsmApiException(new IOException("test")))); assertEquals("Failed to initialize communication with the OSM server "+serverUrl+".
"+ "Check the server URL in your preferences and your internet connection.", ExceptionUtil.explainOsmTransferException(new OsmApiInitializationException(""))); assertEquals("Failed to upload to changeset 0
because it has already been closed on ?.", ExceptionUtil.explainOsmTransferException(new ChangesetClosedException(""))); assertEquals("Uploading to the server failed because your current
"+ "dataset violates a precondition.
The error message is:
ResponseCode=412", ExceptionUtil.explainOsmTransferException(new OsmApiException(HttpURLConnection.HTTP_PRECON_FAILED, "", ""))); assertEquals("The server reports that an object is deleted.
"+ "Uploading failed if you tried to update or delete this object.
"+ "Downloading failed if you tried to download this object.

"+ "The error message is:
ResponseCode=410", ExceptionUtil.explainOsmTransferException(new OsmApiException(HttpURLConnection.HTTP_GONE, "", ""))); assertEquals("The OSM server
'"+baseUrl+"'
reported an internal server error.
"+ "This is most likely a temporary problem. Please try again later.", ExceptionUtil.explainOsmTransferException(new OsmApiException(HttpURLConnection.HTTP_INTERNAL_ERROR, "", ""))); assertEquals("The OSM server '"+baseUrl+"' reported a bad request.

Error message(untranslated): ", ExceptionUtil.explainOsmTransferException(new OsmApiException(HttpURLConnection.HTTP_BAD_REQUEST, "", ""))); assertEquals("Communication with the OSM server '"+baseUrl+"'failed. The server replied
"+ "the following error code and the following error message:
Error code: 509
"+ "Error message (untranslated): ", ExceptionUtil.explainOsmTransferException(new OsmApiException(509, "", ""))); assertEquals("ResponseCode=0", ExceptionUtil.explainOsmTransferException(new OsmApiException(""))); } /** * Test of {@link ExceptionUtil#explainPreconditionFailed} method. */ @Test void testExplainPreconditionFailed() { int code = HttpURLConnection.HTTP_PRECON_FAILED; assertEquals("Uploading to the server failed because your current
dataset violates a precondition.
"+ "The error message is:
ResponseCode=0", ExceptionUtil.explainPreconditionFailed(new OsmApiException(""))); assertEquals("Uploading to the server failed because your current
dataset violates a precondition.
"+ "The error message is:
ResponseCode=412, Error Header=<test>", ExceptionUtil.explainPreconditionFailed(new OsmApiException(code, "test", ""))); assertEquals("Failed to delete node 1. It is still referred to by relation 1.
"+ "Please load the relation, remove the reference to the node, and upload again.", ExceptionUtil.explainPreconditionFailed(new OsmApiException(code, "Node 1 is still used by relation 1", ""))); assertEquals("Failed to delete node 1. It is still referred to by way 1.
"+ "Please load the way, remove the reference to the node, and upload again.", ExceptionUtil.explainPreconditionFailed(new OsmApiException(code, "Node 1 is still used by way 1", ""))); assertEquals("Failed to delete relation 1. It is still referred to by relation 2.
"+ "Please load the relation, remove the reference to the relation, and upload again.", ExceptionUtil.explainPreconditionFailed(new OsmApiException(code, "The relation 1 is used in relation 2", ""))); assertEquals("Failed to delete way 1. It is still referred to by relation 1.
"+ "Please load the relation, remove the reference to the way, and upload again.", ExceptionUtil.explainPreconditionFailed(new OsmApiException(code, "Way 1 is still used by relation 1", ""))); assertEquals("Failed to upload way 1. It refers to deleted nodes [1, 2].
"+ "Please load the nodes, remove the reference in the way, and upload again.", ExceptionUtil.explainPreconditionFailed(new OsmApiException(code, "Way 1 requires the nodes with id in 1,2", ""))); } }