feat: Change default Mail Sender for Notification - MEED-2011 - Meeds…

…-io/meeds#862 (#563)

Prior to this change, the mail sender name and email was using legacy
names. This change will improve it to make the Email Name retrieved from
`BrandingService` (General Settings UI) when not explicitly set. At the
same time, this change will set a new default notifications sender email
instead of legacy.

component/common/src/main/java/org/exoplatform/commons/utils/MailUtils.java

@@ -6,9 +6,12 @@
 import org.exoplatform.commons.api.settings.data.Scope;
 import org.exoplatform.container.ExoContainerContext;
 import org.exoplatform.container.PortalContainer;
+import org.exoplatform.portal.branding.BrandingService;
 
 public class MailUtils {
 
+  public static final String DEFAULT_FROM_EMAIL = "noreply@meeds.io";
+
   public static final String SENDER_NAME_PARAM  = "exo:notificationSenderName";
 
   public static final String SENDER_EMAIL_PARAM = "exo:notificationSenderEmail";
@@ -19,12 +22,12 @@ private MailUtils() {
 
   public static String getSenderName() {
     SettingValue<?> name = getSettingService().get(Context.GLOBAL, Scope.GLOBAL.id(null), SENDER_NAME_PARAM);
-    return name != null ? (String) name.getValue() : System.getProperty("exo.notifications.portalname", "eXo");
+    return name != null ? (String) name.getValue() : System.getProperty("exo.notifications.portalname", getBrandingCompanyName());
   }
 
   public static String getSenderEmail() {
     SettingValue<?> mail = getSettingService().get(Context.GLOBAL, Scope.GLOBAL.id(null), SENDER_EMAIL_PARAM);
-    return mail != null ? (String) mail.getValue() : System.getProperty("gatein.email.smtp.from", "noreply@exoplatform.com");
+    return mail != null ? (String) mail.getValue() : System.getProperty("gatein.email.smtp.from", DEFAULT_FROM_EMAIL);
   }
 
   private static SettingService getSettingService() {
@@ -35,4 +38,12 @@ private static SettingService getSettingService() {
     return settingService;
   }
 
+  private static String getBrandingCompanyName() {
+    BrandingService brandingService = ExoContainerContext.getCurrentContainer().getComponentInstanceOfType(BrandingService.class);
+    if (brandingService != null) {
+      return brandingService.getCompanyName();
+    }
+    return null;
+  }
+
 }

component/common/src/test/java/org/exoplatform/commons/utils/MailUtilsTest.java

@@ -0,0 +1,115 @@
+/*
+ * This file is part of the Meeds project (https://meeds.io/).
+ * Copyright (C) 2020 - 2023 Meeds Association contact@meeds.io
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+package org.exoplatform.commons.utils;
+
+import static org.exoplatform.commons.utils.MailUtils.*;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNull;
+import static org.mockito.Mockito.*;
+
+import org.junit.AfterClass;
+import org.junit.Before;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.MockedStatic;
+import org.mockito.junit.MockitoJUnitRunner;
+
+import org.exoplatform.commons.api.settings.SettingService;
+import org.exoplatform.commons.api.settings.SettingValue;
+import org.exoplatform.commons.api.settings.data.Context;
+import org.exoplatform.commons.api.settings.data.Scope;
+import org.exoplatform.container.ExoContainer;
+import org.exoplatform.container.ExoContainerContext;
+import org.exoplatform.portal.branding.BrandingService;
+
+@RunWith(MockitoJUnitRunner.class)
+public class MailUtilsTest {
+
+  private static final MockedStatic<ExoContainerContext> EXO_CONTAINER_CONTEXT = mockStatic(ExoContainerContext.class);
+
+  private static ExoContainer                            container             = mock(ExoContainer.class);
+
+  @Mock
+  private BrandingService                                brandingService;
+
+  @Mock
+  private SettingService                                 settingService;
+
+  @BeforeClass
+  public static void beforeRunBare() {
+    EXO_CONTAINER_CONTEXT.when(() -> ExoContainerContext.getCurrentContainer()).thenReturn(container);
+  }
+
+  @AfterClass
+  public static void afterRunBare() {
+    EXO_CONTAINER_CONTEXT.close();
+  }
+
+  @Before
+  public void before() {
+    when(container.getComponentInstanceOfType(BrandingService.class)).thenReturn(brandingService);
+    when(container.getComponentInstanceOfType(SettingService.class)).thenReturn(settingService);
+  }
+
+  @SuppressWarnings({
+      "rawtypes", "unchecked"
+  })
+  @Test
+  public void testGetSenderName() {
+    String senderName = MailUtils.getSenderName();
+    assertNull(senderName);
+
+    String companyName = "Company Name";
+    when(brandingService.getCompanyName()).thenReturn(companyName);
+    senderName = MailUtils.getSenderName();
+    assertEquals(companyName, senderName);
+
+    companyName = "Company Name From property";
+    System.setProperty("exo.notifications.portalname", companyName);
+    senderName = MailUtils.getSenderName();
+    assertEquals(companyName, senderName);
+
+    companyName = "Company Name From Settings";
+    SettingValue settingValue = SettingValue.create(companyName);
+    when(settingService.get(Context.GLOBAL, Scope.GLOBAL.id(null), SENDER_NAME_PARAM)).thenReturn(settingValue);
+    senderName = MailUtils.getSenderName();
+    assertEquals(companyName, senderName);
+  }
+
+  @SuppressWarnings({
+      "rawtypes", "unchecked"
+  })
+  @Test
+  public void testGetSenderEmail() {
+    String senderEmail = MailUtils.getSenderEmail();
+    assertEquals(DEFAULT_FROM_EMAIL, senderEmail);
+
+    String companyEmail = "email.property@test.com";
+    System.setProperty("gatein.email.smtp.from", companyEmail);
+    senderEmail = MailUtils.getSenderEmail();
+    assertEquals(companyEmail, senderEmail);
+
+    companyEmail = "email.settings@test.com";
+    SettingValue settingValue = SettingValue.create(companyEmail);
+    when(settingService.get(Context.GLOBAL, Scope.GLOBAL.id(null), SENDER_EMAIL_PARAM)).thenReturn(settingValue);
+    senderEmail = MailUtils.getSenderEmail();
+    assertEquals(companyEmail, senderEmail);
+  }
+
+}

component/portal/src/test/resources/conf/exo.portal.component.portal-configuration.xml

@@ -270,6 +270,17 @@
     </init-params>
   </component>
 
+  <component>
+    <key>MailProperties</key>
+    <type>org.exoplatform.container.ExtendedPropertyConfigurator</type>
+    <init-params>
+      <properties-param>
+        <name>MailProperties</name>
+        <property name="exo.notifications.portalname" value="Meeds Builders" />
+      </properties-param>
+    </init-params>
+  </component>
+
   <external-component-plugins>
     <target-component>org.exoplatform.services.organization.OrganizationService</target-component>
     <component-plugin>