sep_resit_a1_coveragepy

https://github.com/niekmill/sep_resit_a1_coveragepy

Repository

README.rst

Report for Assignment 1 Resit
==============================

Project Chosen:
--------------------------

- **Name:** Coveragepy
- **URL:** `https://github.com/nedbat/coveragepy/tree/master`
- **Number of lines of code and the tool used to count it:** 971593 lines with lizard
- **Programming language:** Python

Coverage Measurement with Existing Tool
----------------------------------------

- **Tool Used:** Coverage.py
- **Execution Method:** The existing tool was used through my mac terminal after fixing many failures and errors. I ran it with coverage run -m pytest and then coverage report to see the results.
- **Coverage Results:**

  .. image:: https://github.com/niekmill/SEP_resit_A1_coveragepy/raw/main/images/coverageresultOG.png
     :width: 1200
     :align: center


Coverage Improvement
---------------------


Function 1: patch_multiprocessing
---------------------------------

- **Patch or Commit Link:** 
    Test creation commit: https://github.com/niekmill/SEP_resit_A1_coveragepy/commit/49a3c9b1b7844a8bcffed5fcf8202833976d442b

- **Old Coverage Results:** 

  .. image:: https://github.com/niekmill/SEP_resit_A1_coveragepy/raw/main/images/oldpatchmultiprocessing.png
     :width: 1200
     :align: center

- **New Coverage Results:** 

  .. image:: https://github.com/niekmill/SEP_resit_A1_coveragepy/raw/main/images/improvedcovresult.png
     :width: 1200
     :align: center

- **Coverage Improvement:** 29.5%
- **Elaboration:** Added test cases to cover all cases of input, resulting in better branch coverage

Function 2: current
--------------------

- **Patch or Commit Link:** 
    Test creation commit: https://github.com/niekmill/SEP_resit_A1_coveragepy/commit/5a68a2143c837d61b23139c86f10df6cd119f101

- **Old Coverage Results:** 

  .. image:: https://github.com/niekmill/SEP_resit_A1_coveragepy/raw/main/images/oldcurrent.png
     :width: 1200
     :align: center

- **New Coverage Results:** 

  .. image:: https://github.com/niekmill/SEP_resit_A1_coveragepy/raw/main/images/improvedcovresult2.png
     :width: 1200
     :align: center

- **Coverage Improvement:** 40%
- **Elaboration:** Added test cases to cover all cases of input, resulting in better branch coverage

Overall
-------

- **Old Coverage Results:** 

  .. image:: https://github.com/niekmill/SEP_resit_A1_coveragepy/raw/main/images/coverageresultOG.png
     :width: 600
     :align: center

- **New Coverage Results:** 

  .. image:: https://github.com/niekmill/SEP_resit_A1_coveragepy/raw/main/images/coverageresultNEW.png
     :width: 600
     :align: center

Owner

Citation (CITATION.cff)

# Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0
# For details: https://github.com/nedbat/coveragepy/blob/master/NOTICE.txt

cff-version: 1.2.0
title: "Coverage.py: The code coverage tool for Python"
message: >-
  If you use this software, please cite it using the metadata from this file.
type: software
authors:
  - family-names: Batchelder
    given-names: Ned
    orcid: https://orcid.org/0009-0006-2659-884X
  - name: "Contributors to Coverage.py"
repository-code: "https://github.com/nedbat/coveragepy"
url: "https://coverage.readthedocs.io/"
abstract: >-
  Coverage.py is a tool for measuring code coverage of Python programs. It monitors your program,
  noting which parts of the code have been executed, then analyzes the source to identify code
  that could have been executed but was not.
  Coverage measurement is typically used to gauge the effectiveness of tests. It can show which
  parts of your code are being exercised by tests, and which are not.
license: Apache-2.0

GitHub Events