gulpfile.js

/*!
 * Copyright 2017 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

'use strict';

/**************/
/*  REQUIRES  */
/**************/
var fs = require('fs');
var _ = require('lodash');
var gulp = require('gulp');
var pkg = require('./package.json');
var runSequence = require('run-sequence');

// File I/O
var fs = require('fs');
var exit = require('gulp-exit');
var tslint = require('gulp-tslint');
var ts = require('gulp-typescript');
var del = require('del');
var merge = require('merge2');
var header = require('gulp-header');
var replace = require('gulp-replace');

// Testing
var mocha = require('gulp-mocha');
var istanbul = require('gulp-istanbul');


/****************/
/*  FILE PATHS  */
/****************/
var paths = {
  src: [
    'src/**/*.ts'
  ],

  databaseSrc: [
    'src/**/*.js'
  ],

  tests: [
    'test/unit/utils.ts',
    'test/unit/**/*.spec.ts',
    'test/resources/mocks.ts'
  ],

  resources: [
    'test/resources/*.json'
  ],

  build: 'lib/',

  testBuild: '.tmp/',

  testRunner: ['.tmp/test/unit/index.spec.js']
};

// Create a separate project for buildProject that overrides the rootDir
// This ensures that the generated production files are in their own root
// rather than including both src and test in the lib dir.
var buildProject = ts.createProject('tsconfig.json', {rootDir: 'src'});
var testProject = ts.createProject('tsconfig.json');

var banner = `/*! firebase-admin v${pkg.version} */\n`;

/***********/
/*  TASKS  */
/***********/

gulp.task('cleanup', function() {
  return del([
    paths.build,
    paths.testBuild
  ]);
});

gulp.task('compile', function() {
  return gulp.src(paths.src)
    // Compile Typescript into .js and .d.ts files
    .pipe(buildProject())

    // Replace SDK version
    .pipe(replace(/\<XXX_SDK_VERSION_XXX\>/g, pkg.version))

    // Add header
    .pipe(header(banner))

    // Write to build directory
    .pipe(gulp.dest(paths.build))
});

gulp.task('copyDatabase', function() {
  return gulp.src(paths.databaseSrc)
    // Add headers
    .pipe(header(fs.readFileSync('third_party/database-license.txt', 'utf8')))
    .pipe(header(banner))

    // Write to build directory
    .pipe(gulp.dest(paths.build))
});

gulp.task('copyTypings', function() {
  return gulp.src('src/index.d.ts')
    // Add header
    .pipe(header(banner))

    // Write to build directory
    .pipe(gulp.dest(paths.build))
});

// Lints the source and test files
gulp.task('lint', function() {
  let filesToLint = _.clone(paths.src.concat(paths.tests));

  // Don't lint the hand-crafted TypeScript typings file
  filesToLint.push('!src/index.d.ts');

  return gulp.src(filesToLint)
    .pipe(tslint())
    .pipe(tslint.report({
      summarizeFailureOutput: true
    }));
});

// Runs the test suite
gulp.task('test', function() {
  merge(
    // Copy compiled source and test files
    gulp.src(paths.tests.concat(paths.src), {base: '.'})
      .pipe(testProject())
      .pipe(gulp.dest(paths.testBuild)),
    // Copy compiled database files
    gulp.src(paths.build + 'database/**/*')
      .pipe(gulp.dest(paths.testBuild + 'src/database/')),
    // Copy test resources
    gulp.src(paths.resources, {base: '.'})
      .pipe(gulp.dest(paths.testBuild))
  ).on('finish', function() {
    return gulp.src([paths.testBuild + 'src/**/*.js', '!' + paths.testBuild + 'src/database/**/*'])
      .pipe(istanbul())
      .pipe(istanbul.hookRequire())
      .on('finish', function() {
        return gulp.src(paths.testRunner)
          .pipe(mocha({
            reporter: 'spec',
            timeout: 5000
          }))
          .pipe(istanbul.writeReports())
          .on('finish', function() {
            return del(paths.testBuild).then(exit);
          });
      });
  })
});

// Re-runs the linter and regenerates js every time a source file changes
gulp.task('watch', function() {
  gulp.watch(paths.src, ['lint', 'compile']);
});

// Build task
gulp.task('build', function(done) {
  runSequence('cleanup', 'compile', 'copyDatabase', 'copyTypings', function(error) {
    done(error && error.err);
  });
});

// Default task
gulp.task('default', function(done) {
  runSequence('lint', 'build', 'test', function(error) {
    done(error && error.err);
  });
});