Added support for gradle projects

README.md

@@ -1,8 +1,8 @@
-# Maven Builds Server
+# Maven and Gradle Builds Server
 This is the repository of the backend for my builds-page.
 The page can be found here: https://thebusybiscuit.github.io/builds/
 
-This kinda serves as a "Continous Integration/Deployment" Service for Maven Projects which utilises static GitHub Pages.
+This kinda serves as a "Continous Integration/Deployment" Service for Maven and Gradle Projects which utilises static GitHub Pages.
 
 # Status
 [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=TheBusyBiscuit_builds&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=TheBusyBiscuit_builds)
@@ -26,10 +26,11 @@ After that it will proceed to step 2.<br>
 
 ### 2. Cloning
 After we established that our repository is out of date, this program will ```git clone``` said repository.<br>
-It will also locate it's pom.xml file and set the version to "DEV - $id (git $commit)".<br>
+It will also locate it's `pom.xml` or `gradle.properties` file and set the version to "DEV - $id (git $commit)".<br>
 
 ### 3. Compiling
 This is the easiest step, the program just runs ```mvn clean package -B``` to compile our Maven Project.<br>
+If a Gradle project is detected, the program runs ```gradlew build``` to compile our Gradle Project.<br>
 It will also catch the state (Success / Failure).<br>
 If you enabled Sonar-Integration for this project, then it will also run a sonar-scan on the repository.<br>
 
@@ -62,7 +63,7 @@ Note that many of these guidelines are requirements of technical nature.
 
 1. They must be publicly available on GitHub and Open-Source.
 2. They must have a valid `LICENSE` file with a permissive Open-Source license (e.g. MIT, Apache or GNU GPL or similar).
-3. They must have a valid `pom.xml` file.
+3. They must have a valid `pom.xml` or `gradle.properties` file.
 4. They are not allowed to force auto-updates on people without providing an option to disable it.
 
 ### Example
@@ -73,10 +74,12 @@ Note that many of these guidelines are requirements of technical nature.
         // Some repositories support the usage of sonar-scanner, custom repositories cannot have this feature though (yet)
         "sonar": {
             "enabled": false
-        },
-        // What the builds will be prefixed with. "DEV" would make builds like "CoolAddon - DEV 1 (githash)"
+        },        
         "options": {
-            "prefix": "DEV"
+            // What the builds will be prefixed with. "DEV" would make builds like "CoolAddon - DEV 1 (githash)"
+            "prefix": "DEV",
+            // What type of build tool will be used, must be "maven" or "gradle"
+            "buildTool": "maven"
         },
         // What your addon supports/depends on. The number key indicates the minium build.
         // You can list any text or even links here.

resources/repos.json

@@ -1062,7 +1062,6 @@
             }
         }
     },
-
     "John000708/SlimeXpansion:master": {
         "sonar": {
             "enabled": false

resources/schema.json

@@ -34,7 +34,7 @@
         },
         "options": {
           "type": "object",
-          "required": ["prefix"],
+          "required": ["prefix", "buildTool"],
           "additionalProperties": false,
 
           "properties": {
@@ -49,6 +49,9 @@
             },
             "createJar": {
               "type": "boolean"
+            },
+            "buildTool": {
+              "type": "string"
             }
           }
         },

src/gradle.js

@@ -0,0 +1,130 @@
+const process = require('child-process-promise')
+const lodash = require('lodash/lang')
+
+const FileSystem = require('fs')
+const fs = FileSystem.promises
+const path = require('path')
+
+const log = require('../src/logger.js')
+const projects = require('../src/projects.js')
+
+module.exports = {
+  getGradleArguments,
+  setVersion,
+  compile,
+  relocate,
+  isValid
+}
+
+/**
+ * This will return the console line arguments for gradle.compile()
+ *
+ * @return {Array<String>}   The needed console line arguments
+ */
+function getGradleArguments () {
+  return ['build']
+}
+
+/**
+ * This method changes the project's version in your gradle.properties file
+ * It also returns a Promise that resolves when it's done.
+ *
+ * @param {Object} job      The currently handled Job Object
+ * @param {String} version  The Version that shall be set
+ */
+function setVersion (job, version) {
+  return new Promise((resolve, reject) => {
+    if (!isValid(job)) {
+      reject(new Error('Invalid Job'))
+      return
+    }
+    const file = path.resolve(__dirname, `../${job.directory}/files/gradle.properties`)
+    if (!FileSystem.existsSync(file)) {
+      fs.writeFile(file, '\nversion=' + version, 'utf8').then(resolve, reject)
+    } else {
+      fs.readFile(file, 'utf8').then((data) => {
+        const content = data.split('\n')
+        const result = []
+        let line
+        for (line in content) {
+          if (!line.includes('version=')) {
+            result.push(line)
+          }
+        }
+        result.push('\nversion=' + version)
+        fs.writeFile(file, result, 'utf8').then(resolve, reject)
+      }, reject)
+    }
+  })
+}
+
+/**
+ * This method will compile a project using the command
+ * 'gradlew build'
+ *
+ * @param  {Object} job      The currently handled Job Object
+ * @param  {Boolean} logging Whether the internal activity should be logged
+ * @return {Promise}         A promise that resolves when this activity finished
+ */
+function compile (job, logging) {
+  return new Promise((resolve, reject) => {
+    if (!isValid(job)) {
+      reject(new Error('Invalid Job'))
+      return
+    }
+
+    log(logging, '-> Granting gradlew +x permissions')
+
+    process.spawn('chmod', ['+x', 'gradlew'], {
+      cwd: path.resolve(__dirname, `../${job.directory}/files`),
+      shell: true
+    })
+
+    log(logging, "-> Executing './gradlew build'")
+
+    const args = getGradleArguments()
+    const compiler = process.spawn('./gradlew', args, {
+      cwd: path.resolve(__dirname, `../${job.directory}/files`),
+      shell: true
+    })
+
+    const logger = (data) => {
+      log(logging, data, true)
+      fs.appendFile(path.resolve(__dirname, `../${job.directory}/${job.repo}-${job.id}.log`), data, 'utf8').catch(err => console.log(err))
+    }
+
+    compiler.childProcess.stdout.on('data', logger)
+    compiler.childProcess.stderr.on('data', logger)
+
+    compiler.then(resolve, reject)
+  })
+}
+
+/**
+ * This method will relocate a project's compiled jar file
+ * to the appropriate directory
+ *
+ * @param  {Object} job      The currently handled Job Object
+ * @return {Promise}         A promise that resolves when this activity finished
+ */
+function relocate (job) {
+  if (!job.success) {
+    return Promise.resolve()
+  }
+  return fs.rename(
+    path.resolve(__dirname, `../${job.directory}/files/build/libs/${job.repo}-${(job.options ? job.options.prefix : 'DEV')} - ${job.id} (git ${job.commit.sha.substr(0, 8)}).jar`),
+    path.resolve(__dirname, `../${job.directory}/${job.repo}-${job.id}.jar`)
+  )
+}
+
+/**
+ * This method will check if a Job is valid.
+ * null / undefined or incomplete Job Objects will fail.
+ *
+ * @param  {Object}  job The job object to be tested
+ * @return {Boolean}     Whether the job is a valid Job
+ */
+function isValid (job) {
+  if (!projects.isValid(job)) return false
+  return lodash.isInteger(job.id)
+}

src/main.js

@@ -5,6 +5,7 @@ const cfg = require('../src/config.js')(path.resolve(__dirname, '../resources/co
 // Modules
 const projects = require('../src/projects.js')
 const maven = require('../src/maven.js')
+const gradle = require('../src/gradle.js')
 const github = require('../src/github.js')(cfg.github)
 const discord = require('../src/discord.js')(cfg.discord)
 const log = require('../src/logger.js')
@@ -149,13 +150,18 @@ function update (job, logging) {
 
     github.clone(job, job.commit.sha, logging).then(() => {
       const name = (job.options ? job.options.prefix : 'DEV') + ' - ' + job.id + ' (git ' + job.commit.sha.substr(0, 8) + ')'
-      maven.setVersion(job, name, true).then(resolve, reject)
+      log(logging, `-> Building using: ${job.options.buildTool === null ? 'maven' : job.options.buildTool}`)
+      if (!job.options.buildTool || job.options.buildTool === 'maven') {
+        maven.setVersion(job, name, true).then(resolve, reject)
+      } else {
+        gradle.setVersion(job, name).then(resolve, reject)
+      }
     }, reject)
   })
 }
 
 /**
- * This method compiles the project using Maven.
+ * This method compiles the project using Maven or Gradle depending on job.config.buildTool.
  * After completing, the job update will have the flag 'success',
  * that is either true or false.
  *
@@ -175,18 +181,32 @@ function compile (job, logging) {
   updateStatus(job, 'Compiling')
 
   return new Promise((resolve) => {
-    log(logging, 'Compiling: ' + job.author + '/' + job.repo + ':' + job.branch + ' (' + job.id + ')')
-
-    maven.compile(job, cfg, logging)
-      .then(() => {
-        job.success = true
-        resolve()
-      })
-      .catch((err) => {
-        log(logging, err.stack)
-        job.success = false
-        resolve()
-      })
+    if (!job.options.buildTool || job.options.buildTool === 'maven') {
+      log(logging, `Compiling using Maven: ${job.author}/${job.repo}:${job.branch} (${job.id})`)
+
+      maven.compile(job, cfg, logging)
+        .then(() => {
+          job.success = true
+          resolve()
+        })
+        .catch((err) => {
+          log(logging, err.stack)
+          job.success = false
+          resolve()
+        })
+    } else {
+      log(logging, `Compiling using Gradle: ${job.author}/${job.repo}:${job.branch} (${job.id})`)
+      gradle.compile(job, logging)
+        .then(() => {
+          job.success = true
+          resolve()
+        })
+        .catch((err) => {
+          log(logging, err.stack)
+          job.success = false
+          resolve()
+        })
+    }
   })
 }
 
@@ -211,12 +231,16 @@ function gatherResources (job, logging) {
 
   return new Promise((resolve, reject) => {
     log(logging, 'Gathering Resources: ' + job.author + '/' + job.repo + ':' + job.branch)
-
-    Promise.all([
+    const promises = [
       github.getLicense(job, logging),
-      github.getTags(job, logging),
-      maven.relocate(job)
-    ]).then((values) => {
+      github.getTags(job, logging)
+    ]
+    if (job.options.buildTool === 'maven') {
+      promises.push(maven.relocate(job))
+    } else {
+      promises.push(gradle.relocate(job))
+    }
+    Promise.all(promises).then((values) => {
       const license = values[0]
       const tags = values[1]
 

src/projects.js

@@ -40,7 +40,6 @@ function getProjects (logging) {
 
         if (json[repo].options) {
           job.options = json[repo].options
-
           if (json[repo].options.custom_directory) {
             job.directory = json[repo].options.custom_directory
           }

src/setup.sh

@@ -1,4 +1,4 @@
 git config user.name "TheBusyBot"
 git config user.email ${LOGIN_EMAIL}
 
-git remote set-url origin https://${ACCESS_TOKEN}@github.com/TheBusyBiscuit/builds.git
+git remote set-url origin https://${ACCESS_TOKEN}@github.com/TheBusyBiscuit/builds.git