Merge pull request #6076 from adobe/jasonsanjose/build-prop-keys

Changes to build.prop file to support Jenkins jobs

Author: ingorichter

.gitignore

@@ -9,6 +9,8 @@ src/brackets.min.css
 /node_modules
 /npm-debug.log
 
+# ignore compiled files
+/dist
 
 # ignore everything in the dev extension directory EXCEPT the README
 # (so that the directory is non-empty and can be in git)

tasks/build.js

@@ -25,41 +25,101 @@
 module.exports = function (grunt) {
     "use strict";
 
-    var child_process   = require("child_process"),
+    var build           = {},
+        child_process   = require("child_process"),
+        path            = require("path"),
         q               = require("q"),
         qexec           = q.denodeify(child_process.exec);
+
+    function getGitInfo(cwd) {
+        var opts = { cwd: cwd, maxBuffer: 1024 * 1024 },
+            json = {};
+
+        // count the number of commits for our version number
+        //     <major>.<sprint>.<patch>-<number of commits>
+        return qexec("git log --format=%h", opts).then(function (stdout) {
+            json.commits = stdout.toString().match(/[0-9a-f]\n/g).length;
+            
+            // get the hash for the current commit (HEAD)
+            return qexec("git rev-parse HEAD", opts);
+        }).then(function (stdout) {
+            json.sha = /([a-f0-9]+)/.exec(stdout.toString())[1];
+            
+            // compare HEAD to the HEADs on the remote
+            return qexec("git ls-remote --heads origin", opts);
+        }).then(function (stdout) {
+            var log = stdout.toString(),
+                re = new RegExp(json.sha + "\\srefs/heads/(\\S+)\\s"),
+                match = re.exec(log),
+                reflog;
+            
+            // if HEAD matches to a remote branch HEAD, grab the branch name
+            if (match) {
+                json.branch = match[1];
+                return json;
+            }
+            
+            // else, try match HEAD using reflog
+            reflog = qexec("git reflog show --no-abbrev-commit --all", opts);
+            
+            return reflog.then(function (stdout) {
+                var log = stdout.toString(),
+                    re = new RegExp(json.sha + "\\srefs/(remotes/origin|heads)/(\\S+)@"),
+                    match = re.exec(log);
+
+                json.branch = (match && match[2]) || "(no branch)";
+    
+                return json;
+            });
+        });
+    }
+
+    function toProperties(prefix, json) {
+        var out = "";
+
+        Object.keys(json).forEach(function (key) {
+            out += prefix + key + "=" + json[key] + "\n";
+        });
+
+        return out;
+    }
 
     // task: build-num
     grunt.registerTask("build-prop", "Write build.prop properties file for Jenkins", function () {
-        var done = this.async(),
-            out  = "",
-            num,
-            branch,
-            sha,
-            opts = { cwd: process.cwd(), maxBuffer: 1024*1024 },
-            version = grunt.config("pkg").version;
-        
-        qexec("git log --format=%h", opts).then(function (stdout, stderr) {
-            num = stdout.toString().match(/[0-9a-f]\n/g).length;
-            return qexec("git status", opts);
-        }).then(function (stdout, stderr) {
-            branch = /On branch (.*)/.exec(stdout.toString().trim())[1];
-            return qexec("git log -1", opts);
-        }).then(function (stdout, stderr) {
-            sha = /commit (.*)/.exec(stdout.toString().trim())[1];
+        var done        = this.async(),
+            json        = {},
+            out         = "",
+            opts        = { cwd: process.cwd(), maxBuffer: 1024 * 1024 },
+            version     = grunt.config("pkg").version,
+            www_repo    = process.cwd(),
+            shell_repo  = path.resolve(www_repo, grunt.config("shell.repo")),
+            www_git,
+            shell_git;
 
-            out += "build.version=" + version.substr(0, version.lastIndexOf("-") + 1) + num + "\n";
-            out += "build.number=" + num + "\n";
-            out += "build.branch=" + branch + "\n";
-            out += "build.sha=" + sha + "\n";
+        getGitInfo(www_repo).then(function (json) {
+            www_git = json;
+            return getGitInfo(shell_repo);
+        }).then(function (json) {
+            shell_git = json;
+        }, function (err) {
+            // shell git info is optional
+            grunt.log.writeln(err);
+        }).finally(function () {
+            out += "brackets_build_version=" + version.substr(0, version.lastIndexOf("-") + 1) + www_git.commits + "\n";
+            out += toProperties("brackets_www_", www_git);
+            
+            if (shell_git) {
+                out += toProperties("brackets_shell_", shell_git);
+            }
 
             grunt.log.write(out);
             grunt.file.write("build.prop", out);
 
             done();
-        }, function (err) {
-            grunt.log.writeln(err);
-            done(false);
         });
     });
+    
+    build.getGitInfo = getGitInfo;
+    
+    return build;
 };

tasks/write-config.js

@@ -20,11 +20,12 @@
  * DEALINGS IN THE SOFTWARE.
  * 
  */
-/*global module, require*/
+/*global module, require, process*/
 module.exports = function (grunt) {
     "use strict";
 
-    var common = require("./lib/common")(grunt);
+    var common  = require("./lib/common")(grunt),
+        build   = require("./build")(grunt);
 
     // task: write-config
     grunt.registerTask("write-config", "Merge package.json and src/brackets.config.json into src/config.json", function () {
@@ -39,4 +40,23 @@ module.exports = function (grunt) {
 
         common.writeJSON(grunt, "src/config.json", appConfigJSON);
     });
+    
+    // task: build-config
+    grunt.registerTask("build-config", "Update config.json with the branch and SHA being built", function () {
+        var done = this.async(),
+            distConfig = grunt.file.readJSON("src/config.json");
+        
+        build.getGitInfo(process.cwd()).then(function (gitInfo) {
+            distConfig.version = distConfig.version.substr(0, distConfig.version.lastIndexOf("-") + 1) + gitInfo.commits;
+            distConfig.repository.SHA = gitInfo.sha;
+            distConfig.repository.branch = gitInfo.branch;
+    
+            common.writeJSON(grunt, "dist/config.json", distConfig);
+            
+            done();
+        }, function (err) {
+            grunt.log.writeln(err);
+            done(false);
+        });
+    });
 };