Skip to content

Latest commit

 

History

History
111 lines (101 loc) · 4.52 KB

README.md

File metadata and controls

111 lines (101 loc) · 4.52 KB

webdriver-login

Webdriver Python code to log into web applications
and optionally load some payload URL

Usage

./webdriver-login.py --help
usage: webdriver-login.py [-h] [--browser-headless BROWSER_HEADLESS]
                          [--browser-fullscreen BROWSER_FULLSCREEN]
                          [--browser-close BROWSER_CLOSE] [--target TARGET]
                          --url URL [--url-payload URL_PAYLOAD] --login-user
                          LOGIN_USER --login-pw LOGIN_PW
                          [--selector-user SELECTOR_USER]
                          [--selector-pw SELECTOR_PW]
                          [--selector-submit SELECTOR_SUBMIT]
                          [--selector-value-user SELECTOR_VALUE_USER]
                          [--selector-value-pw SELECTOR_VALUE_PW]
                          [--selector-value-submit SELECTOR_VALUE_SUBMIT]

optional arguments:
  -h, --help            show this help message and exit
  --browser-headless BROWSER_HEADLESS
                        Run the browser in headless mode
  --browser-fullscreen BROWSER_FULLSCREEN
                        Run browser in fullscreen mode
  --browser-close BROWSER_CLOSE
                        Close browser after successful run
  --target TARGET       The application to log into
  --url URL             URL to open in browser startup
  --url-payload URL_PAYLOAD
                        URL to open after successful login
  --login-user LOGIN_USER
                        Username to use for web-app login
  --login-pw LOGIN_PW   Password to user for web-app login
  --selector-user SELECTOR_USER
                        The method to select the user input element
  --selector-pw SELECTOR_PW
                        The method to select the user input element
  --selector-submit SELECTOR_SUBMIT
                        The method to select the submit button element
  --selector-value-user SELECTOR_VALUE_USER
                        The value for the user element selection
  --selector-value-pw SELECTOR_VALUE_PW
                        The value for the pw element selection
  --selector-value-submit SELECTOR_VALUE_SUBMIT
                        The value for the submit element selection

Using command line arguments

$ ./webdriver-login.py --target grafana \
                       --url https://grafana.example.com \
                       --login-user foo \
                       --login-pw c3VwZXJTZWNyZXRQYXNzd3JvZAo=

Using only environment variable

# For a supported target like Grafana
$ TARGET="grafana" \
  URL="https://grafana.example.com" \
  LOGIN_USER="foo" \
  LOGIN_PW="c3VwZXJTZWNyZXRQYXNzd3JvZAo=" \
  ./webdriver-login.py

# For an unsupported target
$ URL="http://example.com" \
  SELECTOR_USER="id" \
  SELECTOR_VALUE_USER="userName" \
  SELECTOR_PW="name" \
  SELECTOR_VALUE_PW="inputPassword" \
  SELECTOR_SUBMIT="xpath" \
  SELECTOR_VALUE_SUBMIT="/html/body/app/div/div[1]/form/div[3]/button" \
  LOGIN_USER="foo" \
  LOGIN_PW="c3VwZXJTZWNyZXRQYXNzd3JvZAo=" \
  ./webdriver-login.py

Environment Variables

  • TARGET - The application to log into (optional)
  • URL - The target URL
  • URL_PAYLOAD - The URL to open after successful login (optional)
  • LOGIN_USER - The user to use for logging in
  • LOGIN_PW - The base64 encoded password to use for logging in

With a target given, only the above environment variables are needed. TARGET can be one of

  • gitea
  • grafana
  • roundcube

In cases where the target is not supported, the user/password/submit element selection methods and their values must be supplied additionally.
The currently supported methods are one of: "id", "name" or "xpath".
"id" is ideal but does not always exist.

  • SELECTOR_USER - The method to select the user input element

  • SELECTOR_PW - The method to select the user input element

  • SELECTOR_SUBMIT - The method to select the submit button element

  • SELECTOR_VALUE_USER - The value for the above selected element

  • SELECTOR_VALUE_PW - The value for the above selected element

  • SELECTOR_VALUE_SUBMIT - The value for the above selected element

Other optional Environment Variables

  • BROWSER_HEADLESS - Whether to run headless or not (defaults to False)
  • BROWSER_FULLSCREEN - Whether to run fullscreen or not (defaults to True)
  • BROWSER_CLOSE - Whether to close the browser after the script run (defaults to True

Resources

W3C WebDriver Specification
Selenium/WebDriver Documentation
Mozilla geckodriver