Initial unit tests for front-end framework #4576
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 7 commits
August 26, 2019 17:28
w20k
reviewed
Sep 1, 2019
|
@bennothommo could you update Travis? I think we could merge this one after a quick review :) |
added 2 commits
September 24, 2019 16:42
|
@w20k All sync'd up :) |
|
LGTM, @bennothommo. Awesome work! |
LukeTowers
added
Status: Completed
and removed
Status: Review Needed
Testing Needed
labels
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this does
This is a proof-of-concept for unit tests for our front-end JavaScript libraries and frameworks. This current implementation uses an NPM pipeline to test the
framework.jsfile that is made available to the themes.The pipeline leverages jsdom to create a virtual DOM to test the scripts and HTML in a fake environment, and mocha and chai to run and assert the test cases.
What's included
At this stage, there's just a single test case file for
framework.jswhich can be found intests/js/cases/system/framework.test.js. In addition, a helper module has been set up to quickly create a fake DOM, found intests/js/helpers/fakeDom.js.Future applicability
Ideal candidates for future application of this testing framework would be our form widgets that are controlled primarily through JavaScript, such as the repeater and datatable widgets.
How to test this out
Before starting, you will need Node.js and NPM installed - https://nodejs.org/en/ for more information on this.
wip/js-unit-testsbranch.npm ito install the necessary dependencies as defined inpackage.json.npm run testto run the test cases. The test cases can be found intests/js/cases.Other changes
One minor change was made to the real
framework.js- changing a redirect fromwindow.location.hreftowindow.location.assign, so that it could be mocked in the tests (JS properties cannot be easily mocked). This should have no effect on the functionality.