updating readme

Author: nareshnavinash

CONTRIBUTING.md

@@ -73,7 +73,7 @@ further defined and clarified by project maintainers.
 ### Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting me at [mail][mailto:[email protected]]. All
+reported by contacting me at [mail](mailto:[email protected]). All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project member has
 obligated to maintain confidentiality with regard to the reporter of an incident.

README.md

@@ -24,43 +24,43 @@ Selpy-Python is a Page Object Model (POM) framework for selenium automation with
 * Testdata driven tests
 * Multi Thread run
 * Snap
-* Static code analysis
+* Static code analyser
 
 ## Setup
 * Clone this repository
 * Navigate to the cloned folder
-* To install the dependencies in MAC we use Homebrew version manager install [using][https://brew.sh/]
+* To install the dependencies in MAC we use Homebrew version manager install (using)[https://brew.sh/]
 * Once brew is installed install python by ```brew install python3```
 * To get additional dependencies of python like pip3, do ```brew postinstall python3```
 * Install the required packages needed for this framework using ```pip3 install -r requirements.txt```
 
 ## 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 parallel mode for the available test files, try (To have parallel run you need to have atleast 2 tests inside your folder structure)
-```
+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
 ```
 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
 ```
 
@@ -75,7 +75,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>
@@ -84,7 +84,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 {
@@ -113,7 +113,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")
@@ -137,7 +137,7 @@ class AmazonHomePageLocator:
 
 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
 
 
@@ -149,7 +149,6 @@ class AmazonHomePage(AmazonHomePageLocator):
     @classmethod
     def is_home_page_displayed(cls):
         return AmazonHomePageLocator.amazon_logo.is_displayed_with_wait()
-
 ```
 
 3. Ideally each web page should have a new page file inside `pages` folder with the class name same as the web page name.
@@ -158,7 +157,7 @@ class AmazonHomePage(AmazonHomePageLocator):
 ### Creating a new test file in the project
 
 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
@@ -170,7 +169,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
@@ -183,7 +182,7 @@ def test_amazon_book_search_001():
         dynamic_variable = Var("amazon_book_search_result_dynamic.yml", "dynamic")
 ```
 To run the test with marker you can execute as
-```
+```shell script
 pytest -v -m regression 
 # or
 pytest -v -m ui
@@ -192,7 +191,7 @@ 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,
 
-```
+```python
 markers =
     sanity: sanity tests marker
     regression: regression tests marker
@@ -215,7 +214,7 @@ I have created markers to have distinguished marker for automation purpose. The
 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')
@@ -235,7 +234,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')
@@ -247,25 +246,53 @@ def before_module():
 The param `scope='module'`ensures that this block is invoked only once for each test file.
 
 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'
     Store.static_data_path = os.path.dirname(os.path.abspath(__file__)).replace("/Tests", "") + '/Data/TestData/'
     Store.dynamic_data_path = os.path.dirname(os.path.abspath(__file__)).replace("/Tests", "") + '/Data/DynamicData/'
 ```
-This ensures that this data has been set before pytest is being invoked only once. More about `selpy` module can be seen at [pypi page][https://pypi.org/project/selpy/]
+This ensures that this data has been set before pytest is being invoked only once. More about `selpy` module can be seen at [pypi page](https://pypi.org/project/selpy/)
 
 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"
 ```
 
+## Detailing snap Mode:
+
+Snap mode is created to reduce the burden in maintaining the test data. While we test an application with data heavy validations, there is a high chance that the data in the application may change over the course of time.
+
+For example: If you are testing an application which tracks nasdaq or any other market related stuff, the data will change on daily basis. We need to have a capability to embrace to the change that is happening in the application with ease.
+
+To use the snap mode, you need to use `selpy` [selpy](https://pypi.org/project/selpy/) module, and make use of `Var` methods as follows.
+
+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)
+```
+This will compare and report it to allure and assertion has been done within that method.
+
+4. While running the suite for first time where no data is saved within the test file, run the suite with ```snap=1 pytest``` this will ensure the UI data is being saved to the file.
+
+5. Use only YML files for this purpose, since it is easier to handle key value pair with yaml file.
+
 ## Built With
 
 * [pytest](https://docs.pytest.org/en/latest/) - Core test framework
 * [flake8](https://pypi.org/project/flake8/) - Static code analyser
 * [pytest-xdist](https://pypi.org/project/pytest-xdist/) - To run pytest in parallel mode
+* [selpy](https://pypi.org/project/selpy/) - Page Object Model for python
 * [Allure pytest](https://pypi.org/project/allure-pytest/) - For Detailed reporting
 * [Selenium](https://www.seleniumhq.org/) - For web browser automation.