[inlong] branch master updated: [INLONG-5359][Manager] Add query workflow approver API (#5360)

[he...@apache.org]

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

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


The following commit(s) were added to refs/heads/master by this push:
     new bb578afe8 [INLONG-5359][Manager] Add query workflow approver API (#5360)
bb578afe8 is described below

commit bb578afe87712c2e0155d2c37a0627841bf66740
Author: ciscozhou <45...@users.noreply.github.com>
AuthorDate: Fri Aug 5 10:33:58 2022 +0800

    [INLONG-5359][Manager] Add query workflow approver API (#5360)
---
 .../inlong/manager/common/enums/ErrorCodeEnum.java |  1 +
 .../service/core/WorkflowApproverService.java      |  8 ++++
 .../core/impl/WorkflowApproverServiceImpl.java     | 15 ++++++-
 .../workflow/WorkflowApproverServiceImplTest.java  | 50 ++++++++++++++++++++++
 .../web/controller/WorkflowApproverController.java | 19 +++++---
 5 files changed, 85 insertions(+), 8 deletions(-)

diff --git a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/enums/ErrorCodeEnum.java b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/enums/ErrorCodeEnum.java
index 891d995a8..ce24b12ee 100644
--- a/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/enums/ErrorCodeEnum.java
+++ b/inlong-manager/manager-common/src/main/java/org/apache/inlong/manager/common/enums/ErrorCodeEnum.java
@@ -111,6 +111,7 @@ public enum ErrorCodeEnum {
     MQ_TYPE_NOT_SUPPORT(1601, "MQ type '%s' not support"),
 
     WORKFLOW_EXE_FAILED(4000, "Workflow execution exception"),
+    WORKFLOW_APPROVER_NOT_FOUND(4001, "Workflow approver does not exist/no operation authority"),
 
     CONSUMER_GROUP_DUPLICATED(2600, "The consumer group already exists"),
     CONSUMER_GROUP_CREATE_FAILED(2601, "Failed to create TubeMQ consumer group"),
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/WorkflowApproverService.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/WorkflowApproverService.java
index 3ceec795e..72f3ded2c 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/WorkflowApproverService.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/WorkflowApproverService.java
@@ -35,6 +35,14 @@ public interface WorkflowApproverService {
      */
     Integer save(ApproverRequest request, String operator);
 
+    /**
+     * Get workflow approver by ID
+     *
+     * @param id approver id
+     * @return approver info
+     */
+    ApproverResponse get(Integer id);
+
     /**
      * Get process approver by the process name and task name.
      *
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/WorkflowApproverServiceImpl.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/WorkflowApproverServiceImpl.java
index 9dace9df9..8675702a6 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/WorkflowApproverServiceImpl.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/core/impl/WorkflowApproverServiceImpl.java
@@ -20,12 +20,12 @@ package org.apache.inlong.manager.service.core.impl;
 import org.apache.inlong.manager.common.consts.InlongConstants;
 import org.apache.inlong.manager.common.enums.ErrorCodeEnum;
 import org.apache.inlong.manager.common.exceptions.BusinessException;
-import org.apache.inlong.manager.pojo.workflow.ApproverRequest;
-import org.apache.inlong.manager.pojo.workflow.ApproverResponse;
 import org.apache.inlong.manager.common.util.CommonBeanUtils;
 import org.apache.inlong.manager.common.util.Preconditions;
 import org.apache.inlong.manager.dao.entity.WorkflowApproverEntity;
 import org.apache.inlong.manager.dao.mapper.WorkflowApproverEntityMapper;
+import org.apache.inlong.manager.pojo.workflow.ApproverRequest;
+import org.apache.inlong.manager.pojo.workflow.ApproverResponse;
 import org.apache.inlong.manager.service.core.WorkflowApproverService;
 import org.apache.inlong.manager.workflow.core.ProcessDefinitionService;
 import org.apache.inlong.manager.workflow.definition.UserTask;
@@ -77,6 +77,17 @@ public class WorkflowApproverServiceImpl implements WorkflowApproverService {
         return entity.getId();
     }
 
+    @Override
+    public ApproverResponse get(Integer id) {
+        Preconditions.checkNotNull(id, "approver id cannot be null");
+        WorkflowApproverEntity approverEntity = workflowApproverMapper.selectById(id);
+        if (approverEntity == null) {
+            LOGGER.error("workflow approver not found by id={}", id);
+            throw new BusinessException(ErrorCodeEnum.WORKFLOW_APPROVER_NOT_FOUND);
+        }
+        return CommonBeanUtils.copyProperties(approverEntity, ApproverResponse::new);
+    }
+
     @Override
     public List<String> getApprovers(String processName, String taskName) {
         ApproverRequest approverRequest = ApproverRequest.builder()
diff --git a/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/workflow/WorkflowApproverServiceImplTest.java b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/workflow/WorkflowApproverServiceImplTest.java
new file mode 100644
index 000000000..0a90e77d4
--- /dev/null
+++ b/inlong-manager/manager-service/src/test/java/org/apache/inlong/manager/service/workflow/WorkflowApproverServiceImplTest.java
@@ -0,0 +1,50 @@
+/*
+ * 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.inlong.manager.service.workflow;
+
+import org.apache.inlong.manager.pojo.workflow.ApproverRequest;
+import org.apache.inlong.manager.pojo.workflow.ApproverResponse;
+import org.apache.inlong.manager.service.ServiceBaseTest;
+import org.apache.inlong.manager.service.core.impl.WorkflowApproverServiceImpl;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+
+import java.util.List;
+
+/**
+ * Test class for workflow approver service.
+ */
+public class WorkflowApproverServiceImplTest extends ServiceBaseTest {
+
+    @Autowired
+    protected WorkflowApproverServiceImpl workflowApproverService;
+
+    @Test
+    public void testListAndGet() {
+        // The workflow approvers was init by SQL file.
+        List<ApproverResponse> approverList = workflowApproverService.listByCondition(
+                ApproverRequest.builder().build());
+        Assertions.assertTrue(approverList.size() > 0);
+
+        Integer id = approverList.get(0).getId();
+        ApproverResponse approverResponse = workflowApproverService.get(id);
+        Assertions.assertEquals(id, approverResponse.getId());
+    }
+
+}
diff --git a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/WorkflowApproverController.java b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/WorkflowApproverController.java
index bfdfcff02..e0d1acad4 100644
--- a/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/WorkflowApproverController.java
+++ b/inlong-manager/manager-web/src/main/java/org/apache/inlong/manager/web/controller/WorkflowApproverController.java
@@ -18,8 +18,8 @@
 package org.apache.inlong.manager.web.controller;
 
 import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
 import io.swagger.annotations.ApiOperation;
-import io.swagger.annotations.ApiParam;
 import org.apache.inlong.manager.common.enums.OperationType;
 import org.apache.inlong.manager.pojo.common.Response;
 import org.apache.inlong.manager.pojo.workflow.ApproverRequest;
@@ -49,22 +49,29 @@ public class WorkflowApproverController {
     @Autowired
     private WorkflowApproverService workflowApproverService;
 
-    @PostMapping("/workflow/approver/add")
+    @PostMapping("/workflow/approver/save")
     @OperationLog(operation = OperationType.CREATE)
-    @ApiOperation(value = "Save workflow approver")
+    @ApiOperation(value = "Save approver info")
     public Response<Integer> save(@RequestBody ApproverRequest config) {
         return Response.success(workflowApproverService.save(config, LoginUserUtils.getLoginUser().getName()));
     }
 
+    @GetMapping(value = "/workflow/approver/get/{id}")
+    @ApiOperation(value = "Get approver by ID")
+    @ApiImplicitParam(name = "id", value = "Workflow approver ID", dataTypeClass = Integer.class, required = true)
+    public Response<ApproverResponse> get(@PathVariable Integer id) {
+        return Response.success(workflowApproverService.get(id));
+    }
+
     @GetMapping("/workflow/approver/list")
     @ApiOperation(value = "List workflow approvers")
     public Response<List<ApproverResponse>> listByCondition(ApproverRequest request) {
         return Response.success(workflowApproverService.listByCondition(request));
     }
 
-    @PostMapping("/workflow/approver/update/{id}")
+    @PostMapping("/workflow/approver/update")
     @OperationLog(operation = OperationType.UPDATE)
-    @ApiOperation(value = "Update workflow approver")
+    @ApiOperation(value = "Update approver info")
     public Response<Integer> update(@RequestBody ApproverRequest request) {
         return Response.success(workflowApproverService.update(request, LoginUserUtils.getLoginUser().getName()));
     }
@@ -72,7 +79,7 @@ public class WorkflowApproverController {
     @DeleteMapping("/workflow/approver/delete/{id}")
     @OperationLog(operation = OperationType.DELETE)
     @ApiOperation(value = "Delete approver by ID")
-    @ApiParam(value = "Approver info ID", required = true)
+    @ApiImplicitParam(name = "id", value = "Workflow approver ID", dataTypeClass = Integer.class, required = true)
     public Response<Boolean> delete(@PathVariable Integer id) {
         workflowApproverService.delete(id, LoginUserUtils.getLoginUser().getName());
         return Response.success(true);