<div class="post-toc-block float-default with-border"> 
						<div class="post-toc-header">Table of Contents</div>
						<nav id="md-post-toc" class="md-post-toc"></nav>
						</div><p>In this blog, we will demonstrate how to get the code coverage data for each incoming request on a python web server built using any web framework.</p>
</p>
<h2>What is Code Coverage ?</h2>
<p>Code coverage is a metric used in <a href="https://keploy.io/blog/community/understanding-code-coverage-in-software-testing">software testing</a> to measure the extent to which the source code of a program has been executed during testing. It indicates the percentage of code that has been covered by the test cases. It analysis helps developers understand how thoroughly their tests exercise the codebase.</p>
<p>Coverage tools are used to collect data on code execution during testing and generate reports showing the coverage metrics. These reports help developers identify areas of the code that are not adequately covered by tests, allowing them to write additional tests to improve coverage and increase confidence in the software&#8217;s correctness and reliability.</p>
<h2>What does it mean to get coverage data for each request ?</h2>
<p>Obtaining coverage data for each request coming to a web server offers several benefits:</p>
<ol>
<li><a href="https://www.corteva.us/products-and-solutions/digital-solutions/granular-insights.html"><strong>Granular Insights</strong></a>: By capturing coverage data for each request, developers gain detailed insights into which parts of the codebase are executed in response to different types of requests. This level of granularity allows for a deeper understanding of the application&#8217;s behavior under various conditions.</li>
<li><strong>Identifying Untested Code Paths</strong>: Coverage data helps identify areas of the code that are not adequately covered by tests. By analyzing coverage reports, developers can pinpoint specific code paths that need additional testing, ensuring comprehensive test coverage across the entire codebase.</li>
<li><strong>Building deduplication feature:</strong> coverage data for each e2e testcase can be analyzed to identify duplicate tests and remove them.</li>
</ol>
<h3>Obtaining coverage data</h3>
<p>To obtain the coverage data, we would be using the coverage.py library. coverage.py is mostly used through CLI. But it provides API to use it programmatically.</p>
<p>We will define a middleware through which every incoming request would pass. In our &quot;coverage&quot; middleware before passing control to other parts of our application, we will call <code>start</code> function from coverage library. Coverage measurement is only collected in functions called after <code>start()</code> function is invoked, so if this middleware is scheduled to run first then coverage of other middleware would also be captured along with main application code.</p>
<p>Once the application returns then we would stop collecting coverage data. We can then fetch the data and further process it.</p>
<p>The below is a code snippet for the coverage middleware which can be used in servers built using flask web framework:</p>
<pre><code class="language-python">
import coverage

class CoverageMiddleware:
    def __init__(self, app):
        self.app = app

    def __call__(self, environ, start_response):
        cov = coverage.Coverage(cover_pylib=False)
        cov.start()
        response = self.app(environ, start_response)
        cov.stop()
        result = cov.get_data()
        Write(result)
        return response</code></pre>
<p><em>here,</em><code>Write</code><em>function writes the coverage data to a file, say dedupData.yaml, which can then be used to identify duplicate testcases in e2e scenario.</em></p>
<p>Here is the modified sample python application with middleware and writing logic in place : <a href="https://github.com/AkashKumar7902/samples-python/tree/v1.0.0/flask-mongo"><a href="https://github.com/AkashKumar7902/samples-python/tree/v1.0.0/flask-mongo"><a href="https://github.com/AkashKumar7902/samples-python/tree/v1.0.0/flask-mongo">https://github.com/AkashKumar7902/samples-python/tree/v1.0.0/flask-mongo</a></a></a></p>
<p>The repository includes test cases generated by Keploy, which can be replayed using the command <code>keploy test -c &quot;python</code><a href="http://app.py"><code>app.py</code></a><code>&quot;</code>. Upon successful execution of this command, a <code>dedupdata.yaml</code> file will be generated. This file will contain details of the executed files, including the lines covered, for each test case.</p>
<p>Here is a sample dedupdata.yaml:</p>
<pre><code class="language-yaml">
- id: test-1
  executedLinesByFile:
    /home/akash/Desktop/githubrepo/samples-python/flask-mongo/app.py:
    - 33
    - 34
    - 35
- id: test-2
  executedLinesByFile:
    /home/akash/Desktop/githubrepo/samples-python/flask-mongo/app.py:
    - 24
    - 23</code></pre>
<h3>Using Coverage data to identify duplicate tests</h3>
<p>Earlier written <code>dedupData.yaml</code> which contains coverage data for each testcases, can be used to identify and flag duplicate testcases by analyzing similar codepaths.</p>
<p>There are also multiple deduplication features for test cases based on coverage data for Keploy Cloud.</p>
<h2><strong>Conclusion</strong></h2>
<p>This is how with very little code change you can collect coverage data for each incoming requests and prioritise increasing coverage for most frequent requests and also it can be used to build a deduplication feature.</p>
<p><strong><em>Reference:</em></strong><a href="https://coverage.readthedocs.io/en/7.4.1/api.html"><a href="https://coverage.readthedocs.io/en/7.4.1/api.html"><a href="https://coverage.readthedocs.io/en/7.4.1/api.html">https://coverage.readthedocs.io/en/7.4.1/api.html</a></a></a></p>
<h2>FAQ&#8217;s</h2>
<h3>How can coverage data for each request benefit developers?</h3>
<p>Obtaining coverage data for each request provides granular insights into the codebase&#8217;s execution under various conditions, helps identify untested code paths, and can be used to build deduplication features for test cases.</p>
<h3>How can coverage data be obtained in a Python web server?</h3>
<p>Coverage data can be obtained using the <code>coverage.py</code> library, which provides both CLI and API for collecting coverage metrics programmatically. In a web server, coverage data can be captured using a middleware that wraps around the application logic and collects coverage information for each incoming request.</p>
<h3>What are some deduplication features for test cases based on coverage data?</h3>
<p>Deduplication features for test cases based on coverage data may include identifying and flagging duplicate tests by analyzing similar code paths, removing redundant tests, and optimizing test suites for better coverage and efficiency.</p>

         
        
                    

                    
                    <div class="pp-multiple-authors-boxes-wrapper pp-multiple-authors-wrapper pp-multiple-authors-layout-boxed multiple-authors-target-the-content box-post-id-16 box-instance-id-1 ppma_boxes_16"
                    data-post_id="16"
                    data-instance_id="1"
                    data-additional_class="pp-multiple-authors-layout-boxed.multiple-authors-target-the-content"
                    data-original_class="pp-multiple-authors-boxes-wrapper pp-multiple-authors-wrapper box-post-id-16 box-instance-id-1">
                                                                                    <h2 class="widget-title box-header-title">Author</h2>
                                                                            <span class="ppma-layout-prefix"></span>
                        <div class="ppma-author-category-wrap">
                                                                                                <span class="ppma-category-group ppma-category-group-">
                                                                                                                        <ul class="pp-multiple-authors-boxes-ul">
                                                                                                                                                                                                                                                                                                                                                                                                                    <li class="pp-multiple-authors-boxes-li author_index_0 author_akash-kumar has-avatar">
                                                                                                                                                                                                                                            <div class="pp-author-boxes-avatar">
                                                                                                                                            <img alt='Akash Kumar' src='https://wp.keploy.io/wp-content/uploads/2024/10/Gravatar-Logo.jpg' srcset='https://wp.keploy.io/wp-content/uploads/2024/10/Gravatar-Logo.jpg' class='multiple_authors_guest_author_avatar avatar' height='80' width='80'/>                                                                                                                                    </div>
                                                            
                                                            <div class="pp-author-boxes-avatar-details">
                                                                                                                                                                                                <div class="pp-author-boxes-name multiple-authors-name">
                                                                        <a href="https://wp.keploy.io/author/akash-kumar/" rel="author" title="Akash Kumar" class="author url fn">Akash Kumar</a> 
                                                                    </div>
                                                                                                                                                                                                                                                                    <p class="pp-author-boxes-description multiple-authors-description">
                                                                        Akash Kumar is a software developer with a strong focus on backend technologies and API development. He works on building scalable systems and improving software performance through efficient coding practices.                                                                    </p>
                                                                                                                                
                                                                                                                                
                                                                                                                            </div>
                                                                                                                                                                                                                                                                                                                                                                                                             </li>
                                                                                                                                                                                                                                    </ul>
                                                                            </span>
                                                                                    </div>
                    <span class="ppma-layout-suffix"></span>
                    </div>
                    
                    
                
                                <style>
                .pp-multiple-authors-boxes-wrapper.box-post-id-16.pp-multiple-authors-layout-boxed.multiple-authors-target-the-content.box-instance-id-1 .pp-author-boxes-avatar img { width: 80px !important; height: 80px !important; } .pp-multiple-authors-boxes-wrapper.box-post-id-16.pp-multiple-authors-layout-boxed.multiple-authors-target-the-content.box-instance-id-1 .pp-author-boxes-avatar img { border-style: none !important; } .pp-multiple-authors-boxes-wrapper.box-post-id-16.pp-multiple-authors-layout-boxed.multiple-authors-target-the-content.box-instance-id-1 .pp-author-boxes-avatar img { border-radius: 50% !important; } .pp-multiple-authors-boxes-wrapper.box-post-id-16.pp-multiple-authors-layout-boxed.multiple-authors-target-the-content.box-instance-id-1 .pp-author-boxes-meta a { background-color: #655997 !important; } .pp-multiple-authors-boxes-wrapper.box-post-id-16.pp-multiple-authors-layout-boxed.multiple-authors-target-the-content.box-instance-id-1 .pp-author-boxes-meta a { color: #ffffff !important; } .pp-multiple-authors-boxes-wrapper.box-post-id-16.pp-multiple-authors-layout-boxed.multiple-authors-target-the-content.box-instance-id-1 .pp-author-boxes-meta a:hover { color: #ffffff !important; } .pp-multiple-authors-boxes-wrapper.box-post-id-16.pp-multiple-authors-layout-boxed.multiple-authors-target-the-content.box-instance-id-1 .ppma-author-user_email-profile-data { background-color: #655997 !important; } .pp-multiple-authors-boxes-wrapper.box-post-id-16.pp-multiple-authors-layout-boxed.multiple-authors-target-the-content.box-instance-id-1 .ppma-author-user_email-profile-data { border-radius: 100% !important; } .pp-multiple-authors-boxes-wrapper.box-post-id-16.pp-multiple-authors-layout-boxed.multiple-authors-target-the-content.box-instance-id-1 .ppma-author-user_email-profile-data { color: #ffffff !important; } .pp-multiple-authors-boxes-wrapper.box-post-id-16.pp-multiple-authors-layout-boxed.multiple-authors-target-the-content.box-instance-id-1 .ppma-author-user_url-profile-data { background-color: #655997 !important; } .pp-multiple-authors-boxes-wrapper.box-post-id-16.pp-multiple-authors-layout-boxed.multiple-authors-target-the-content.box-instance-id-1 .ppma-author-user_url-profile-data { border-radius: 100% !important; } .pp-multiple-authors-boxes-wrapper.box-post-id-16.pp-multiple-authors-layout-boxed.multiple-authors-target-the-content.box-instance-id-1 .ppma-author-user_url-profile-data { color: #ffffff !important; } .pp-multiple-authors-boxes-wrapper.box-post-id-16.pp-multiple-authors-layout-boxed.multiple-authors-target-the-content.box-instance-id-1 .pp-author-boxes-recent-posts-title { border-bottom-style: dotted !important; } .pp-multiple-authors-boxes-wrapper.box-post-id-16.pp-multiple-authors-layout-boxed.multiple-authors-target-the-content.box-instance-id-1 .pp-multiple-authors-boxes-li { border-style: solid !important; } .pp-multiple-authors-boxes-wrapper.box-post-id-16.pp-multiple-authors-layout-boxed.multiple-authors-target-the-content.box-instance-id-1 .pp-multiple-authors-boxes-li { border-width: 1px !important; } .pp-multiple-authors-boxes-wrapper.box-post-id-16.pp-multiple-authors-layout-boxed.multiple-authors-target-the-content.box-instance-id-1 .pp-multiple-authors-boxes-li { border-color: #999 !important; } .pp-multiple-authors-boxes-wrapper.box-post-id-16.pp-multiple-authors-layout-boxed.multiple-authors-target-the-content.box-instance-id-1 .pp-multiple-authors-boxes-li { color: #3c434a !important; }             </style>

Getting code coverage data for each request coming to a python web server

How to Use Software Testing Metrics to Drive Better QA Decisions

Load vs Performance vs Stress Testing: Differences & Examples

What is Grey Box Testing? (Techniques & Example)

What You Need to Know About Root Cause Analysis

What is UAT? A Complete Guide to User Acceptance Testing

Mockito Spy: Your Complete Guide to Testing with Real Objects

How to Check Network Latency

Building Keploy.io, an EBPF based open source framework to generate test cases and data stubs from API calls.

Neha Gupta

Cloud technology veteran and probably the youngest (globally) to have completed all 5 AWS certifications (including Solutions architect Professional and Dev­ops engineer professional)

Getting Code Coverage Data For Each Request Coming To A Python Web Server

More Stories