wdio-cli: allow for custom path for WDIO config (webdriverio#4911)

* wdio-cli: allow for custom path for WDIO config * add documentation for install config flag

Author: baruchvlz

docs/CLI.md

@@ -135,10 +135,16 @@ wdio install reporter dot # installs @wdio/dot-reporter
 wdio install framework mocha # installs @wdio/mocha-framework
 ```
 
-If your project is using `package-lock.json` instead of `yarn.lock`, you can pass a `--npm` flag to make sure the packages are installed via NPM.
+If you want to install the packages using `yarn` instead, you can pass the `--yarn` flag to the command:
 
 ```bash
-wdio install service sauce --npm
+wdio install service sauce --yarn
+```
+
+You could also pass a custom configuration path if your WDIO config file is not in the same folder you're working on:
+
+```bash
+wdio install service sauce --config="./path/to/wdio.conf.js"
 ```
 
 #### List of supported services

packages/wdio-cli/src/commands/install.js

@@ -31,7 +31,11 @@ export const cmdArgs = {
  desc: 'Install packages using yarn',
  type: 'boolean',
  default: false
- }
+ },
+ config: {
+ desc: 'Location of your WDIO configuration',
+ default: './wdio.conf.js',
+ },
 }
 
 export const builder = (yargs) => {
@@ -55,7 +59,7 @@ export async function handler(argv) {
  * name = names for the supported service or reporter
  * yarn = optional flag to install package using yarn instead of default yarn
  */
- const { type, name, yarn } = argv
+ const { type, name, yarn, config } = argv
 
  /**
  * verify for supported types via `supportedInstallations` keys
@@ -75,7 +79,7 @@ export async function handler(argv) {
  return
  }
 
- const localConfPath = path.join(process.cwd(), 'wdio.conf.js')
+ const localConfPath = path.join(process.cwd(), config)
  if (!fs.existsSync(localConfPath)) {
  try {
  const promptMessage = `Cannot install packages without a WebdriverIO configuration.

packages/wdio-cli/tests/commands/install.test.js

@@ -29,14 +29,14 @@ describe('Command: install', () => {
  })
 
  it('should log out when an unknown installation type is passed', async () => {
- await installCmd.handler({ type: 'foobar' })
+ await installCmd.handler({ type: 'foobar', config: './wdio.conf.js' })
 
  expect(console.log).toHaveBeenCalled()
  expect(console.log).toHaveBeenCalledWith('Type foobar is not supported.')
  })
 
  it('should log out when unknown package name is used', async () => {
- await installCmd.handler({ type: 'service', name: 'foobar' })
+ await installCmd.handler({ type: 'service', name: 'foobar', config: './wdio.conf.js' })
 
  expect(console.log).toHaveBeenCalled()
  expect(console.log).toHaveBeenCalledWith('foobar is not a supported service.')
@@ -46,7 +46,7 @@ describe('Command: install', () => {
  jest.spyOn(utils, 'missingConfigurationPrompt').mockImplementation(() => Promise.reject())
  fs.existsSync.mockReturnValue(false)
 
- await installCmd.handler({ type: 'service', name: 'chromedriver' })
+ await installCmd.handler({ type: 'service', name: 'chromedriver', config: './wdio.conf.js' })
 
  expect(utils.missingConfigurationPrompt).toHaveBeenCalledWith('install', `Cannot install packages without a WebdriverIO configuration.
 You can create one by running 'wdio config'`, undefined)
@@ -56,7 +56,7 @@ You can create one by running 'wdio config'`, undefined)
  findInConfigMock.mockReturnValue(['chromedriver'])
  fs.existsSync.mockReturnValue(true)
 
- await installCmd.handler({ type: 'service', name: 'chromedriver' })
+ await installCmd.handler({ type: 'service', name: 'chromedriver', config: './wdio.conf.js' })
 
  expect(console.log).toHaveBeenCalledWith('The service chromedriver is already part of your configuration.')
  })
@@ -67,7 +67,22 @@ You can create one by running 'wdio config'`, undefined)
  fs.readFileSync.mockReturnValue('module.config = {}')
  yarnInstall.mockImplementation(() => ({ status: 0 }))
 
- await installCmd.handler({ type: 'service', name: 'chromedriver' })
+ await installCmd.handler({ type: 'service', name: 'chromedriver', config: './wdio.conf.js' })
+
+ expect(console.log).toHaveBeenCalledWith('Installing "wdio-chromedriver-service".')
+ expect(console.log).toHaveBeenCalledWith('Package "wdio-chromedriver-service" installed successfully.')
+ expect(utils.replaceConfig).toHaveBeenCalled()
+ expect(fs.writeFileSync).toHaveBeenCalled()
+ expect(console.log).toHaveBeenCalledWith('Your wdio.conf.js file has been updated.')
+ expect(process.exit).toHaveBeenCalledWith(0)
+ })
+ it('allows for custom config location', async () => {
+ findInConfigMock.mockReturnValue([''])
+ fs.existsSync.mockReturnValue(true)
+ fs.readFileSync.mockReturnValue('module.config = {}')
+ yarnInstall.mockImplementation(() => ({ status: 0 }))
+
+ await installCmd.handler({ type: 'service', name: 'chromedriver', config: './path/to/wdio.conf.js' })
 
  expect(console.log).toHaveBeenCalledWith('Installing "wdio-chromedriver-service".')
  expect(console.log).toHaveBeenCalledWith('Package "wdio-chromedriver-service" installed successfully.')
@@ -83,7 +98,7 @@ You can create one by running 'wdio config'`, undefined)
  yarnInstall.mockImplementation(() => ({ status: 1, stderr: 'test error' }))
  jest.spyOn(console, 'error')
 
- await installCmd.handler({ type: 'service', name: 'chromedriver' })
+ await installCmd.handler({ type: 'service', name: 'chromedriver', config: './wdio.conf.js' })
 
  expect(console.error).toHaveBeenCalledWith('Error installing packages', 'test error')
  expect(process.exit).toHaveBeenCalledWith(1)