Merge pull request #56 from takezoe/build-file-in-repos

Makes possible to use a file in the git repository to build

Author: takezoe

README.md

@@ -35,7 +35,8 @@ In addition, this plug-in is made to just experiment continuous integration on G
 
 Plugin version | GitBucket version
 :--------------|:--------------------
-1.4.x -        | 4.23.x -
+1.5.x -        | 4.23.1 -
+1.4.x -        | 4.23.0
 1.3.x -        | 4.19.x -
 1.0.x - 1.2.x  | 4.17.x, 4.18.x
 
@@ -49,6 +50,11 @@ Run `sbt assembly` and copy generated `/target/scala-2.12/gitbucket-ci-plugin-as
 
 ## Release Notes
 
+### 1.5.0
+
+- Build branches even other than the default branch
+- Support the use of an arbitrary file in the git repository as a build script
+
 ### 1.4.0
 
 - Max parallel builds and max stored history became configurable

src/main/resources/update/gitbucket-ci_1.5.0.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<changeSet>
+    <addColumn tableName="CI_CONFIG">
+        <column name="BUILD_TYPE" type="varchar(200)" nullable="true"/>
+    </addColumn>
+    <update tableName="CI_CONFIG">
+        <column name="BUILD_TYPE" value="script"/>
+    </update>
+</changeSet>

src/main/scala/Plugin.scala

@@ -52,7 +52,9 @@ class Plugin extends gitbucket.core.plugin.Plugin with CIService with AccountSer
     new Version("1.2.1"),
     new Version("1.3.0"),
     new Version("1.4.0",
-      new LiquibaseMigration("update/gitbucket-ci_1.4.0.xml"))
+      new LiquibaseMigration("update/gitbucket-ci_1.4.0.xml")),
+    new Version("1.5.0",
+      new LiquibaseMigration("update/gitbucket-ci_1.5.0.xml"))
   )
 
   override val assetsMappings = Seq("/ci" -> "/gitbucket/ci/assets")

src/main/scala/io/github/gitbucket/ci/controller/CIController.scala

@@ -43,7 +43,9 @@ object CIController {
 
   case class BuildConfigForm(
     enableBuild: Boolean,
+    buildType: Option[String],
     buildScript: Option[String],
+    buildFile: Option[String],
     notification: Boolean,
     skipWords: Option[String],
     runWords: Option[String]
@@ -63,7 +65,9 @@ class CIController extends ControllerBase
 
   val buildConfigForm = mapping(
     "enableBuild" -> trim(label("Enable build", boolean())),
-    "buildScript" -> trim(label("Build script", optional(text()))),
+    "buildType" -> trim(label("Build type", optionalRequiredIfChecked("enableBuild", text()))),
+    "buildScript" -> trim(label("Build script", optionalRequired(_("buildType") == Seq("script"), text()))),
+    "buildFile" -> trim(label("Build file", optionalRequired(_("buildType") == Seq("file"), text()))),
     "notification" -> trim(label("Notification", boolean())),
     "skipWords" -> trim(label("Skip words", optional(text()))),
     "runWords" -> trim(label("Run words", optional(text())))
@@ -293,12 +297,17 @@ class CIController extends ControllerBase
 
   post("/:owner/:repository/settings/build", buildConfigForm)(ownerOnly { (form, repository) =>
     if(form.enableBuild){
-      // TODO buildScript is required!!
+      val buildType = form.buildType.getOrElse("script")
       saveCIConfig(repository.owner, repository.name, Some(
         CIConfig(
           repository.owner,
           repository.name,
-          form.buildScript.getOrElse(""),
+          buildType,
+          (buildType match {
+            case "script" => form.buildScript.getOrElse("")
+            case "file" => form.buildFile.getOrElse("")
+            case _ => ""
+          }),
           form.notification,
           form.skipWords,
           form.runWords

src/main/scala/io/github/gitbucket/ci/manager/BuildJobThread.scala

@@ -112,7 +112,7 @@ class BuildJobThread(queue: LinkedBlockingQueue[BuildJob], threads: LinkedBlocki
           }
 
           // run script
-          val command = prepareBuildScript(buildDir, job.config.buildScript)
+          val command = prepareBuildScript(buildDir, job.config.buildType, job.config.buildScript)
           val process = Process(command, dir,
             "CI"                   -> "true",
             "HOME"                 -> buildDir.getAbsolutePath,
@@ -256,17 +256,29 @@ class BuildJobThread(queue: LinkedBlockingQueue[BuildJob], threads: LinkedBlocki
     runningProcess.get.foreach(_.destroy())
   }
 
-  private def prepareBuildScript(buildDir: File, buildScript: String): String = {
-    if(CIUtils.isWindows){
-      val buildFile = new File(buildDir, "build.bat")
-      FileUtils.write(buildFile, buildScript, "UTF-8")
-      buildFile.setExecutable(true)
-      buildFile.getAbsolutePath
-    } else {
-      val buildFile = new File(buildDir, "build.sh")
-      FileUtils.write(buildFile, "#!/bin/sh\n" + buildScript.replaceAll("\r\n", "\n"), "UTF-8")
-      buildFile.setExecutable(true)
-      "../build.sh"
+  private def prepareBuildScript(buildDir: File, buildType: String, buildScript: String): String = {
+    buildType match {
+      case "script" =>
+        if(CIUtils.isWindows){
+          val buildFile = new File(buildDir, "build.bat")
+          FileUtils.write(buildFile, buildScript, "UTF-8")
+          buildFile.setExecutable(true)
+          buildFile.getAbsolutePath
+        } else {
+          val buildFile = new File(buildDir, "build.sh")
+          FileUtils.write(buildFile, "#!/bin/sh\n" + buildScript.replaceAll("\r\n", "\n"), "UTF-8")
+          buildFile.setExecutable(true)
+          "../build.sh"
+        }
+      case "file" =>
+        if(CIUtils.isWindows){
+          val dir = new File(buildDir, "workspace")
+          new File(dir, buildScript).getAbsolutePath
+        } else {
+          "./" + buildScript
+        }
+      case _ =>
+        throw new MatchError("Invalid build type: " + buildType)
     }
   }
 

src/main/scala/io/github/gitbucket/ci/model/CIConfig.scala

@@ -9,17 +9,19 @@ trait CIConfigComponent { self: gitbucket.core.model.Profile =>
   class CIConfigs(tag: Tag) extends Table[CIConfig](tag, "CI_CONFIG") {
     val userName = column[String]("USER_NAME", O PrimaryKey)
     val repositoryName = column[String]("REPOSITORY_NAME")
+    val buildType = column[String]("BUILD_TYPE")
     val buildScript = column[String]("BUILD_SCRIPT")
     val notification = column[Boolean]("NOTIFICATION")
     val skipWords = column[String]("SKIP_WORDS")
     val runWords = column[String]("RUN_WORDS")
-    def * = (userName, repositoryName, buildScript, notification, skipWords.?, runWords.?) <> (CIConfig.tupled, CIConfig.unapply)
+    def * = (userName, repositoryName, buildType, buildScript, notification, skipWords.?, runWords.?) <> (CIConfig.tupled, CIConfig.unapply)
   }
 }
 
 case class CIConfig(
   userName: String,
   repositoryName: String,
+  buildType: String,
   buildScript: String,
   notification: Boolean,
   skipWords: Option[String],

src/main/twirl/gitbucket/ci/config.scala.html

@@ -6,7 +6,7 @@
   @gitbucket.core.html.menu("settings", repository){
     @gitbucket.core.settings.html.menu("build", repository){
       @gitbucket.core.helper.html.information(info)
-      <form action="@url(repository)/settings/build" method="POST" validate="true">
+      <form action="@url(repository)/settings/build" method="POST" validate="true" autocomplete="off">
         <div class="panel panel-default">
           <div class="panel-heading strong">Build</div>
           <div class="panel-body">
@@ -17,10 +17,25 @@
               </label>
             </fieldset>
             <div id="buildSettings">
-              <label>Build script</label>
-              <fieldset>
-                <textarea id="buildScript" name="buildScript" class="form-control" style="height: 100px;">@config.map(_.buildScript)</textarea>
-              </fieldset>
+              <fielset class="form-group">
+                <div>
+                  <span id="error-buildType" class="error"></span>
+                </div>
+                <label>
+                  <input type="radio" name="buildType" value="script" @if(config.exists(_.buildType == "script") || config.isEmpty){checked}>
+                  Build script
+                  <span class="normal muted">(Put arbitrary scripts to build this project)</span>
+                  </label>
+                  <textarea id="buildScript" name="buildScript" class="form-control" style="height: 100px;">@config.filter(_.buildType == "script").map(_.buildScript)</textarea>
+                  <span id="error-buildScript" class="error"></span>
+                  <label>
+                    <input type="radio" name="buildType" value="file" @if(config.exists(_.buildType == "file")){checked}>
+                    Build file
+                    <span class="normal muted">(Specify a script file in your repository to build this project)</span>
+                  </label>
+                  <input id="buildFile" name="buildFile" class="form-control" value="@config.filter(_.buildType == "file").map(_.buildScript)">
+                  <span id="error-buildFile" class="error"></span>
+              </fielset>
               <fieldset class="form-group">
                 <label class="checkbox" for="notification">
                   <input type="checkbox" id="notification" name="notification"@if(config.exists(_.notification)){ checked}/>
@@ -50,8 +65,29 @@
 }
 <script>
 $(function(){
-  $('#enableBuild').change(function(){
-    $('#buildSettings textarea, #buildSettings input').prop('disabled', !$(this).prop('checked'));
-  }).change();
+  $('#enableBuild').change(updateStatus);
+  $('input[name=buildType]').change(updateStatus);
+
+  updateStatus();
 });
+
+function updateStatus(){
+  console.log($('#enableBuild').prop('checked'));
+  if($('#enableBuild').prop('checked')){
+    // Enables radio buttons
+    $('#buildSettings input[type=radio]').prop('disabled', false);
+    // Once disables both fields
+    $('textarea[name=buildScript], input[name=buildFile]').prop('disabled', true);
+    // Enables a field if corresponding radio button has been checked
+    var buildType = $('input[name=buildType]:checked').val();
+    if(buildType == 'script'){
+      $('textarea[name=buildScript]').prop('disabled', false);
+    } else if(buildType == 'file'){
+      $('input[name=buildFile]').prop('disabled', false);
+    }
+  } else {
+    // Disables all fields
+    $('#buildSettings textarea, #buildSettings input').prop('disabled', true);
+  }
+}
 </script>