完善 mail 单元测试

yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/service/mail/MailSendServiceImpl.java

@@ -3,7 +3,6 @@ package cn.iocoder.yudao.module.system.service.mail;
 import cn.hutool.core.util.StrUtil;
 import cn.hutool.extra.mail.MailAccount;
 import cn.hutool.extra.mail.MailUtil;
-import cn.iocoder.yudao.framework.common.core.KeyValue;
 import cn.iocoder.yudao.framework.common.enums.CommonStatusEnum;
 import cn.iocoder.yudao.framework.common.enums.UserTypeEnum;
 import cn.iocoder.yudao.module.system.convert.mail.MailAccountConvert;
@@ -20,15 +19,13 @@ import org.springframework.stereotype.Service;
 import org.springframework.validation.annotation.Validated;
 
 import javax.annotation.Resource;
-import java.util.List;
 import java.util.Map;
-import java.util.stream.Collectors;
 
 import static cn.iocoder.yudao.framework.common.exception.util.ServiceExceptionUtil.exception;
 import static cn.iocoder.yudao.module.system.enums.ErrorCodeConstants.*;
 
 /**
- * 邮箱模版 服务实现类
+ * 邮箱发送 Service 实现类
  *
  * @author wangjingyi
  * @since 2022-03-21
@@ -82,14 +79,13 @@ public class MailSendServiceImpl implements MailSendService {
     public Long sendSingleMail(String mail, Long userId, Integer userType,
                                String templateCode, Map<String, Object> templateParams) {
         // 校验邮箱模版是否合法
-        MailTemplateDO template = checkMailTemplateValid(templateCode);
+        MailTemplateDO template = validateMailTemplate(templateCode);
         // 校验邮箱账号是否合法
-        MailAccountDO account = checkMailAccountValid(template.getAccountId());
+        MailAccountDO account = validateMailAccount(template.getAccountId());
 
         // 校验邮箱是否存在
-        mail = checkMail(mail);
-        // 校验参数模版
-        checkTemplateParams(template, templateParams);
+        mail = validateMail(mail);
+        validateTemplateParams(template, templateParams);
 
         // 创建发送日志。如果模板被禁用，则不发送短信，只记录日志
         Boolean isSend = CommonStatusEnum.ENABLE.getStatus().equals(template.getStatus());
@@ -107,7 +103,7 @@ public class MailSendServiceImpl implements MailSendService {
     @Override
     public void doSendMail(MailSendMessage message) {
         // 1. 创建发送账号
-        MailAccountDO account = checkMailAccountValid(message.getAccountId());
+        MailAccountDO account = validateMailAccount(message.getAccountId());
         MailAccount mailAccount  = MailAccountConvert.INSTANCE.convert(account, message.getNickname());
         // 2. 发送邮件
         try {
@@ -122,7 +118,7 @@ public class MailSendServiceImpl implements MailSendService {
     }
 
     @VisibleForTesting
-    public MailTemplateDO checkMailTemplateValid(String templateCode) {
+    MailTemplateDO validateMailTemplate(String templateCode) {
         // 获得邮件模板。考虑到效率，从缓存中获取
         MailTemplateDO template = mailTemplateService.getMailTemplateByCodeFromCache(templateCode);
         // 邮件模板不存在
@@ -133,7 +129,7 @@ public class MailSendServiceImpl implements MailSendService {
     }
 
     @VisibleForTesting
-    public MailAccountDO checkMailAccountValid(Long accountId) {
+    MailAccountDO validateMailAccount(Long accountId) {
         // 获得邮箱账号。考虑到效率，从缓存中获取
         MailAccountDO account = mailAccountService.getMailAccountFromCache(accountId);
         // 邮箱账号不存在
@@ -144,7 +140,7 @@ public class MailSendServiceImpl implements MailSendService {
     }
 
     @VisibleForTesting
-    public String checkMail(String mail) {
+    String validateMail(String mail) {
         if (StrUtil.isEmpty(mail)) {
             throw exception(MAIL_SEND_MAIL_NOT_EXISTS);
         }
@@ -152,13 +148,13 @@ public class MailSendServiceImpl implements MailSendService {
     }
 
     /**
-     * 校验参数模板
+     * 校验邮件参数是否确实
      *
      * @param template 邮箱模板
-     * @param templateParams 原始参数
+     * @param templateParams 参数列表
      */
     @VisibleForTesting
-    public void checkTemplateParams(MailTemplateDO template, Map<String, Object> templateParams) {
+    void validateTemplateParams(MailTemplateDO template, Map<String, Object> templateParams) {
         template.getParams().forEach(key -> {
             Object value = templateParams.get(key);
             if (value == null) {

yudao-module-system/yudao-module-system-biz/src/test/java/cn/iocoder/yudao/module/system/service/mail/MailAccountServiceImplTest.java

@@ -13,6 +13,7 @@ import org.springframework.boot.test.mock.mockito.MockBean;
 import org.springframework.context.annotation.Import;
 
 import javax.annotation.Resource;
+import java.util.List;
 import java.util.Map;
 
 import static cn.iocoder.yudao.framework.common.util.object.ObjectUtils.cloneIgnoreId;
@@ -21,7 +22,9 @@ import static cn.iocoder.yudao.framework.test.core.util.AssertUtils.assertServic
 import static cn.iocoder.yudao.framework.test.core.util.RandomUtils.*;
 import static cn.iocoder.yudao.module.system.enums.ErrorCodeConstants.MAIL_ACCOUNT_NOT_EXISTS;
 import static org.junit.jupiter.api.Assertions.*;
+import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
 
 /**
 * {@link MailAccountServiceImpl} 的单元测试类
@@ -107,6 +110,8 @@ public class MailAccountServiceImplTest extends BaseDbUnitTest {
         mailAccountMapper.insert(dbMailAccount);// @Sql: 先插入出一条存在的数据
         // 准备参数
         Long id = dbMailAccount.getId();
+        // mock 方法（无关联模版）
+        when(mailTemplateService.countByAccountId(eq(id))).thenReturn(0L);
 
         // 调用
         mailAccountService.deleteMailAccount(id);
@@ -115,6 +120,21 @@ public class MailAccountServiceImplTest extends BaseDbUnitTest {
         verify(mailProducer).sendMailAccountRefreshMessage();
     }
 
+    @Test
+    public void testGetMailAccountFromCache() {
+        // mock 数据
+        MailAccountDO dbMailAccount = randomPojo(MailAccountDO.class);
+        mailAccountMapper.insert(dbMailAccount);// @Sql: 先插入出一条存在的数据
+        mailAccountService.initLocalCache();
+        // 准备参数
+        Long id = dbMailAccount.getId();
+
+        // 调用
+        MailAccountDO mailAccount = mailAccountService.getMailAccountFromCache(id);
+        // 断言
+        assertPojoEquals(dbMailAccount, mailAccount);
+    }
+
     @Test
     public void testDeleteMailAccount_notExists() {
         // 准备参数
@@ -149,4 +169,35 @@ public class MailAccountServiceImplTest extends BaseDbUnitTest {
        assertPojoEquals(dbMailAccount, pageResult.getList().get(0));
     }
 
+    @Test
+    public void testGetMailAccount() {
+        // mock 数据
+        MailAccountDO dbMailAccount = randomPojo(MailAccountDO.class);
+        mailAccountMapper.insert(dbMailAccount);// @Sql: 先插入出一条存在的数据
+        // 准备参数
+        Long id = dbMailAccount.getId();
+
+        // 调用
+        MailAccountDO mailAccount = mailAccountService.getMailAccount(id);
+        // 断言
+        assertPojoEquals(dbMailAccount, mailAccount);
+    }
+
+    @Test
+    public void testGetMailAccountList() {
+        // mock 数据
+        MailAccountDO dbMailAccount01 = randomPojo(MailAccountDO.class);
+        mailAccountMapper.insert(dbMailAccount01);
+        MailAccountDO dbMailAccount02 = randomPojo(MailAccountDO.class);
+        mailAccountMapper.insert(dbMailAccount02);
+        // 准备参数
+
+        // 调用
+        List<MailAccountDO> list = mailAccountService.getMailAccountList();
+        // 断言
+        assertEquals(2, list.size());
+        assertPojoEquals(dbMailAccount01, list.get(0));
+        assertPojoEquals(dbMailAccount02, list.get(1));
+    }
+
 }

yudao-module-system/yudao-module-system-biz/src/test/java/cn/iocoder/yudao/module/system/service/mail/MailLogServiceImplTest.java

@@ -116,6 +116,20 @@ public class MailLogServiceImplTest extends BaseDbUnitTest {
         assertEquals("NullPointerException: 测试异常", dbLog.getSendException());
     }
 
+    @Test
+    public void testGetMailLog() {
+        // mock 数据
+        MailLogDO dbMailLog = randomPojo(MailLogDO.class, o -> o.setTemplateParams(randomTemplateParams()));
+        mailLogMapper.insert(dbMailLog);
+        // 准备参数
+        Long id = dbMailLog.getId();
+
+        // 调用
+        MailLogDO mailLog = mailLogService.getMailLog(id);
+        // 断言
+        assertPojoEquals(dbMailLog, mailLog);
+    }
+
     @Test
     public void testGetMailLogPage() {
        // mock 数据

yudao-module-system/yudao-module-system-biz/src/test/java/cn/iocoder/yudao/module/system/service/mail/MailTemplateServiceImplTest.java

@@ -14,6 +14,8 @@ import org.springframework.boot.test.mock.mockito.MockBean;
 import org.springframework.context.annotation.Import;
 
 import javax.annotation.Resource;
+import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 
 import static cn.iocoder.yudao.framework.common.util.date.LocalDateTimeUtils.buildBetweenTime;
@@ -25,6 +27,7 @@ import static cn.iocoder.yudao.framework.test.core.util.RandomUtils.randomLongId
 import static cn.iocoder.yudao.framework.test.core.util.RandomUtils.randomPojo;
 import static cn.iocoder.yudao.module.system.enums.ErrorCodeConstants.MAIL_TEMPLATE_NOT_EXISTS;
 import static org.junit.jupiter.api.Assertions.*;
+import static org.mockito.Mockito.verify;
 
 /**
 * {@link MailTemplateServiceImpl} 的单元测试类
@@ -70,6 +73,7 @@ public class MailTemplateServiceImplTest extends BaseDbUnitTest {
         // 校验记录的属性是否正确
         MailTemplateDO mailTemplate = mailTemplateMapper.selectById(mailTemplateId);
         assertPojoEquals(reqVO, mailTemplate);
+        verify(mailProducer).sendMailTemplateRefreshMessage();
     }
 
     @Test
@@ -87,6 +91,7 @@ public class MailTemplateServiceImplTest extends BaseDbUnitTest {
         // 校验是否更新正确
         MailTemplateDO mailTemplate = mailTemplateMapper.selectById(reqVO.getId()); // 获取最新的
         assertPojoEquals(reqVO, mailTemplate);
+        verify(mailProducer).sendMailTemplateRefreshMessage();
     }
 
     @Test
@@ -110,6 +115,7 @@ public class MailTemplateServiceImplTest extends BaseDbUnitTest {
         mailTemplateService.deleteMailTemplate(id);
         // 校验数据不存在了
         assertNull(mailTemplateMapper.selectById(id));
+        verify(mailProducer).sendMailTemplateRefreshMessage();
     }
 
     @Test
@@ -158,4 +164,77 @@ public class MailTemplateServiceImplTest extends BaseDbUnitTest {
        assertPojoEquals(dbMailTemplate, pageResult.getList().get(0));
     }
 
+    @Test
+    public void testGetMailTemplateList() {
+        // mock 数据
+        MailTemplateDO dbMailTemplate01 = randomPojo(MailTemplateDO.class);
+        mailTemplateMapper.insert(dbMailTemplate01);
+        MailTemplateDO dbMailTemplate02 = randomPojo(MailTemplateDO.class);
+        mailTemplateMapper.insert(dbMailTemplate02);
+
+        // 调用
+        List<MailTemplateDO> list = mailTemplateService.getMailTemplateList();
+        // 断言
+        assertEquals(2, list.size());
+        assertEquals(dbMailTemplate01, list.get(0));
+        assertEquals(dbMailTemplate02, list.get(1));
+    }
+
+    @Test
+    public void testGetTemplate() {
+        // mock 数据
+        MailTemplateDO dbMailTemplate = randomPojo(MailTemplateDO.class);
+        mailTemplateMapper.insert(dbMailTemplate);
+        // 准备参数
+        Long id = dbMailTemplate.getId();
+
+        // 调用
+        MailTemplateDO mailTemplate = mailTemplateService.getMailTemplate(id);
+        // 断言
+        assertPojoEquals(dbMailTemplate, mailTemplate);
+    }
+
+    @Test
+    public void testGetMailTemplateByCodeFromCache() {
+        // mock 数据
+        MailTemplateDO dbMailTemplate = randomPojo(MailTemplateDO.class);
+        mailTemplateMapper.insert(dbMailTemplate);
+        mailTemplateService.initLocalCache();
+        // 准备参数
+        String code = dbMailTemplate.getCode();
+
+        // 调用
+        MailTemplateDO mailTemplate = mailTemplateService.getMailTemplateByCodeFromCache(code);
+        // 断言
+        assertPojoEquals(dbMailTemplate, mailTemplate);
+    }
+
+    @Test
+    public void testFormatMailTemplateContent() {
+        // 准备参数
+        Map<String, Object> params = new HashMap<>();
+        params.put("name", "小红");
+        params.put("what", "饭");
+
+        // 调用，并断言
+        assertEquals("小红，你好，饭吃了吗？",
+                mailTemplateService.formatMailTemplateContent("{name}，你好，{what}吃了吗？", params));
+    }
+
+    @Test
+    public void testCountByAccountId() {
+        // mock 数据
+        MailTemplateDO dbMailTemplate = randomPojo(MailTemplateDO.class);
+        mailTemplateMapper.insert(dbMailTemplate);
+        // 测试 accountId 不匹配
+        mailTemplateMapper.insert(cloneIgnoreId(dbMailTemplate, o -> o.setAccountId(2L)));
+        // 准备参数
+        Long accountId = dbMailTemplate.getAccountId();
+
+        // 调用
+        long count = mailTemplateService.countByAccountId(accountId);
+        // 断言
+        assertEquals(1, count);
+    }
+
 }