coverage-crawler/README.md

1.1 KiB

coverage-crawler

Task Status

A crawler to find websites that exercise code in Firefox that is not covered by unit tests

Software requirements

Usage as a script

  • Install requirements with pip install -r requirements.txt;
  • Install development requirements with pip install -r test-requirements.txt;
  • Run the download_artifacts.py script with the desired revision passed as argument to download the latest Firefox coverage build;
  • Run the run_crawler.py script.

Usage as a module

  • Add this project's repository to your requirements file as a Git dependency;
  • Import coverage_crawler;
  • Use function download_artifacts from latest_cov_build.py with the desired revision passed as argument to download the latest Firefox coverage build and other artifacts;
  • Run function run from crawler.py with the desired website passed as an argument.