This is an automated email from the ASF dual-hosted git repository.

zhengqiwei pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/hertzbeat.git


The following commit(s) were added to refs/heads/master by this push:
     new 7ac21d317 [improve] Add GeneralConfigTypeEnum. (#2555)
7ac21d317 is described below

commit 7ac21d31712849847b7b7901d28e6337bafd5d90
Author: b_mountain <[email protected]>
AuthorDate: Mon Aug 19 00:41:49 2024 +0800

    [improve] Add GeneralConfigTypeEnum. (#2555)
    
    Co-authored-by: Calvin <[email protected]>
---
 .../common/constants/GeneralConfigTypeEnum.java    | 54 ++++++++++++++++++++++
 .../service/impl/MailGeneralConfigServiceImpl.java |  3 +-
 .../service/impl/ObjectStoreConfigServiceImpl.java |  3 +-
 .../service/impl/SmsGeneralConfigServiceImpl.java  |  3 +-
 .../impl/SystemGeneralConfigServiceImpl.java       |  3 +-
 .../service/impl/SystemSecretServiceImpl.java      |  3 +-
 .../service/impl/TemplateConfigServiceImpl.java    |  3 +-
 .../manager/service/ConfigServiceTest.java         | 16 ++++---
 .../service/MailGeneralConfigServiceTest.java      |  3 +-
 .../service/ObjectStoreConfigServiceTest.java      |  3 +-
 .../service/SmsGeneralConfigServiceTest.java       |  3 +-
 .../service/SystemGeneralConfigServiceTest.java    |  3 +-
 .../manager/service/SystemSecretServiceTest.java   |  3 +-
 .../manager/service/TemplateConfigServiceTest.java |  3 +-
 14 files changed, 87 insertions(+), 19 deletions(-)

diff --git 
a/common/src/main/java/org/apache/hertzbeat/common/constants/GeneralConfigTypeEnum.java
 
b/common/src/main/java/org/apache/hertzbeat/common/constants/GeneralConfigTypeEnum.java
new file mode 100644
index 000000000..6d8d0d74e
--- /dev/null
+++ 
b/common/src/main/java/org/apache/hertzbeat/common/constants/GeneralConfigTypeEnum.java
@@ -0,0 +1,54 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.hertzbeat.common.constants;
+
+/**
+ * General Config Type Enum
+ */
+public enum GeneralConfigTypeEnum {
+
+    /**
+     * template config
+     */
+    template,
+
+    /**
+     * system secret config
+     */
+    secret,
+
+    /**
+     * sms general config
+     */
+    sms,
+
+    /**
+     * system config
+     */
+    system,
+
+    /**
+     * mail general config
+     */
+    email,
+
+    /**
+     * system store config
+     */
+    oss;
+}
diff --git 
a/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/MailGeneralConfigServiceImpl.java
 
b/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/MailGeneralConfigServiceImpl.java
index aac05ad6b..4397e1729 100644
--- 
a/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/MailGeneralConfigServiceImpl.java
+++ 
b/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/MailGeneralConfigServiceImpl.java
@@ -20,6 +20,7 @@ package org.apache.hertzbeat.manager.service.impl;
 import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import java.lang.reflect.Type;
+import org.apache.hertzbeat.common.constants.GeneralConfigTypeEnum;
 import org.apache.hertzbeat.manager.dao.GeneralConfigDao;
 import org.apache.hertzbeat.manager.pojo.dto.EmailNoticeSender;
 import org.springframework.stereotype.Service;
@@ -46,7 +47,7 @@ public class MailGeneralConfigServiceImpl extends 
AbstractGeneralConfigServiceIm
     
     @Override
     public String type() {
-        return "email";
+        return GeneralConfigTypeEnum.email.name();
     }
     
     /**
diff --git 
a/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/ObjectStoreConfigServiceImpl.java
 
b/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/ObjectStoreConfigServiceImpl.java
index 5a0dd1424..9682935d8 100644
--- 
a/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/ObjectStoreConfigServiceImpl.java
+++ 
b/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/ObjectStoreConfigServiceImpl.java
@@ -23,6 +23,7 @@ import com.obs.services.ObsClient;
 import java.lang.reflect.Type;
 import javax.annotation.Resource;
 import lombok.extern.slf4j.Slf4j;
+import org.apache.hertzbeat.common.constants.GeneralConfigTypeEnum;
 import org.apache.hertzbeat.manager.dao.GeneralConfigDao;
 import org.apache.hertzbeat.manager.pojo.dto.ObjectStoreConfigChangeEvent;
 import org.apache.hertzbeat.manager.pojo.dto.ObjectStoreDTO;
@@ -63,7 +64,7 @@ public class ObjectStoreConfigServiceImpl extends
 
     @Override
     public String type() {
-        return "oss";
+        return GeneralConfigTypeEnum.oss.name();
     }
 
     @Override
diff --git 
a/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/SmsGeneralConfigServiceImpl.java
 
b/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/SmsGeneralConfigServiceImpl.java
index ebd8da365..c7cd36475 100644
--- 
a/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/SmsGeneralConfigServiceImpl.java
+++ 
b/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/SmsGeneralConfigServiceImpl.java
@@ -20,6 +20,7 @@ package org.apache.hertzbeat.manager.service.impl;
 import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import java.lang.reflect.Type;
+import org.apache.hertzbeat.common.constants.GeneralConfigTypeEnum;
 import org.apache.hertzbeat.manager.dao.GeneralConfigDao;
 import org.apache.hertzbeat.manager.pojo.dto.SmsNoticeSender;
 import org.springframework.stereotype.Service;
@@ -46,7 +47,7 @@ public class SmsGeneralConfigServiceImpl extends 
AbstractGeneralConfigServiceImp
     
     @Override
     public String type() {
-        return "sms";
+        return GeneralConfigTypeEnum.sms.name();
     }
     
     /**
diff --git 
a/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/SystemGeneralConfigServiceImpl.java
 
b/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/SystemGeneralConfigServiceImpl.java
index 5d2b629a9..396721afe 100644
--- 
a/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/SystemGeneralConfigServiceImpl.java
+++ 
b/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/SystemGeneralConfigServiceImpl.java
@@ -22,6 +22,7 @@ import com.fasterxml.jackson.databind.ObjectMapper;
 import jakarta.annotation.Resource;
 import java.lang.reflect.Type;
 import java.util.Objects;
+import org.apache.hertzbeat.common.constants.GeneralConfigTypeEnum;
 import org.apache.hertzbeat.common.support.event.SystemConfigChangeEvent;
 import org.apache.hertzbeat.common.util.TimeZoneUtil;
 import org.apache.hertzbeat.manager.dao.GeneralConfigDao;
@@ -60,7 +61,7 @@ public class SystemGeneralConfigServiceImpl extends 
AbstractGeneralConfigService
     
     @Override
     public String type() {
-        return "system";
+        return GeneralConfigTypeEnum.system.name();
     }
     
     @Override
diff --git 
a/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/SystemSecretServiceImpl.java
 
b/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/SystemSecretServiceImpl.java
index 4c25b12ad..2915298dd 100644
--- 
a/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/SystemSecretServiceImpl.java
+++ 
b/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/SystemSecretServiceImpl.java
@@ -20,6 +20,7 @@ package org.apache.hertzbeat.manager.service.impl;
 import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import java.lang.reflect.Type;
+import org.apache.hertzbeat.common.constants.GeneralConfigTypeEnum;
 import org.apache.hertzbeat.manager.dao.GeneralConfigDao;
 import org.apache.hertzbeat.manager.pojo.dto.SystemSecret;
 import org.springframework.stereotype.Service;
@@ -43,7 +44,7 @@ public class SystemSecretServiceImpl extends 
AbstractGeneralConfigServiceImpl<Sy
     
     @Override
     public String type() {
-        return "secret";
+        return GeneralConfigTypeEnum.secret.name();
     }
     
     @Override
diff --git 
a/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/TemplateConfigServiceImpl.java
 
b/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/TemplateConfigServiceImpl.java
index 099e794d3..492918ca2 100644
--- 
a/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/TemplateConfigServiceImpl.java
+++ 
b/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/TemplateConfigServiceImpl.java
@@ -21,6 +21,7 @@ import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import jakarta.annotation.Resource;
 import java.lang.reflect.Type;
+import org.apache.hertzbeat.common.constants.GeneralConfigTypeEnum;
 import org.apache.hertzbeat.manager.dao.GeneralConfigDao;
 import org.apache.hertzbeat.manager.pojo.dto.TemplateConfig;
 import org.apache.hertzbeat.manager.service.AppService;
@@ -55,7 +56,7 @@ public class TemplateConfigServiceImpl extends 
AbstractGeneralConfigServiceImpl<
     
     @Override
     public String type() {
-        return "template";
+        return GeneralConfigTypeEnum.template.name();
     }
     
     @Override
diff --git 
a/manager/src/test/java/org/apache/hertzbeat/manager/service/ConfigServiceTest.java
 
b/manager/src/test/java/org/apache/hertzbeat/manager/service/ConfigServiceTest.java
index ed7f1ac4e..af7e16136 100644
--- 
a/manager/src/test/java/org/apache/hertzbeat/manager/service/ConfigServiceTest.java
+++ 
b/manager/src/test/java/org/apache/hertzbeat/manager/service/ConfigServiceTest.java
@@ -25,6 +25,8 @@ import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 import java.util.ArrayList;
 import java.util.List;
+
+import org.apache.hertzbeat.common.constants.GeneralConfigTypeEnum;
 import org.apache.hertzbeat.manager.pojo.dto.EmailNoticeSender;
 import org.apache.hertzbeat.manager.pojo.dto.ObjectStoreDTO;
 import org.apache.hertzbeat.manager.pojo.dto.TemplateConfig;
@@ -57,9 +59,9 @@ public class ConfigServiceTest {
     @BeforeEach
     public void setUp() {
         List<GeneralConfigService> generalConfigServices = new ArrayList<>();
-        when(objectStoreConfigService.type()).thenReturn("oss");
-        when(templateConfigService.type()).thenReturn("template");
-        when(mailGeneralConfigService.type()).thenReturn("mail");
+        
when(objectStoreConfigService.type()).thenReturn(GeneralConfigTypeEnum.oss.name());
+        
when(templateConfigService.type()).thenReturn(GeneralConfigTypeEnum.template.name());
+        
when(mailGeneralConfigService.type()).thenReturn(GeneralConfigTypeEnum.email.name());
         generalConfigServices.add(objectStoreConfigService);
         generalConfigServices.add(templateConfigService);
         generalConfigServices.add(mailGeneralConfigService);
@@ -68,10 +70,10 @@ public class ConfigServiceTest {
 
     @Test
     public void testSaveConfig() {
-        configService.saveConfig("oss", new ObjectStoreDTO<>());
+        configService.saveConfig(GeneralConfigTypeEnum.oss.name(), new 
ObjectStoreDTO<>());
         verify(objectStoreConfigService, 
times(1)).saveConfig(any(ObjectStoreDTO.class));
 
-        configService.saveConfig("mail", new EmailNoticeSender());
+        configService.saveConfig(GeneralConfigTypeEnum.email.name(), new 
EmailNoticeSender());
         verify(mailGeneralConfigService, 
times(1)).saveConfig(any(EmailNoticeSender.class));
     }
 
@@ -79,11 +81,11 @@ public class ConfigServiceTest {
     public void testGetConfig() {
         ObjectStoreDTO ossConfig = new ObjectStoreDTO<>();
         when(objectStoreConfigService.getConfig()).thenReturn(ossConfig);
-        assertNotNull(configService.getConfig("oss"));
+        
assertNotNull(configService.getConfig(GeneralConfigTypeEnum.oss.name()));
 
         EmailNoticeSender emailNoticeSender = new EmailNoticeSender();
         
when(mailGeneralConfigService.getConfig()).thenReturn(emailNoticeSender);
-        configService.getConfig("mail");
+        configService.getConfig(GeneralConfigTypeEnum.email.name());
         verify(mailGeneralConfigService, times(1)).getConfig();
     }
 
diff --git 
a/manager/src/test/java/org/apache/hertzbeat/manager/service/MailGeneralConfigServiceTest.java
 
b/manager/src/test/java/org/apache/hertzbeat/manager/service/MailGeneralConfigServiceTest.java
index 5a9fc3454..9a7a662c4 100644
--- 
a/manager/src/test/java/org/apache/hertzbeat/manager/service/MailGeneralConfigServiceTest.java
+++ 
b/manager/src/test/java/org/apache/hertzbeat/manager/service/MailGeneralConfigServiceTest.java
@@ -19,6 +19,7 @@ package org.apache.hertzbeat.manager.service;
 
 import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import org.apache.hertzbeat.common.constants.GeneralConfigTypeEnum;
 import org.apache.hertzbeat.manager.dao.GeneralConfigDao;
 import org.apache.hertzbeat.manager.pojo.dto.EmailNoticeSender;
 import org.apache.hertzbeat.manager.service.impl.MailGeneralConfigServiceImpl;
@@ -54,7 +55,7 @@ class MailGeneralConfigServiceTest {
        @Test
        void testType() {
 
-               assertEquals("email", mailGeneralConfigService.type());
+               assertEquals(GeneralConfigTypeEnum.email.name(), 
mailGeneralConfigService.type());
        }
 
        @Test
diff --git 
a/manager/src/test/java/org/apache/hertzbeat/manager/service/ObjectStoreConfigServiceTest.java
 
b/manager/src/test/java/org/apache/hertzbeat/manager/service/ObjectStoreConfigServiceTest.java
index 95f123ffb..d9a008788 100644
--- 
a/manager/src/test/java/org/apache/hertzbeat/manager/service/ObjectStoreConfigServiceTest.java
+++ 
b/manager/src/test/java/org/apache/hertzbeat/manager/service/ObjectStoreConfigServiceTest.java
@@ -18,6 +18,7 @@
 package org.apache.hertzbeat.manager.service;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
+import org.apache.hertzbeat.common.constants.GeneralConfigTypeEnum;
 import org.apache.hertzbeat.manager.pojo.dto.ObjectStoreConfigChangeEvent;
 import org.apache.hertzbeat.manager.pojo.dto.ObjectStoreDTO;
 import org.apache.hertzbeat.manager.service.impl.ObjectStoreConfigServiceImpl;
@@ -66,7 +67,7 @@ class ObjectStoreConfigServiceTest {
        void testGetType() {
 
                String type = objectStoreConfigService.type();
-               assertEquals("oss", type);
+               assertEquals(GeneralConfigTypeEnum.oss.name(), type);
        }
 
        @Test
diff --git 
a/manager/src/test/java/org/apache/hertzbeat/manager/service/SmsGeneralConfigServiceTest.java
 
b/manager/src/test/java/org/apache/hertzbeat/manager/service/SmsGeneralConfigServiceTest.java
index ab98888a9..2a1e8be3c 100644
--- 
a/manager/src/test/java/org/apache/hertzbeat/manager/service/SmsGeneralConfigServiceTest.java
+++ 
b/manager/src/test/java/org/apache/hertzbeat/manager/service/SmsGeneralConfigServiceTest.java
@@ -19,6 +19,7 @@ package org.apache.hertzbeat.manager.service;
 
 import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import org.apache.hertzbeat.common.constants.GeneralConfigTypeEnum;
 import org.apache.hertzbeat.manager.dao.GeneralConfigDao;
 import org.apache.hertzbeat.manager.pojo.dto.SmsNoticeSender;
 import org.apache.hertzbeat.manager.service.impl.SmsGeneralConfigServiceImpl;
@@ -60,7 +61,7 @@ class SmsGeneralConfigServiceTest {
        @Test
        void testType() {
                String result = service.type();
-               assertEquals("sms", result);
+               assertEquals(GeneralConfigTypeEnum.sms.name(), result);
        }
 
        @Test
diff --git 
a/manager/src/test/java/org/apache/hertzbeat/manager/service/SystemGeneralConfigServiceTest.java
 
b/manager/src/test/java/org/apache/hertzbeat/manager/service/SystemGeneralConfigServiceTest.java
index 942928f3f..defb241b0 100644
--- 
a/manager/src/test/java/org/apache/hertzbeat/manager/service/SystemGeneralConfigServiceTest.java
+++ 
b/manager/src/test/java/org/apache/hertzbeat/manager/service/SystemGeneralConfigServiceTest.java
@@ -19,6 +19,7 @@ package org.apache.hertzbeat.manager.service;
 
 import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import org.apache.hertzbeat.common.constants.GeneralConfigTypeEnum;
 import org.apache.hertzbeat.manager.dao.GeneralConfigDao;
 import org.apache.hertzbeat.manager.pojo.dto.SystemConfig;
 import 
org.apache.hertzbeat.manager.service.impl.SystemGeneralConfigServiceImpl;
@@ -58,7 +59,7 @@ class SystemGeneralConfigServiceTest {
        void testType() {
 
                String result = service.type();
-               assertEquals("system", result);
+               assertEquals(GeneralConfigTypeEnum.system.name(), result);
        }
 
        @Test
diff --git 
a/manager/src/test/java/org/apache/hertzbeat/manager/service/SystemSecretServiceTest.java
 
b/manager/src/test/java/org/apache/hertzbeat/manager/service/SystemSecretServiceTest.java
index 688847e3c..21f1986dc 100644
--- 
a/manager/src/test/java/org/apache/hertzbeat/manager/service/SystemSecretServiceTest.java
+++ 
b/manager/src/test/java/org/apache/hertzbeat/manager/service/SystemSecretServiceTest.java
@@ -19,6 +19,7 @@ package org.apache.hertzbeat.manager.service;
 
 import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import org.apache.hertzbeat.common.constants.GeneralConfigTypeEnum;
 import org.apache.hertzbeat.manager.dao.GeneralConfigDao;
 import org.apache.hertzbeat.manager.pojo.dto.SystemSecret;
 import org.apache.hertzbeat.manager.service.impl.SystemSecretServiceImpl;
@@ -54,7 +55,7 @@ class SystemSecretServiceTest {
        @Test
        void testType() {
 
-               assertEquals("secret", systemSecretService.type());
+               assertEquals(GeneralConfigTypeEnum.secret.name(), 
systemSecretService.type());
        }
 
        @Test
diff --git 
a/manager/src/test/java/org/apache/hertzbeat/manager/service/TemplateConfigServiceTest.java
 
b/manager/src/test/java/org/apache/hertzbeat/manager/service/TemplateConfigServiceTest.java
index 81ba4f6dd..872167d5b 100644
--- 
a/manager/src/test/java/org/apache/hertzbeat/manager/service/TemplateConfigServiceTest.java
+++ 
b/manager/src/test/java/org/apache/hertzbeat/manager/service/TemplateConfigServiceTest.java
@@ -18,6 +18,7 @@
 package org.apache.hertzbeat.manager.service;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
+import org.apache.hertzbeat.common.constants.GeneralConfigTypeEnum;
 import org.apache.hertzbeat.manager.dao.GeneralConfigDao;
 import org.apache.hertzbeat.manager.pojo.dto.TemplateConfig;
 import org.apache.hertzbeat.manager.service.impl.TemplateConfigServiceImpl;
@@ -88,7 +89,7 @@ class TemplateConfigServiceTest {
        void testType() {
 
                String type = templateConfigServiceImpl.type();
-               assertEquals("template", type);
+               assertEquals(GeneralConfigTypeEnum.template.name(), type);
        }
 
 }


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to