Support fully qualified paths to plugins (webdriverio#4959)

* Support fully qualified paths to plugins - closes webdriverio#4867 * better check of absolute path

Author: christian-bromann

docs/CustomReporter.md

@@ -37,9 +37,20 @@ const CustomReporter = require('./reporter/my.custom.reporter')
 
 exports.config = {
  // ...
- reporters: [[CustomReporter, {
- someOption: 'foobar'
- }]],
+ reporters: [
+ /**
+ * use imported reporter class
+ */
+ [CustomReporter, {
+ someOption: 'foobar'
+ }]
+ /**
+ * use absolute path to reporter
+ */
+ ['/path/to/reporter.js', {
+ someOption: 'foobar'
+ }]
+ ],
  // ...
 }
 ```

docs/CustomServices.md

@@ -3,9 +3,9 @@ id: customservices
 title: Custom Services
 ---
 
-You can write your own custom service for the WDIO test runner to custom-fit your needs. 
+You can write your own custom service for the WDIO test runner to custom-fit your needs.
 
-<dfn>Services</dfn> are add-ons that are created for reusable logic to simplify tests, manage your test suite, and integrate results. Services have access to all the same [`before`/`after` hooks](ConfigurationFile.md) available in the `wdio.conf.js`. 
+<dfn>Services</dfn> are add-ons that are created for reusable logic to simplify tests, manage your test suite, and integrate results. Services have access to all the same [`before`/`after` hooks](ConfigurationFile.md) available in the `wdio.conf.js`.
 
 The basic construction of a custom service should look like this:
 
@@ -23,7 +23,7 @@ export default class CustomService {
 }
 ```
 
-The only thing to do now in order to use this service is to assign it to the `services` property. 
+The only thing to do now in order to use this service is to assign it to the `services` property.
 
 Modify your `wdio.conf.js` file to look like this:
 
@@ -32,9 +32,20 @@ import CustomService from './service/my.custom.service'
 
 exports.config = {
  // ...
- services: [[CustomService, {
- someOption: true
- }]],
+ services: [
+ /**
+ * use imported service class
+ */
+ [CustomService, {
+ someOption: true
+ }],
+ /**
+ * use absolute path to service
+ */
+ ['/path/to/service.js', {
+ someOption: true
+ }]
+ ],
  // ...
 }
 ```
@@ -60,13 +71,13 @@ exports.config = {
 ```
 
 > **Note:** Services that are added by name behave slightly differently compared to your own imported services. Instead of the service handling all the hooks, as in the example above, the service needs to export a launcher that handles `onPrepare` and `onComplete`. The rest of the hooks will be handled by the service (the default export), as normal.
-> 
+>
 > Example:
 >
 > ```
 > import Launcher from './launcher'
 > import Service from './service'
-> 
+>
 > export default Service
 > export const launcher = Launcher
 > ```

packages/wdio-utils/src/initialisePlugin.js

@@ -1,3 +1,4 @@
+import path from 'path'
 import { safeRequire } from './utils'
 
 /**
@@ -8,9 +9,9 @@ import { safeRequire } from './utils'
  */
 export default function initialisePlugin (name, type, target = 'default') {
  /**
- * directly import packages that are scoped
+ * directly import packages that are scoped or start with an absolute path
  */
- if (name[0] === '@') {
+ if (name[0] === '@' || path.isAbsolute(name)) {
  const service = safeRequire(name)
  return service[target]
  }

packages/wdio-utils/tests/initialisePlugin.test.js

@@ -25,6 +25,12 @@ describe('initialisePlugin', () => {
  expect(service.foo).toBe('barfoo')
  })
 
+ it('should allow to load service referenced with an absolute path', () => {
+ const Service = initialisePlugin(require.resolve(__dirname + '/__mocks__/@saucelabs/wdio-foobar-reporter'))
+ const service = new Service()
+ expect(service.foo).toBe('barfoo')
+ })
+
  it('should prefer scoped over unscoped packages', () => {
  const Service = initialisePlugin('scoped', 'service')
  const service = new Service()