Skip to main content

A continuous integration tool for Python static analysis

Project description

bugcatcher-ci

Continuous Integration Tool Assisting in Static Code Analysis Facilitated Through BugCatcher by Faster Than Light

PyPI version CircleCI

Issues Forks Stars License: GPL v2

Installation

Installing with PIP

pip install bugcatcher-ci

Sample Integration

Please view the changed files in this PR. Setting up your testing is as easy as following this example and making sure you have an environment variable saved on CircleCI/TravisCI for FTL_SID. Your FTL_SID can be found on the dashboard of your BugCatcher account at https://bugcatcher.fasterthanlight.dev

Example of a test run using BugCatcher-CI:

% pytest -s
=============================================================== test session starts ===============================================================
platform darwin -- Python 3.8.0, pytest-5.2.2, py-1.8.0, pluggy-0.13.0
rootdir: /sampleproject
plugins: bugcatcher-0.1.6
collected 2 items                                                                                                                                 

tests/test_simple.py 
Testing codebase with BugCatcher API...
Uploading "sampleproject" code to BugCatcher...
Found a `.gitignore` file. Evaluating files...
6 of 20 local files match .gitignore patterns.
14 files ready to upload...
Local item MANIFEST.in
Local item README.md
Local item setup.py
Local item .gitignore
Local item tox.ini
Local item setup.cfg
Local item LICENSE.txt
Local item .travis.yml
Local item tests/test_simple.py
Local item tests/__init__.py
Local item sample/__init__.py
Local item sample/package_data.dat
Local item data/data_file
Local item .circleci/config.yml
Sending new files:
	.circleci/config.yml
	.gitignore
	.travis.yml
	LICENSE.txt
	MANIFEST.in
	README.md
	data/data_file
	sample/__init__.py
	sample/package_data.dat
	setup.cfg
	setup.py
	tests/__init__.py
	tests/test_simple.py
	tox.ini

14 items total changed

Running tests on "sampleproject" using BugCatcher...
BugCatcher results for "sampleproject":

Severity: low ===> tests/test_simple.py (lines 15-15)
	assert_used - Use of assert detected. The enclosed code will be removed when compiling to optimised byte code.

Severity: low ===> tests/test_simple.py (lines 17-17)
	assert_used - Use of assert detected. The enclosed code will be removed when compiling to optimised byte code.

Severity: low ===> tests/test_simple.py (lines 21-21)
	assert_used - Use of assert detected. The enclosed code will be removed when compiling to optimised byte code.

Minimum Severity Level to FAIL tests: "medium"
PASSING! - All results are less than "medium" level severity.
..

=============================================================== 2 passed in 34.72s ================================================================

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for bugcatcher-ci, version 0.1.9
Filename, size File type Python version Upload date Hashes
Filename, size bugcatcher_ci-0.1.9-py2.py3-none-any.whl (12.4 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size bugcatcher-ci-0.1.9.tar.gz (13.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page