Skip to content

Commit

Permalink
Change side menu structure
Browse files Browse the repository at this point in the history
  • Loading branch information
jBorkowska committed Nov 26, 2024
1 parent 58732f1 commit db6db94
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 16 deletions.
25 changes: 18 additions & 7 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,17 @@
}
],
"sidebar": [
["Logs", "/logs"],
["About", "/"],
["Getting started", "/getting-started"],
["Patrol 3.0 is here!", "/v3"],
["New package - patrol_finders", "/patrol-finders-release"],
["Supported platforms", "/supported-platforms"],

["Patrol by LeanCode", "/"],
[
"Introduction",
[
["Getting started", "/getting-started"],
["Logs and test results", "/logs"],
["Supported platforms", "/supported-platforms"],
["Compatibility table", "/compatibility-table"]
]
],
[
"Finders",
[
Expand Down Expand Up @@ -80,10 +85,16 @@
["Browserstack", "/integrations/browserstack"]
]
],
[
"Announcements",
[
["Patrol 3.0 is here!", "/v3"],
["New package - patrol_finders", "/patrol-finders-release"]
]
],
["Effective Patrol", "/effective-patrol"],
["Tips and tricks", "/tips-and-tricks"],
["Debugging Patrol tests", "/debugging-patrol-tests"],
["Compatibility table", "/compatibility-table"],
["LeanCode", "https://leancode.co"]
]
}
16 changes: 7 additions & 9 deletions docs/logs.mdx
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
---
title: Logs and Test Results
title: Logs and test results
---

# Logs and Test Results

**Understanding Test Execution**
# Logs and test results

Once you've written and executed your tests, it's essential to monitor their results. Patrol provides two main methods for reporting test outcomes: **console logs** and **native test reports**.

## Logging Test Steps
## Logging test steps

<Warning>
This feature is available starting from version `3.13.0`.
Expand All @@ -18,7 +16,7 @@ If you're using this version but don't see logs for test steps, check if you're

During test execution, every test step (e.g., `tap` or `enterText`) is logged to the console along with its status. Additionally, the test name, status, and execution time are displayed.

**Example Console Output:**
**Example console output:**

```
...
Expand Down Expand Up @@ -60,7 +58,7 @@ The test description was:
...
```

**Test Summary:**
## Test summary

Once the tests are complete, a summary is printed:

Expand All @@ -80,7 +78,7 @@ Test summary:
⏱️ Duration: 227s
```

**Customizing Log Behavior:**
## Customizing log behavior

You can customize which logs are displayed by using the following flags. These can be passed to the `patrol test` or `patrol develop` commands:

Expand All @@ -90,7 +88,7 @@ You can customize which logs are displayed by using the following flags. These c
| --[no-]hide-test-steps | Hide test steps while running the tests. | `patrol test` and `patrol develop` | `false` |
| --[no-]clear-test-steps | Clear test steps after the test finishes. | `patrol test` | `true` |

## Native Test Reports
## Native test reports

In addition to console logs, you can review test results in a **native test report**. The report's file path is provided in the test summary, for example:

Expand Down

0 comments on commit db6db94

Please sign in to comment.