build.js

/*
 * Copyright (c) 2013 - present Adobe Systems Incorporated. All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 *
 */

"use strict";

module.exports = function (grunt) {
    var fs          = require("fs"),
        common      = require("./common")(grunt),
        semver      = require("semver"),
        spawn       = common.spawn,
        resolve     = common.resolve,
        platform    = common.platform(),
        _           = grunt.util._;

    function getBracketsEnv() {
        var env = _.extend(process.env);

        env.BRACKETS_SRC = resolve(grunt.config("git.www.repo"));
        env.BRACKETS_APP_NAME = grunt.config("build.name");

        return env;
    }
    
    function safeReplace(content, regexp, replacement) {
        if (!regexp.test(content)) {
            grunt.fail.fatal("Regexp " + regexp + " did not match");
        }

        var newContent = content.replace(regexp, replacement);

        if (newContent === content) {
            grunt.log.warn("Buildnumber for ", regexp, "hasn't been updated, because it's already set.");
        }

        return newContent;
    }

    // task: full-build
    grunt.registerTask("full-build", ["git", "create-project", "build-www", "build", "stage", "package"]);
    grunt.registerTask("installer", ["set-release-optional", "full-build", "build-installer"]);

    // task: build
    grunt.registerTask("build", "Build shell executable. Run 'grunt full-build' to update repositories, build the shell and package www files.", function (wwwBranch, shellBranch) {
        grunt.task.run("build-" + platform);
    });

    // task: build-www
    grunt.registerTask("build-www", "Check brackets repository for build artifacts", function () {
        var distPath = resolve(grunt.config("copy.www.files")[0].cwd);
        grunt.log.writeln(distPath);

        if (!grunt.file.exists(distPath)) {
            grunt.log.error(distPath + " file does not exist. Run `grunt build` in the brackets repo first.");
            return false;
        }
    });

    // task: build-mac
    grunt.registerTask("build-mac", "Build mac shell", function () {
        var done = this.async();

        spawn([
            "xcodebuild -project appshell.xcodeproj -config Release clean",
            "xcodebuild -project appshell.xcodeproj -config Release build"
        ]).then(function (result) {
            if (result.stderr.match('xcrun: Error')) {
                grunt.log.error('Unable to run : ' + result.cmd + ' ' + result.args.join(' '));
                grunt.log.error(result.stderr);
                return done(false);
            }
            done();
        }, function (err) {
            grunt.log.error(err);
            done(false);
        });
    });

    // task: build-win
    grunt.registerTask("build-win", "Build windows shell", function () {
        var done = this.async();

        spawn(["cmd.exe /c scripts\\build_projects.bat", "cmd.exe /c scripts\\brackets_installer_projects.bat"]).then(function () {
            done();
        }, function (err) {
            grunt.log.error(err);
            done(false);
        });
    });

    // task: build-linux
    grunt.registerTask("build-linux", "Build linux shell", function () {
        var done = this.async();

        spawn("make").then(function () {
            done();
        }, function (err) {
            grunt.log.error(err);
            done(false);
        });
    });

    // task: git
    grunt.registerMultiTask("git", "Pull specified repo branch from origin", function () {
        var repo = this.data.repo;

        if (!repo) {
            grunt.fail.fatal("Missing repo config");
        }

        repo = resolve(repo);

        if (this.data.branch) {
            grunt.log.writeln("Updating repo " + this.target + " at " + repo + " to branch " + this.data.branch);

            var done = this.async(),
                promise = spawn([
                    "git fetch origin",
                    "git checkout " + this.data.branch,
                    "git pull origin " + this.data.branch,
                    "git submodule sync",
                    "git submodule update --init --recursive"
                ], { cwd: repo });

            promise.then(function () {
                done();
            }, function (err) {
                grunt.log.writeln(err);
                done(false);
            });
        } else {
            grunt.log.writeln("Skipping fetch for " + this.target + " repo");
        }
    });

    // task: stage
    grunt.registerTask("stage", "Stage release files", function () {
        // stage platform-specific binaries
        grunt.task.run(["clean:staging-" + platform, "stage-" + platform]);
    });

    // task: stage-mac
    grunt.registerTask("stage-mac", "Stage mac executable files", function () {
        // stage platform-specific binaries, then package www files
        grunt.task.run("copy:mac");
        grunt.task.run("copy:cefplist");
    });

    // task: stage-win
    grunt.registerTask("stage-win", "Stage win executable files", function () {
        // stage platform-specific binaries, then package www files
        grunt.task.run("copy:winInstallerDLLs");
        grunt.task.run("copy:win");
    });

    // task: stage-linux
    grunt.registerTask("stage-linux", "Stage linux executable files", function () {
        // stage platform-specific binaries, then package www files
        grunt.task.run("copy:linux");
    });

    // task: package
    grunt.registerTask("package", "Package www files", function () {
        grunt.task.run(["clean:www", "copy:www", "copy:samples"]);
    });

    // task: build-installer
    grunt.registerTask("build-installer", "Build installer", function () {
        // TODO update brackets.config.json
        grunt.task.run(["clean:installer-" + platform, "build-installer-" + platform]);
    });

    // task: build-installer-mac
    grunt.registerTask("build-installer-mac", "Build mac installer", function () {
        var done = this.async();

        spawn(["bash buildInstaller.sh"], { cwd: resolve("installer/mac"), env: getBracketsEnv() }).then(function () {
            done();
        }, function (err) {
            grunt.log.error(err);
            done(false);
        });
    });

    // task: build-installer-win
    grunt.registerTask("build-installer-win", "Build windows installer", function () {
        var done = this.async();

        var configData = grunt.file.readJSON(grunt.config("config-json"));
        var packageData = grunt.file.readJSON("package.json");
        var buildnumber = configData.buildnumber;
        var winInstallerBuildXmlPath  = "installer/win/brackets-win-install-build.xml";
        var text = grunt.file.read(winInstallerBuildXmlPath);
        text = safeReplace(
            text,
            /<property name="product\.release\.number\.build" value="(\d+)"\/>/,
            '<property name="product.release.number.build" value="' + buildnumber + '"/>'
        );
        configData.prerelease = packageData.prerelease;
        
        grunt.file.write(winInstallerBuildXmlPath, text);
        grunt.file.write(grunt.config("config-json"), JSON.stringify(configData, null, "    "));
        
        
        spawn(["cmd.exe /c ant.bat -f brackets-win-install-build.xml"], { cwd: resolve("installer/win"), env: getBracketsEnv() }).then(function () {
            done();
        }, function (err) {
            grunt.log.error(err);
            done(false);
        });
    });

    // task: build-installer-linux
    grunt.registerTask("build-installer-linux", "Build linux installer", function () {
        var template = grunt.file.read("installer/linux/debian/control"),
            templateData = {},
            content;

        // populate debian control template fields
        templateData.version = grunt.file.readJSON(grunt.config("config-json")).version;
        templateData.size = 0;
        templateData.arch = (common.arch() === 64) ? "amd64" : "i386";

        // uncompressed file size
        grunt.file.recurse("installer/linux/debian/package-root/opt", function (abspath) {
            templateData.size += fs.statSync(abspath).size;
        });
        templateData.size = Math.round(templateData.size / 1000);

        // write file
        content = grunt.template.process(template, { data: templateData });
        grunt.file.write("installer/linux/debian/package-root/DEBIAN/control", content);

        var done = this.async(),
            version = semver.parse(grunt.config("pkg").version),
            release = version.major + "." + version.minor;

        spawn(["bash build_installer.sh"], { cwd: resolve("installer/linux"), env: getBracketsEnv() }).then(function () {
            return common.rename("installer/linux/brackets.deb", "installer/linux/Brackets Release " + release + " " + common.arch() + "-bit.deb");
        }).then(function () {
            done();
        }, function (err) {
            grunt.log.error(err);
            done(false);
        });
    });

    // task: build-linux-archive
    grunt.registerTask("build-linux-archive", "Build portable Linux .tar.gz", function () {
        var done = this.async(),
            version = semver.parse(grunt.config("pkg").version),
            release = version.major + "." + version.minor;

        spawn(["bash build_archive.sh"], { cwd: resolve("installer/linux"), env: getBracketsEnv() }).then(function () {
            return common.rename("installer/linux/brackets.tar.gz", "installer/linux/Brackets Release " + release + " " + common.arch() + "-bit.tar.gz");
        }).then(function () {
            done();
        }, function (err) {
            grunt.log.error(err);
            done(false);
        });
    });
};