github.com/composer22/pzscan

pzscan

A simple site scanner in golang to validate links and content are SEO compliant.

Description

This simple application will transverse a given URL and report back the following confirmations:

• All resources can be loaded on the page (CSS, js, images), and all links point to a working URL (non-4xx/non-5xx response).
• Pages have a canonical link tag.
• Pages have meta descriptions and each description is between 131 and 154 characters.
• Pages have title tags between 57 and 68 characters.
• Images have "alt" attributes.
• Pages are allowed only one "h1" tag.

Note: Images, javascript, and css files are tested for downloading separately. css files are not parsed for img content.

Each element result is written to the log as an INFO message with a json encoded structure of the statistics of the scan. These can then be imported into a database for queries.

Usage

Usage: pzscan [options...]

Server options:
    -H, --hostname HOSTNAME          HOSTNAME to scan (default: example.com).
    -X, --procs MAX                  MAX processor cores to use from the
	                                 machine (default 1).
    -m, --minutes MAX                MAX minutes to live (default: 5).
    -W, --workers MAX                MAX running workers allowed (default: 4).

Common options:
    -h, --help                       Show this message.
    -V, --version                    Show version.

Example:

    # Scan example.com; 1 processor; 2 min max; 10 worker go routines.

    ./pzscan -H "example.com" -X 1 -m 2 -W 10

Building

This code currently requires version 1.42 or higher of Golang.

Information on Golang installation, including pre-built binaries, is available at http://golang.org/doc/install.

Run go version to see the version of Go which you have installed.

Run go build inside the directory to build.

Run go test ./... to run the unit regression tests.

A successful build run produces no messages and creates an executable called pzscan in this directory.

Run go help for more guidance, and visit http://golang.org/ for tutorials, presentations, references and more.

Docker Image

A prebuilt docker image is available at (http://www.docker.com) pzscan

If you have docker installed, run:

docker pull composer22/pzscan:latest

See /docker directory README for more information on how to run it.

License

(The MIT License)

Copyright (c) 2015 Pyxxel Inc.

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.