add git settings controller

Author: gy2006

core/src/main/java/com/flowci/core/flow/controller/GitController.java

@@ -21,7 +21,7 @@
 import com.flowci.core.flow.domain.FlowAction;
 import com.flowci.core.flow.domain.FlowGitTest;
 import com.flowci.core.flow.service.FlowService;
-import com.flowci.core.flow.service.GitService;
+import com.flowci.core.flow.service.GitConnService;
 import com.flowci.util.StringHelper;
 import java.util.List;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -44,7 +44,7 @@ public class GitController {
     private FlowService flowService;
 
     @Autowired
-    private GitService gitService;
+    private GitConnService gitConnService;
 
     @PostMapping(value = "/{name}/git/test")
     @Action(FlowAction.GIT_TEST)
@@ -53,26 +53,26 @@ public void gitTest(@PathVariable String name, @Validated @RequestBody FlowGitTe
         String gitUrl = body.getGitUrl();
 
         if (body.hasCredential()) {
-            gitService.testConn(flow, gitUrl, body.getSecret());
+            gitConnService.testConn(flow, gitUrl, body.getSecret());
             return;
         }
 
         if (body.hasPrivateKey()) {
-            gitService.testConn(flow, gitUrl, body.getRsa());
+            gitConnService.testConn(flow, gitUrl, body.getRsa());
             return;
         }
 
         if (body.hasUsernamePassword()) {
-            gitService.testConn(flow, gitUrl, body.getAuth());
+            gitConnService.testConn(flow, gitUrl, body.getAuth());
         }
 
-        gitService.testConn(flow, gitUrl, StringHelper.EMPTY);
+        gitConnService.testConn(flow, gitUrl, StringHelper.EMPTY);
     }
 
     @GetMapping(value = "/{name}/git/branches")
     @Action(FlowAction.LIST_BRANCH)
     public List<String> listGitBranches(@PathVariable String name) {
         Flow flow = flowService.get(name);
-        return gitService.listGitBranch(flow);
+        return gitConnService.listGitBranch(flow);
     }
 }

core/src/main/java/com/flowci/core/flow/service/GitService.java renamed to core/src/main/java/com/flowci/core/flow/service/GitConnService.java

@@ -25,7 +25,7 @@
 /**
  * @author yang
  */
-public interface GitService {
+public interface GitConnService {
 
     /**
      * Test git connection for http or ssh with credential

core/src/main/java/com/flowci/core/flow/service/GitServiceImpl.java renamed to core/src/main/java/com/flowci/core/flow/service/GitConnServiceImpl.java

@@ -45,8 +45,8 @@
  * @author yang
  */
 @Log4j2
-@Service
-public class GitServiceImpl implements GitService {
+@Service("gitConnService")
+public class GitConnServiceImpl implements GitConnService {
 
     @Autowired
     private TaskExecutor appTaskExecutor;

core/src/main/java/com/flowci/core/git/client/GitAPIClient.java

@@ -1,8 +1,9 @@
 package com.flowci.core.git.client;
 
 import com.flowci.core.git.domain.GitCommitStatus;
+import com.flowci.core.secret.domain.Secret;
 
 public interface GitAPIClient {
 
-    void writeCommitStatus(GitCommitStatus commit);
+    void writeCommitStatus(GitCommitStatus commit, Secret secret);
 }

core/src/main/java/com/flowci/core/git/client/GithubAPIClient.java

@@ -3,16 +3,15 @@
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
-import com.flowci.core.git.dao.GitSettingsDao;
 import com.flowci.core.git.domain.GitCommit;
 import com.flowci.core.git.domain.GitCommitStatus;
 import com.flowci.core.git.domain.GitRepo;
-import com.flowci.core.git.domain.GitSettings;
+import com.flowci.core.secret.domain.Secret;
+import com.flowci.core.secret.domain.TokenSecret;
+import com.flowci.exception.ArgumentException;
 import com.flowci.exception.CIException;
-import com.flowci.exception.NotFoundException;
 import com.flowci.exception.UnsupportedException;
 import lombok.extern.log4j.Log4j2;
-import org.springframework.stereotype.Component;
 import org.springframework.web.util.UriTemplate;
 
 import java.net.URI;
@@ -23,7 +22,6 @@
 import java.util.Objects;
 
 @Log4j2
-@Component("githubClient")
 public class GithubAPIClient implements GitAPIClient {
 
     private final static UriTemplate HttpTemplate = new UriTemplate("https://github.com/{owner}/{repo}.git");
@@ -34,21 +32,23 @@ public class GithubAPIClient implements GitAPIClient {
 
     private final static String CommitStatusAPI = "https://api.github.com/repos/%s/%s/statuses/%s";
 
-    private final GitSettingsDao gitSettingsDao;
-
     private final HttpClient httpClient;
 
     private final ObjectMapper objectMapper;
 
-    public GithubAPIClient(GitSettingsDao gitSettingsDao, HttpClient httpClient, ObjectMapper objectMapper) {
-        this.gitSettingsDao = gitSettingsDao;
+    public GithubAPIClient(HttpClient httpClient, ObjectMapper objectMapper) {
         this.httpClient = httpClient;
         this.objectMapper = objectMapper;
     }
 
     @Override
-    public void writeCommitStatus(GitCommitStatus commit) {
-        GitRepo repo = getRepo(commit);
+    public void writeCommitStatus(GitCommitStatus commit, Secret secret) {
+        if (!(secret instanceof TokenSecret)) {
+            throw new ArgumentException("Token secret is required");
+        }
+
+        var tokenSecret = (TokenSecret) secret;
+        var repo = getRepo(commit);
 
         var body = new GitCommitPostBody();
         body.state = commit.getStatus();
@@ -57,7 +57,7 @@ public void writeCommitStatus(GitCommitStatus commit) {
 
         try {
             var api = String.format(CommitStatusAPI, repo.getOwner(), repo.getOwner(), commit.getId());
-            var request = getRequestBuilder(api)
+            var request = getRequestBuilder(api, tokenSecret.getTokenData())
                     .POST(HttpRequest.BodyPublishers.ofString(objectMapper.writeValueAsString(body)))
                     .build();
 
@@ -69,18 +69,10 @@ public void writeCommitStatus(GitCommitStatus commit) {
         }
     }
 
-    private HttpRequest.Builder getRequestBuilder(String url) {
-        var optional = gitSettingsDao.findByKey(GitSettings.Key);
-        if (optional.isEmpty()) {
-            throw new NotFoundException("Git settings is missing");
-        }
-
-        var tokenSecret = optional.get().getGitHubTokenSecret();
-        Objects.requireNonNull(tokenSecret, "Github token secret is missing");
-
+    private HttpRequest.Builder getRequestBuilder(String url, String token) {
         return HttpRequest.newBuilder(URI.create(url))
                 .setHeader("Accept", "application/vnd.github.v3+json")
-                .setHeader("Authorization", "token " + tokenSecret);
+                .setHeader("Authorization", "token " + token);
     }
 
     private static class GitCommitPostBody {

core/src/main/java/com/flowci/core/git/controller/GitSettingsController.java

@@ -0,0 +1,30 @@
+package com.flowci.core.git.controller;
+
+import com.flowci.core.common.domain.GitSource;
+import com.flowci.core.git.domain.GitSettings;
+import com.flowci.core.git.service.GitService;
+import com.flowci.exception.UnsupportedException;
+import lombok.extern.log4j.Log4j2;
+import org.springframework.beans.factory.annotation.Autowired;
+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.RestController;
+
+@Log4j2
+@RestController
+@RequestMapping("/gitsettings")
+public class GitSettingsController {
+
+    @Autowired
+    private GitService gitService;
+
+    @PostMapping("/save")
+    public GitSettings save(@RequestBody Request.SaveOptions options) {
+        if (options.getSource() == GitSource.GITHUB) {
+            return gitService.saveGithubSecret(options.getSecret());
+        }
+
+        throw new UnsupportedException("Unsupported git source");
+    }
+}

core/src/main/java/com/flowci/core/git/controller/Request.java

@@ -0,0 +1,24 @@
+package com.flowci.core.git.controller;
+
+import com.flowci.core.common.domain.GitSource;
+import lombok.Getter;
+import lombok.Setter;
+
+import javax.validation.constraints.NotEmpty;
+import javax.validation.constraints.NotNull;
+
+public abstract class Request {
+
+    @Getter
+    @Setter
+    public static class SaveOptions {
+
+        @NotNull
+        private GitSource source;
+
+        @NotEmpty
+        private String secret;
+
+    }
+
+}

core/src/main/java/com/flowci/core/git/domain/GitSettings.java

@@ -15,7 +15,7 @@ public class GitSettings {
     private String id;
 
     @Indexed(unique = true)
-    private String key;
+    private String key = Key;
 
     private String gitHubTokenSecret;
 }

core/src/main/java/com/flowci/core/git/service/GitService.java

@@ -1,5 +1,8 @@
 package com.flowci.core.git.service;
 
+import com.flowci.core.git.domain.GitSettings;
+
 public interface GitService {
 
+    GitSettings saveGithubSecret(String secret);
 }

core/src/main/java/com/flowci/core/git/service/GitServiceImpl.java

@@ -1,33 +1,77 @@
 package com.flowci.core.git.service;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
 import com.flowci.core.common.domain.GitSource;
+import com.flowci.core.common.manager.SpringEventManager;
 import com.flowci.core.git.client.GitAPIClient;
+import com.flowci.core.git.client.GithubAPIClient;
+import com.flowci.core.git.dao.GitSettingsDao;
 import com.flowci.core.git.domain.GitCommitStatus;
+import com.flowci.core.git.domain.GitSettings;
 import com.flowci.core.job.domain.Job;
 import com.flowci.core.job.event.JobFinishedEvent;
 import com.flowci.core.job.util.JobContextHelper;
+import com.flowci.core.secret.domain.Secret;
+import com.flowci.core.secret.domain.TokenSecret;
+import com.flowci.core.secret.event.GetSecretEvent;
+import com.flowci.exception.ArgumentException;
 import com.flowci.util.StringHelper;
 import lombok.extern.log4j.Log4j2;
-import org.jvnet.hk2.annotations.Service;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.event.EventListener;
+import org.springframework.dao.DuplicateKeyException;
+import org.springframework.stereotype.Service;
 
 import javax.annotation.PostConstruct;
+import java.net.http.HttpClient;
 import java.util.HashMap;
 import java.util.Map;
 
 @Log4j2
-@Service
+@Service("gitService")
 public class GitServiceImpl implements GitService {
 
     @Autowired
-    private GitAPIClient githubClient;
+    private HttpClient httpClient;
 
-    private final Map<GitSource, GitAPIClient> clients = new HashMap<>(5);
+    @Autowired
+    private ObjectMapper objectMapper;
+
+    @Autowired
+    private GitSettingsDao gitSettingsDao;
+
+    @Autowired
+    private SpringEventManager eventManager;
+
+    private final Map<GitSource, ActionHandler> actions = new HashMap<>(5);
 
     @PostConstruct
     public void init() {
-        clients.put(GitSource.GITHUB, githubClient);
+        actions.put(GitSource.GITHUB, new GitHubActionHandler());
+
+        var optional = gitSettingsDao.findByKey(GitSettings.Key);
+        if (optional.isEmpty()) {
+            try {
+                gitSettingsDao.save(new GitSettings());
+            } catch (DuplicateKeyException ignore) {
+                // ignore the duplicate git settings key
+            }
+        }
+    }
+
+    @Override
+    public GitSettings saveGithubSecret(String secretName) {
+        var event = eventManager.publish(new GetSecretEvent(this, secretName));
+        var event1 = eventManager.publish(new GetSecretEvent(this, secretName));
+        Secret secret = event1.getFetched();
+
+        if (!(secret instanceof TokenSecret)) {
+            throw new ArgumentException("Token secret is required");
+        }
+
+        var settings = loadGitSettings();
+        settings.setGitHubTokenSecret(secretName);
+        return gitSettingsDao.save(settings);
     }
 
     @EventListener
@@ -40,22 +84,54 @@ public void onJobFinishEvent(JobFinishedEvent event) {
             return;
         }
 
-        var commit = new GitCommitStatus();
-        commit.setId(JobContextHelper.getCommitId(job));
-        commit.setUrl(JobContextHelper.getGitUrl(job));
-        commit.setTargetUrl(JobContextHelper.getJobUrl(job));
-        commit.setStatus(JobContextHelper.getStatus(job).name().toLowerCase());
-        commit.setDesc(String.format("build %s from flow.ci", commit.getStatus()));
-
         try {
             var source = GitSource.valueOf(gitSourceStr);
-            var apiClient = clients.get(source);
+            var handler = actions.get(source);
 
-            if (apiClient != null) {
-                apiClient.writeCommitStatus(commit);
+            if (handler == null) {
+                return;
             }
+
+            var commit = new GitCommitStatus();
+            commit.setId(JobContextHelper.getCommitId(job));
+            commit.setUrl(JobContextHelper.getGitUrl(job));
+            commit.setTargetUrl(JobContextHelper.getJobUrl(job));
+            commit.setStatus(JobContextHelper.getStatus(job).name().toLowerCase());
+            commit.setDesc(String.format("build %s from flow.ci", commit.getStatus()));
+
+            handler.write(commit);
         } catch (Throwable e) {
             log.warn(e.getMessage());
         }
     }
+
+    private GitSettings loadGitSettings() {
+        return gitSettingsDao.findByKey(GitSettings.Key).get();
+    }
+
+    private interface ActionHandler {
+        void write(GitCommitStatus commit);
+    }
+
+    private class GitHubActionHandler implements ActionHandler {
+
+        private final GitAPIClient client = new GithubAPIClient(httpClient, objectMapper);
+
+        @Override
+        public void write(GitCommitStatus commit) {
+            var settings = loadGitSettings();
+            String secretName = settings.getGitHubTokenSecret();
+
+            var event = eventManager.publish(new GetSecretEvent(GitServiceImpl.this, secretName));
+            Secret secret = event.getFetched();
+
+            if (!(secret instanceof TokenSecret)) {
+                throw new ArgumentException("Token secret is required");
+            }
+
+            TokenSecret tokenSecret = (TokenSecret) secret;
+            client.writeCommitStatus(commit, tokenSecret);
+        }
+    }
+
 }