Skip to content

digitronik/miqsel

Repository files navigation

miqsel

Miq Selenium Server

Python Versions Build Status License: GPLV3 PyPI version Downloads Code style: black

miqsel is a Python CLI utility leaveraging a Selenium container image to efficiently manage a selenium server and provide vnc access.

Prerequisite:

  1. Podman/Docker:

    Make sure podman or docker running on your system.

  2. VNC Viewer:

    You can choose any vnc viewer but most of user used tigervnc.

Installation:

pip install miqsel --user

or

 pip install git+https://github.com/digitronik/miqsel#egg=miqsel --user

Usage:

  • Help:

    ❯❯❯ miqsel --help
    Usage: miqsel [OPTIONS] COMMAND [ARGS]...
    
      Miq Selenium Server
    
    Options:
      --version  Show the version and exit.
      --help     Show this message and exit.
    
    Commands:
      config    Set Configuration
      executor  Selenium executor URL
      start     Start Selenium Server
      status    Status of Selenium Server
      stop      Stop Selenium Server
      viewer    VNC viewer
      vnc       VNC URL
  • Status: Check status of selenium container (running/ stopped).

    ❯❯❯ miqsel status
    stopped
  • Start/Stop:

    ❯❯❯ miqsel start
    Selenium Server started
    
    TigerVNC Viewer 64-bit v1.9.0
    
    ❯❯❯ miqsel stop
    
    Sun Apr 28 12:29:02 2019
     CConn:       End of stream
    Selenium Server stopped

    Note: start default invoke vnc-viewer. You can stop it like miqsel start --no-viewer

  • Viewer: Take vnc access of selenium server. At the start of selenium server, vnc viewer will be invoked automatically. If the status is running and the viewer is close then viewer command will help to re-open vnc session.

    ❯❯❯ miqsel status
    running
    ❯❯❯ miqsel viewer
    TigerVNC Viewer 64-bit v1.9.0
  • Executor: Get command executor url

    ❯❯❯ miqsel executor
    http://172.17.0.2:4444/wd/hub
  • VNC: Get vnc session url

    ❯❯❯ miqsel vnc
    172.17.0.2:5999
  • Configuration: Manage your miqsel configuration and change default setting as per need.

    ❯❯❯ miqsel config
    Container Engine (auto, podman, docker) [auto]:
    Selenium container image [selenium/standalone-chrome:latest]:
    VNC viewer (auto, vncviewer, vinagre, xdg-open) [auto]:
    Selenium server running on port? [4444]:
    VNC running on port? [5999]:
    Selenium container name [miqsel_container]:
    Selenium container network [default]:
    Selenium container shared Memory [2g]:
    Testing data mount to directory '/data' [default]:
    Configuration saved successfully...

    selenium/standalone-chrome:latest is default image. You can use other from SeleniumHQ or custom images.