Bug report writing in Testing Fundamentals - Test Execution Trace

Test Overview

This test simulates writing a clear and effective bug report after finding a problem in a software application. It verifies that the bug report contains all necessary details to help developers understand and fix the issue.

Test Code - PyTest

Testing Fundamentals

def test_bug_report_contents():
    # Simulate finding a bug in the app
    bug_found = True
    # Create a bug report dictionary
    bug_report = {
        'title': 'Login button not working',
        'steps_to_reproduce': [
            'Open the app',
            'Navigate to login page',
            'Click the login button'
        ],
        'expected_result': 'User should be logged in and redirected to dashboard',
        'actual_result': 'Nothing happens when login button is clicked',
        'severity': 'High',
        'environment': 'Android 12, App version 1.4.2'
    }
    # Assertions to verify bug report completeness
    assert bug_found is True
    assert bug_report['title'] != ''
    assert len(bug_report['steps_to_reproduce']) > 0
    assert bug_report['expected_result'] != ''
    assert bug_report['actual_result'] != ''
    assert bug_report['severity'] in ['Low', 'Medium', 'High', 'Critical']
    assert bug_report['environment'] != ''

Execution Trace - 7 Steps

Step	Action	System State	Assertion	Result
1	Test starts and simulates finding a bug in the app	Bug found flag is set to True	Check bug_found is True	PASS
2	Creates a bug report with title, steps, expected and actual results, severity, and environment	Bug report dictionary is populated with all required fields	Verify bug_report['title'] is not empty	PASS
3	Verifies steps to reproduce are listed	Steps to reproduce list has 3 steps	Check length of bug_report['steps_to_reproduce'] > 0	PASS
4	Checks expected result is described	Expected result string is present	bug_report['expected_result'] is not empty	PASS
5	Checks actual result is described	Actual result string is present	bug_report['actual_result'] is not empty	PASS
6	Verifies severity level is valid	Severity is 'High'	bug_report['severity'] in ['Low', 'Medium', 'High', 'Critical']	PASS
7	Checks environment details are provided	Environment string is present	bug_report['environment'] is not empty	PASS

Failure Scenario

Failing Condition: Bug report missing required fields or bug_found flag is False

Execution Trace Quiz - 3 Questions

What does the test verify about the bug report's severity?

A Severity is not checked in this test

B It can be any string describing the problem

C It must be one of Low, Medium, High, or Critical

D Severity must always be High

Key Result

Always include clear and complete information in a bug report: title, steps to reproduce, expected and actual results, severity, and environment. This helps developers fix bugs faster.

Practice

1. What is the main purpose of writing a bug report in software testing?

easy

A. To clearly explain the problem and how to reproduce it

B. To praise the software for its features

C. To describe the software's design

D. To list all the software's functions

Solution

1. Step 1: Understand the role of a bug report

   A bug report is meant to communicate a problem clearly so developers can fix it.

2. Step 2: Identify the correct purpose

   Among the options, only explaining the problem and how to reproduce it matches the bug report's goal.

3. Final Answer:

   To clearly explain the problem and how to reproduce it -> Option A

4. Quick Check:

   Bug report purpose = clear problem explanation [OK]

Hint: Focus on clear problem explanation and reproduction steps [OK]

Common Mistakes:

• Confusing bug report with feature description
• Writing vague problem statements
• Ignoring reproduction steps

2. Which of the following is the correct way to write the 'Expected Result' in a bug report?

easy

A. The software crashes sometimes.

B. The software is slow.

C. I don't like how the software looks.

D. The software should save the file without errors.

Solution

1. Step 1: Understand what 'Expected Result' means

   It describes what should happen when the software works correctly.

2. Step 2: Choose the option that clearly states the correct expected behavior

   The software should save the file without errors. clearly states the expected behavior: saving the file without errors.

3. Final Answer:

   The software should save the file without errors. -> Option D

4. Quick Check:

   Expected result = correct software behavior [OK]

Hint: Expected result shows correct behavior, not opinions [OK]

Common Mistakes:

• Writing vague or subjective expected results
• Confusing actual and expected results
• Skipping expected result section

3. Consider this bug report snippet:

Steps to reproduce:
1. Open the app
2. Click 'Save'
3. Observe error message

Expected result:
File saves successfully

Actual result:
Error message 'Save failed'

What is the main problem this bug report helps identify?

medium

A. The save function shows an error instead of saving

B. The app crashes on startup

C. The error message text is correct

D. The app saves files too quickly

Solution

1. Step 1: Analyze the steps and results

   The steps show clicking 'Save' leads to an error message instead of saving.

2. Step 2: Match the problem with options

   The save function shows an error instead of saving correctly describes the issue: save function shows error instead of saving.

3. Final Answer:

   The save function shows an error instead of saving -> Option A

4. Quick Check:

   Bug report identifies save error issue [OK]

Hint: Match steps and results to find the problem [OK]

Common Mistakes:

• Ignoring actual vs expected results
• Misreading the steps
• Choosing unrelated options

4. A tester writes this bug report:

Steps:
1. Login
2. Click 'Profile'
3. See blank page

Expected: Profile page loads
Actual: Blank page

What is missing that would improve this bug report?

medium

A. The tester should add unrelated screenshots

B. The tester should remove the expected result

C. The tester should add environment details like browser and OS

D. The tester should write a longer story

Solution

1. Step 1: Review the bug report content

   The report has steps, expected and actual results but lacks environment details.

2. Step 2: Identify what improves bug reports

   Adding environment details helps developers reproduce and fix bugs accurately.

3. Final Answer:

   The tester should add environment details like browser and OS -> Option C

4. Quick Check:

   Environment details improve bug reports [OK]

Hint: Always include environment info for better bug reports [OK]

Common Mistakes:

• Skipping environment details
• Adding irrelevant information
• Ignoring clear reproduction steps

5. You find a bug that only happens when the user uploads a file larger than 5MB on a slow internet connection. What is the best way to write this bug report?

hard

A. Report the bug without any reproduction steps.

B. Report the bug with steps, expected vs actual results, and mention file size and network speed.

C. Report the bug but say it happens on all file sizes.

D. Report only that the upload fails without details.

Solution

1. Step 1: Identify key details for reproduction

   File size and network speed are important to reproduce this bug.

2. Step 2: Choose the option that includes clear steps and environment details

   Report the bug with steps, expected vs actual results, and mention file size and network speed. includes steps, expected vs actual results, and important conditions.

3. Final Answer:

   Report the bug with steps, expected vs actual results, and mention file size and network speed. -> Option B

4. Quick Check:

   Include all relevant details for complex bugs [OK]

Hint: Include all conditions that trigger the bug [OK]

Common Mistakes:

• Omitting important reproduction conditions
• Giving vague or incomplete steps
• Ignoring environment factors