liferay-theme-tasks/plugin/__tests__/index.test.js

A set of tasks for building and deploying Liferay Portal themes.

/**
 * SPDX-FileCopyrightText: © 2017 Liferay, Inc. <https://liferay.com>
 * SPDX-License-Identifier: MIT
 */

'use strict';

const fs = require('fs-extra');
const {Gulp} = require('gulp');
const {
	default: FilePath,
} = require('liferay-npm-build-tools-common/lib/file-path');
const path = require('path');
const sinon = require('sinon');

const project = require('../../lib/project');
const {cleanTempPlugin, setupTempPlugin} = require('../../lib/test/util');
const {getArgv} = require('../../lib/util');
const {registerTasks} = require('../index');

let deployPath;
let gulp;
let tempPlugin;

beforeEach(() => {
	gulp = new Gulp();

	tempPlugin = setupTempPlugin({
		init: () => {},
		namespace: 'plugin',
		pluginName: 'test-plugin-layouttpl',
		version: '7.0',
	});

	deployPath = path.join(tempPlugin.tempPath, '..', 'appserver', 'deploy');
});

afterEach(() => {
	cleanTempPlugin(tempPlugin);
	fs.removeSync(deployPath);
});

test('registerTasks should invoke extension functions', (done) => {
	if (process.platform === 'win32') {

		// Skipping some tests on Windows, for now; see:
		// https://github.com/liferay/liferay-frontend-projects/pull/260

		done();

		return;
	}

	const extFunction = function (options) {
		expect(options).toEqual({
			argv: getArgv(),
			distName: 'test-plugin-layouttpl',
			extensions: [extFunction],
			gulp,
			pathDist: new FilePath('./dist'),
			rootDir: new FilePath('./docroot'),
			storeConfig: {
				name: 'LiferayPlugin',
				path: 'liferay-plugin.json',
			},
		});

		done();
	};

	registerTasks({
		extensions: extFunction,
		gulp,
	});
});

test('registerTasks should accept array of extension function', (done) => {
	const extFunction = function (options) {
		expect(options.gulp).toBe(gulp);

		done();
	};

	registerTasks({
		extensions: [extFunction],
		gulp,
	});
});

test('registerTasks should register hooks', (done) => {
	const hookSpy = sinon.spy();

	const hookFn = function (gulp) {
		gulp.hook('before:plugin:war', (callback) => {
			hookSpy('before:plugin:war');

			callback();
		});

		gulp.hook('after:plugin:war', (callback) => {
			hookSpy('after:plugin:war');

			callback();
		});

		gulp.hook('after:plugin:deploy', (callback) => {
			hookSpy('after:plugin:deploy');

			callback();
		});
	};

	registerTasks({
		gulp,
		hookFn,
	});

	project.store.deployPath = deployPath;

	project.gulp.runSequence('plugin:war', 'plugin:deploy', () => {
		expect(path.join(deployPath, 'test-plugin-layouttpl.war')).toBeFile();

		expect(project.store.deployed).toBe(true);

		expect(hookSpy.getCall(0).calledWith('before:plugin:war')).toBe(true);
		expect(hookSpy.getCall(1).calledWith('after:plugin:war')).toBe(true);
		expect(hookSpy.getCall(2).calledWith('after:plugin:deploy')).toBe(true);

		done();
	});
});

test('registerTasks should register hooks for extension tasks', (done) => {
	const hookSpy = sinon.spy();

	const hookFn = function (gulp) {
		gulp.hook('before:plugin:war', (callback) => {
			hookSpy('before:plugin:war');

			callback();
		});

		gulp.hook('after:my-custom:task', (callback) => {
			hookSpy('after:my-custom:task');

			callback();
		});
	};

	registerTasks({
		extensions(options) {
			options.gulp.task('my-custom:task', (callback) => {
				hookSpy('my-custom:task');

				callback();
			});
		},
		gulp,
		hookFn,
	});

	project.gulp.runSequence('plugin:war', 'my-custom:task', () => {
		expect(hookSpy.getCall(0).calledWith('before:plugin:war')).toBe(true);
		expect(hookSpy.getCall(1).calledWith('my-custom:task')).toBe(true);
		expect(hookSpy.getCall(2).calledWith('after:my-custom:task')).toBe(
			true
		);

		done();
	});
});

test('registerTasks should overwrite task', (done) => {
	const hookSpy = sinon.spy();

	const hookFn = function (gulp) {
		gulp.hook('before:plugin:war', (callback) => {
			hookSpy('before:plugin:war');

			callback();
		});

		gulp.task('plugin:war', (callback) => {
			hookSpy('plugin:war');

			callback();
		});
	};

	registerTasks({
		gulp,
		hookFn,
	});

	project.gulp.runSequence('plugin:war', () => {
		expect(hookSpy.getCall(0).calledWith('before:plugin:war')).toBe(true);
		expect(hookSpy.getCall(1).calledWith('plugin:war')).toBe(true);

		done();
	});
});

test('registerTasks should use distName as template if delimiters are present', (done) => {
	registerTasks({
		distName: '${name}-${version}-${liferayPlugin.version}',
		extensions(options) {
			expect(options.distName).toBe('test-plugin-layouttpl-1.2.3-7.0');

			done();
		},
		gulp,
	});
});