jasinner / victims-db-builder

victims-db-builder

Parses CVE files from github.com/victims/victims-cve-db Downloads artifacts, and submits them to victims web api

Development

This is a short guide on how to work with this codebase

Requirements

• virtualenv
• pip

Setup the development environment

Create a virtualenv using:

virtualenv dbuild

You should see the following output, and a new folder 'dbbuild' should be created.

New python executable in dbbuild/bin/python2.7
Also creating executable in dbbuild/bin/python
Installing setuptools, pip, wheel...done.

Activate the development environment

Activate the previously created environment using:

source dbuild/bin/activate

Once this is complete, you should see the name prepended to the command prompt eg: '(dbbuild)'

Install the required dependencies

Install dependencies using 'pip':

 pip install -r requirements.txt

Submit a single report:

 python processor.py ../tests/data/7501.yaml <username> <password>

Run the test suite

Install test dependencies using pip

  pip install -r test-requirements.txt

Use 'nose' to execute the test suite, found in the 'tests' directory using:

nosetests

Output will look like this for a successful run of the tests:

............
----------------------------------------------------------------------
Ran 12 tests in 16.545s

OK

Create a source distribution

Using distutil to create a '.tar' source distribution of the project:

python setup.py sdist

After running this, you should have a '.tar' file in 'dist/'