Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sanosuke009/poseidonframework

An omnipotent automation framework in Python
https://github.com/sanosuke009/poseidonframework

appium automation-framework automation-test continuous-integration playwright playwright-python python pywinauto

Last synced: about 5 hours ago
JSON representation

An omnipotent automation framework in Python

Host: GitHub
URL: https://github.com/sanosuke009/poseidonframework
Owner: sanosuke009
License: apache-2.0
Created: 2023-01-14T15:16:00.000Z (almost 2 years ago)
Default Branch: master
Last Pushed: 2024-04-13T10:40:30.000Z (7 months ago)
Last Synced: 2024-04-14T01:29:53.069Z (7 months ago)
Topics: appium, automation-framework, automation-test, continuous-integration, playwright, playwright-python, python, pywinauto
Language: Python
Homepage:
Size: 20.7 GB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 15
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Poseidon Framework
## A trident to penetrate the test automation barrier! One stop test automation framework for all types of application with 3-pronged approach!

[![Project Poseidon](https://github.com/sanosuke009/PoseidonFramework/actions/workflows/python-app.yml/badge.svg?branch=master)](https://github.com/sanosuke009/PoseidonFramework/actions/workflows/python-app.yml)

## Features:
1. Playwright with Pytest -> To Automate Web applications -> In Progress
1. Allure report plugin -> DONE
2. Screenshot of each validation step -> DONE
3. Playwright default html report -> DONE
4. Video recording of the execution -> DONE
5. Parallel execution -> DONE
6. Integration with CI -> DONE
7. Segregation of pages and configured context -> DONE
8. Integration with Github Actions -> DONE
9. Publish Allure-Reports on Github Pages -> DONE
2. Playwright with Pytest -> To Automate API -> TODO
3. PyWinAuto with Pytest -> To Automate Desktop applications -> TODO
4. Appium with Pytest -> To Automate Mobile applications -> TODO

## Installation Required:
Either you can run
```python
python3 -m pip install -r requirements.txt
python3 -m playwright install
```
Or, if you know what you are doing, then run
```python
python3 -m pip install pytest
python3 -m pip install pytest-xdist
python3 -m pip install allure-pytest
python3 -m pip install pytest-playwright
python -m pip install pytest-rerunfailures
python3 -m playwright install #For installing Chromium, Firefox and Webkit browsers
```
## If allure is not recognized as powershell command Troubleshooting:
1. For Windows install nvm from [here](https://github.com/coreybutler/nvm-windows/releases)
2. Install node using nvm
```node
nvm install
nvm use
npm install -g allure-commandline --save-dev
```
3. If you find authentication error then
```shell
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
```
4. Now allure serve command should work
5. If you are getting JAVA_HOME not set error, then you need to install Java as well from [here](https://oracle.com/in/java/technologies/downloads/) and set JAVA_HOME="C:\Program Files\Java\jdkxxx.xx.xx" in the environment variables.

## VENV Troubleshooting:
In VSCode, there is no default option to create virtual environment in Python. So follow below steps to create one:
1. Open Visual Studio Code in your project's folder.
2. In the terminal:
```python
# venv is your virtual environment name
# You can also use py -3 -m venv .venv
python -m venv venv
```
3. After the virtual environment is generated, use the following command to activate the virtual environment
```python
# venv is your virtual environment name
venv\scripts\activate
```
4. If you get error message after running above command, please do this:
1. Change the execution policies by adding -ExecutionPolicy Bypass args. in vscode you will have to create a shell profile with these args by adding below in settings.json (ctrl + shift + p and type "settings.json")

```python
"terminal.integrated.profiles.windows": {
"PowerShell": {
"source": "PowerShell",
"icon": "terminal-powershell",
"args": ["-ExecutionPolicy", "Bypass"]
}
},
"terminal.integrated.defaultProfile.windows": "PowerShell",
```
2. Need to restart VS Code and the Terminal.
3. Run:
```python
# venv is your virtual environment name
venv\scripts\activate
```
5. Then Python: Select Interpreter (via Ctrl + Shift + P)
6. And select the option (in my case towards the bottom)
7. Select --> Python 3.7 (venv) ./venv/Scripts/python.exe

## Remove VENV:
```python
source venv/bin/activate
pip freeze > requirements.txt
pip uninstall -r requirements.txt -y
deactivate
rm -r venv/
```

## Troubleshooting Importerror: module not found _greenlet:
1. Reinstall the Microsoft Visual C++
Here is the link for downloading [Microsoft Visual C++](https://support.microsoft.com/en-us/topic/the-latest-supported-visual-c-downloads-2647da03-1eea-4433-9aff-95f26a218cc0).
2. Restart the system
3. Reinstall the venv & Python packages

## Starting with the first Playwright test:
1. Install all the required packages and set up vscode as mentioned above
2. Run:
```python
pytest --alluredir=allure-results --headed --numprocesses auto
allure serve .\allure-results
```

## Docker commands to dockerize and run a few test cases in the image:
1. Install all the required packages and set up vscode as mentioned above
2. Run:
```shell
docker build -t .
docker run -it sanochuke/poseidonframework-docker-v1 pytest web/src/test/testcases/youtube
```

# TODO:
1. Debugging using page.pause() & inspector
2. https://shields.io/
3. [Cloud hosting on Vercel](https://vercel.com/pricing)

# Jenkins Integration:
## TODO

## Troubleshooting for allure report:
1. Install allure plugin for jenkins
2. Add below code in the jenkins file:
```bash
stage('Generating Reports') {
steps {
script {
allure([
includePorperties: false,
jdk: '',
properties: [],
reportBuildPolicy: 'ALWAYS',
results: [[path: 'allure-results']]
])
}
}
}
```

### References & Resources:
1. [Integration with Github Action & Pages](https://elaichenkov.medium.com/allure-report-integration-with-playwright-8c1570c67dda)
2. [Cronjob Help](https://crontab.guru/)
3. [Scheduling Github Actions](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule)
4. [Scheduling Blog](https://medium.com/tradeling/how-to-schedule-jobs-using-github-actions-9f32667706ea)
5. [JAVA_HOME Troubleshooting](https://stackoverflow.com/questions/45182717/java-home-is-set-to-an-invalid-directory)