Merge branch '3-assertions' into 4-page-objects

Author: AutomationPanda

README.md

@@ -1,12 +1,20 @@
 # tau-playwright-workshop
 
-This repository contains the example code for the Playwright workshop
+This repository contains the instructions and example code for the Playwright workshop
 for [TAU: The Homecoming](https://applitools.com/tau-homecoming/)
 on December 1, 2021.
 The workshop will be done in [Python](python.org).
 
-The `workshop` folder contains full instructions for the workshop.
-That way, you can still code along to learn Playwright even if you miss the main event!
+
+## Instructions
+
+Please try to attend the workshop *live* on the day of the event.
+However, if you cannot make it, never fear!
+**You can still take the workshop as a self-guided tutorial.**
+Start by reading this README.
+Then, follow the guides in the `workshop` folder.
+Each part of the workshop has a `workshop` guide with full instructions.
+Feel free to open issues against this repository if you have any trouble completing the workshop independently.
 
 
 ## Abstract
@@ -41,7 +49,7 @@ If you are using a different shell or a Windows command line, some commands may
 
 ## Agenda
 
-This workshop has five main parts:
+This workshop has five main parts, each with three sections:
 
 1. Getting started
    1. What is Playwright?
@@ -67,7 +75,7 @@ This workshop has five main parts:
 
 ## Example code branches
 
-Each part has a corresponding branch in this repository containing the part's example code and `workshop` instructions.
+Each workshop part has a corresponding branch in this repository containing the part's example code and `workshop` instructions.
 The branches allow you to check your progress at any point during the workshop.
 The branch names are:
 

workshop/1-getting-started.md

@@ -1,6 +1,6 @@
 # Part 1: Getting started
 
-Part 1 of the workshop explains how to start testing with Playwright and pytest in Python.
+Part 1 of the workshop explains how to set up a Python test automation project with pytest and Playwright.
 
 
 ## What is Playwright?
@@ -62,13 +62,10 @@ to manage dependency packages locally:
 
 ```bash
 $ python3 -m venv venv
-$ source venv/bin/activate
 ```
 
 Creating a new virtual environment for each Python project is a recommended practice.
 This command will create a subdirectory named `venv` that holds all virtual environment files, including dependency packages.
-After creating a virtual environment, you must "activate" it to use it using the `source` command shown above.
-You can tell if a virtual environment is active if its name appears in the bash prompt.
 
 *A note about Python commands:*
 Python has two incompatible major versions: 2 and 3.
@@ -77,6 +74,21 @@ For example, macOS comes bundled with Python 2.7.18.
 Sometimes, the `python` executable may point to Python 2 instead of 3.
 To be precise about versions and executables, we will use the `python3` and `pip3` commands explicitly in this workshop.
 
+After creating a virtual environment, you must "activate" it.
+On macOS or Linux, use the following command:
+
+```bash
+$ source venv/bin/activate
+```
+
+The equivalent command for a Windows command line is:
+
+```
+> venv\Scripts\activate.bat
+```
+
+You can tell if a virtual environment is active if its name appears in the prompt.
+
 Let's add some Python packages to our new virtual environment:
 
 ```bash

workshop/2-first-steps.md

@@ -46,9 +46,9 @@ However, the `pytest-playwright` plugin takes care of these things automatically
 * The `context` fixture provides a new browser context for a test.
 * The `page` fixture provides a new browser page for a test.
 
-All of the Playwright calls with `pytest-playwright` use the synchronous API instead of the async API.
-The `browser` fixture has session scope, meaning all tests will share one browser instance.
-The `context` and `page` fixtures have function scope, meaning each test gets new ones.
+All the Playwright calls with `pytest-playwright` use the synchronous API instead of the async API.
+The `browser` fixture has *session* scope, meaning all tests will share one browser instance.
+The `context` and `page` fixtures have *function* scope, meaning each test gets new ones.
 Typically, a test will only need to call the `page` fixture directly.
 These fixtures will also automatically clean up everything after testing is complete.
 You do not need to explicitly close the browser.
@@ -66,13 +66,13 @@ To this:
 def test_basic_duckduckgo_search(page):
 ```
 
-
-## Navigating to a web page
-
 Now the test has access to a fresh page in a new browser context.
 If we write multiple tests, each test will get its own page and context,
 but they will all share the same browser instance.
 
+
+## Navigating to a web page
+
 Now that we have a page, let's do something on it!
 Our first test step is, "Given the DuckDuckGo home page is displayed".
 Let's [navigate](https://playwright.dev/python/docs/navigations) to the DuckDuckGo home page like this:

workshop/3-assertions.md

@@ -67,7 +67,7 @@ the `input_value` method performs *implicit* waiting for the element to be ready
 Check the [Auto-waiting](https://playwright.dev/python/docs/actionability) page
 for a full list of actionability checks for each interaction.
 
-Rerun the test using the same pytest command (`python3 -m pytest tests --headed --slowmo 1000).
+Rerun the test using the same pytest command (`python3 -m pytest tests --headed --slowmo 1000`).
 This time, you should see the result page for a good second or two before the browser window closes.
 The test should still pass.