Merge pull request #136 from FlowCI/feature/api/import_export_yml

Feature/api/import export yml

Author: yang.guo

platform-api/src/main/java/com/flow/platform/api/controller/FlowController.java

@@ -27,20 +27,26 @@
 import com.flow.platform.api.security.WebSecurity;
 import com.flow.platform.api.service.GitService;
 import com.flow.platform.api.service.node.YmlService;
+import com.flow.platform.api.util.CommonUtil;
 import com.flow.platform.core.exception.IllegalParameterException;
 import com.flow.platform.util.StringUtil;
 import com.google.common.base.Strings;
+import java.io.IOException;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
+import javax.servlet.http.HttpServletResponse;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.core.io.Resource;
 import org.springframework.web.bind.annotation.DeleteMapping;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RequestPart;
 import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.multipart.MultipartFile;
 
 /**
  * @author yh@firim
@@ -416,6 +422,53 @@ public String createFromYml(@RequestBody(required = false) String yml) {
         return yml;
     }
 
+    /**
+     * @api {post} /flows/:root/yml/upload upload yml
+     * @apiParam {String} root flow node name to set yml content
+     * @apiParam file
+     * @apiGroup Flow Yml
+     * @apiDescription Create yml for flow,
+     * the flow name must be matched with flow name defined in yml
+     *
+     * @apiSuccessExample {json} Success-Response
+     *
+     *  yml body
+     */
+    @PostMapping("/{root}/yml/upload")
+    @WebSecurity(action = Actions.FLOW_CREATE)
+    public String createFromUploadYml(@RequestPart MultipartFile file) throws IOException {
+        String yml = CommonUtil.commonsMultipartFileToString(file);
+        if (Strings.isNullOrEmpty(yml)) {
+            throw new IllegalParameterException("file is not available");
+        }
+
+        nodeService.createOrUpdateYml(currentNodePath.get(), yml);
+        return yml;
+    }
+
+
+    /**
+     * @api {post} /flows/:root/yml/download download yml
+     * @apiParam {String} root flow node name to set yml content
+     * @apiGroup Flow Yml
+     * @apiDescription download yml for flow,
+     * the flow name must be matched with flow name defined in yml
+     *
+     * @apiSuccessExample {json} Success-Response
+     *
+     *  yml file
+     */
+    @GetMapping("/{root}/yml/download")
+    @WebSecurity(action = Actions.FLOW_CREATE)
+    public Resource downloadFlowYml(HttpServletResponse httpResponse) {
+        String path = currentNodePath.get();
+        Node root = nodeService.find(path).root();
+        httpResponse.setHeader(
+            "Content-Disposition",
+            String.format("attachment; filename=%s", ".flow.yml"));
+        return ymlService.getResource(root);
+    }
+
     /**
      * @api {post} /flows/:root/users/auth
      * @apiParam {String} root flow node name
@@ -481,7 +534,7 @@ public List<User> flowAuthUsers(@RequestBody ListParam<String> listParam) {
      *      }
      */
     @PostMapping("/{root}/trigger")
-    public Node trigger(@RequestBody TriggerParam triggerParam){
+    public Node trigger(@RequestBody TriggerParam triggerParam) {
         String path = currentNodePath.get();
         Node flow = nodeService.find(path).root();
         envService.save(flow, triggerParam.toEnv(), true);

platform-api/src/main/java/com/flow/platform/api/service/node/YmlService.java

@@ -20,6 +20,7 @@
 import com.flow.platform.api.domain.node.Yml;
 import com.flow.platform.api.domain.request.ThreadConfigParam;
 import java.util.function.Consumer;
+import org.springframework.core.io.Resource;
 
 /**
  * @author yang
@@ -48,6 +49,13 @@ public interface YmlService {
      */
     Yml get(Node root);
 
+    /**
+     * yml content to resource
+     * @param root
+     * @return
+     */
+    Resource getResource(Node root);
+
     /**
      * Load yml content from git repo in async and create tree from yml,
      * Then call "get" to get yml

platform-api/src/main/java/com/flow/platform/api/service/node/YmlServiceImpl.java

@@ -16,6 +16,7 @@
 
 package com.flow.platform.api.service.node;
 
+import com.flow.platform.api.config.AppConfig;
 import com.flow.platform.api.dao.YmlDao;
 import com.flow.platform.api.domain.credential.Credential;
 import com.flow.platform.api.domain.credential.CredentialType;
@@ -36,17 +37,22 @@
 import com.flow.platform.core.context.ContextEvent;
 import com.flow.platform.core.exception.IllegalParameterException;
 import com.flow.platform.core.exception.IllegalStatusException;
+import com.flow.platform.core.exception.NotFoundException;
 import com.flow.platform.core.util.ThreadUtil;
 import com.flow.platform.util.Logger;
 import com.flow.platform.util.git.model.GitSource;
 import com.google.common.base.Strings;
 import com.google.common.cache.Cache;
 import com.google.common.cache.CacheBuilder;
+import java.io.ByteArrayInputStream;
+import java.io.InputStream;
 import java.util.Map;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.TimeUnit;
 import java.util.function.Consumer;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.core.io.InputStreamResource;
+import org.springframework.core.io.Resource;
 import org.springframework.core.task.TaskRejectedException;
 import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
 import org.springframework.stereotype.Service;
@@ -110,6 +116,21 @@ public Yml get(final Node root) {
         return ymlDao.get(root.getPath());
     }
 
+    @Override
+    public Resource getResource(Node root) {
+
+        Yml yml = ymlDao.get(root.getPath());
+        String body = yml.getFile();
+        Resource allResource;
+        try (InputStream is = new ByteArrayInputStream(body.getBytes(AppConfig.DEFAULT_CHARSET))) {
+            allResource = new InputStreamResource(is);
+        } catch (Throwable throwable) {
+            throw new NotFoundException("yml not found");
+        }
+
+        return allResource;
+    }
+
     @Override
     public Node startLoad(final Node root, final Consumer<Yml> onSuccess, final Consumer<Throwable> onError) {
         if (!EnvUtil.hasRequiredEnvKey(root, GitService.REQUIRED_ENVS)) {

platform-api/src/main/java/com/flow/platform/api/util/CommonUtil.java

@@ -16,10 +16,14 @@
 
 package com.flow.platform.api.util;
 
+import com.flow.platform.api.config.AppConfig;
+import java.io.InputStream;
 import java.math.BigInteger;
 import java.time.LocalDateTime;
 import java.time.format.DateTimeFormatter;
 import java.util.UUID;
+import org.apache.commons.io.IOUtils;
+import org.springframework.web.multipart.MultipartFile;
 
 /**
  * @author yh@firim
@@ -39,4 +43,18 @@ public synchronized static BigInteger randomId() {
         return new BigInteger(stringBuilder.append(uuid).toString());
     }
 
+
+    /**
+     * read commonsMultipartFile content to String
+     * @param file
+     * @return
+     */
+    public static String commonsMultipartFileToString(MultipartFile file) {
+        try (InputStream is = file.getInputStream()) {
+            return IOUtils.toString(is, AppConfig.DEFAULT_CHARSET.name());
+        } catch (Throwable throwable) {
+            return null;
+        }
+    }
+
 }

platform-api/src/test/java/com/flow/platform/api/test/controller/FlowControllerTest.java

@@ -16,6 +16,7 @@
 
 package com.flow.platform.api.test.controller;
 
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.fileUpload;
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
 import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print;
@@ -28,10 +29,12 @@
 import com.flow.platform.api.util.PathUtil;
 import com.flow.platform.core.response.ResponseError;
 import com.flow.platform.util.StringUtil;
+import java.io.IOException;
 import org.junit.Assert;
 import org.junit.Before;
 import org.junit.Test;
 import org.springframework.http.MediaType;
+import org.springframework.mock.web.MockMultipartFile;
 import org.springframework.test.web.servlet.MvcResult;
 import org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder;
 
@@ -167,4 +170,37 @@ public void should_return_empty_string_if_no_yml_content() throws Throwable {
         // then:
         Assert.assertEquals(StringUtil.EMPTY, content);
     }
+
+    @Test
+    public void should_upload_yml_success() throws Exception {
+        String url = "/flows/" + flowName + "/yml/upload";
+        performRequestWith200Status(fileUpload(url)
+            .file(createYmlFilePart(".flow.yml"))
+        );
+
+        MockHttpServletRequestBuilder request = get("/flows/" + flowName)
+            .contentType(MediaType.APPLICATION_JSON);
+
+        MvcResult result = mockMvc.perform(request).andExpect(status().isOk()).andReturn();
+        Node flowNode = Node.parse(result.getResponse().getContentAsString(), Node.class);
+        Assert.assertEquals("FOUND", flowNode.getEnv(FlowEnvs.FLOW_YML_STATUS));
+    }
+
+    @Test
+    public void should_download_yml_success() throws Exception {
+        String url = "/flows/" + flowName + "/yml/upload";
+        performRequestWith200Status(fileUpload(url)
+            .file(createYmlFilePart(".flow.yml"))
+        );
+
+        MockHttpServletRequestBuilder request = get("/flows/" + flowName + "/yml/download")
+            .contentType(MediaType.ALL);
+        MvcResult result = mockMvc.perform(request).andExpect(status().isOk()).andReturn();
+        Assert.assertNotNull(result.getResponse());
+    }
+
+    private MockMultipartFile createYmlFilePart(String name) throws IOException {
+        String resourceContent = getResourceContent("demo_flow.yaml");
+        return new MockMultipartFile("file", name, "", resourceContent.getBytes());
+    }
 }