Merge branch 'master' of https://github.com/nareshnavinash/Selpy-Python

Author: nareshnavinash

README.md

@@ -2,7 +2,7 @@
 
 Selpy-Python is a Page Object Model (POM) framework for selenium automation with python `pytest`. This framework uses 'pytest-xdist' module to run multiple threads to run the tests at the same time depending on the number of available processor cores (2X of number of available cores).
 
-This framework also uses [selpy](https://pypi.org/project/selpy/) custom built pypi module to implement snapshot feature (which is available in jest framework). If there are any change in UI we can directly change this in the test data file during the test run with ease. Manual maintenance of test data can be reduced drastically with this feature.
+This framework also uses _**[selpy](https://pypi.org/project/selpy/) custom built pypi module**_ to implement snapshot feature (which is available in jest framework). If there are any change in UI we can directly change this in the test data file during the test run with ease. Manual maintenance of test data can be reduced drastically with this feature.
 
 More details of this module can be refered in [selpy](https://pypi.org/project/selpy/) or [repo](https://github.com/nareshnavinash/selpy)
 
@@ -42,31 +42,31 @@ More details of this module can be refered in [selpy](https://pypi.org/project/s
 ## To Run the tests
 For a simple run of all the test files in normal mode, try
 
-```shell script
+```
 pytest
 ```
 
 To run the tests in snap mode (to save the UI texts to the dynamic file)
-```shell script
+```
 snap=1 pytest
 ```
 Once the changes are saved to the file run the tests with `pytest` to get the test running against the saved data. To verify this feature I intentionally added two locator texts which will be changing continuously.
 
 To Run the tests in parallel mode or multi thread run for the available test files, try (To have parallel run you need to have atleast 2 tests inside your folder structure)
 
-```shell script
+```
 pytest -s -v -n=2
 ```
 
 To Run the tests in parallel mode for the available test files along with browser specification, try
 
-```shell script
+```
 browser=chrome pytest -s -v -n=2
 ```
 
 To Run the tests in parallel mode for the available test files in headless mode, try
 
-```shell script
+```
 headless=1 browser=chrome pytest -s -v -n=2
 ```
 
@@ -75,14 +75,14 @@ This will run the tests in headless mode
 ## To open allure results
 Allure is a open source framework for reporting the test runs. To install allure in mac, use the following steps
 
-```shell script
+```
 brew cask install adoptopenjdk
 brew install allure
 ```
 
 To view the results for the test run, use
 
-```shell script
+```
 allure serve reports/allure
 ```
 
@@ -98,7 +98,7 @@ For better illustration on the testcases, allure reports has been integrated. Al
 ## Jenkins Integration with Docker images
 Get any of the linux with python docker image as the slaves in jenkins and use the same for executing the UI automation with this framework (Sample docker image - `https://hub.docker.com/_/python`). From the jenkins bash Execute the following to get the testcases to run,
 
-```shell script
+```
 #!/usr/bin/python3
 python --version
 cd <path_to_the_project>
@@ -108,7 +108,7 @@ headless=1 pytest -s -v -n 4
 
 In Jenkins pipeline, try to add the following snippet to execute the tests,
 
-```shell script
+```
 pipeline {
     agent { docker { image 'python:3.7.6' } }
     stages {
@@ -137,7 +137,7 @@ In `Data/GlobalData/global_data.yml` file, if the headless is `1`, the chrome wi
 
 3. For each page add a new class and declare the locators. Static locators can be class variables. Dynamic locators can be separate methods. 
 
-```python
+```
 class AmazonHomePageLocator:
     amazon_logo = Locator("css selector", "div#nav-logo a[aria-label='Amazon']")
     amazon_search_categories = Locator("css selector", "div.nav-search-scope select.nav-search-dropdown")
@@ -174,7 +174,7 @@ CLASS NAME - 'class name'
 
 3. For each page add a new class and each page class should inherit the locators class of the same page
 
-```python
+```
 from Locators.amazon_home_page import AmazonHomePageLocator
 
 
@@ -195,7 +195,7 @@ class AmazonHomePage(AmazonHomePageLocator):
 
 1. Define the tests inside the Tests folder. Create a new `.py` file and import the required modules inside (depending on the requirement). Mainly require the page modules inside the test file. It is not recommended to import locator modules since we can access the locators from the page module.
 
-```python
+```
 import allure
 import pytest
 import time
@@ -208,7 +208,7 @@ from selpy.variable import Var
 
 2. It is suggested to mention the allure feature name, severity, pytest's markers to the test. This allows us to have better reporting and dynamic way to run in the future.
 
-```python
+```
 @allure.feature("Feature name")
 @allure.severity('Critical')
 @pytest.mark.regression
@@ -223,17 +223,17 @@ def test_amazon_book_search_001():
 
 To run the test with marker you can execute as
 
-```shell script
+```
 pytest -v -m regression 
 # or
 pytest -v -m ui
 ```
 
 Use `allure.step("step name")` to have a detailed reporting in allure.
 
-3. Append the method name for the test as `test_` only then it will be taken as a test case. This has been configured in ```pytest.ini``` as,
+3. Append the method name for the test as `test_` only then it will be taken as a test case. This has been configured in `pytest.ini` as,
 
-```ini
+```
 markers =
     sanity: sanity tests marker
     regression: regression tests marker
@@ -257,7 +257,7 @@ Allure configurations and pytest's default report has been wired here.
 
 4. A file `conftest.py` should be created inside the Tests folder. In this file we can have the run before each, run before each module, run during and after pytest setup methods. Adding screenshot to the testcases is handled by,
 
-```python
+```
 @pytest.fixture(autouse=True)
 def before_each():
     print('*-* Before each INITIALIZATION')
@@ -278,7 +278,7 @@ The fixture param `autouse=True` ensures that this block is invoked only once fo
 
 Closing of all the drivers has been handled like,
 
-```python
+```
 @pytest.fixture(scope='module', autouse=True)
 def before_module():
     print('*-* Before module INITIALIZATION')
@@ -292,7 +292,7 @@ The param `scope='module'`ensures that this block is invoked only once for each
 
 5. We used home grown pypi published module `selpy` for Page Object Model support as well as snap support. To use that module data files path has to be set, this is done by,
 
-```python
+```
 from selpy.store import Store
 def pytest_configure(config):
     Store.global_data_path = os.path.dirname(os.path.abspath(__file__)).replace("/Tests", "") + '/Data/GlobalData/global_data.yml'
@@ -304,7 +304,7 @@ This ensures that this data has been set before pytest is being invoked only onc
 
 6. Assert using pytest's default assertion method. Make sure you have a proper description to the assertion, so that once it is failed the failure message is proper.
 
-```python
+```
 assert (AmazonHomePage.is_home_page_displayed() is True), "Amazon home page is not displayed"
 ```
 
@@ -326,20 +326,20 @@ To use the snap mode, you need to use `selpy` [selpy](https://pypi.org/project/s
 
 1. Declare the dictionary where the UI texts/data is to be stored during the test run.
 
-```python
+```
 ui_dynamic_data = {}
 ui_dynamic_data["amazon_product_title"] = AmazonProductPage.amazon_product_title.texts_as_string()
 ```
 
 2. Initiate a class variable with the file name against which you need to verify the UI data.
 
-```python
+```
 dynamic_variable = Var("amazon_book_search_result_dynamic.yml", "dynamic")
 ``` 
 
 3. To compare the UI data with the file use the `compare` method that comes along with the `dynamic_variable`
 
-```python
+```
 dynamic_variable.compare(ui_dynamic_data)
 ```
 
@@ -353,7 +353,7 @@ This will compare and report it to allure and assertion has been done within tha
 
 For static code analyser I used flake8. To check the configurations view (.flake8)[.flake8] file. To check on the code status execte,
 
-```shell script
+```
 flake8
 ```
 

_config.yml

@@ -1 +1 @@
-theme: jekyll-theme-hacker
+theme: jekyll-theme-cayman