Merge pull request #53 from zebrunner/notification-enhancements

Sergey Brenko · web-flow · commit 155c7210264e · 2023-05-31T15:52:11.000+03:00
Added possibility to disable notifications
diff --git a/src/main/java/com/zebrunner/agent/core/config/ConfigurationHolder.java b/src/main/java/com/zebrunner/agent/core/config/ConfigurationHolder.java
@@ -122,6 +122,11 @@ private static String toSerializedRunContext(String ciRunId) {
 //        return new Gson().toJson(runContext);
 //    }
 
+    public static boolean notificationsEnabled() {
+        Boolean enabled = configuration.getNotification().getEnabled();
+        return enabled == null || enabled;
+    }
+
     public static boolean shouldNotifyOnEachFailure() {
         Boolean notifyOnEachFailure = configuration.getNotification().getNotifyOnEachFailure();
         return notifyOnEachFailure != null && notifyOnEachFailure;
@@ -149,7 +154,7 @@ public static String getMilestoneName() {
 
     public static boolean isTcmSyncEnabled() {
         Boolean pushResults = configuration.getTcm().getZebrunner().getPushResults();
-        return pushResults != null && pushResults;
+        return pushResults == null || pushResults;
     }
 
     public static boolean isTcmRealTimeSyncEnabled() {
@@ -163,7 +168,7 @@ public static String getTcmTestRunId() {
 
     public static boolean isTestRailSyncEnabled() {
         Boolean pushResults = configuration.getTcm().getTestRail().getPushResults();
-        return pushResults != null && pushResults;
+        return pushResults == null || pushResults;
     }
 
     public static boolean isTestRailRealTimeSyncEnabled() {
@@ -198,7 +203,7 @@ public static String getTestRailAssignee() {
 
     public static boolean isXraySyncEnabled() {
         Boolean pushResults = configuration.getTcm().getXray().getPushResults();
-        return pushResults != null && pushResults;
+        return pushResults == null || pushResults;
     }
 
     public static boolean isXrayRealTimeSyncEnabled() {
@@ -212,7 +217,7 @@ public static String getXrayExecutionKey() {
 
     public static boolean isZephyrSyncEnabled() {
         Boolean pushResults = configuration.getTcm().getZephyr().getPushResults();
-        return pushResults != null && pushResults;
+        return pushResults == null || pushResults;
     }
 
     public static boolean isZephyrSyncRealTimeEnabled() {
diff --git a/src/main/java/com/zebrunner/agent/core/config/ConfigurationProvidersChain.java b/src/main/java/com/zebrunner/agent/core/config/ConfigurationProvidersChain.java
@@ -142,7 +142,7 @@ private static void normalizeMilestoneConfiguration(ReportingConfiguration confi
 
     private static void normalizeNotificationConfiguration(ReportingConfiguration config) {
         if (config.getNotification() == null) {
-            config.setNotification(new ReportingConfiguration.NotificationConfiguration(null, null, null, null));
+            config.setNotification(new ReportingConfiguration.NotificationConfiguration(null, null, null, null, null));
         } else {
             ReportingConfiguration.NotificationConfiguration notificationConfig = config.getNotification();
 
@@ -321,6 +321,9 @@ private static void merge(ReportingConfiguration config, ReportingConfiguration
         }
 
         ReportingConfiguration.NotificationConfiguration notification = config.getNotification();
+        if (notification.getEnabled() == null) {
+            notification.setEnabled(providedConfig.getNotification().getEnabled());
+        }
         if (notification.getNotifyOnEachFailure() == null) {
             notification.setNotifyOnEachFailure(providedConfig.getNotification().getNotifyOnEachFailure());
         }
@@ -449,6 +452,7 @@ private static boolean areAllArgsSet(ReportingConfiguration config) {
         String testCaseStatusOnFail = config.getTcm().getTestCaseStatus().getOnFail();
         String testCaseStatusOnSkip = config.getTcm().getTestCaseStatus().getOnSkip();
 
+        Boolean notificationsEnabled = config.getNotification().getEnabled();
         Boolean notifyOnEachFailure = config.getNotification().getNotifyOnEachFailure();
         String slackChannels = config.getNotification().getSlackChannels();
         String msTeamsChannels = config.getNotification().getMsTeamsChannels();
@@ -482,7 +486,7 @@ private static boolean areAllArgsSet(ReportingConfiguration config) {
                 && displayName != null && build != null && environment != null && context != null
                 && retryKnownIssues != null && substituteRemoteWebDrivers != null && treatSkipsAsFailures != null
                 && testCaseStatusOnPass != null && testCaseStatusOnFail != null && testCaseStatusOnSkip != null
-                && notifyOnEachFailure != null && slackChannels != null && msTeamsChannels != null && emails != null
+                && notificationsEnabled != null && notifyOnEachFailure != null && slackChannels != null && msTeamsChannels != null && emails != null
                 && tcmPushResults != null && tcmPushInRealTime != null && tcmRunId != null
                 && testRailPushResults != null && testRailPushInRealTime != null && testRailSuiteId != null
                 && testRailRunId != null && testRailIncludeAllTestCasesInNewRun != null && testRailRunName != null
diff --git a/src/main/java/com/zebrunner/agent/core/config/ReportingConfiguration.java b/src/main/java/com/zebrunner/agent/core/config/ReportingConfiguration.java
@@ -66,6 +66,7 @@ public static class RunConfiguration {
     @AllArgsConstructor
     public static class NotificationConfiguration {
 
+        private Boolean enabled;
         private Boolean notifyOnEachFailure;
         private String slackChannels;
         private String msTeamsChannels;
diff --git a/src/main/java/com/zebrunner/agent/core/config/provider/EnvironmentConfigurationProvider.java b/src/main/java/com/zebrunner/agent/core/config/provider/EnvironmentConfigurationProvider.java
@@ -49,6 +49,7 @@ public class EnvironmentConfigurationProvider implements ConfigurationProvider {
     private static final String TCM_ZEPHYR_JIRA_PROJECT_KEY_VARIABLE = "REPORTING_TCM_ZEPHYR_JIRA_PROJECT_KEY";
     private static final String TCM_ZEPHYR_TEST_CYCLE_KEY_VARIABLE = "REPORTING_TCM_ZEPHYR_TEST_CYCLE_KEY";
 
+    private static final String NOTIFICATION_ENABLED = "REPORTING_NOTIFICATION_ENABLED";
     private static final String NOTIFICATION_NOTIFY_ON_EACH_FAILURE_VARIABLE = "REPORTING_NOTIFICATION_NOTIFY_ON_EACH_FAILURE";
     private static final String NOTIFICATION_SLACK_CHANNELS_VARIABLE = "REPORTING_NOTIFICATION_SLACK_CHANNELS";
     private static final String NOTIFICATION_MS_TEAMS_CHANNELS_VARIABLE = "REPORTING_NOTIFICATION_MS_TEAMS_CHANNELS";
@@ -98,6 +99,7 @@ public ReportingConfiguration getConfiguration() {
         String zephyrJiraProjectKey = System.getenv(TCM_ZEPHYR_JIRA_PROJECT_KEY_VARIABLE);
         String zephyrTestCycleKey = System.getenv(TCM_ZEPHYR_TEST_CYCLE_KEY_VARIABLE);
 
+        Boolean notificationsEnabled = parseBoolean(System.getenv(NOTIFICATION_ENABLED));
         Boolean notifyOnEachFailure = parseBoolean(System.getenv(NOTIFICATION_NOTIFY_ON_EACH_FAILURE_VARIABLE));
         String slackChannels = System.getenv(NOTIFICATION_SLACK_CHANNELS_VARIABLE);
         String msTeamsChannels = System.getenv(NOTIFICATION_MS_TEAMS_CHANNELS_VARIABLE);
@@ -124,7 +126,7 @@ public ReportingConfiguration getConfiguration() {
                                              milestoneId, milestoneName
                                      ))
                                      .notification(new ReportingConfiguration.NotificationConfiguration(
-                                             notifyOnEachFailure, slackChannels, msTeamsChannels, emails
+                                             notificationsEnabled, notifyOnEachFailure, slackChannels, msTeamsChannels, emails
                                      ))
                                      .tcm(new ReportingConfiguration.TcmConfiguration(
                                              new ReportingConfiguration.TcmConfiguration.TestCaseStatus(
diff --git a/src/main/java/com/zebrunner/agent/core/config/provider/PropertiesConfigurationProvider.java b/src/main/java/com/zebrunner/agent/core/config/provider/PropertiesConfigurationProvider.java
@@ -51,6 +51,7 @@ public class PropertiesConfigurationProvider implements ConfigurationProvider {
     private static final String TCM_ZEPHYR_JIRA_PROJECT_KEY_PROPERTY = "reporting.tcm.zephyr.jira-project-key";
     private static final String TCM_ZEPHYR_TEST_CYCLE_KEY_PROPERTY = "reporting.tcm.zephyr.test-cycle-key";
 
+    private static final String NOTIFICATION_ENABLED = "reporting.notification.enabled";
     private static final String NOTIFICATION_NOTIFY_ON_EACH_FAILURE_PROPERTY = "reporting.notification.notify-on-each-failure";
     private final static String NOTIFICATION_SLACK_CHANNELS_PROPERTY = "reporting.notification.slack-channels";
     private final static String NOTIFICATION_MS_TEAMS_PROPERTY = "reporting.notification.ms-teams-channels";
@@ -104,6 +105,7 @@ public ReportingConfiguration getConfiguration() {
         String zephyrJiraProjectKey = agentProperties.getProperty(TCM_ZEPHYR_JIRA_PROJECT_KEY_PROPERTY);
         String zephyrTestCycleKey = agentProperties.getProperty(TCM_ZEPHYR_TEST_CYCLE_KEY_PROPERTY);
 
+        Boolean notificationsEnabled = ConfigurationUtils.parseBoolean(agentProperties.getProperty(NOTIFICATION_ENABLED));
         Boolean notifyOnEachFailure = ConfigurationUtils.parseBoolean(agentProperties.getProperty(NOTIFICATION_NOTIFY_ON_EACH_FAILURE_PROPERTY));
         String slackChannels = agentProperties.getProperty(NOTIFICATION_SLACK_CHANNELS_PROPERTY);
         String msTeamsChannels = agentProperties.getProperty(NOTIFICATION_MS_TEAMS_PROPERTY);
@@ -130,7 +132,7 @@ public ReportingConfiguration getConfiguration() {
                                              milestoneId, milestoneName
                                      ))
                                      .notification(new ReportingConfiguration.NotificationConfiguration(
-                                             notifyOnEachFailure, slackChannels, msTeamsChannels, emails
+                                             notificationsEnabled, notifyOnEachFailure, slackChannels, msTeamsChannels, emails
                                      ))
                                      .tcm(new ReportingConfiguration.TcmConfiguration(
                                              new ReportingConfiguration.TcmConfiguration.TestCaseStatus(
diff --git a/src/main/java/com/zebrunner/agent/core/config/provider/SystemPropertiesConfigurationProvider.java b/src/main/java/com/zebrunner/agent/core/config/provider/SystemPropertiesConfigurationProvider.java
@@ -47,6 +47,7 @@ public class SystemPropertiesConfigurationProvider implements ConfigurationProvi
     private static final String TCM_ZEPHYR_JIRA_PROJECT_KEY_PROPERTY = "reporting.tcm.zephyr.jira-project-key";
     private static final String TCM_ZEPHYR_TEST_CYCLE_KEY_PROPERTY = "reporting.tcm.zephyr.test-cycle-key";
 
+    private static final String NOTIFICATION_ENABLED = "reporting.notification.enabled";
     private static final String NOTIFICATION_NOTIFY_ON_EACH_FAILURE_PROPERTY = "reporting.notification.notify-on-each-failure";
     private final static String SLACK_CHANNELS_PROPERTY = "reporting.notification.slack-channels";
     private final static String MS_TEAMS_CHANNELS_PROPERTY = "reporting.notification.ms-teams-channels";
@@ -96,6 +97,7 @@ public ReportingConfiguration getConfiguration() {
         String zephyrJiraProjectKey = System.getProperty(TCM_ZEPHYR_JIRA_PROJECT_KEY_PROPERTY);
         String zephyrTestCycleKey = System.getProperty(TCM_ZEPHYR_TEST_CYCLE_KEY_PROPERTY);
 
+        Boolean notificationsEnabled = ConfigurationUtils.parseBoolean(System.getProperty(NOTIFICATION_ENABLED));
         Boolean notifyOnEachFailure = ConfigurationUtils.parseBoolean(System.getProperty(NOTIFICATION_NOTIFY_ON_EACH_FAILURE_PROPERTY));
         String slackChannels = System.getProperty(SLACK_CHANNELS_PROPERTY);
         String msTeamsChannels = System.getProperty(MS_TEAMS_CHANNELS_PROPERTY);
@@ -122,7 +124,7 @@ public ReportingConfiguration getConfiguration() {
                                              milestoneId, milestoneName
                                      ))
                                      .notification(new ReportingConfiguration.NotificationConfiguration(
-                                             notifyOnEachFailure, slackChannels, msTeamsChannels, emails
+                                             notificationsEnabled, notifyOnEachFailure, slackChannels, msTeamsChannels, emails
                                      ))
                                      .tcm(new ReportingConfiguration.TcmConfiguration(
                                              new ReportingConfiguration.TcmConfiguration.TestCaseStatus(
diff --git a/src/main/java/com/zebrunner/agent/core/config/provider/YamlConfigurationProvider.java b/src/main/java/com/zebrunner/agent/core/config/provider/YamlConfigurationProvider.java
@@ -56,6 +56,7 @@ public class YamlConfigurationProvider implements ConfigurationProvider {
     private static final String TCM_ZEPHYR_JIRA_PROJECT_KEY_PROPERTY = "reporting.tcm.zephyr.jira-project-key";
     private static final String TCM_ZEPHYR_TEST_CYCLE_KEY_PROPERTY = "reporting.tcm.zephyr.test-cycle-key";
 
+    private static final String NOTIFICATION_ENABLED = "reporting.notification.enabled";
     private static final String NOTIFICATION_NOTIFY_ON_EACH_FAILURE_PROPERTY = "reporting.notification.notify-on-each-failure";
     private final static String NOTIFICATION_SLACK_CHANNELS_PROPERTY = "reporting.notification.slack-channels";
     private final static String NOTIFICATION_MS_TEAMS_CHANNELS_PROPERTY = "reporting.notification.ms-teams-channels";
@@ -110,6 +111,7 @@ public ReportingConfiguration getConfiguration() {
         String zephyrJiraProjectKey = getProperty(yamlProperties, TCM_ZEPHYR_JIRA_PROJECT_KEY_PROPERTY);
         String zephyrTestCycleKey = getProperty(yamlProperties, TCM_ZEPHYR_TEST_CYCLE_KEY_PROPERTY);
 
+        Boolean notificationsEnabled = ConfigurationUtils.parseBoolean(getProperty(yamlProperties, NOTIFICATION_ENABLED));
         Boolean notifyOnEachFailure = ConfigurationUtils.parseBoolean(getProperty(yamlProperties, NOTIFICATION_NOTIFY_ON_EACH_FAILURE_PROPERTY));
         String slackChannels = getProperty(yamlProperties, NOTIFICATION_SLACK_CHANNELS_PROPERTY);
         String msTeamsChannels = getProperty(yamlProperties, NOTIFICATION_MS_TEAMS_CHANNELS_PROPERTY);
@@ -136,7 +138,7 @@ public ReportingConfiguration getConfiguration() {
                                              milestoneId, milestoneName
                                      ))
                                      .notification(new ReportingConfiguration.NotificationConfiguration(
-                                             notifyOnEachFailure, slackChannels, msTeamsChannels, emails
+                                             notificationsEnabled, notifyOnEachFailure, slackChannels, msTeamsChannels, emails
                                      ))
                                      .tcm(new ReportingConfiguration.TcmConfiguration(
                                              new ReportingConfiguration.TcmConfiguration.TestCaseStatus(
diff --git a/src/main/java/com/zebrunner/agent/core/registrar/ReportingRegistrar.java b/src/main/java/com/zebrunner/agent/core/registrar/ReportingRegistrar.java
@@ -68,6 +68,7 @@ public void registerStart(TestRunStartDescriptor tr) {
                                          ConfigurationHolder.getMilestoneName()
                                  ))
                                        .notifications(new TestRunDTO.Notifications(
+                                         ConfigurationHolder.notificationsEnabled(),
                                          collectNotificationTargets(),
                                          ConfigurationHolder.shouldNotifyOnEachFailure()
                                  ))
diff --git a/src/main/java/com/zebrunner/agent/core/registrar/domain/TestRunDTO.java b/src/main/java/com/zebrunner/agent/core/registrar/domain/TestRunDTO.java
@@ -68,6 +68,7 @@ public static class JenkinsContext {
     @Value
     public static class Notifications {
 
+        boolean enabled;
         Set<NotificationTargetDTO> targets;
         boolean notifyOnEachFailure;
 
