OpenSourceWorkshop - Coderage

Coderage is a package that allows running tests and code coverage in comparison over time. The purpose of this project is to enable easy and efficient analyzing and conclusion drawing regarding software testing.

Requirements for Installing:

• git clone https://github.com/shakedkialy/Coderage.git
• pip install -e <path to package>
• Wait for the package to be successfully installed - "Successfully installed Coderage"

Test Your Installment:

• If you clone our files in git, the folder DemoProject contains examples files for running (module1, module2 folders contain 2 code modules for example. Tests contains pytest tests for these modules).
  enter code_examples directory cd DemoProject and run this command:
  Coderage test -m . -t Tests
  This command runs coverage on the whole directory and runs the tests in the Tests_Examples folder.

After this command line script is complete, you should see the following message:

  Coverage annotated source written to dir Results\annotate
  Coverage HTML written to dir Results\html
  Coverage XML written to file Results\coverage.xml

Usage Instructions

1. Name your test files test_filename or filename_test (for pytest to recognize them as test files)

• In order to run Coderage you can use the following command:
  Coderage test -m <modules> -t <tests>
  or Coderage merge -f <first database> -s <second database> -o <output path>

Coderage -h will display this:

usage: Coderage [-h] {test,merge} ...

Usage: Coderage -m <Modules to test> -t <Test directory>

positional arguments:
{test,merge}  help for subcommand
  test        arguments to test your program
  merge       arguments to merge two databases

optional arguments:
-h, --help    show this help message and exit

Coderage test -h will display this:

usage: Coderage [-h] [-m  [...]] [-t  [...]] [-o] [-d] [-ct] [-e [[...]]]

Usage: Coderage -m <Modules to test> -t <Test directory>

optional arguments:
  -h, --help            show this help message and exit
  -m  [ ...], --module  [ ...]
                        Path to your tested modules
  -t  [ ...], --tests  [ ...]
                        Path to your tests directory
  -o , --out_dir        Path to your output directory
  -d , --delete_out     True/False, delete unnecessary pytest files from out
                        dir
  -ct , --create_template
                      True/False, Creates template files to help
                      build tests for all untested functions
  -e [ [ ...]], --extra_args [ [ ...]]
                        Extra args to pass pytest

and Coderage merge -h will display this:

usage: Coderage merge [-h] -f  -s  -o

optional arguments:
-h, --help       show this help message and exit
-f , --first     Path to the first database
-s , --second    Path to the second database
-o , --out_dir   Path to your output directory

Results

• The Coderage results located under Results folder in your project directory. Results folder created after at least one run.

  • Results\html contains HTML files where you can find graphs and analysis of your last run.
  • Results\tests_templates contains the test files templates, if asked to create them.
  • Results\coverage
  • Results\annotate
    Notice that the package automatically deletes the result files that aren't necessary for the html report. If you wish to keep all the files, add the parameter delete_out=False to the command line.

• To view the results of this package open main_index.html (located in /Results/html/main_index.html) via any web browser and navigate from there to all the reports.