Created new rule for cancelling all notifications
Bug: 304828674
Test: Unit Tests
Change-Id: Ib593e7d16f5881261d267472233ada24fb3cafd5
diff --git a/libraries/health/rules/src/android/platform/test/rule/CancelNotificationRule.java b/libraries/health/rules/src/android/platform/test/rule/CancelNotificationRule.java
new file mode 100644
index 0000000..614c071
--- /dev/null
+++ b/libraries/health/rules/src/android/platform/test/rule/CancelNotificationRule.java
@@ -0,0 +1,51 @@
+/*
+ * Copyright (C) 2023 The Android Open Source Project
+ *
+ * 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
+ *
+ * http://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 android.platform.test.rule;
+
+import static androidx.test.platform.app.InstrumentationRegistry.getInstrumentation;
+
+import android.app.NotificationManager;
+import android.platform.test.util.HealthTestingUtils;
+
+import androidx.annotation.VisibleForTesting;
+
+import org.junit.runner.Description;
+
+/** This rule will cancel all the notifications. */
+public class CancelNotificationRule extends TestWatcher {
+ private static android.app.NotificationManager sNotificationManager =
+ getInstrumentation().getTargetContext().getSystemService(NotificationManager.class);
+
+ @Override
+ protected void starting(Description description) {
+ sNotificationManager.cancelAll();
+ HealthTestingUtils.waitForCondition(
+ () ->
+ "Notification count didn't become 0. It is currently equal to "
+ + getNotificationCount(),
+ () -> getNotificationCount() == 0);
+ }
+
+ @VisibleForTesting
+ void setNotificationManager(NotificationManager notificationManager) {
+ sNotificationManager = notificationManager;
+ }
+
+ private static int getNotificationCount() {
+ return sNotificationManager.getActiveNotifications().length;
+ }
+}
diff --git a/libraries/health/rules/tests/src/android/platform/test/rule/CancelNotificationRuleTest.java b/libraries/health/rules/tests/src/android/platform/test/rule/CancelNotificationRuleTest.java
new file mode 100644
index 0000000..56cf082
--- /dev/null
+++ b/libraries/health/rules/tests/src/android/platform/test/rule/CancelNotificationRuleTest.java
@@ -0,0 +1,82 @@
+/*
+ * Copyright (C) 2023 The Android Open Source Project
+ *
+ * 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
+ *
+ * http://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 android.platform.test.rule;
+
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+import android.app.NotificationManager;
+import android.os.Bundle;
+import android.service.notification.StatusBarNotification;
+
+import androidx.test.uiautomator.UiDevice;
+
+import org.junit.Test;
+import org.junit.runner.Description;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+import org.junit.runners.model.Statement;
+import org.mockito.Mockito;
+
+/** Tests for {@link CancelNotificationRule}. */
+@RunWith(JUnit4.class)
+public class CancelNotificationRuleTest {
+
+ private static final Statement TEST_STATEMENT =
+ new Statement() {
+ @Override
+ public void evaluate() {}
+ };
+ private static final Description TEST_DESCRIPTION =
+ Description.createTestDescription("class", "method");
+
+ @Test
+ public void testCancelNotificationRule() throws Throwable {
+ CancelNotificationRuleTest.TestableCancelNotificationRule rule =
+ new CancelNotificationRuleTest.TestableCancelNotificationRule();
+ NotificationManager mockNotificationManager = Mockito.mock(NotificationManager.class);
+ when(mockNotificationManager.getActiveNotifications())
+ .thenReturn(new StatusBarNotification[0]);
+
+ rule.setNotificationManager(mockNotificationManager);
+ rule.apply(TEST_STATEMENT, TEST_DESCRIPTION).evaluate();
+
+ // Validate if the cancelAll is called once
+ verify(mockNotificationManager, times(1)).cancelAll();
+ }
+
+ private static class TestableCancelNotificationRule extends CancelNotificationRule {
+ private UiDevice mDevice;
+ private Bundle mArgs;
+
+ TestableCancelNotificationRule() {
+ mDevice = Mockito.mock(UiDevice.class);
+ mArgs = new Bundle();
+ }
+
+ @Override
+ protected Bundle getArguments() {
+ return mArgs;
+ }
+
+ @Override
+ protected UiDevice getUiDevice() {
+ return mDevice;
+ }
+ }
+}
