Create a JSDom instance for browserless testing, exposing some handling methods
JavaScript
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

jsdomify

Build Status Coverage Status

A ready to use DOM right at your finger tips for easy and fast testing without any browser in the Node environment (with mocha, for example)

as of jsdom 7.x, jsdomify requires Node v4.x
For node 0.1x compatibility please see jsdomify-compat

Getting started

npm install --save-dev jsdomify

Usage

You can create a new jsdom instance simply with

import jsdomify from 'jsdomify';
jsdomify.create();

If you're using ReactJS, you have to be careful of requiring it after you've created a DOM instance, like:

import jsdomify from 'jsdomify';
let React;

describe('ReactElement', () => {
  
  before(() => {
    jsdomify.create();
    React = require('react');
  });
  
  after(() => {
    jsdomify.destroy();
  });
  
  it('should test something', () => {
    // your test case  
  });
  
});

You can even provide an HTML string that will be used as your DOM

jsdomify.create(
  '<!DOCTYPE html><html><head></head><body>hello</body></html>'
);

Methods

jsdomify expose some useful methods that can be used to control the DOM instance

create(domString)

jsdomify.create();

Create a new DOM instance (with or without an optional DOM string).

clear()

jsdomify.clear();

Clear the current instance and recreate a new one using the same DOM string (if any).

destroy()

jsdomify.destroy([clearRequireCache]);

Close the window, destroy the document and all the other leaked globals. Can be used to isolate the tests and prevent leaking from one test suite to another.

If clearRequireCache === true all the cached node-require modules will be purged (defaults to true).
This is needed in order to use ReactJS with MochaJS and prevent caching issues from one test to another.

Related issues:

getDocument()

const documentRef = jsdomify.getDocument();
const elm = documentRef.getElementById('whatever');

Get a reference to the document that has been created as a global.
Useful when running with strict linting that doesn't allow globals but you still want to test directly on the document.

Usage examples

From our very own test suite

describe('Isolation test', function() {

  before(function() {
    jsdomify.create();
  });

  beforeEach(function() {
    jsdomify.clear();
  });

  after(function() {
    jsdomify.destroy();
  });

  it('should append a child to the body', function() {

    let par = document.createElement("P");
    const text = document.createTextNode("some text");
    par.appendChild(text);
    document.body.appendChild(par);
    const parCount = document.getElementsByTagName("P");

    expect(document.body.innerHTML, 'not to be empty');
    expect(parCount.length, 'to be', 1);
  });

  it('should not find the previously appended child', function() {

    const parCount = document.getElementsByTagName("P");

    expect(document.body.innerHTML, 'to be empty');
    expect(parCount.length, 'to be', 0);
  });

});

Test

npm test

License

The MIT License (MIT)

Copyright (c) 2015 Domenico Matteo

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.