jamiehannaford/doc-validator

Simple scraper for validating nested XML/JSON examples in HTML

doc-validator

Simple scraper for validating nested XML/JSON examples in OpenStack/Rackspace doc files., _(*1)

General outline

1. Executes a recursive wget for a given URI. The process follows every link nested in a given piece of markup until every possible link is exhausted. It saves each remote URI to the local filesystem. An example location might be: ./docs/docs.openstack.org, where docs.openstack.org is the root URI you specified. Only HTML files are saved, any other remote file type is omitted., _(*2)

2. Once the wget procedure is complete, the PHP script traverses the local directory recursively, scanning each HTML file for a given regex pattern. The regular expression indicates how code samples are nested into the markup., _(*3)

3. Once code samples are extracted, the script judges whether it is either JSON or XML. It then executes the relevant parsing test for either type., _(*4)

4. If the parsing fails, it is likely malformed, and generates an error. These errors can either be output to the console (i.e. STDOUT) or to a local log file., _(*5)

CLI options

The main script you will need to run is:, _(*6)

./bin/doc-validator

Supported CLI flags

Convenience scripts

To run against docs.openstack.org, run: ./bin/openstack, _(*7)

To run against docs.rackspace.com, run: ./bin/rackspace, _(*8)

Installation

You will need to install this package with Composer:, _(*9)

# Install Composer executable
curl -sS https://getcomposer.org/installer | php

# Install package
php composer.phar require jamiehannaford/doc-validator:1.0.0

You can then access the binary:, _(*10)

./vendor/bin/doc-validator -udocs.foo.com -q -l < /dev/null &

Because you have left the --log-file flag empty, it will log everything to a default location:, _(*11)

./vendor/jamiehannaford/doc-validator/log/docs.foo.com.log