vigilant-kit 1.2.0__tar.gz → 1.2.1__tar.gz

vigilant_kit-1.2.1/PKG-INFO

@@ -0,0 +1,59 @@
+Metadata-Version: 2.1
+Name: vigilant_kit
+Version: 1.2.1
+Summary: Library that makes functional testing with Selenium WebDriver fast and easy. 
+Project-URL: Homepage, https://github.com/ivpel/vigilant
+Project-URL: Bug Tracker, https://github.com/ivpel/vigilant/issues
+Author-email: Pelykh Ivan <ivan.pelykh@protonmail.com>
+License-File: LICENSE
+Keywords: bdd,functional,functional-testing,pytest,selenium,tdd,testing,unittest,webdriver
+Requires-Python: >=3.7
+Requires-Dist: click
+Requires-Dist: python-dotenv
+Requires-Dist: requests
+Requires-Dist: selenium
+Description-Content-Type: text/markdown
+
+# Vigilant Kit
+Vigilant is a set of tools designed to help write and run robust functional tests using Selenium WebDriver. It provides
+methods for interacting with the WebBrowser, assertions, and waiting. With Vigilant, you can start writing complex test
+cases in a minute.
+
+## Why Vigilant?
+- **Easy to start & Fast To Write**: Easy configuration process, straightforward way to writing your tests.
+Vigilant provides you with methods that help you write functional tests quickly without spending time on writing 
+boilerplate code every time you start a new project. 
+- **Flexible Framework Usage**: Usage is not limited to a single testing framework; you can use Vigilant with unittest,
+  pytest, or anything else.
+
+## What it includes?
+Methods for **interacting** with WebBrowser (`click`, `scroll_to`,  etc.), **assertions** (`see`, `dont_see`, `see_text`
+, etc.) **waiters** (`wait_for_element_to_be_visible`, `wait_for_element_to_be_clickable`, etc.)
+It is already there, ready to use.
+
+Also, a bunch of CLI scripts, to make your life easier!
+
+Use `vgl --help` to see all available commands.
+
+List of all available [actions](docs/actions.md).
+
+## Extending Functionality
+If you need something that is not covered in this library, you still have access to all native `Selenium WebDriver` 
+methods. You can create your own methods or use native `WebDriver` methods and share them on one browser session.
+
+## Install
+```shell
+pip install vigilant-kit
+```
+
+## Docs
+ - [How to install Selenium server & browser drivers](docs/selenium_install.md)
+ - [Quick start example using `unittest` library](docs/vigilant_unittest.md) 
+ - [Quick start example using `pytest`](docs/vigilant_pytest.md) 
+ - [How to add custom browser options](docs/browser_options.md)
+ - [Access native Selenium WebDriver methods](docs/native_selenium.md)
+ - [List of actions](docs/actions.md).
+
+## Tutorials
+ - [Testing ecommerce project using `vigilant-kit` and `pytest`](docs/tutorial_pytest.md)
+ 

vigilant_kit-1.2.1/README.md

@@ -0,0 +1,43 @@
+# Vigilant Kit
+Vigilant is a set of tools designed to help write and run robust functional tests using Selenium WebDriver. It provides
+methods for interacting with the WebBrowser, assertions, and waiting. With Vigilant, you can start writing complex test
+cases in a minute.
+
+## Why Vigilant?
+- **Easy to start & Fast To Write**: Easy configuration process, straightforward way to writing your tests.
+Vigilant provides you with methods that help you write functional tests quickly without spending time on writing 
+boilerplate code every time you start a new project. 
+- **Flexible Framework Usage**: Usage is not limited to a single testing framework; you can use Vigilant with unittest,
+  pytest, or anything else.
+
+## What it includes?
+Methods for **interacting** with WebBrowser (`click`, `scroll_to`,  etc.), **assertions** (`see`, `dont_see`, `see_text`
+, etc.) **waiters** (`wait_for_element_to_be_visible`, `wait_for_element_to_be_clickable`, etc.)
+It is already there, ready to use.
+
+Also, a bunch of CLI scripts, to make your life easier!
+
+Use `vgl --help` to see all available commands.
+
+List of all available [actions](docs/actions.md).
+
+## Extending Functionality
+If you need something that is not covered in this library, you still have access to all native `Selenium WebDriver` 
+methods. You can create your own methods or use native `WebDriver` methods and share them on one browser session.
+
+## Install
+```shell
+pip install vigilant-kit
+```
+
+## Docs
+ - [How to install Selenium server & browser drivers](docs/selenium_install.md)
+ - [Quick start example using `unittest` library](docs/vigilant_unittest.md) 
+ - [Quick start example using `pytest`](docs/vigilant_pytest.md) 
+ - [How to add custom browser options](docs/browser_options.md)
+ - [Access native Selenium WebDriver methods](docs/native_selenium.md)
+ - [List of actions](docs/actions.md).
+
+## Tutorials
+ - [Testing ecommerce project using `vigilant-kit` and `pytest`](docs/tutorial_pytest.md)
+ 

vigilant_kit-1.2.1/docs/selenium_install.md

@@ -0,0 +1,50 @@
+# How to install Selenium Server & browser drivers
+
+***
+## Option 1: Run Selenium server + browser driver locally
+###  1. Install Selenium Standalone Server and Webdriver
+`vgl install dev-kit -b chrome`
+
+If everything is okay and your machine has all dependencies installed, you will see this output:
+```text
+Found: chrome browser, version 112.0.5615.165.
+Downloading driver for chrome browser ... OK
+Downloading Selenium Standalone server ...OK
+```
+
+### 2. Run Selenium Server
+To run your Selenium Server use:
+`vgl run selenium-server`
+
+This command will launch Selenium Standalone server on your local machine.
+
+### Need help? Use `--help`
+To see all available options for these commands you can use `--help` flag.
+
+For example:
+`vgl run selenium-server --help`
+
+Will output this:
+```text
+Usage: vgl run selenium-server [OPTIONS]
+
+  Run Selenium Server JAR file
+
+Options:
+  -p, --port INTEGER  Port number for the server
+  -D, --driver TEXT   Specify driver options (e.g.
+                      -Dwebdriver.chrome.driver=chromedriver)
+  -d, --daemon        Run the server as a daemon
+  --help              Show this message and exit.
+```
+
+## Option 2: Start Selenium server + browser inside Docker
+***
+If you don't want to install and run Selenium server and the browser locally, you can run both of them in a Docker 
+container. The Selenium project provides many prepared official containers.
+For example to start a container with Selenium server and Firefox, simply run:
+```shell
+docker run -d -p 4446:4444 -p 7902:7900 --shm-size="2g" selenium/standalone-firefox:4.6.0-20221104
+```
+
+For more info about available options check official [Docker Selenium](https://github.com/SeleniumHQ/docker-selenium) page.

vigilant_kit-1.2.0/README.md → vigilant_kit-1.2.1/docs/vigilant_unittest.md

@@ -1,42 +1,3 @@
-# Vigilant Kit
-Vigilant is a set of tools made to help writing and running robust functional tests using Selenium WebDriver.
-
-## Why Vigilant?
- - It allows you to start writing complex test cases in a minute.
- - Simple configuration process (just one `.vigilant.env` file to start)
- - Usage is not limited to a single testing framework, it can be used with `unittest`, `pytest` or anything else.
-It is up to you.
-
-**Vigilant** provide you with methods that help write functional tests fast, without spending your time on writing
-boilerplate code every time you start new project.
-
-Methods for **interacting** with WebBrowser (`click`, `scroll_to`,  etc.), **assertions** (`see`, `dont_see`, `see_text`
-, etc.) **waiting** (`wait_for_element_to_be_visible`, `wait_for_element_to_be_clickable`, etc.)
-It is already there, ready to use.
-
-List of all available [actions](docs/actions.md).
-
-### What if you need something that is not covered in this library?
-
-You still have access to all native `Selenium WebDriver` methods. Despite all functional that library provide - 
-you can create your own methods or use native `WebDriver` methods and share them on one browser session.
-
-## Docs
- - [How to install Selenium server & browser drivers](docs/selenium_install.md)
- - [Quick start example using `unittest` library](docs/vigilant_unittest.md) 
- - [Quick start example using `pytest`](docs/vigilant_pytest.md) 
- - [How to add custom browser options](docs/browser_options.md)
- - [Access native Selenium WebDriver methods](docs/native_selenium.md)
- - [List of actions](docs/actions.md).
-
-## Tutorials
- - [Testing ecommerce project using `vigilant-kit` and `pytest`](docs/tutorial_pytest.md)
- 
-## Install
-```shell
-pip install vigilant-kit
-```
-
 ## Quick start
 We will write our first test with `unittest` library. Also make sure that you installed
 `vigilant-kit` library.
@@ -44,7 +5,7 @@ We will write our first test with `unittest` library. Also make sure that you in
 
 ### Configuration
 Configuration can be done through environment variables. Make sure that your Selenium Server is up and running, if not -
-[**Install Selenium server**](docs/selenium_install.md)
+[**Install Selenium server**](selenium_install.md)
 
 Create `.vigilant.env` file with next data:
 ```shell

{vigilant_kit-1.2.0 → vigilant_kit-1.2.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "vigilant_kit"
-version = "1.2.0"
+version = "1.2.1"
 authors = [
   { name="Pelykh Ivan", email="ivan.pelykh@protonmail.com" },
 ]

vigilant_kit-1.2.0/PKG-INFO

@@ -1,150 +0,0 @@
-Metadata-Version: 2.1
-Name: vigilant_kit
-Version: 1.2.0
-Summary: Library that makes functional testing with Selenium WebDriver fast and easy. 
-Project-URL: Homepage, https://github.com/ivpel/vigilant
-Project-URL: Bug Tracker, https://github.com/ivpel/vigilant/issues
-Author-email: Pelykh Ivan <ivan.pelykh@protonmail.com>
-License-File: LICENSE
-Keywords: bdd,functional,functional-testing,pytest,selenium,tdd,testing,unittest,webdriver
-Requires-Python: >=3.7
-Requires-Dist: click
-Requires-Dist: python-dotenv
-Requires-Dist: requests
-Requires-Dist: selenium
-Description-Content-Type: text/markdown
-
-# Vigilant Kit
-Vigilant is a set of tools made to help writing and running robust functional tests using Selenium WebDriver.
-
-## Why Vigilant?
- - It allows you to start writing complex test cases in a minute.
- - Simple configuration process (just one `.vigilant.env` file to start)
- - Usage is not limited to a single testing framework, it can be used with `unittest`, `pytest` or anything else.
-It is up to you.
-
-**Vigilant** provide you with methods that help write functional tests fast, without spending your time on writing
-boilerplate code every time you start new project.
-
-Methods for **interacting** with WebBrowser (`click`, `scroll_to`,  etc.), **assertions** (`see`, `dont_see`, `see_text`
-, etc.) **waiting** (`wait_for_element_to_be_visible`, `wait_for_element_to_be_clickable`, etc.)
-It is already there, ready to use.
-
-List of all available [actions](docs/actions.md).
-
-### What if you need something that is not covered in this library?
-
-You still have access to all native `Selenium WebDriver` methods. Despite all functional that library provide - 
-you can create your own methods or use native `WebDriver` methods and share them on one browser session.
-
-## Docs
- - [How to install Selenium server & browser drivers](docs/selenium_install.md)
- - [Quick start example using `unittest` library](docs/vigilant_unittest.md) 
- - [Quick start example using `pytest`](docs/vigilant_pytest.md) 
- - [How to add custom browser options](docs/browser_options.md)
- - [Access native Selenium WebDriver methods](docs/native_selenium.md)
- - [List of actions](docs/actions.md).
-
-## Tutorials
- - [Testing ecommerce project using `vigilant-kit` and `pytest`](docs/tutorial_pytest.md)
- 
-## Install
-```shell
-pip install vigilant-kit
-```
-
-## Quick start
-We will write our first test with `unittest` library. Also make sure that you installed
-`vigilant-kit` library.
-
-
-### Configuration
-Configuration can be done through environment variables. Make sure that your Selenium Server is up and running, if not -
-[**Install Selenium server**](docs/selenium_install.md)
-
-Create `.vigilant.env` file with next data:
-```shell
-# Selenium host URL
-SELENIUM_HOST=http://127.0.0.1:4444/wd/hub 
-
-# Browser which will performing the tests
-SELENIUM_BROWSER=firefox 
-
-# The root URL of the application under test.
-BASE_URL=http://www.python.org 
-
-# Amount of time (in seconds) that a test will wait while loading a page or waiting for element
-WAIT_TIMEOUT=10 
-
-# Log level
-LOGGER_LEVEL=INFO 
-```
-
-### Test
-Create file `test_first.py` with same code as below. We will cover 3 simple cases for demo purposes.
-```python
-import unittest
-
-from vigilant.driver.vigilant_driver import VigilantDriver
-
-
-class TestHomePage(unittest.TestCase):
-
-    @classmethod
-    def setUpClass(cls) -> None:
-        cls.act = VigilantDriver()
-
-    @classmethod
-    def tearDownClass(cls) -> None:
-        cls.act.quit()
-
-    def test_home_page(self):
-        # Case 1. Go to some page and assert page title
-        self.act.get_page('/')  # Go to root page
-        self.act.assertions.see_in_title('Python')  # Assert that page title contains 'Python' string
-
-    def test_text_block(self):
-        # Case 2. Scroll to some block and assert visible text
-        self.act.get_page('/')  # Go to root page
-        self.act.scroll_to('//h2[text()="Success Stories"]')  # Scroll to Success Stories block
-        self.act.assertions.see_text('Success Stories')  # Assert that Success Stories string is visible
-
-    def test_search_page(self):
-        # Case 3. Fill in Search field with search key word, assert result in search result page.
-        self.act.get_page('/')  # Go to root page
-        self.act.fill_field('//input[@name="q"]', 'python')  # Fill search field
-        self.act.click('//button[@id="submit"]')  # Click Search button
-        self.act.assertions.see_in_url(
-            '/search/?q=python')  # See in URL that we are redirected to search result page
-        self.act.assertions.see_text('Results')  # Assert visible Results text
-
-
-if __name__ == '__main__':
-    unittest.main()
-
-```
-Now run our script:
-```shell
-python3 test_first.py
-```
-### Results
-If you are running your Selenium Server locally - you can see how script interact with browser in real time. But in any
-case you should have terminal output similar to this, due to LOGGER_LEVEL=INFO:
-```text
-[2022-11-02 16:34:26,452: INFO] Creating remote session.
-Command executor: http://127.0.0.1:4444/wd/hub
-Browser: firefox
-[2022-11-02 16:34:26,452: INFO] Setting default browser options: firefox
-[2022-11-02 16:34:27,890: INFO] Getting page: /
-[2022-11-02 16:34:33,942: INFO] Assert: see string Python in current page title
-[2022-11-02 16:34:33,956: INFO] Scrolling to element: //h2[text()="Success Stories"]
-[2022-11-02 16:34:33,956: INFO] Execute JS script: arguments[0].scrollIntoView({block: "center"}) with arguments: <selenium.webdriver.remote.webelement.WebElement (session="3c63a627-1ffd-40ed-b008-78e671d82085", element="703e049a-3ab4-4bd5-814a-bb38dd64864a")>
-[2022-11-02 16:34:33,980: INFO] Waiting for element with selector: //input[@name="q"] - to be visible.
-[2022-11-02 16:34:33,991: INFO] Filling field: //input[@name="q"] with value: python
-[2022-11-02 16:34:34,012: INFO] Waiting for element with selector: //button[@id="submit"] - to be visible.
-[2022-11-02 16:34:34,026: INFO] Clicking on element: //button[@id="submit"]
-[2022-11-02 16:34:34,411: INFO] Assert: see string /search/?q=python in current page URL
-[2022-11-02 16:34:34,434: INFO] Quits the driver and closes every associated window
-
-```
-Congrats! You successfully created your first testing script using Vigilant Kit :)

vigilant_kit-1.2.0/docs/selenium_install.md

@@ -1,41 +0,0 @@
-# How to install Selenium Server & browser drivers
-
-***
-## Option 1: Run Selenium server + browser driver locally
-### 1. Install Selenium server
-Selenium server is simply a jar file. To install (download) it, just run this command in the root directory
-of your project or root directory of your tests
-```shell
-mkdir selenium-server && cd selenium && wget https://github.com/SeleniumHQ/selenium/releases/download/selenium-4.6.0/selenium-server-4.6.0.jar && cd -
-```
-### 2. Install browser driver
-You will also need to download Selenium driver for the browser where you want to execute the tests. This driver is used
-by Selenium server to start the browser of your choice - see following table for the most common browsers:
-
-| Browser | Driver              | Download link                                                                     |
-|---------|---------------------|-----------------------------------------------------------------------------------|
-| Firefox | Geckodriver         | [Download](https://github.com/mozilla/geckodriver/releases)                       |
-| Chrome  | Chromedriver        | [Download](https://sites.google.com/a/chromium.org/chromedriver/downloads)        |
-| MS Edge | Microsoft WebDriver | [Download](https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/) |
-
-Download the browser driver and place the binary file (like geckodriver or chromedriver) to the `selenium-server/` 
-directory (where our selenium standalone server is located).
-You can also place the file elsewhere, but then you must pass the path to the Selenium server, but as for me, it is easier
-to have server and driver binaries in one place.
-
-### 3. Start Selenium server
-To start the Selenium server listening for incoming connections simply run:
-```shell
-java -jar selenium-server/selenium-server-4.6.0.jar
-```
-
-## Option 2: Start Selenium server + browser inside Docker
-***
-If you don't want to install and run Selenium server and the browser locally, you can run both of them in a Docker 
-container. The Selenium project provides many prepared official containers.
-For example to start a container with Selenium server and Firefox, simply run:
-```shell
-docker run -d -p 4446:4444 -p 7902:7900 --shm-size="2g" selenium/standalone-firefox:4.6.0-20221104
-```
-
-For more info about available options check official [Docker Selenium](https://github.com/SeleniumHQ/docker-selenium) page.

vigilant_kit-1.2.0/docs/vigilant_unittest.md

@@ -1,49 +0,0 @@
-# How to start testing with `unittest` library
-
-If you are not already familiar with the basic concepts of testing, you might want to read this tutorial:
-[unittest](https://docs.python.org/3/library/unittest.html)
-
-Example using `unittest` library.
-```python
-import unittest
-
-from vigilant.driver.vigilant_driver import VigilantDriver
-from selenium.webdriver.firefox.options import Options
-
-
-class TestHomePage(unittest.TestCase):
-
-    @classmethod
-    def setUpClass(cls) -> None:
-        cls.act = VigilantDriver()
-
-    @classmethod
-    def tearDownClass(cls) -> None:
-        cls.act.quit()
-
-    def test_home_page(self):
-        # Case 1. Go to some page and assert page title
-        self.act.get_page('/')  # Go to root page
-        self.act.assertions.see_in_title('Python')  # Assert that page title contains 'Python' string
-
-    def test_text_block(self):
-        # Case 2. Scroll to some block and assert visible text
-        self.act.get_page('/')  # Go to root page
-        self.act.scroll_to('//h2[text()="Success Stories"]')  # Scroll to Success Stories block
-        self.act.assertions.see_text('Success Stories')  # Assert that Success Stories string is visible
-
-    def test_search_page(self):
-        # Case 3. Fill in Search field with search key word, assert result in search result page.
-        self.act.get_page('/')  # Go to root page
-        self.act.fill_field('//input[@name="q"]', 'python')  # Fill search field
-        self.act.click('//button[@id="submit"]')  # Click Search button
-        self.act.assertions.see_in_url(
-            '/search/?q=python')  # See in URL that we are redirected to search result page
-        self.act.assertions.see_text('Results')  # Assert visible Results text
-
-
-if __name__ == '__main__':
-    unittest.main()
-
-```
-