Merge pull request #573 from guardicore/567/add-code-coverage

567/add code coverage

.travis.yml

@@ -15,6 +15,7 @@ install:
 # Python
 - pip install -r monkey/monkey_island/requirements.txt  # for unit tests
 - pip install flake8 pytest dlint  # for next stages
+- pip install coverage  # for code coverage
 - pip install -r monkey/infection_monkey/requirements.txt  # for unit tests
 
 before_script:
@@ -23,24 +24,28 @@ before_script:
 
 script:
 # Check Python code
-# Check syntax errors and fail the build if any are found.
+## Check syntax errors and fail the build if any are found.
 - flake8 . --count --select=E901,E999,F821,F822,F823 --show-source --statistics
 
-# Warn about linter issues.
-# --exit-zero forces Flake8 to use the exit status code 0 even if there are errors, which means this will NOT fail the build.
-# --count will print the total number of errors.
-# --statistics Count the number of occurrences of each error/warning code and print a report.
-# The output is redirected to a file.
+## Warn about linter issues.
+### --exit-zero forces Flake8 to use the exit status code 0 even if there are errors, which means this will NOT fail the build.
+### --count will print the total number of errors.
+### --statistics Count the number of occurrences of each error/warning code and print a report.
+### The output is redirected to a file.
 - flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics > flake8_warnings.txt
-# Display the linter issues
+## Display the linter issues
 - cat flake8_warnings.txt
-# Make sure that we haven't increased the amount of warnings.
+## Make sure that we haven't increased the amount of warnings.
 - PYTHON_WARNINGS_AMOUNT_UPPER_LIMIT=190
-- if [ $(tail -n 1 flake8_warnings.txt) -gt $PYTHON_WARNINGS_AMOUNT_UPPER_LIMIT ]; then echo "Too many warnings! Failing this build. Lower the amount of linter errors in this and try again. " && exit 1; fi
+- if [ $(tail -n 1 flake8_warnings.txt) -gt $PYTHON_WARNINGS_AMOUNT_UPPER_LIMIT ]; then echo "Too many python linter warnings! Failing this build. Lower the amount of linter errors in this and try again. " && exit 1; fi
 
+## Run unit tests
 - cd monkey  # This is our source dir
 - python -m pytest  # Have to use `python -m pytest` instead of `pytest` to add "{$builddir}/monkey/monkey" to sys.path.
 
+## Calculate Code Coverage
+- coverage run -m pytest
+
 # Check JS code. The npm install must happen AFTER the flake8 because the node_modules folder will cause a lot of errors.
 - cd monkey_island/cc/ui
 - npm i
@@ -51,6 +56,10 @@ script:
 - JS_WARNINGS_AMOUNT_UPPER_LIMIT=37
 - eslint ./src --max-warnings $JS_WARNINGS_AMOUNT_UPPER_LIMIT
 
+after_success:
+  # Upload code coverage results to codecov.io, see https://github.com/codecov/codecov-bash for more information
+  - bash <(curl -s https://codecov.io/bash)
+
 notifications:
   slack:  # Notify to slack
       rooms:

README.md

@@ -1,6 +1,9 @@
 # Infection Monkey
-[![Build Status](https://travis-ci.com/guardicore/monkey.svg?branch=develop)](https://travis-ci.com/guardicore/monkey)
 [![GitHub release (latest by date)](https://img.shields.io/github/v/release/guardicore/monkey)](https://github.com/guardicore/monkey/releases)
+
+[![Build Status](https://travis-ci.com/guardicore/monkey.svg?branch=develop)](https://travis-ci.com/guardicore/monkey)
+[![codecov](https://codecov.io/gh/guardicore/monkey/branch/master/graph/badge.svg)](https://codecov.io/gh/guardicore/monkey)
+
 ![GitHub stars](https://img.shields.io/github/stars/guardicore/monkey)
 ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/guardicore/monkey)
 
@@ -14,14 +17,15 @@ The Infection Monkey is an open source security tool for testing a data center's
 
 <img src=".github/Security-overview.png" width="800" height="500">
 
-
 The Infection Monkey is comprised of two parts:
-* Monkey - A tool which infects other machines and propagates to them
-* Monkey Island - A dedicated server to control and visualize the Infection Monkey's progress inside the data center
 
-To read more about the Monkey, visit http://infectionmonkey.com 
+* **Monkey** - A tool which infects other machines and propagates to them.
+* **Monkey Island** - A dedicated server to control and visualize the Infection Monkey's progress inside the data center.
+
+To read more about the Monkey, visit [infectionmonkey.com](https://infectionmonkey.com). 
 
 ## Main Features
+
 The Infection Monkey uses the following techniques and exploits to propagate to other machines.
 
 * Multiple propagation techniques:
@@ -42,12 +46,10 @@ Check out the [Setup](https://github.com/guardicore/monkey/wiki/setup) page in t
 
 The Infection Monkey supports a variety of platforms, documented [in the wiki](https://github.com/guardicore/monkey/wiki/OS-compatibility).
 
-
 ## Building the Monkey from source
 To deploy development version of monkey you should refer to readme in the [deployment scripts](deployment_scripts) folder.
 If you only want to build the monkey from source, see [Setup](https://github.com/guardicore/monkey/wiki/Setup#compile-it-yourself)
-and follow the instructions at the readme files under [infection_monkey](infection_monkey) and [monkey_island](monkey_island). 
-
+and follow the instructions at the readme files under [infection_monkey](monkey/infection_monkey) and [monkey_island](monkey/monkey_island). 
 
 ### Build status
 | Branch | Status |
@@ -56,13 +58,21 @@ and follow the instructions at the readme files under [infection_monkey](infecti
 | Master | [![Build Status](https://travis-ci.com/guardicore/monkey.svg?branch=master)](https://travis-ci.com/guardicore/monkey) | 
 
 ## Tests
+
 ### Unit Tests
+
 In order to run all of the Unit Tests, run the command `python -m pytest` in the `monkey` directory. 
 
+To get a coverage report, first make sure the `coverage` package is installed using `pip install coverage`. Run the command 
+`coverage run -m unittest` in the `monkey` directory and then `coverage html`. The coverage report can be found in 
+`htmlcov.index`.  
+
 ### Blackbox tests
+
 In order to run the Blackbox tests, refer to `envs/monkey_zoo/blackbox/README.md`. 
 
 # License
+
 Copyright (c) Guardicore Ltd
 
 See the [LICENSE](LICENSE) file for license rights and limitations (GPLv3).

monkey/codecov.yml

@@ -0,0 +1,20 @@
+codecov:
+  require_ci_to_pass: yes
+
+coverage:
+  precision: 2
+  round: down
+  range: "50...90"
+
+parsers:
+  gcov:
+    branch_detection:
+      conditional: yes
+      loop: yes
+      method: no
+      macro: no
+
+comment:
+  layout: "reach,diff,flags,tree"
+  behavior: default
+  require_changes: no

monkey/pytest.ini

@@ -4,3 +4,4 @@ log_cli_level = DEBUG
 log_cli_format = %(asctime)s [%(levelname)s] %(module)s.%(funcName)s.%(lineno)d: %(message)s
 log_cli_date_format=%H:%M:%S
 addopts = -v --capture=sys
+norecursedirs = node_modules dist