- * Specifically, the following scenarios are covered:
- * 1) Submitting a GET request to an invalid REST endpoint 2) Submitting a GET request to a valid
- * endpoint which throws an error rather than replying successfully.
- *
- * Note that this test exercises the 'single attempt' variant of the query method. - */ - @Test - public void queryAAI_FailureTest() { - - // Create an instance of the AAIClient that uses our test version of - // the REST client builder. - RestClient testClient = new RestClient(new TestRestClientBuilder()); - - // Query our stubbed out AAI with a URL that we expecte to get a successful - // reply from. - OperationResult or = - testClient.get(getBaseURI() + INVALID_AAI_ENDPOINT, null, MediaType.APPLICATION_JSON_TYPE); - - // Validate that an attempt to query a non-existing endpoint results in - // a 404 error. - assertEquals("Unexpected result code", INVALID_END_POINT_RESULT_CODE, or.getResultCode()); - - // Validate that no payload was set since the query failed. - assertNull("Payload should not be set on 404 error", or.getResult()); - - // Now, submit a query request to the stubbed AAI. - or = testClient.get(getBaseURI() + FAIL_ALWAYS_AAI_ENDPOINT, null, - MediaType.APPLICATION_JSON_TYPE); - - // Validate that a query to a avalid returns a result code of 500. - assertEquals("Unexpected result code", INTERNAL_ERR_RESULT_CODE, or.getResultCode()); - } - - - /** - * This test validates the behaviour of querying the AAI with a number of retries requested in the - * case where we never get a successful reply. - */ - @Test - public void queryAAIWithRetries_TimeoutTest() { - - int NUM_RETRIES = 3; - - - // Create an instance of the AAIClient that uses our test version of - // the REST client builder. - RestClient testClient = new RestClient(new TestRestClientBuilder()); - - // Initialize our test endpoint to make sure that all of its - // counters have valid starting values - // AAI_FailAlways_Stub.initialize(); - - // Perform a query against the stubbed AAI, specifying a number of times - // to retry in the event of an error. - OperationResult or = testClient.get(getBaseURI() + FAIL_ALWAYS_AAI_ENDPOINT, null, - MediaType.APPLICATION_JSON_TYPE, NUM_RETRIES); - - // Validate that failing for all of our retry attempts results in a - // 504 error. - assertEquals("Unexpected result code", TIMEOUT_RESULT_CODE, or.getResultCode()); - - // Validate that our stubbed AAI actually received the expected number - // of retried requests. - assertEquals("Unexpected number of retries", NUM_RETRIES, AAI_FailAlways_Stub.getCount); - } - - - /** - * This test validates the behaviour of querying the AAI with a number of retries requested in the - * case where our query initially fails but then succeeds on one of the subsequent retries. - */ - @Test - public void queryAAIWithRetries_FailThenSucceedTest() { - - int num_retries = AAI_FailThenSucceed_Stub.MAX_FAILURES + 2; - - // Create an instance of the AAIClient that uses our test version of - // the REST client builder. - RestClient testClient = new RestClient(new TestRestClientBuilder()); - - // Initialize our test endpoint to make sure that all of its - // counters have valid starting values. - // AAI_FailThenSucceed_Stub.initialize(); - - // Perform a query against the stubbed AAI, specifying a number of times - // to retry in the event of an error. - OperationResult or = testClient.get(getBaseURI() + FAIL_THEN_SUCCEED_ENDPOINT, null, - MediaType.APPLICATION_JSON_TYPE, num_retries); - - // Validate that after failing a few attempts we finally got back a - // success code. - assertEquals("Unexpected result code", SUCCESS_RESULT_CODE, or.getResultCode()); - - // Validate that our stubbed AAI actually received the expected number - // of retried requests. - assertEquals("Unexpected number of retries", AAI_FailThenSucceed_Stub.MAX_FAILURES + 1, - AAI_FailThenSucceed_Stub.getCount); - } - - - /** - * This class provides a simple in-memory REST end point to stand in for a real AAI. - *
- * This endpoint always returns a valid reply to a GET request and is used for success path - * testing. - */ - @Path(GOOD_AAI_ENDPOINT) - public static class AAI_Success_Stub { - - /** - * This is the end point for GET requests. It just returns a simple, pre-canned response - * payload. - * - * @return - A pre-canned response. - */ - @GET - public String getEndpoint() { - return AAI_GET_REPLY_PAYLOAD; - } - } - - - /** - * This class provides a simple in-memory REST end point to stand in for a real AAI. - *
- * This endpoint always returns throws an error instead of responding successfully and is used for - * certain failure path tests. - */ - @Path(FAIL_ALWAYS_AAI_ENDPOINT) - public static class AAI_FailAlways_Stub { - - /** - * Maintains a running count of the number of GET requests that have been received. - */ - public static int getCount; - - - /** - * Resets all of the endpoints counters. - */ - public static void initialize() { - getCount = 0; - } - - - /** - * This is the end point for GET requests. It just throws an error instead of returning a valid - * response. - * - * @return - NONE. We actually throw an exception intentionally instead of returning. - */ - @GET - public String getEndpoint() { - - // Keep track of the number of get requests that we have received - // so that this value can be used for validation purposes later. - getCount++; - - // Always just throw an error instead of replying successfully. - throw new UnsupportedOperationException("Intentional Failure"); - } - } - - - /** - * This class provides a simple in-memory REST end point to stand in for a real AAI. - *
- * This end point will throw errors instead of responding for a certain number of requests, after - * which it will return a valid, pre-canned response. - * - * @return - A pre-canned response. - */ - @Path(FAIL_THEN_SUCCEED_ENDPOINT) - public static class AAI_FailThenSucceed_Stub { - - /** - * The number of requests for which we should throw errors before responding successfully. - */ - public static int MAX_FAILURES = 2; - - /** - * Maintains a running count of the number of GET requests that have been received. - */ - public static int getCount; - - /** - * Maintains a running count of the number of requests which we have failed, so that we will - * know when to stop failing and return a valid response. - */ - private static int failCount; - - - /** - * Resets all of the endpoints counters. - */ - public static void initialize() { - getCount = 0; - failCount = 0; - } - - - /** - * This is the end point for GET requests. It will throw errors for a certain number of requests - * and then return a valid response. - * - * @return - A pre-canned response string. - */ - @GET - public String getEndpoint() { - - // Keep track of the number of get requests that we have received - // so that this value can be used for validation purposes later. - getCount++; - - // We only want to fail a set number of times, so check now to - // see what we should do. - if (failCount < MAX_FAILURES) { - failCount++; - throw new UnsupportedOperationException("Intentional Failure"); - - } else { - // We've failed as often as we need to. Time to reply - // successfully. - failCount = 0; - return AAI_GET_REPLY_PAYLOAD; - } - } - } - - - /** - * This class overrides the behaviour of the {@link RestClientBuilder} used by the - * {@link RestClient} to just return the in memory client provided by the JerseyTest framework. - */ - private class TestRestClientBuilder extends RestClientBuilder { - - @Override - public Client getClient() throws Exception { - return client(); - } - } -}