Skip to content

Commit 414f7ca

Browse files
As per PR # 89 comments, changes are implemented.
1 parent 4131e39 commit 414f7ca

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

docs/utility-guides/LoadProperties.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,12 @@ The Load Properties Utility can be used to retrieve values from a properties fil
77
- [Utility Guide: Load Properties](#utility-guide-load-properties)
88
- [Table of Contents](#table-of-contents)
99
- [How This Works](#how-this-works)
10-
- [Example Usage for Properties](#example-usage-for-properties)
10+
- [----------------------------------](#----------------------------------)
11+
- [EXAMPLE VALUES](#example-values)
12+
- [----------------------------------](#-----------------------------------1)
13+
- [Reasoning for storing values in the properties file](#reasoning-for-storing-values-in-the-properties-file)
1114
- [Using the Load Properties Utility](#using-the-load-properties-utility)
12-
- [Example Usage Python Code Block](#example-usage-python-code-block)
15+
- [Example Usage](#example-usage)
1316

1417
## How This Works
1518

@@ -27,15 +30,21 @@ To ensure that there are no mistakes when providing this input there are two add
2730

2831
To add values to the properties file follow the format:
2932

30-
## Example Usage for Properties
33+
# ----------------------------------
34+
# EXAMPLE VALUES
35+
# ----------------------------------
36+
example_value_1=value1
37+
example_value_2=value2
38+
39+
## Reasoning for storing values in the properties file
3140

3241
1. Properties files use key-value pairs because they provide a simple, organized, and flexible way to store configuration data.
3342

3443
2. Each line in the file assigns a value to a key (For example, c1_daily_invitation_rate=10). This makes it easy to look up and change values as needed.
3544

3645
3. Using key-value pairs in properties files helps keep your tests clean, flexible, and easy to maintain by avoiding hard-coded values in your test scripts.
3746

38-
Why avoid hard coded values in tests?
47+
**Why avoid hard coded values in tests?**
3948

4049
1. Maintainability: If we need to update a value (like a test organization ID or a rate), we only have to change it in one place—the properties file—instead of searching through all your test code.
4150

@@ -56,7 +65,7 @@ Here there are two fixtures:
5665
1. `smokescreen_properties` - which is used to load the file: tests/smokescreen/bcss_smokescreen_tests.properties
5766
2. `get_general_properties` - which is used to load the file: tests/bcss_tests.properties
5867

59-
## Example Usage Python Code Block
68+
## Example Usage
6069

6170
```python
6271
def test_example_1(page: Page, general_properties: dict) -> None:

0 commit comments

Comments
 (0)