not-impressed

A generalized multi-stage build scanner written in nodejs

Provides a simple structure for discovering, building, scanning, and parsing the various groupings of build systems with tools that analyze them.

dependencies

• Nodejs >= 0.8.x

optional dependencies

Any.

Some dependencies that have been used with success.

• maven, java
• bundler, ruby, rubygems
• license_finder
• OWASP Dependency Check

installation

npm install -g not-impressed

or as a dependency in your package.json

configuration

Create a configuration object that describes how to build and/or scan things.

When using a globally installed ni, this takes the form of a a .ni.json file in root path of your project. (see examples for more useful configurations)

{
    "Report": "Your Report Name",
    "output": "results.json"
}

When requiring this module in your own project, specify at least one target.

{
    "Report": "Your Report Name",
    "targets": [
        {"/some/interesting/build": "" }
    ]
}

configuration examples

• build and scan
• running a scan only
• arbitrary phases
• multiple targets
• displaying debug information
• running license_finder

usage

on a command shell

cd <your repository with a .ni.json file>
ni

Results are generated in JSON format based on .ni.json configuration.

To include not-impressed in your Travis build, add the following to .travis.yml.

before_script:
  - npm install -g not-impressed
script:
 - ni

Here is an example of including not-impressed in your node application directly.

var ni = require('not-impressed'),
    util = require('util');


var conf = {
    "Report": "Your Report Name",
    "targets": [
        {"..": "" }
    ],
    ...
}

ni.run(conf, function(output){
    console.log(util.inspect(output, true, null));
});

You can also leverage a webservice docker container (for play only!) at not-impressed-docker

testing

Mochajs needs to be installed

npm install -g mocha

running tests

mocha test