dom-validate

dom-validate

A tool to check required/refused DOM nodes, can also output TAP or JUnit reports

Usage

# Install
npm install dom-validate -g

# Check for Google page, there should be a .lsb element
node-validate -u 'https://google.com/' -r '.lsb' -v=2

# Check for Yahoo page, there should not be any empty link
node-validate -u 'https://us.yahoo.com/' -n 'a[href=""]' -v=2

# Yes, there should not be any broken images...check again
node-validate -u 'https://us.yahoo.com/' -n 'img[src=""]' -v=2

Command line options

• -u specify a url string to verify
• -r specify the css selector for the required element
• -n specify the css selector for the refused element
• -v show verbose message for the error cases
• -v=2 show verbose message for the success cases
• -v=3 show verbose message for the html of css selector selected elements
• -c [BATCH] specify a local yaml config file to do batch check
• -b [BATCH] specify base URL
• -t [BATCH] output result as TAP format

The exit code will be the number of failed cases.

BATCH check example

Try this command: node-validate -c sample.yaml -b https://tw.search.yahoo.com -v=2

The content of sample.yaml can be:

# do one check for one URL
http://google.com:
  require: .lsb

# do 2 required element checks for the URL
http://us.yahoo.com:
  require:
    - body > div
    - form

# do many required and refused element check for the URL
/search?p=test:
  require:
    - body > div
    - form button
  refuse:
    - 'a[href=""]'

Sample output:

# check for http://google.com
OK: required element ".lsb" found(2)
# check for http://us.yahoo.com
OK: required element "body > div" found(2)
OK: required element "form" found(1)
# check for https://tw.search.yahoo.com/search?p=test
OK: required element "body > div" found(1)
OK: required element "form button" found(2)
OK: refused element "a[href=""]" not found

Output test report

Try this to save TAP report file as result.tap:

node-validate -c sample.yaml -b https://tw.search.yahoo.com -t > result.tap

You may also get JUnit (xUnit) report file by:

npm install tap-xunit -g
node-validate -c sample.yaml -b https://tw.search.yahoo.com -t | tap-xunit > junit-result.xml

node module usage

var DV = require('dom-validate');

// validate by a HTML string
DV.validateHTML(htmlString, options);

// validate by an URL
DV.validateURL(urlString, options);

// validate by a yaml config file
DV.validateByYaml(yamlFileName, options);

Options

var options = {
    url: 'http://sample.com',                  // URL for error or debug message
    baseURL: 'https://test.com',               // Will be used for relative URL when call .validateByYaml()
    require: 'body',                           // String or Array of CSS selector to check
    refuse: ['a[href=""]', 'img[src=""]'],     // String or Array of CSS selector to check
    exit: false,                               // true to end process when test done, the exit code will be number of failed case
    verbose: false,                            // true to show message for success cases
                                               // 2 to show verbose message for the success cases
                                               // 3 to show verbose message for the html of css selector selected elements
    report: false,                             // true to output TAP report
    callback: function (err, options) {        // Will be executed for every cases
        if (err) {
            // err will be the error message string when the case failed
            console.log('ERROR!' + err);
            return;
        } else {
            // success case
            connsole.log('OK!');
        }
        // You can get the whole options object in callback function, plus:
        // options.selector will be the CSS selector of current case
        // options.nodes will be the selected nodes (check cheerio document)
        // options.task will be 'require' or 'refuse'
    }
};