Defect reporting best practices in Testing Fundamentals - Test Execution Trace

Test Overview

This test simulates reporting a defect in a software application. It verifies that the defect report contains all necessary information such as steps to reproduce, expected and actual results, severity, and environment details.

Test Code - unittest

Testing Fundamentals

import unittest

class DefectReport:
    def __init__(self, title, steps, expected, actual, severity, environment):
        self.title = title
        self.steps = steps
        self.expected = expected
        self.actual = actual
        self.severity = severity
        self.environment = environment

    def is_complete(self):
        return all([
            bool(self.title.strip()),
            bool(self.steps.strip()),
            bool(self.expected.strip()),
            bool(self.actual.strip()),
            self.severity in ['Low', 'Medium', 'High', 'Critical'],
            bool(self.environment.strip())
        ])

class TestDefectReporting(unittest.TestCase):
    def test_defect_report_completeness(self):
        report = DefectReport(
            title="Login button not working",
            steps="1. Open login page\n2. Enter valid credentials\n3. Click login button",
            expected="User should be logged in and redirected to dashboard",
            actual="Nothing happens when login button is clicked",
            severity="High",
            environment="Windows 11, Chrome 114"
        )
        self.assertTrue(report.is_complete(), "Defect report is incomplete or invalid")

if __name__ == '__main__':
    unittest.main()

Execution Trace - 5 Steps

Step	Action	System State	Assertion	Result
1	Test starts	Test framework initialized, ready to run test_defect_report_completeness	—	PASS
2	Create DefectReport object with all required fields filled	DefectReport instance created with title, steps, expected, actual, severity, environment	—	PASS
3	Call is_complete() method to verify all fields are valid and present	Method checks each field for non-empty and severity is valid	All fields are non-empty and severity is one of ['Low', 'Medium', 'High', 'Critical']	PASS
4	Assert that is_complete() returns True	Assertion verifies defect report completeness	assertTrue(report.is_complete())	PASS
5	Test ends successfully	Test framework reports test_defect_report_completeness PASSED	—	PASS

Failure Scenario

Failing Condition: One or more required fields in the defect report are empty or severity is invalid

Execution Trace Quiz - 3 Questions

What does the test verify about the defect report?

A That the defect report is submitted to the developer

B That the defect report contains screenshots

C That all required fields are filled and severity is valid

D That the defect report is automatically fixed

Key Result

Always include clear, complete, and valid information in defect reports to help developers understand and fix issues quickly.

Practice

1. Which of the following is the most important information to include in a defect report?

easy

A. Number of team members working on the project

B. Steps to reproduce the defect

C. Tester's personal opinion about the software

D. The color scheme of the application

Solution

1. Step 1: Understand the purpose of a defect report

   A defect report should help developers find and fix the problem quickly by providing clear information.

2. Step 2: Identify key information needed

   Steps to reproduce the defect allow developers to see the problem themselves, which is essential.

3. Final Answer:

   Steps to reproduce the defect -> Option B

4. Quick Check:

   Include reproduction steps = C [OK]

Hint: Always include how to reproduce the defect [OK]

Common Mistakes:

• Including irrelevant personal opinions
• Omitting reproduction steps
• Ignoring environment details

2. Which format is best for writing the 'Expected Result' in a defect report?

easy

A. A clear, specific statement like 'The login button should redirect to the dashboard.'

B. A list of unrelated features.

C. A long paragraph about the software's history.

D. A vague description like 'It should work better.'

Solution

1. Step 1: Understand the role of 'Expected Result'

   The expected result tells what should happen if the software works correctly.

2. Step 2: Choose the clear and specific statement

   A clear, specific statement like 'The login button should redirect to the dashboard.' clearly states what the correct behavior is, helping developers understand the issue.

3. Final Answer:

   A clear, specific statement like 'The login button should redirect to the dashboard.' -> Option A

4. Quick Check:

   Expected result must be clear and specific = D [OK]

Hint: Write expected results clearly and specifically [OK]

Common Mistakes:

• Being vague or unclear
• Adding unrelated information
• Writing too much unnecessary detail

3. Given the following defect report snippet, what is missing?

Title: App crashes on clicking 'Save'
Steps:
1. Open app
2. Enter data
3. Click 'Save'
Actual Result: App crashes

medium

A. Environment details like OS and app version

B. Steps to reproduce the defect

C. Actual result description

D. Title of the defect

Solution

1. Step 1: Review the defect report snippet

   The snippet includes title, steps, and actual result but no environment details.

2. Step 2: Identify missing key information

   Environment details (like OS, app version) help reproduce the defect accurately.

3. Final Answer:

   Environment details like OS and app version -> Option A

4. Quick Check:

   Missing environment info = A [OK]

Hint: Always include environment details in defect reports [OK]

Common Mistakes:

• Forgetting environment info
• Assuming steps are enough
• Ignoring actual result clarity

4. A tester writes this defect report:

Title: Error message shown
Steps:
1. Click 'Submit'
2. See error
Expected Result: No error
Actual Result: Error message appears

What is the main problem with this report?

medium

A. The actual result is missing

B. The expected result is incorrect

C. The steps are too vague and not detailed enough

D. The title is too long

Solution

1. Step 1: Analyze the steps provided

   The steps only say 'Click Submit' and 'See error' without details like what page or data was entered.

2. Step 2: Understand why detailed steps matter

   Without clear steps, developers cannot reproduce the defect reliably.

3. Final Answer:

   The steps are too vague and not detailed enough -> Option C

4. Quick Check:

   Vague steps cause confusion = A [OK]

Hint: Write detailed, clear steps to reproduce defects [OK]

Common Mistakes:

• Writing vague reproduction steps
• Ignoring environment info
• Not specifying expected results clearly

5. You are reporting a defect that happens only on mobile devices running Android 12. Which combination of details is best to include in your defect report to help developers fix it quickly?

hard

A. Only the error message text and your phone brand

B. Expected result and a list of all tested devices

C. Steps to reproduce and a long history of previous defects

D. Steps to reproduce, expected vs actual results, device model, OS version, and a screenshot

Solution

1. Step 1: Identify key details for mobile-specific defects

   Device model and OS version are critical to reproduce issues on specific platforms.

2. Step 2: Combine with clear reproduction steps and evidence

   Including steps, expected vs actual results, and a screenshot gives full context for developers.

3. Final Answer:

   Steps to reproduce, expected vs actual results, device model, OS version, and a screenshot -> Option D

4. Quick Check:

   Complete details + environment + evidence = B [OK]

Hint: Include environment, steps, results, and screenshots for clarity [OK]

Common Mistakes:

• Omitting device or OS details
• Providing incomplete reproduction steps
• Not attaching helpful evidence like screenshots