/** * @license Copyright (c) 2003-2015, CKSource - Frederico Knabben. All rights reserved. * For licensing, see LICENSE.md. */ /* global describe, it, beforeEach, afterEach */ 'use strict'; const chai = require( 'chai' ); const sinon = require( 'sinon' ); const expect = chai.expect; const tools = require( '../tasks/utils/tools' ); const path = require( 'path' ); const fs = require( 'fs' ); let toRestore; describe( 'utils', () => { beforeEach( () => toRestore = [] ); afterEach( () => { toRestore.forEach( item => item.restore() ); } ); describe( 'tools', () => { describe( 'linkDirectories', () => { it( 'should be defined', () => expect( tools.linkDirectories ).to.be.a( 'function' ) ); it( 'should link directories', () => { const isDirectoryStub = sinon.stub( tools, 'isDirectory' ).returns( false ); const symlinkStub = sinon.stub( fs, 'symlinkSync' ); const source = '/source/dir'; const destination = '/destination/dir'; toRestore.push( symlinkStub, isDirectoryStub ); tools.linkDirectories( source, destination ); expect( isDirectoryStub.calledOnce ).to.equal( true ); expect( symlinkStub.calledOnce ).to.equal( true ); expect( symlinkStub.firstCall.args[ 0 ] ).to.equal( source ); expect( symlinkStub.firstCall.args[ 1 ] ).to.equal( destination ); } ); it( 'should remove destination directory before linking', () => { const shExecStub = sinon.stub( tools, 'shExec' ); const isDirectoryStub = sinon.stub( tools, 'isDirectory' ).returns( true ); const symlinkStub = sinon.stub( fs, 'symlinkSync' ); const source = '/source/dir'; const destination = '/destination/dir'; toRestore.push( symlinkStub, shExecStub, isDirectoryStub ); tools.linkDirectories( source, destination ); expect( isDirectoryStub.calledOnce ).to.equal( true ); expect( shExecStub.calledOnce ).to.equal( true ); expect( symlinkStub.firstCall.args[ 0 ] ).to.equal( source ); expect( symlinkStub.firstCall.args[ 1 ] ).to.equal( destination ); } ); } ); describe( 'getCKEditorDependencies', () => { it( 'should be defined', () => expect( tools.getCKEditorDependencies ).to.be.a( 'function' ) ); it( 'should return null if no CKEditor5 repository is found', () => { const dependencies = { 'plugin1': '', 'plugin2': '', 'plugin3': '' }; expect( tools.getCKEditorDependencies( dependencies ) ).to.equal( null ); } ); it( 'should return only ckeditor5- dependencies', () => { const dependencies = { 'plugin1': '', 'ckeditor5-plugin-image': 'ckeditor/ckeditor5-plugin-image', 'plugin2': '', 'ckeditor5-core': 'ckeditor/ckeditor5-core' }; const ckeditorDependencies = tools.getCKEditorDependencies( dependencies ); expect( ckeditorDependencies ).to.be.an( 'object' ); expect( ckeditorDependencies.plugin1 ).to.be.a( 'undefined' ); expect( ckeditorDependencies.plugin2 ).to.be.a( 'undefined' ); expect( ckeditorDependencies[ 'ckeditor5-plugin-image' ] ).to.be.a( 'string' ); expect( ckeditorDependencies[ 'ckeditor5-core' ] ).to.be.a( 'string' ); } ); } ); describe( 'getDirectories', () => { it( 'should be defined', () => expect( tools.getDirectories ).to.be.a( 'function' ) ); it( 'should get directories in specified path', () => { const fs = require( 'fs' ); const directories = [ 'dir1', 'dir2', 'dir3' ]; const readdirSyncStub = sinon.stub( fs, 'readdirSync', () => directories ); const isDirectoryStub = sinon.stub( tools, 'isDirectory' ).returns( true ); const dirPath = 'path'; toRestore.push( readdirSyncStub, isDirectoryStub ); tools.getDirectories( dirPath ); expect( readdirSyncStub.calledOnce ).to.equal( true ); expect( isDirectoryStub.calledThrice ).to.equal( true ); expect( isDirectoryStub.firstCall.args[ 0 ] ).to.equal( path.join( dirPath, directories[ 0 ] ) ); expect( isDirectoryStub.secondCall.args[ 0 ] ).to.equal( path.join( dirPath, directories[ 1 ] ) ); expect( isDirectoryStub.thirdCall.args[ 0 ] ).to.equal( path.join( dirPath, directories[ 2 ] ) ); } ); } ); describe( 'isDirectory', () => { it( 'should be defined', () => expect( tools.isDirectory ).to.be.a( 'function' ) ); it( 'should return true if path points to directory', () => { const fs = require( 'fs' ); const statSyncStub = sinon.stub( fs, 'statSync', () => ( { isDirectory: () => true } ) ); const path = 'path'; toRestore.push( statSyncStub ); const result = tools.isDirectory( path ); expect( statSyncStub.calledOnce ).to.equal( true ); expect( statSyncStub.firstCall.args[ 0 ] ).to.equal( path ); expect( result ).to.equal( true ); } ); it( 'should return false if path does not point to directory', () => { const fs = require( 'fs' ); const statSyncStub = sinon.stub( fs, 'statSync', () => ( { isDirectory: () => false } ) ); const path = 'path'; toRestore.push( statSyncStub ); const result = tools.isDirectory( path ); expect( statSyncStub.calledOnce ).to.equal( true ); expect( statSyncStub.firstCall.args[ 0 ] ).to.equal( path ); expect( result ).to.equal( false ); } ); it( 'should return false if statSync method throws', () => { const fs = require( 'fs' ); const statSyncStub = sinon.stub( fs, 'statSync' ).throws(); const path = 'path'; toRestore.push( statSyncStub ); const result = tools.isDirectory( path ); expect( statSyncStub.calledOnce ).to.equal( true ); expect( statSyncStub.firstCall.args[ 0 ] ).to.equal( path ); expect( result ).to.equal( false ); } ); } ); describe( 'getCKE5Directories', () => { it( 'should be defined', () => expect( tools.getCKE5Directories ).to.be.a( 'function' ) ); it( 'should return only ckeditor5 directories', () => { const workspacePath = '/workspace/path'; const sourceDirectories = [ 'tools', 'ckeditor5', 'ckeditor5-core', '.bin', 'ckeditor5-plugin-image' ]; const getDirectoriesStub = sinon.stub( tools, 'getDirectories', () => sourceDirectories ); toRestore.push( getDirectoriesStub ); const directories = tools.getCKE5Directories( workspacePath ); expect( directories.length ).equal( 2 ); expect( directories[ 0 ] ).equal( 'ckeditor5-core' ); expect( directories[ 1 ] ).equal( 'ckeditor5-plugin-image' ); } ); } ); describe( 'updateJSONFile', () => { it( 'should be defined', () => expect( tools.updateJSONFile ).to.be.a( 'function' ) ); it( 'should read, update and save JSON file', () => { const path = 'path/to/file.json'; const fs = require( 'fs' ); const readFileStub = sinon.stub( fs, 'readFileSync', () => '{}' ); const modifiedJSON = { modified: true }; const writeFileStub = sinon.stub( fs, 'writeFileSync' ); toRestore.push( readFileStub, writeFileStub ); tools.updateJSONFile( path, () => { return modifiedJSON; } ); expect( readFileStub.calledOnce ).to.equal( true ); expect( readFileStub.firstCall.args[ 0 ] ).to.equal( path ); expect( writeFileStub.calledOnce ).to.equal( true ); expect( writeFileStub.firstCall.args[ 0 ] ).to.equal( path ); expect( writeFileStub.firstCall.args[ 1 ] ).to.equal( JSON.stringify( modifiedJSON, null, 2 ) ); } ); } ); describe( 'npmInstall', () => { it( 'should be defined', () => expect( tools.npmInstall ).to.be.a( 'function' ) ); it( 'should execute npm install command', () => { const shExecStub = sinon.stub( tools, 'shExec' ); const path = '/path/to/repository'; toRestore.push( shExecStub ); tools.npmInstall( path ); expect( shExecStub.calledOnce ).to.equal( true ); expect( shExecStub.firstCall.args[ 0 ] ).to.equal( `cd ${ path } && npm install` ); } ); } ); describe( 'installGitHooks', () => { it( 'should be defined', () => expect( tools.installGitHooks ).to.be.a( 'function' ) ); it( 'should execute grunt githooks command', () => { const shExecStub = sinon.stub( tools, 'shExec' ); const path = '/path/to/repository'; toRestore.push( shExecStub ); tools.installGitHooks( path ); expect( shExecStub.calledOnce ).to.equal( true ); expect( shExecStub.firstCall.args[ 0 ] ).to.equal( `cd ${ path } && grunt githooks` ); } ); } ); describe( 'copyTemplateFiles', () => { it( 'should be defined', () => expect( tools.copyTemplateFiles ).to.be.a( 'function' ) ); it( 'should copy template files', () => { const path = require( 'path' ); const TEMPLATE_PATH = './dev/tasks/templates'; const templatesPath = path.resolve( TEMPLATE_PATH ); const shExecStub = sinon.stub( tools, 'shExec' ); const repositoryPath = '/path/to/repository'; toRestore.push( shExecStub ); tools.copyTemplateFiles( repositoryPath ); expect( shExecStub.calledOnce ).to.equal( true ); expect( shExecStub.firstCall.args[ 0 ] ).to.equal( `cp ${ path.join( templatesPath, '*.md' ) } ${ repositoryPath }` ); } ); } ); describe( 'getGitUrlFromNpm', () => { const repository = { type: 'git', url: 'git@github.com:ckeditor/ckeditor5-core' }; const moduleName = 'ckeditor5-core'; it( 'should be defined', () => expect( tools.getGitUrlFromNpm ).to.be.a( 'function' ) ); it( 'should call npm view command', () => { const shExecStub = sinon.stub( tools, 'shExec', () => { return JSON.stringify( repository ); } ); toRestore.push( shExecStub ); const url = tools.getGitUrlFromNpm( moduleName ); expect( shExecStub.calledOnce ).to.equal( true ); expect( shExecStub.firstCall.args[ 0 ] ).to.equal( `npm view ${ moduleName } repository --json` ); expect( url ).to.equal( repository.url ); } ); it( 'should return null if module is not found', () => { const shExecStub = sinon.stub( tools, 'shExec' ).throws( new Error( 'npm ERR! code E404' ) ); toRestore.push( shExecStub ); const url = tools.getGitUrlFromNpm( moduleName ); expect( url ).to.equal( null ); } ); it( 'should throw on other errors', () => { const error = new Error( 'Random error.' ); const shExecStub = sinon.stub( tools, 'shExec' ).throws( error ); const getUrlSpy = sinon.spy( tools, 'getGitUrlFromNpm' ); toRestore.push( shExecStub ); toRestore.push( getUrlSpy ); try { tools.getGitUrlFromNpm( moduleName ); } catch ( e ) {} expect( getUrlSpy.threw( error ) ).to.equal( true ); } ); } ); } ); } );