Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 32 commits into from Feb 12, 2015
Merged

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

merged 32 commits into from Feb 12, 2015

Conversation

fredck
Copy link
Contributor

@fredck fredck commented Jan 20, 2015

Fixes #1.

Tests for ckeditor5 code included with 100% code coverage.

@fredck fredck added the type:improvement This issue reports a possible enhancement of an existing feature. label Jan 20, 2015
( function() {
// Override bender.start to wait until the "ckeditor" module is ready.
var originalStart = bender.start;
bender.start = function() {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@fredck
Copy link
Contributor Author

fredck commented Jan 21, 2015

@gregpabian, I've fixed all your comments.


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

CKEDITOR.getPluginPath = originalGetPluginPath;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@fredck
Copy link
Contributor Author

fredck commented Jan 22, 2015

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


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

describe( 'getPluginPath()', function( CKEDITOR, core ) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@fredck
Copy link
Contributor Author

fredck commented Jan 22, 2015

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

];

module.exports = {
name: 'bender-framework-ckeditor5',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

framework is no longer needed

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed with 0de6f6b.

gregpabian added a commit that referenced this pull request Feb 12, 2015
t/1: Introduce tests and Bender.js
@gregpabian gregpabian merged commit 21b0cf9 into ckeditor:master Feb 12, 2015
@gregpabian gregpabian deleted the t/1 branch February 12, 2015 12:14
@@ -9,3 +9,4 @@

node_modules/**
build/**
coverage/**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:improvement This issue reports a possible enhancement of an existing feature.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Introduce tests and Bender.js
3 participants