Merge pull request #345 from FlowCI/feature/1433

load default template from url

Author: gy2006

core/pom.xml

@@ -129,11 +129,6 @@
       <artifactId>springfox-swagger-ui</artifactId>
     </dependency>
 
-    <dependency>
-      <groupId>org.apache.velocity</groupId>
-      <artifactId>velocity-engine-core</artifactId>
-    </dependency>
-
     <dependency>
       <groupId>com.cronutils</groupId>
       <artifactId>cron-utils</artifactId>

core/src/main/java/com/flowci/core/common/config/AppConfig.java

@@ -21,7 +21,10 @@
 import com.flowci.core.common.helper.JacksonHelper;
 import com.flowci.util.FileHelper;
 import lombok.extern.log4j.Log4j2;
+import org.apache.http.client.HttpClient;
+import org.apache.http.client.config.RequestConfig;
 import org.apache.http.client.utils.URIBuilder;
+import org.apache.http.impl.client.HttpClientBuilder;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.autoconfigure.web.servlet.MultipartProperties;
 import org.springframework.cache.annotation.EnableCaching;
@@ -91,6 +94,18 @@ public ObjectMapper objectMapper() {
         return JacksonHelper.create();
     }
 
+    @Bean("httpClient")
+    public HttpClient httpClient() {
+        int timeout = 10 * 1000;
+        RequestConfig config = RequestConfig.custom()
+                .setConnectTimeout(timeout)
+                .setConnectionRequestTimeout(timeout)
+                .setSocketTimeout(timeout)
+                .build();
+
+        return HttpClientBuilder.create().setDefaultRequestConfig(config).build();
+    }
+
     @Bean(name = "applicationEventMulticaster")
     public ApplicationEventMulticaster simpleApplicationEventMulticaster() {
         SimpleApplicationEventMulticaster multicaster = new SimpleApplicationEventMulticaster() {

core/src/main/java/com/flowci/core/common/config/AppProperties.java

@@ -72,6 +72,12 @@ public Zookeeper zk() {
         return new Zookeeper();
     }
 
+    @Bean("flowProperties")
+    @ConfigurationProperties(prefix = "app.flow")
+    public Flow flow() {
+        return new Flow();
+    }
+
     @Bean("jobProperties")
     @ConfigurationProperties(prefix = "app.job")
     public Job job() {
@@ -114,6 +120,12 @@ public static class Admin {
         private String defaultPassword;
     }
 
+    @Data
+    public static class Flow {
+
+        private String defaultTemplateUrl;
+    }
+
     @Data
     public static class Job {
 

core/src/main/java/com/flowci/core/flow/config/FlowConfig.java

@@ -16,18 +16,22 @@
 
 package com.flowci.core.flow.config;
 
+import com.flowci.core.common.config.AppProperties;
 import com.flowci.core.common.helper.CacheHelper;
 import com.flowci.core.common.helper.ThreadHelper;
 import com.github.benmanes.caffeine.cache.Cache;
 import lombok.extern.log4j.Log4j2;
-import org.apache.velocity.Template;
-import org.apache.velocity.app.Velocity;
+import org.apache.http.HttpResponse;
+import org.apache.http.client.HttpClient;
+import org.apache.http.client.methods.HttpGet;
+import org.apache.http.util.EntityUtils;
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
 
+import java.io.IOException;
 import java.util.List;
-import java.util.Properties;
 
 /**
  * @author yang
@@ -36,28 +40,28 @@
 @Configuration
 public class FlowConfig {
 
-    private static final Properties templateProperties = new Properties();
+    @Autowired
+    private AppProperties.Flow flowProperties;
 
-    static {
-        templateProperties.setProperty("resource.loader", "class");
-        templateProperties.setProperty("class.resource.loader.class",
-                "org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader");
-
-        Velocity.init(templateProperties);
-    }
+    @Autowired
+    private HttpClient httpClient;
 
     @Bean("gitTestExecutor")
     public ThreadPoolTaskExecutor gitTestExecutor() {
         return ThreadHelper.createTaskExecutor(20, 20, 100, "git-test-");
     }
 
-    @Bean
-    public Template defaultYmlTemplate() {
-        return Velocity.getTemplate("templates/example.yml.vm");
-    }
-
     @Bean("gitBranchCache")
     public Cache<String, List<String>> gitBranchCache() {
         return CacheHelper.createLocalCache(50, 300);
     }
+
+    @Bean("defaultTemplateYml")
+    public String defaultTemplateYml() throws IOException {
+        String url = flowProperties.getDefaultTemplateUrl();
+        HttpResponse response = httpClient.execute(new HttpGet(url));
+        String yml = EntityUtils.toString(response.getEntity());
+        log.info("Default template yml is loaded from {}", url);
+        return yml;
+    }
 }

core/src/main/java/com/flowci/core/flow/service/YmlServiceImpl.java

@@ -32,8 +32,6 @@
 import com.flowci.tree.YmlParser;
 import com.flowci.util.StringHelper;
 import com.google.common.base.Strings;
-import org.apache.velocity.Template;
-import org.apache.velocity.VelocityContext;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.event.EventListener;
 import org.springframework.stereotype.Service;
@@ -51,7 +49,7 @@
 public class YmlServiceImpl implements YmlService {
 
     @Autowired
-    private Template defaultYmlTemplate;
+    private String defaultTemplateYml;
 
     @Autowired
     private YmlDao ymlDao;
@@ -115,7 +113,7 @@ public Yml saveYml(Flow flow, String yml) {
 
     @Override
     public Yml saveDefaultTemplate(Flow flow) {
-        return saveYml(flow, getTemplateYml());
+        return saveYml(flow, defaultTemplateYml);
     }
 
     //====================================================================
@@ -159,15 +157,4 @@ private Optional<RuntimeException> verifyPlugins(FlowNode flowNode) {
 
         return Optional.empty();
     }
-
-    private String getTemplateYml() {
-        VelocityContext context = new VelocityContext();
-
-        try (StringWriter sw = new StringWriter()) {
-            defaultYmlTemplate.merge(context, sw);
-            return sw.toString();
-        } catch (IOException e) {
-            return StringHelper.EMPTY;
-        }
-    }
 }

core/src/main/resources/flow.properties

@@ -14,6 +14,8 @@ app.auth.enabled=true
 app.auth.expire-seconds=7200
 app.auth.refresh-expired-seconds=14400
 
+app.flow.default-template-url=${FLOWCI_DEFAULT_TEMPLATE:https://raw.githubusercontent.com/FlowCI/templates/master/helloworld.yaml}
+
 app.job.retry-waiting-seconds=10
 
 app.plugin.default-repo=${FLOWCI_PLUGIN_URL:https://raw.githubusercontent.com/FlowCI/plugins/master/repository.json}

core/src/main/resources/templates/example.yml.vm

@@ -134,7 +134,7 @@ public void should_create_and_confirm_flow_with_git_template() {
         Assert.assertNotNull(yml);
 
         Node root = YmlParser.load("test", yml.getRaw());
-        Assert.assertEquals(1, root.getChildren().size());
+        Assert.assertTrue(root.getChildren().size() > 0);
 
         // then:
         List<Flow> flows = flowService.list(Status.CONFIRMED);

core/src/test/java/com/flowci/core/test/flow/FlowServiceTest.java

@@ -14,6 +14,8 @@ app.auth.enabled=false
 app.auth.expire-seconds=5
 app.auth.refresh-expired-seconds=7200
 
+app.flow.default-template-url=${FLOWCI_DEFAULT_TEMPLATE:https://raw.githubusercontent.com/FlowCI/templates/master/helloworld.yaml}
+
 app.job.retry-waiting-seconds=5
 
 app.plugin.default-repo=https://raw.githubusercontent.com/yang-guo-2016/flowci-plugins/master/plugin-repos.json
@@ -27,8 +29,8 @@ app.minio.secret = minio123
 
 app.rabbitmq.uri=amqp://guest:[email protected]:5672
 app.rabbitmq.callback-queue = flow.q.callback-test
-app.rabbitmq.shell-log-exchange = flow.ex.shelllog-test
-app.rabbitmq.tty-log-exchange = flow.ex.ttylog-test
+app.rabbitmq.shell-log-ex = flow.ex.shelllog-test
+app.rabbitmq.tty-log-ex = flow.ex.ttylog-test
 app.rabbitmq.job-dl-queue = flow.q.job-dl-test
 app.rabbitmq.job-dl-exchange = flow.ex.job-dl-test
 

core/src/test/resources/flow.properties

@@ -38,7 +38,6 @@
         <groovy-all.version>2.4.12</groovy-all.version>
         <docker-java.version>3.2.1</docker-java.version>
         <cron-utils.version>7.0.5</cron-utils.version>
-        <velocity-engine-core.version>2.1</velocity-engine-core.version>
         <amqp-client.version>5.9.0</amqp-client.version>
         <java-jwt.version>3.8.1</java-jwt.version>
         <minio.version>6.0.11</minio.version>
@@ -204,12 +203,6 @@
                 <version>${jackson.version}</version>
             </dependency>
 
-            <dependency>
-                <groupId>org.apache.velocity</groupId>
-                <artifactId>velocity-engine-core</artifactId>
-                <version>${velocity-engine-core.version}</version>
-            </dependency>
-
             <dependency>
                 <groupId>org.springframework.boot</groupId>
                 <artifactId>spring-boot-dependencies</artifactId>