This service is intended for use with WebdriverIO and it helps run functional/integration tests against/using containerized applications. It uses popular Docker service (installed separately) to run containers.
Ideally your tests would run in some variety of CI/CD pipeline where often there are no "real" browsers and other resources your application depends on. With advent of Docker practically all necessary application dependencies can be containerized. With this service you may run your application container or a docker-selenium in your CI and in complete isolation (assuming CI can have Docker installed as a dependency). Same may apply to local development if your application needs to have a level of isolation from your main OS.
Service will run an existing docker image and once its ready, will initiate WebdriverIO tests that should run against your containerized application.
Instructions on how to install WebdriverIO can be found here.
By default, Google Chrome, Firefox and PhantomJS are available when installed on the host system.
In order to use the service you need to add
docker to your service array:
Various options required to run docker container
Docker container name tag. Could be local or from Docker HUB.
Configuration which checks your containers' readiness before initiating tests. Normally this would be a localhost url. If healthCheck is not configured, Webdriver will start running tests immediately after Docker container starts, which maybe too early considering that it takes time for web service to start inside a Docker container.
Options for Object use:
- url - url to an app running inside your container
- maxRetries - number of retries until healthcheck fails. Default: 10
- inspectInterval - interval between each retry in ms. Default: 500
- startDelay - initial delay to begin healthcheck in ms. Default: 0
Example 1 (String):
Example 2 (Object):
Map of options used by
docker run command. For more details on
run command click here.
Any single-letter option will be converted to
d: true ->
Any option of two-character or more will
be converted to
rm: true ->
For options that may be used more than once
--expose, etc.), please use array notation (i.e.
e: ["NODE_ENV=development", "FOO=bar"]).
Any arguments you may want to pass into container. Corresponds to
[ARG...] in Docker run CLI.
Any command you may want to pass into container. Corresponds to
[COMMAND] in Docker run CLI.
A callback method which is called when Docker application is ready. Readiness is determined by ability to ping
Path to where logs from docker container should be stored
Please visit our Wiki for more details.