test: add integration test

Author: mjeanroy

package.json

@@ -46,12 +46,13 @@
     "gulp": "4.0.2",
     "gulp-babel": "8.0.0",
     "gulp-bump": "3.1.3",
-    "gulp-conventional-changelog": "^2.0.29",
+    "gulp-conventional-changelog": "2.0.29",
     "gulp-eslint": "6.0.0",
     "gulp-git": "2.10.1",
     "gulp-jasmine": "4.0.0",
     "jasmine-core": "3.5.0",
     "rimraf": "3.0.2",
+    "tmp": "0.2.1",
     "vinyl": "2.2.0"
   }
 }

src/index.js

@@ -34,7 +34,7 @@ const _ = require('lodash');
 const moment = require('moment');
 const commenting = require('commenting');
 const through = require('through2');
-const read = require('./read');
+const Q = require('q');
 
 module.exports = function gulpHeaderComment(options = {}) {
   const separator = _.isObject(options) && _.isString(options.separator) ? options.separator : '\n';
@@ -265,3 +265,25 @@ function maySkipFirstLine(type) {
 function shouldSkipFirstLine(type, line) {
   return prologCheckers[type](line);
 }
+
+/**
+ * Read file specified by given options.
+ *
+ * @param {Object} options Read options.
+ * @return {Promise<string>} A promise resolved with file content.
+ */
+function read(options) {
+  if (_.isString(options)) {
+    return Q.when(options);
+  }
+
+  const file = options.file;
+  const encoding = options.encoding || 'utf-8';
+  const deferred = Q.defer();
+
+  fs.readFile(file, {encoding}, (err, data) => {
+    return err ? deferred.reject(err) : deferred.resolve(data);
+  });
+
+  return deferred.promise;
+}

test/index.spec.js

@@ -30,7 +30,8 @@ const Vinyl = require('vinyl');
 const Stream = require('stream');
 const moment = require('moment');
 const gulpHeaderComment = require('../src/index');
-const EOL = '\n';
+const joinLines = require('./utils/join-lines');
+const EOL = require('./utils/eol');
 
 describe('gulp-header-comment', () => {
   let cwd;
@@ -646,13 +647,4 @@ describe('gulp-header-comment', () => {
     stream.write(vinyl);
     stream.end();
   });
-
-  /**
-   * Join given strings with the EOL character.
-   * @param {Array<string>} lines Given lines to join.
-   * @return {string} Joined lines.
-   */
-  function joinLines(lines) {
-    return lines.join(EOL);
-  }
 });

test/it.spec.js

@@ -0,0 +1,76 @@
+/**
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2017-2019 Mickael Jeanroy
+ *
+ * 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';
+
+const path = require('path');
+const fs = require('fs');
+const gulp = require('gulp');
+const tmp = require('tmp');
+const headerComment = require('../src/index');
+const joinLines = require('./utils/join-lines');
+
+describe('[IT] gulp-header-comment', () => {
+  let tmpDir;
+
+  beforeEach(() => {
+    tmpDir = tmp.dirSync({
+      unsafeCleanup: true,
+    });
+  });
+
+  afterEach(() => {
+    tmpDir.removeCallback();
+  });
+
+  it('should prepend header', (done) => {
+    const fName = 'test.txt';
+    const src = path.join(__dirname, 'fixtures', fName);
+    const dest = path.join(tmpDir.name);
+
+    gulp.src(src)
+        .pipe(headerComment('License MIT'))
+        .pipe(gulp.dest(dest))
+        .on('error', (err) => done.fail(err))
+        .on('end', () => {
+          fs.readFile(path.join(dest, fName), 'utf8', (err, data) => {
+            if (err) {
+              done.fail(err);
+              return;
+            }
+
+            expect(data).toEqual(joinLines([
+              '/**',
+              ' * License MIT',
+              ' */',
+              '',
+              'Hello World',
+              '',
+            ]));
+
+            done();
+          });
+        });
+  });
+});

test/read.spec.js

@@ -0,0 +1,25 @@
+/**
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2017-2019 Mickael Jeanroy
+ *
+ * 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.
+ */
+
+module.exports = '\n';

test/utils/eol.js

@@ -22,24 +22,13 @@
  * THE SOFTWARE.
  */
 
-'use strict';
+const EOL = require('./eol');
 
-const fs = require('fs');
-const _ = require('lodash');
-const Q = require('q');
-
-module.exports = function read(options) {
-  if (_.isString(options)) {
-    return Q.when(options);
-  }
-
-  const file = options.file;
-  const encoding = options.encoding || 'utf-8';
-  const deferred = Q.defer();
-
-  fs.readFile(file, {encoding}, (err, data) => {
-    return err ? deferred.reject(err) : deferred.resolve(data);
-  });
-
-  return deferred.promise;
+/**
+ * Join given strings with the EOL character.
+ * @param {Array<string>} lines Given lines to join.
+ * @return {string} Joined lines.
+ */
+module.exports = function joinLines(lines) {
+  return lines.join(EOL);
 };