Refactored cloudwatch integration test so that it's clearer what's being tested and to fix flakiness.

Author: kiiadi

services/cloudwatch/src/it/java/software/amazon/awssdk/services/cloudwatch/CloudWatchIntegrationTest.java

@@ -15,9 +15,14 @@
 
 package software.amazon.awssdk.services.cloudwatch;
 
+import static java.util.stream.Collectors.toList;
+import static org.hamcrest.CoreMatchers.is;
 import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.equalTo;
+import static org.hamcrest.Matchers.greaterThan;
+import static org.hamcrest.Matchers.hasSize;
+import static org.hamcrest.Matchers.isIn;
 import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertTrue;
 import static org.junit.Assert.fail;
@@ -26,8 +31,10 @@
 import java.io.IOException;
 import java.time.Duration;
 import java.time.Instant;
+import java.util.ArrayList;
 import java.util.Collection;
 import java.util.LinkedList;
+import java.util.List;
 import org.junit.AfterClass;
 import org.junit.BeforeClass;
 import org.junit.Test;
@@ -37,15 +44,10 @@
 import software.amazon.awssdk.core.regions.Region;
 import software.amazon.awssdk.services.cloudwatch.model.Datapoint;
 import software.amazon.awssdk.services.cloudwatch.model.DeleteAlarmsRequest;
-import software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmHistoryRequest;
-import software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmHistoryResponse;
-import software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsForMetricRequest;
 import software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsForMetricResponse;
 import software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsRequest;
 import software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmsResponse;
 import software.amazon.awssdk.services.cloudwatch.model.Dimension;
-import software.amazon.awssdk.services.cloudwatch.model.DisableAlarmActionsRequest;
-import software.amazon.awssdk.services.cloudwatch.model.EnableAlarmActionsRequest;
 import software.amazon.awssdk.services.cloudwatch.model.GetMetricStatisticsRequest;
 import software.amazon.awssdk.services.cloudwatch.model.GetMetricStatisticsResponse;
 import software.amazon.awssdk.services.cloudwatch.model.HistoryItemType;
@@ -56,10 +58,9 @@
 import software.amazon.awssdk.services.cloudwatch.model.MetricDatum;
 import software.amazon.awssdk.services.cloudwatch.model.PutMetricAlarmRequest;
 import software.amazon.awssdk.services.cloudwatch.model.PutMetricDataRequest;
-import software.amazon.awssdk.services.cloudwatch.model.SetAlarmStateRequest;
+import software.amazon.awssdk.services.cloudwatch.model.StateValue;
 import software.amazon.awssdk.testutils.Waiter;
 import software.amazon.awssdk.testutils.service.AwsIntegrationTestBase;
-import software.amazon.awssdk.testutils.SdkAsserts;
 
 /**
  * Integration tests for the AWS CloudWatch service.
@@ -90,7 +91,7 @@ public static void setUp() throws IOException {
     public static void cleanupAlarms() {
         if (cloudwatch != null) {
             DescribeAlarmsResponse describeResult = cloudwatch.describeAlarms(DescribeAlarmsRequest.builder().build());
-            Collection<String> toDelete = new LinkedList<String>();
+            Collection<String> toDelete = new LinkedList<>();
             for (MetricAlarm alarm : describeResult.metricAlarms()) {
                 if (alarm.metricName().startsWith(CloudWatchIntegrationTest.class.getName())) {
                     toDelete.add(alarm.alarmName());
@@ -176,7 +177,7 @@ public void put_metric_large_data_throws_request_entity_large_exception()
         long now = System.currentTimeMillis();
         double value = 42.0;
 
-        Collection<MetricDatum> data = new LinkedList<MetricDatum>();
+        Collection<MetricDatum> data = new LinkedList<>();
         for (int i = ONE_WEEK_IN_MILLISECONDS; i >= 0; i -= ONE_HOUR_IN_MILLISECONDS) {
             long time = now - i;
             MetricDatum datum = MetricDatum.builder().dimensions(
@@ -200,112 +201,88 @@ public void put_metric_large_data_throws_request_entity_large_exception()
      */
     @Test
     public void describe_alarms_returns_values_set() {
-        String metricName = this.getClass().getName()
-                            + System.currentTimeMillis();
+        String metricName = this.getClass().getName() + System.currentTimeMillis();
 
-        PutMetricAlarmRequest[] rqs = createTwoNewAlarms(metricName);
+        List<PutMetricAlarmRequest> rqs = createTwoNewAlarms(metricName);
 
-        PutMetricAlarmRequest rq1 = rqs[0];
-        PutMetricAlarmRequest rq2 = rqs[1];
+        rqs.forEach(rq -> cloudwatch.setAlarmState(r -> r.alarmName(rq.alarmName()).stateValue("ALARM").stateReason("manual")));
 
-        /*
-         * Set the state
-         */
-        SetAlarmStateRequest setAlarmStateRequest = SetAlarmStateRequest.builder()
-                .alarmName(rq1.alarmName()).stateValue("ALARM")
-                .stateReason("manual").build();
-        cloudwatch.setAlarmState(setAlarmStateRequest);
-        setAlarmStateRequest = SetAlarmStateRequest.builder().alarmName(
-                rq2.alarmName()).stateValue("ALARM").stateReason(
-                "manual").build();
-        cloudwatch.setAlarmState(setAlarmStateRequest);
-
-        DescribeAlarmsForMetricResponse describeResult = cloudwatch
-                .describeAlarmsForMetric(DescribeAlarmsForMetricRequest.builder()
-                                                 .dimensions(rq1.dimensions()).metricName(
-                                metricName).namespace(rq1.namespace()).build());
-        assertEquals(2, describeResult.metricAlarms().size());
-        for (MetricAlarm alarm : describeResult.metricAlarms()) {
-            assertTrue(rq1.alarmName().equals(alarm.alarmName())
-                       || rq2.alarmName().equals(alarm.alarmName()));
-            assertEquals(setAlarmStateRequest.stateValue(), alarm
-                    .stateValue());
-            assertEquals(setAlarmStateRequest.stateReason(), alarm
-                    .stateReason());
-        }
+        DescribeAlarmsForMetricResponse describeResult = describeAlarmsForMetric(rqs);
 
-        /*
-         * Get the history
-         */
-        DescribeAlarmHistoryRequest alarmHistoryRequest = DescribeAlarmHistoryRequest.builder()
-                .alarmName(rq1.alarmName()).historyItemType(HistoryItemType.STATE_UPDATE)
-                .build();
-        DescribeAlarmHistoryResponse historyResult = cloudwatch
-                .describeAlarmHistory(alarmHistoryRequest);
-        assertEquals(1, historyResult.alarmHistoryItems().size());
+        assertThat(describeResult.metricAlarms(), hasSize(2));
+
+        //check the state is correct
+        describeResult.metricAlarms().forEach(alarm -> {
+            assertThat(alarm.alarmName(), isIn(rqs.stream().map(PutMetricAlarmRequest::alarmName).collect(toList())));
+            assertThat(alarm.stateValue(), equalTo(StateValue.ALARM));
+            assertThat(alarm.stateReason(), equalTo("manual"));
+        });
+
+        //check the state history has been recorded
+        rqs.stream().map(alarm -> cloudwatch.describeAlarmHistory(r -> r.alarmName(alarm.alarmName())
+                                                                        .historyItemType(HistoryItemType.STATE_UPDATE)))
+           .forEach(history -> assertThat(history.alarmHistoryItems(), hasSize(greaterThan(0))));
     }
 
     /**
      * Tests disabling and enabling alarm actions
      */
     @Test
     public void disable_enable_alarms_returns_success() {
-        String metricName = this.getClass().getName()
-                            + System.currentTimeMillis();
+        String metricName = this.getClass().getName() + System.currentTimeMillis();
 
-        PutMetricAlarmRequest[] rqs = createTwoNewAlarms(metricName);
+        List<PutMetricAlarmRequest> rqs = createTwoNewAlarms(metricName);
+        List<String> alarmNames = rqs.stream().map(PutMetricAlarmRequest::alarmName).collect(toList());
 
-        PutMetricAlarmRequest rq1 = rqs[0];
-        PutMetricAlarmRequest rq2 = rqs[1];
+        PutMetricAlarmRequest rq1 = rqs.get(0);
+        PutMetricAlarmRequest rq2 = rqs.get(1);
 
         /*
          * Disable
          */
-        DisableAlarmActionsRequest disable = DisableAlarmActionsRequest.builder()
-                .alarmNames(rq1.alarmName(), rq2.alarmName()).build();
-        cloudwatch.disableAlarmActions(disable);
-
-        DescribeAlarmsForMetricResponse describeResult = cloudwatch
-                .describeAlarmsForMetric(DescribeAlarmsForMetricRequest.builder()
-                                                 .dimensions(rq1.dimensions()).metricName(
-                                metricName).namespace(rq1.namespace()).build());
-        assertEquals(2, describeResult.metricAlarms().size());
-        for (MetricAlarm alarm : describeResult.metricAlarms()) {
-            assertTrue(rq1.alarmName().equals(alarm.alarmName())
-                       || rq2.alarmName().equals(alarm.alarmName()));
-            assertFalse(alarm.actionsEnabled());
-        }
+        cloudwatch.disableAlarmActions(r -> r.alarmNames(alarmNames));
+
+        DescribeAlarmsForMetricResponse describeDisabledResult = describeAlarmsForMetric(rqs);
+
+        assertThat(describeDisabledResult.metricAlarms(), hasSize(2));
+
+        describeDisabledResult.metricAlarms().forEach(alarm -> {
+            assertThat(alarm.alarmName(), isIn(alarmNames));
+            assertThat(alarm.actionsEnabled(), is(false));
+        });
 
         /*
          * Enable
          */
-        EnableAlarmActionsRequest enable = EnableAlarmActionsRequest.builder()
-                .alarmNames(rq1.alarmName(), rq2.alarmName()).build();
-        cloudwatch.enableAlarmActions(enable);
-
-        describeResult = cloudwatch
-                .describeAlarmsForMetric(DescribeAlarmsForMetricRequest.builder()
-                                                 .dimensions(rq1.dimensions()).metricName(
-                                metricName).namespace(rq1.namespace()).build());
-        assertEquals(2, describeResult.metricAlarms().size());
-        for (MetricAlarm alarm : describeResult.metricAlarms()) {
-            assertTrue(rq1.alarmName().equals(alarm.alarmName())
-                       || rq2.alarmName().equals(alarm.alarmName()));
-            assertTrue(alarm.actionsEnabled());
-        }
+        cloudwatch.enableAlarmActions(r -> r.alarmNames(alarmNames));
+
+        DescribeAlarmsForMetricResponse describeEnabledResult = describeAlarmsForMetric(rqs);
+
+        assertThat(describeEnabledResult.metricAlarms(), hasSize(2));
+        describeEnabledResult.metricAlarms().forEach(alarm -> {
+            assertThat(alarm.alarmName(), isIn(alarmNames));
+            assertThat(alarm.actionsEnabled(), is(true));
+        });
+    }
+
+    private DescribeAlarmsForMetricResponse describeAlarmsForMetric(List<PutMetricAlarmRequest> rqs) {
+        return cloudwatch.describeAlarmsForMetric(r -> r.dimensions(rqs.get(0).dimensions())
+                                                        .metricName(rqs.get(0).metricName())
+                                                        .namespace(rqs.get(0).namespace()));
     }
 
     /**
      * Creates two alarms on the metric name given and returns the two requests
      * as an array.
      */
-    private PutMetricAlarmRequest[] createTwoNewAlarms(String metricName) {
-        PutMetricAlarmRequest[] rqs = new PutMetricAlarmRequest[2];
+    private List<PutMetricAlarmRequest> createTwoNewAlarms(String metricName) {
+
+        List<PutMetricAlarmRequest> rqs = new ArrayList<>();
 
         /*
-         * Put two metric alarms
+         * Create & put two metric alarms
          */
-        rqs[0] = PutMetricAlarmRequest.builder().actionsEnabled(true)
+        rqs.add(PutMetricAlarmRequest.builder().actionsEnabled(true)
                                             .alarmDescription("Some alarm description").alarmName(
                         "An Alarm Name" + metricName).comparisonOperator(
                         "GreaterThanThreshold").dimensions(
@@ -314,11 +291,10 @@ private PutMetricAlarmRequest[] createTwoNewAlarms(String metricName) {
                                             .metricName(metricName).namespace("AWS/EC2")
                                             .period(60).statistic("Average").threshold(1.0)
                                             .unit("Count")
-                .build();
+                .build());
 
-        cloudwatch.putMetricAlarm(rqs[0]);
 
-        rqs[1] = PutMetricAlarmRequest.builder().actionsEnabled(true)
+        rqs.add(PutMetricAlarmRequest.builder().actionsEnabled(true)
                                             .alarmDescription("Some alarm description 2")
                                             .alarmName("An Alarm Name 2" + metricName)
                                             .comparisonOperator("GreaterThanThreshold").dimensions(
@@ -327,8 +303,9 @@ private PutMetricAlarmRequest[] createTwoNewAlarms(String metricName) {
                                             .metricName(metricName).namespace("AWS/EC2")
                                             .period(60).statistic("Average").threshold(2.0)
                                             .unit("Count")
-                .build();
-        cloudwatch.putMetricAlarm(rqs[1]);
+                .build());
+
+        rqs.forEach(cloudwatch::putMetricAlarm);
         return rqs;
     }