t/1: Introduce tests and Bender.js #11

fredck · 2015-01-20T16:46:51Z

Fixes #1.

Tests for ckeditor5 code included with 100% code coverage.

…ugin for it.

…o it can be tested.

…have full URLs.

gregpabian · 2015-01-21T07:23:06Z

dev/bender/plugins/ckeditor5/static/extensions.js

+( function() {
+	// Override bender.start to wait until the "ckeditor" module is ready.
+	var originalStart = bender.start;
+	bender.start = function() {


I'm not sure if we discussed this already, but I think we should consider adding some space between the variable definition and the rest of the code. It would improve the readability of the code because right now it looks a bit crammed.

+1 and in this case it also matches the "margin around blocks" rule that we agreed on.

… match with "it".

fredck · 2015-01-21T10:57:33Z

@gregpabian, I've fixed all your comments.

Reinmar · 2015-01-21T12:34:44Z

tests/ckeditor/ckeditor.js

+
+			expect( path ).to.equal( basePath + 'plugins/test/' );
+
+			CKEDITOR.getPluginPath = originalGetPluginPath;


It's not going to be executed if expect().equal() throws. I don't know how it works in Mocha+Chai, but in CKE4 you would need to handle teardown outside the test or in try-catch-finally :D.

Nice catch... I've just pushed a fix for it by simply reverting the override before the assertion.

… failure.

…odules in tests.

fredck · 2015-01-22T10:32:16Z

Just pushed commits that introduce bender.amd.require(), making the tests much cleaner.

…ywhere else.

gregpabian · 2015-01-22T11:30:51Z

tests/ckeditor/ckeditor.js

+
+bender.amd.require( 'ckeditor', 'ckeditor-core' );
+
+describe( 'getPluginPath()', function( CKEDITOR, core ) {


I'm not so convinced with this solution - this means we have to keep in mind the order of required modules and write them down in every describe's callback. I think this solution would work better:

var modules = bender.amd.require( 'ckeditor', 'ckeditor-core' );

And then we can use modules.ckeditor etc.

Besides, I feel it's too closely coupled with Mocha (which could be avoided thanks to bender.defer).

Still you would much probably not call modules.ckeditor directly, but instead have var CKEDITOR = modules.ckeditor on every single test, messing things again. This describe() helper cleans things up by defining this variables once only as its callback parameters.

Also, to make it work right, var modules would have to go in the global scope. Maybe not a big deal, but not better than the current solution as well.

Additionally, the proposed gives this sensation of being much similar to AMD (list of requires and modules as params).

I don't know, I still like it a lot and I don't see the big deal.

Besides, I feel it's too closely coupled with Mocha (which could be avoided thanks to bender.defer).

I don't understand this.

this means we have to keep in mind the order of required modules and write them down in every describe's callback

Hm... Makes sense. Usually we're testing one thing in one file, so there will be one describe() call. But eventually this mechanism will be adopted by benderjs-amd and then other projects will start using it and may want to use far more describe()s.

Besides that, I'm ok with both APIs.

But eventually this mechanism will be adopted by benderjs-amd

Just to underline this, this feature has been coded with the CKEditor 5 dev environment in mind, exclusively, and is proposed in the ckeditor5 plugin for bender right because of this. It is optimized for our needs and the way we code tests.

I don't understand this.

I mean the current solution is for BDD frameworks only (it's based on describe() method) - you can't use other testing framework/style with it, whereas the solution with the modules variable would work.

I agree, but please check my previous comment. This is intentional.

A generic solution may look different, in fact, but we should not miss the chance to bring an optimized solution to be used by us only.

This reverts commit 1137ff7.

This reverts commit 41ec3ce.

…Editor modules in tests." This reverts commit 26f6c7c.

…r modules in tests.

fredck · 2015-01-22T14:28:03Z

Changed strategy so now bender.amd.require() returns an object that will hold all loaded modules.

gregpabian · 2015-01-23T08:14:48Z

dev/bender/plugins/ckeditor5/lib/index.js

+];
+
+module.exports = {
+	name: 'bender-framework-ckeditor5',


framework is no longer needed

Fixed with 0de6f6b.

t/1: Introduce tests and Bender.js

Reinmar · 2015-02-13T17:57:11Z

.gitignore

@@ -9,3 +9,4 @@

 node_modules/**
 build/**
+coverage/**


What's in this directory? AFAICS we didn't have to ignore it in CKE4.

This is created while running bender run with coverage plugin enabled. I want to avoid a situation where someone accidentally pushes CC results to the repo.

fredck added 9 commits January 19, 2015 17:32

Added npm devDependency for bender with mocha and chai.

118a4eb

Initialized the bender configuration file.

ffe17c5

Introduced the "ckeditor" application in bender and the CKEditor 5 pl…

e7e9834

…ugin for it.

Added code coverage support for bender.

09fa91e

Added basic tests for AMD.

c9ad4d0

Made it in a way that "ckeditor-core" keeps its original definition s…

5aa7d5a

…o it can be tested.

Removed code that should (hopefully) be deprecated as scripts always …

dd79ce5

…have full URLs.

Added a "dev" flag to CKEDITOR.

2946304

Added tests for CKEDITOR.

47cde86

fredck added the type:improvement This issue reports a possible enhancement of an existing feature. label Jan 20, 2015

gregpabian reviewed Jan 21, 2015
View reviewed changes

fredck added 5 commits January 21, 2015 10:05

Changed the ckeditor plugin for bender to user bender.defer().

87f8200

Reviewed the tests titles and made better use of "describe" to better…

19e29d0

… match with "it".

Standardized the equality checks to to.equal().

6488116

Fixed a wrong object check in tests.

0c63b0a

Minor white-space cleanup.

ebcbd4e

Reinmar reviewed Jan 21, 2015
View reviewed changes

fredck added 3 commits January 21, 2015 14:51

Fixed an override reversion that would not take place in case of test…

758b958

… failure.

Introduced bender.amd.require() - a tool to easily require CKEditor m…

26f6c7c

…odules in tests.

Reviewed tests to use bender.amd.require().

41ec3ce

fredck mentioned this pull request Jan 22, 2015

t/4: Added tests for "utils" ckeditor/ckeditor5-engine#5

Merged

Avoided a test dependency on utils.isObject(), which is not in use an…

70373f7

…ywhere else.

gregpabian reviewed Jan 22, 2015
View reviewed changes

fredck added 6 commits January 22, 2015 14:18

Added support for describe.skip().

1137ff7

Revert "Added support for describe.skip()."

a7f512d

This reverts commit 1137ff7.

Revert "Reviewed tests to use bender.amd.require()."

907ef34

This reverts commit 41ec3ce.

Revert "Introduced bender.amd.require() - a tool to easily require CK…

af63433

…Editor modules in tests." This reverts commit 26f6c7c.

Re-introduced bender.amd.require() - a tool to easily require CKEdito…

a8afa0a

…r modules in tests.

Re-reviewed tests to use bender.amd.require().

338f468

fredck added 3 commits January 22, 2015 16:33

Moved the bender.amd.require() call out of describe().

c15dbcd

Removing third-party libs from code coverage.

938c8d9

Passing code coverage through untestable code.

6bf8aa1

gregpabian reviewed Jan 23, 2015
View reviewed changes

fredck and others added 5 commits February 3, 2015 14:02

Upgraded to Bender 0.2.

61c5f9c

Corrected the plugin name.

0de6f6b

Added support for Sinon.

a60cb57

Exclude code coverage reports from the repository.

a530d20

Minor typo fixes.

0968169

gregpabian added the review+ label Feb 12, 2015

gregpabian added a commit that referenced this pull request Feb 12, 2015

Merge pull request #11 from cksource/t/1

21b0cf9

t/1: Introduce tests and Bender.js

gregpabian merged commit 21b0cf9 into ckeditor:master Feb 12, 2015

gregpabian deleted the t/1 branch February 12, 2015 12:14

Reinmar reviewed Feb 13, 2015
View reviewed changes

gregpabian mentioned this pull request Mar 2, 2015

t/16: Introduced the configuration API ckeditor/ckeditor5-engine#19

Merged

gregpabian mentioned this pull request Oct 9, 2019

Unify some assertion styles in the tests #3437

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

t/1: Introduce tests and Bender.js #11

t/1: Introduce tests and Bender.js #11

fredck commented Jan 20, 2015

gregpabian Jan 21, 2015

Reinmar Jan 21, 2015

fredck commented Jan 21, 2015

Reinmar Jan 21, 2015

fredck Jan 21, 2015

fredck commented Jan 22, 2015

gregpabian Jan 22, 2015

fredck Jan 22, 2015

Reinmar Jan 22, 2015

fredck Jan 22, 2015

gregpabian Jan 22, 2015

fredck Jan 22, 2015

fredck commented Jan 22, 2015

gregpabian Jan 23, 2015

fredck Feb 3, 2015

Reinmar Feb 13, 2015

gregpabian Feb 16, 2015


		expect( path ).to.equal( basePath + 'plugins/test/' );

		CKEDITOR.getPluginPath = originalGetPluginPath;


		bender.amd.require( 'ckeditor', 'ckeditor-core' );

		describe( 'getPluginPath()', function( CKEDITOR, core ) {

t/1: Introduce tests and Bender.js #11

t/1: Introduce tests and Bender.js #11

Conversation

fredck commented Jan 20, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fredck commented Jan 21, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fredck commented Jan 22, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fredck commented Jan 22, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment