saucelabs/wdio-static-server-service

Name: wdio-static-server-service

Owner: Sauce Labs

Description: Creates a static server for WebdriverIO.

Created: 2018-02-08 14:40:34.0

Updated: 2018-02-08 14:40:36.0

Pushed: 2018-02-08 18:42:23.0

Homepage: null

Size: 45

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

WDIO Static Server Service

Some projects are front-end assets only and don't run on more than a static server. This service helps you to run a static file server during testing.

Installation

The easiest way is to keep wdio-static-server-service as a devDependency in your package.json.

evDependencies": {
"wdio-static-server-service": "^1.0.0"

You can simple do it by:

install wdio-static-server-service --save-dev

Instructions on how to install WebdriverIO can be found here.

Configuration

In order to use the static server service you need to add static-server to your service array:

dio.conf.js
rt.config = {
 ...
rvices: ['static-server'],
 ...

Options

staticServerFolders (required)

Array of folder paths and mount points.

Type: Array<Object> Props:

• mount {String} - URL endpoint where folder will be mounted.
• path {String} - Path to the folder to mount.

wdio.conf.js
ort.config = {
/ ...
taticServerFolders: [
 { mount: '/fixtures', path: './tests/fixtures' },
 { mount: '/dist', path: './dist' },
,
/ ...

staticServerPort

Port to bind the server.

Type: Number

Default: 4567

staticServerLog

Debugging logs, will print mount points and requests. When staticServerLogs is set to true it will print into the console. Otherwise a string will be treated as the log folder.

Type: Boolean or String

staticServerMiddleware

Array of middleware objects. Load and instatiate these in the config and pass them in for the static server to use.

Type: Array<Object> Props:

• mount {String} - URL endpoint where middleware will be mounted.
• middleware <Object> - Middleware function callback

Default: []

wdio.conf.js
ort.config = {
onst middleware = require('middleware-package');
/ ...
taticServerMiddleware: [{
 mount: '/',
 middleware: middleware(/* middleware options */),
],
/ ...

---

For more information on WebdriverIO see the homepage.