Merge pull request #50680 from ShawnKupfer/WB1803

AB#1055059: Testing with Pytest

Author: v-ccolin

learn-pr/language/test-python-with-pytest/1-introduction.yml

@@ -3,8 +3,8 @@ uid: learn.test-python-with-pytest.introduction
 title: Introduction
 metadata:
   title: Introduction to testing with Pytest
-  description: This module will go through the basics of Pytest, a powerful testing tool for Python. You'll learn writing and running tests, and reporting.
-  ms.date: 12/08/2023
+  description: This module will go through the basics of Pytest, a powerful testing tool for Python. You'll learn to write and run tests, as well as reporting.
+  ms.date: 05/27/2025
   author: alfredodeza
   ms.author: alfredodeza
   ms.custom:

learn-pr/language/test-python-with-pytest/2-pytest-basics.yml

@@ -4,7 +4,7 @@ title: Pytest basics
 metadata:
   title: Pytest basics
   description: Find about the basics on testing conventions in Python and Pytest. These conventions will help you organize your tests and get them discovered.
-  ms.date: 12/08/2023
+  ms.date: 05/27/2025
   author: alfredodeza
   ms.author: alfredodeza
   ms.custom:

learn-pr/language/test-python-with-pytest/4-test-classes-and-methods.yml

@@ -4,7 +4,7 @@ title: Test classes and methods
 metadata:
   title: Test classes and methods
   description: Aside from test functions, you can use test classes and methods. Test classes come with helpers and capabilities that will help you write better tests.
-  ms.date: 12/08/2023
+  ms.date: 05/27/2025
   author: alfredodeza
   ms.author: alfredodeza
   ms.custom:

learn-pr/language/test-python-with-pytest/5-exercise.yml

@@ -4,7 +4,7 @@ title: Exercise
 metadata:
   title: Exercise - Write test classes and method for Pytest
   description: Practice writing test classes and methods for tests with Pytest
-  ms.date: 12/08/2023
+  ms.date: 05/27/2025
   author: alfredodeza
   ms.author: alfredodeza
   ms.custom:

learn-pr/language/test-python-with-pytest/6-knowledge-check.yml

@@ -4,7 +4,7 @@ title: Module assessment
 metadata:
   title: Module assessment
   description: Check your knowledge about testing functions and classes with Pytest
-  ms.date: 12/08/2023
+  ms.date: 05/27/2025
   author: alfredodeza
   ms.author: alfredodeza
   ms.custom:
@@ -19,14 +19,14 @@ quiz:
     choices:
     - content: "It makes tests perform faster."
       isCorrect: false
-      explanation: "Incorrect. Tests don’t perform faster when using plain assert statements."
+      explanation: "Incorrect. Tests don't perform faster when using plain assert statements."
     - content: "It allows you to use Python operators for any comparison."
       isCorrect: true
       explanation: "Correct. By using the plain assert statement, you can take advantage of using Python operators for all comparisons."
     - content: "It allows tests to be executed in parallel."
       isCorrect: false
       explanation: "Incorrect. Using plain assert statements aren't required for parallel testing."
-  - content: "What is one reason to group tests in a test class?"
+  - content: "What's one reason to group tests in a test class?"
     choices:
     - content: "So that tests can benefit from a common setup or cleanup."
       isCorrect: true

learn-pr/language/test-python-with-pytest/7-summary.yml

@@ -4,7 +4,7 @@ title: Summary
 metadata:
   title: Summary
   description: In this module, we went through the basics of testing with Pytest. We covered writing and organizing tests and some examples running Pytest.
-  ms.date: 12/08/2023
+  ms.date: 05/27/2025
   author: alfredodeza
   ms.author: alfredodeza
   ms.custom:

learn-pr/language/test-python-with-pytest/includes/1-introduction.md

@@ -1,14 +1,14 @@
-Getting started with testing in Python can be overwhelming. Python's standard library does offer some utilities and helpers to write tests, but has some drawbacks that might make it difficult. 
+Getting started with testing in Python can be overwhelming. Python's standard library offers some utilities and helpers to write tests, but has some drawbacks that might make it difficult. 
 
 Pytest is one of the most popular testing tools and frameworks for Python. Although Pytest can help with highly complex testing scenarios, it doesn't force its capabilities when creating tests. You can write simple tests and still benefit from the fast and featureful test runner and useful reporting.
 
 A crucial aspect of Pytest is that it makes writing tests easier. You can write a test function with no dependencies or configuration and run the test right away.
 
 Here, we cover some of the basics needed to get started with Pytest so you can take your test suite to the next level.
 
-## What you will learn
+## What you'll learn
 
-By the end of this module, you're able to write tests with Pytest, interpret its rich failure reporting, and take advantage of its featureful test runner. You should feel comfortable working with both test functions and classes, and be capable of determining when to use either.
+By the end of this module, you'll be able to write tests with Pytest, interpret its rich failure reporting, and take advantage of its featureful test runner. You should feel comfortable working with both test functions and classes, and be capable of determining when to use either.
 
 This knowledge allows you to:
 
@@ -18,4 +18,4 @@ This knowledge allows you to:
 
 ## What is the main goal?
 
-You should feel comfortable working with Pytest and writing tests for Pytest, allowing you to become a more efficient engineer by helping you write more and better tests.
+You should feel comfortable working with Pytest and writing tests for Pytest, which allows you to become a more efficient engineer by helping you write more and better tests.

learn-pr/language/test-python-with-pytest/includes/2-pytest-basics.md

@@ -1,19 +1,19 @@
-Let's get started testing with Pytest. As we mentioned in the previous unit, Pytest is highly configurable and can handle complex test suites. But it doesn't require much to start writing tests. In fact, the easier a framework allows you to write tests, the better. 
+Let's get started testing with Pytest. As we mentioned in the previous unit, Pytest is highly configurable and can handle complex test suites, but it doesn't require much to start writing tests. In fact, the easier a framework allows you to write tests, the better. 
 
 By the end of this section you should have everything you need to start writing your first tests and run them with Pytest.
 
 ## Conventions
 
 Before diving into writing tests, we must cover some of the testing conventions that Pytest relies on.
 
-There aren't hard rules about test files, test directories, or general testing layouts in Python. By knowing these rules, you can take advantage of automatic test discovery and execution without the need for any extra configuration.
+There aren't many hard rules about test files, test directories, or general testing layouts in Python. By knowing these rules, you can take advantage of automatic test discovery and execution without the need for any extra configuration.
 
 ### Tests directory and test files
 
 The main directory for tests is the *tests* directory. You can place this directory at the root level of the project, but it's also not unusual to see it alongside code modules.
 
 > [!NOTE]
-> In this module we'll default to using *tests* at the root of a project.
+> In this module, we'll default to using *tests* at the root of a project.
 
 Let's see how the root of a small Python project named `jformat` looks:
 
@@ -38,7 +38,7 @@ The *tests* directory is at the root of the project with a single test file. In
 
 ### Test functions
 
-One of the strong arguments for using Pytest is that it allows you to write test functions. Similar to test files, test functions must be prefixed with `test_`. The `test_` prefix ensures that Pytest collects the test and executes it.
+A strong argument for using Pytest is that it allows you to write test functions. Similar to test files, test functions must be prefixed with `test_`. The `test_` prefix ensures that Pytest collects the test and executes it.
 
 Here's what a simple test function looks like:
 
@@ -48,7 +48,7 @@ def test_main():
 ```
 
 > [!NOTE]
-> If you are familiar with `unittest`, it might be surprising to see the use of `assert` in the test function. We cover plain asserts in more detail later, but with Pytest, you get rich failure reporting with plain asserts.
+> If you're familiar with `unittest`, it might be surprising to see the use of `assert` in the test function. We cover plain asserts in more detail later, but with Pytest, you get rich failure reporting with plain asserts.
 
 ### Test classes and test methods
 
@@ -70,15 +70,15 @@ class TestUser:
 
 ## Run tests
 
-Pytest is both a test framework and a test runner. The test runner is an executable in the command line that at a high level can:
+Pytest is both a test framework and a test runner. The test runner is an executable in the command line that (at a high level) can:
 
 - Perform the collection of tests by finding all test files, test classes, and test functions for a test run.
 - Initiate a test run by executing all tests.
-- Keep track of failures, errors, and passing tests. 
+- Keep track of failures, errors, and passing tests.
 - Provide rich reporting at the end of a test run.
 
 > [!NOTE]
-> Since Pytest is an external library it *must* be installed in order to use it.
+> Because Pytest is an external library, it *must* be installed in order to use it.
 
 Given these contents in a *test_main.py* file, we can see how Pytest behaves running the tests:
 
@@ -107,9 +107,9 @@ Behind the scenes, Pytest collects the example test in the test file without any
 
 ### The powerful assert statement
 
-So far, our test examples are all using the plain `assert` call. Usually, in Python, the `assert` statement isn't used for tests because it lacks proper reporting when the assertion fails. Pytest, however, doesn't have this limitation. Behind the scenes, Pytest is enabling the statement to perform rich comparisons without forcing the user to write more code or configure anything.
+So far, our test examples are all using the plain `assert` call. Usually, in Python, the `assert` statement isn't used for tests, because it lacks proper reporting when the assertion fails. Pytest, however, doesn't have this limitation. Behind the scenes, Pytest enables the statement to perform rich comparisons without forcing the user to write more code or configure anything.
 
-By using the plain `assert` statement, you can make use of Python's operators. For example: `>`, `<`, `!=`, `>=`, or `<=`. All of Python's operators are valid. This capability might be the single most crucial feature of Pytest: you aren't required to learn new syntax to write assertions.
+By using the plain `assert` statement, you can make use of Python's operators; for example, `>`, `<`, `!=`, `>=`, or `<=`. All of Python's operators are valid. This capability might be the single most crucial feature of Pytest: you aren't required to learn new syntax to write assertions.
 
 Let's see how that translates when dealing with common comparisons with Python objects. In this case, let's go through the failure report when comparing long strings:
 
@@ -130,7 +130,7 @@ E         ? ^                         +
 test_main.py:4: AssertionError
 ```
 
-Pytest shows useful context around the failure. An incorrect casing at the beginning of the string, and an extra character in a word. But beyond strings, Pytest can help with other objects and data structures. For example, here's how it behaves with lists:
+Pytest shows useful context around the failure: an incorrect casing at the beginning of the string and an extra character in a word. But beyond strings, Pytest can help with other objects and data structures. For example, here's how it behaves with lists:
 
 ```text
 ________________________________ test_lists ________________________________
@@ -193,7 +193,7 @@ E         ...Full output truncated (12 lines hidden), use '-vv' to show
 
 In this test, there are two failures in the dictionary. One is that the `"street"` value is different, and the other one is that `"number"` doesn't match.
 
-Pytest is accurately detecting these differences (even though it's one failure in a single test). Since the dictionaries contain many items, Pytest omits the identical parts and only shows relevant content. Let's see what happens if we make use of the suggested `-vv` flag to increase the verbosity in the output:
+Pytest accurately detects these differences (even though it's one failure in a single test). Because the dictionaries contain many items, Pytest omits the identical parts and only shows relevant content. Let's see what happens if we make use of the suggested `-vv` flag to increase the verbosity in the output:
 
 ```text
 ____________________________ test_dictionaries _____________________________
@@ -224,4 +224,4 @@ E            'zipcode': 30877,
 E           }
 ```
 
-By running `pytest -vv`, the reporting increases the amount of detail and provides a granular comparison. Not only does this report detect and show the failure, but it allows you to quickly make changes to remediate the problem.
+By running `pytest -vv`, the reporting increases the amount of detail and provides a granular comparison. Not only does this report detect and show the failure, but it allows you to quickly make changes to remediate the problem.

learn-pr/language/test-python-with-pytest/includes/4-test-classes-and-methods.md

@@ -1,4 +1,4 @@
-In addition to writing test functions, Pytest allows you to use classes. As we already mentioned, there's no need for inheritance and the test classes follow a few simple rules. Using classes gives you more flexibility and reusability. As you see next, Pytest keeps out of the way and avoids forcing you to write tests in a certain way.
+In addition to writing test functions, Pytest allows you to use classes. As we already mentioned, there's no need for inheritance, and the test classes follow a few simple rules. Using classes gives you more flexibility and reusability. As you see next, Pytest keeps out of the way and avoids forcing you to write tests in a certain way.
 
 Just like functions, you can still write assertions using the `assert` statement.
 
@@ -39,7 +39,7 @@ class TestIsDone:
 ```
 
 > [!CAUTION]
-> The test methods are using the */tmp* path for a temporary test file because it's easier to use for the example. However, if you need to use temporary files, consider using a library like `tempfile` that can create (and remove) them safely for you. Not every system has a */tmp* directory and that location might not be temporary depending on the operating system.
+> The test methods use the */tmp* path for a temporary test file because it's easier to use for the example. However, if you need to use temporary files, consider using a library like `tempfile` that can create (and remove) them safely for you. Not every system has a */tmp* directory, and that location might not be temporary depending on the operating system.
 
 Running the tests with the `-v` flag to increase verbosity shows the tests passing:  
 
@@ -61,12 +61,12 @@ Although the tests are passing, they look repetitive and they're also leaving fi
 
 ## Helper methods
 
-In a test class, there are a few methods you can use to setup and teardown test execution. Pytest executes them automatically if they're defined. To use these methods, you should know that they have a specific order and behavior.
+In a test class, there are a few methods you can use to set up and tear down test execution. Pytest executes them automatically if they're defined. To use these methods, you should know that they have a specific order and behavior.
 
-- `setup`: Executes once before each test in a class
-- `teardown`: Executes once after each test in a class
-- `setup_class`: Executes once before all tests in a class
-- `teardown_class`: Executes once after all tests in a class
+- `setup`: Executes once before each test in a class.
+- `teardown`: Executes once after each test in a class.
+- `setup_class`: Executes once before all tests in a class.
+- `teardown_class`: Executes once after all tests in a class.
 
 When tests require similar (or identical) resources to work, it's useful to write setup methods. Ideally, a test shouldn't leave resources when it completes, so teardown methods can help in test cleanup in those situations.
 
@@ -122,7 +122,7 @@ class TestIsDone:
 
 ### Custom helper methods
 
-You can create custom helper methods in a class. These methods must not be prefixed with the name `test` and can't be named as the setup or cleanup methods. In the `TestIsDone` class, we could automate the creation of the temporary file in a custom helper. That custom helper method might look like this example:
+You can create custom helper methods in a class. These methods must not be prefixed with the name `test` and can't be named as the setup or cleanup methods. In the `TestIsDone` class, we could automate creating the temporary file in a custom helper. That custom helper method might look like this example:
 
 ```python
     def write_tmp_file(self, content):