add initial custom action implementation

Author: t2y

README.md

@@ -1,2 +1,50 @@
 # backlog-github-integration-action
-github integration action for Nulab's backlog
+
+This action helps integrate with [Nulab's backlog](https://nulab.com/products/backlog/) via GitHub events.
+
+Here are the features.
+
+* updates a Pull Request link into related issues when it has opened.
+
+## Precondition to run
+
+Set environment variables.
+
+```bash
+export APP_LOCALE="en_US"
+export APP_LOG_LEVEL="debug"
+export BACKLOG_FQDN="YOUR-SPACE.backlog.com"
+export BACKLOG_API_KEY="..."
+export BACKLOG_PROJECT_KEY="TEST"
+export GITHUB_TOKEN="..."
+```
+
+## How to run
+
+```bash
+$ ./gradlew run --args="pull_request --repository kazamori/backlog-github-integration-action --pr-number 1"
+```
+
+## for debugging
+
+### GitHub Client
+
+```bash
+$ ./gradlew githubClient --args='--repository kazamori/backlog-github-integration-action --pr-number 1'
+```
+
+### Backlog Client
+
+```bash
+$ ./gradlew backlogClient --args="--issue-id PROJECT-1"
+```
+
+```bash
+$ ./gradlew backlogClient --args='--issue-id PROJECT-3 --custom-field "MyTextField" --issue-comment "* comment from REST API"'
+```
+
+## How to test
+
+```bash
+$ ./gradlew test --info
+```

app/build.gradle

@@ -1,38 +1,65 @@
-/*
- * This file was generated by the Gradle 'init' task.
- *
- * This generated file contains a sample Java application project to get you started.
- * For more details take a look at the 'Building Java & JVM projects' chapter in the Gradle
- * User Manual available at https://docs.gradle.org/7.4/userguide/building_java_projects.html
- * This project uses @Incubating APIs which are subject to change.
- */
-
 plugins {
-    // Apply the application plugin to add support for building a CLI application in Java.
     id 'application'
 }
 
 repositories {
-    // Use Maven Central for resolving dependencies.
     mavenCentral()
 }
 
 dependencies {
-    // This dependency is used by the application.
+    // app
+    implementation 'com.nulab-inc:backlog4j:2.4.4'
+    implementation 'com.typesafe:config:1.4.2'
+    implementation 'info.picocli:picocli:4.6.3'
+    implementation 'org.kohsuke:github-api:1.303'
+
+    // logging
+    implementation 'org.slf4j:slf4j-api:1.7.36'
+    implementation 'org.slf4j:slf4j-simple:1.7.36'
+
+    // build
     implementation 'com.google.guava:guava:30.1.1-jre'
+    compileOnly 'org.projectlombok:lombok:1.18.22'
+    annotationProcessor 'org.projectlombok:lombok:1.18.22'
+
+    // testing
+    testCompileOnly 'org.projectlombok:lombok:1.18.22'
+    testAnnotationProcessor 'org.projectlombok:lombok:1.18.22'
+    // mock
+    testImplementation 'org.mockito:mockito-core:4.4.0'
+    testImplementation 'org.mockito:mockito-junit-jupiter:4.4.0'
 }
 
 testing {
     suites {
-        // Configure the built-in test suite
         test {
-            // Use JUnit Jupiter test framework
             useJUnitJupiter('5.8.1')
         }
     }
 }
 
 application {
-    // Define the main class for the application.
-    mainClass = 'jp.kazamori.github.actions.backlog.App'
+    mainClass = 'jp.kazamori.github.actions.backlog.Main'
+}
+
+task githubClient(type: JavaExec) {
+    mainClass = 'jp.kazamori.github.actions.backlog.cli.GitHubClientCli'
+    classpath = sourceSets.main.runtimeClasspath
+}
+
+task backlogClient(type: JavaExec) {
+    mainClass = 'jp.kazamori.github.actions.backlog.cli.BacklogClientCli'
+    classpath = sourceSets.main.runtimeClasspath
+}
+
+task config(type: JavaExec) {
+    mainClass = 'jp.kazamori.github.actions.backlog.cli.ConfigCli'
+    classpath = sourceSets.main.runtimeClasspath
+}
+
+tasks.withType(JavaExec) {
+    jvmArgs += '--add-opens'
+    jvmArgs += 'java.base/sun.net.www.protocol.https=ALL-UNNAMED'
+    jvmArgs += '--add-opens'
+    jvmArgs += 'java.base/java.net=ALL-UNNAMED'
 }

app/src/main/java/jp/kazamori/github/actions/backlog/App.java

@@ -0,0 +1,31 @@
+/*
+ * This Java source file was generated by the Gradle 'init' task.
+ */
+package jp.kazamori.github.actions.backlog;
+
+import com.typesafe.config.ConfigFactory;
+import jp.kazamori.github.actions.backlog.client.BacklogClientUtil;
+import jp.kazamori.github.actions.backlog.client.GitHubClient;
+import jp.kazamori.github.actions.backlog.command.PullRequest;
+import jp.kazamori.github.actions.backlog.config.ConfigUtil;
+import lombok.val;
+import picocli.CommandLine;
+import picocli.CommandLine.Command;
+import picocli.CommandLine.HelpCommand;
+
+@Command(name = "Backlog GitHub integration action",
+        subcommands = {HelpCommand.class},
+        description = "provides functionalities to integrate with Backlog")
+public class Main {
+
+    public static void main(String[] args) {
+        val config = ConfigFactory.load();
+        ConfigUtil.setLogLevel(config);
+        val backlogClient = BacklogClientUtil.createClient(config);
+        val githubClient = GitHubClient.create(config);
+        val exitCode = new CommandLine(new Main())
+                .addSubcommand(new PullRequest(backlogClient, githubClient))
+                .execute(args);
+        System.exit(exitCode);
+    }
+}

app/src/main/java/jp/kazamori/github/actions/backlog/Main.java

@@ -0,0 +1,77 @@
+package jp.kazamori.github.actions.backlog.cli;
+
+import com.nulabinc.backlog4j.api.option.AddIssueCommentParams;
+import com.nulabinc.backlog4j.api.option.UpdateIssueParams;
+import com.typesafe.config.Config;
+import com.typesafe.config.ConfigFactory;
+import jp.kazamori.github.actions.backlog.client.BacklogClientUtil;
+import jp.kazamori.github.actions.backlog.config.AppConst;
+import jp.kazamori.github.actions.backlog.config.ConfigUtil;
+import lombok.val;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import picocli.CommandLine;
+
+import java.util.Optional;
+
+@CommandLine.Command(name = "Backlog client debug cli",
+        description = "run backlog client for debugging")
+public class BacklogClientCli implements Runnable {
+    private final Logger logger = LoggerFactory.getLogger(BacklogClientCli.class);
+    private final Config config;
+
+    public BacklogClientCli(Config config) {
+        this.config = config;
+    }
+
+    @CommandLine.Option(names = "--issue-id",
+            required = true,
+            description = "set issue id associates with the pull request")
+    private String issueId;
+
+    @CommandLine.Option(names = "--issue-comment",
+            description = "set issue comment")
+    private Optional<String> issueComment;
+
+    @CommandLine.Option(names = "--issue-description",
+            description = "set issue description")
+    private Optional<String> issueDescription;
+
+    @CommandLine.Option(names = "--custom-field",
+            description = "set custom field name")
+    private Optional<String> customField;
+
+    @Override
+    public void run() {
+        val client = BacklogClientUtil.createClient(this.config);
+        val util = new BacklogClientUtil(this.config, client);
+        val issue = client.getIssue(this.issueId);
+        logger.info(" * summary: {}", issue.getSummary());
+
+        if (issueComment.isPresent()) {
+            val params = new AddIssueCommentParams(this.issueId, this.issueComment.get());
+            val comment = client.addIssueComment(params);
+            logger.info(" * comment id: {}", comment.getId());
+        }
+
+        if (issueDescription.isPresent()) {
+            val desc = issue.getDescription();
+            val params = new UpdateIssueParams(this.issueId)
+                    .description(desc + "\n" + this.issueDescription.get());
+            val updated = client.updateIssue(params);
+            logger.info("Updated issue description:\n{}", updated.getDescription());
+        }
+
+        if (customField.isPresent()) {
+            val customFieldName = this.customField.get();
+            util.updateCustomFieldOfIssue(issue, customFieldName, this.issueComment.get());
+        }
+    }
+
+    public static void main(String[] args) {
+        val config = ConfigFactory.load(AppConst.LOCAL_DEV_CONF);
+        ConfigUtil.setLogLevel(config);
+        val exitCode = new CommandLine(new BacklogClientCli(config)).execute(args);
+        System.exit(exitCode);
+    }
+}

app/src/main/java/jp/kazamori/github/actions/backlog/cli/BacklogClientCli.java

@@ -0,0 +1,50 @@
+package jp.kazamori.github.actions.backlog.cli;
+
+import com.typesafe.config.Config;
+import com.typesafe.config.ConfigFactory;
+import jp.kazamori.github.actions.backlog.config.*;
+import lombok.val;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import picocli.CommandLine;
+
+@CommandLine.Command(name = "Loading config file debug cli",
+        description = "load config file for debugging")
+public class ConfigCli implements Runnable {
+    private final Logger logger = LoggerFactory.getLogger(ConfigCli.class);
+    private final Config config;
+
+    public ConfigCli(Config config) {
+        this.config = config;
+    }
+
+    @Override
+    public void run() {
+        // app
+        logger.info(" * app.locale: {}", this.config.getString(AppConfigKey.LOCALE.get()));
+        logger.info(" * app.logLevel: {}", this.config.getString(AppConfigKey.LOG_LEVEL.get()));
+        // backlog
+        logger.info(" * backlog.apiKey: {}", this.config.getString(BacklogConfigKey.API_KEY.get()));
+        logger.info(" * backlog.fqdn: {}", this.config.getString(BacklogConfigKey.FQDN.get()));
+        logger.info(" * backlog.projectKey: {}", this.config.getString(BacklogConfigKey.PROJECT_KEY.get()));
+        // github
+        logger.info(" * github.token: {}", this.config.getString(GitHubConfigKey.TOKEN.get()));
+        logger.info("");
+
+        // util
+        logger.trace(" * trace message");
+        logger.debug(" * debug message");
+        logger.info(" * info message");
+        logger.warn(" * warn message");
+        logger.error(" * error message");
+        val locale = ConfigUtil.getLocale(this.config);
+        logger.info(" * locale: {}", locale);
+    }
+
+    public static void main(String[] args) {
+        val config = ConfigFactory.load(AppConst.LOCAL_DEV_CONF);
+        ConfigUtil.setLogLevel(config);
+        val exitCode = new CommandLine(new ConfigCli(config)).execute(args);
+        System.exit(exitCode);
+    }
+}

app/src/main/java/jp/kazamori/github/actions/backlog/cli/ConfigCli.java

@@ -0,0 +1,48 @@
+package jp.kazamori.github.actions.backlog.cli;
+
+import com.typesafe.config.Config;
+import com.typesafe.config.ConfigFactory;
+import jp.kazamori.github.actions.backlog.client.GitHubClient;
+import jp.kazamori.github.actions.backlog.config.AppConst;
+import jp.kazamori.github.actions.backlog.config.ConfigUtil;
+import lombok.val;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import picocli.CommandLine;
+
+@CommandLine.Command(name = "Github client debug cli",
+        description = "run github client for debugging")
+public class GitHubClientCli implements Runnable {
+    private final Logger logger = LoggerFactory.getLogger(GitHubClientCli.class);
+    private final Config config;
+
+    public GitHubClientCli(Config config) {
+        this.config = config;
+    }
+
+    @CommandLine.Option(names = "--repository",
+            required = true,
+            description = "set repository (owner/repo) that the pull request was created")
+    private String repository;
+
+    @CommandLine.Option(names = "--pr-number",
+            required = true,
+            description = "set number of the pull request was created")
+    private int prNumber;
+
+    @Override
+    public void run() {
+        val locale = ConfigUtil.getLocale(this.config);
+        val client = GitHubClient.create(this.config);
+        val info = client.getIssueIds(this.repository, this.prNumber);
+        logger.info(" * link: {}", info.makeLink());
+        logger.info(" * comment: {}", info.makeComment(locale));
+    }
+
+    public static void main(String[] args) {
+        val config = ConfigFactory.load(AppConst.LOCAL_DEV_CONF);
+        ConfigUtil.setLogLevel(config);
+        val exitCode = new CommandLine(new GitHubClientCli(config)).execute(args);
+        System.exit(exitCode);
+    }
+}