cypress/packages/server/lib/util/specs.js

const _ = require('lodash')
const R = require('ramda')
const la = require('lazy-ass')
const path = require('path')
const check = require('check-more-types')
const debug = require('debug')('cypress:server:specs')
const minimatch = require('minimatch')
const Bluebird = require('bluebird')
const pluralize = require('pluralize')
const glob = require('./glob')
const Table = require('cli-table3')

const MINIMATCH_OPTIONS = { dot: true, matchBase: true }

/**
 * Enums to help keep track of what types of spec files we find.
 * By default, every spec file is assumed to be integration.
*/
const SPEC_TYPES = {
  INTEGRATION: 'integration',
}

const getPatternRelativeToProjectRoot = (specPattern, projectRoot) => {
  return _.map(specPattern, (p) => {
    return path.relative(projectRoot, p)
  })
}

/**
 * Finds all spec files that pass the config for given type. Note that "searchOptions" is
 * a subset of the project's "config" object
 */
function findSpecsOfType (searchOptions, specPattern) {
  let fixturesFolderPath

  la(check.maybe.strings(specPattern), 'invalid spec pattern', specPattern)

  const searchFolderPath = searchOptions.searchFolder

  la(check.unemptyString(searchFolderPath), 'expected spec folder path in', searchOptions)

  debug(
    'looking for test specs in the folder:',
    searchFolderPath,
  )

  if (specPattern) {
    debug('spec pattern "%s"', specPattern)
  } else {
    debug('there is no spec pattern')
  }

  // support files are not automatically
  // ignored because only _fixtures are hard
  // coded. the rest is simply whatever is in
  // the javascripts array

  if (check.unemptyString(searchOptions.fixturesFolder)) {
    // users should be allowed to set the fixtures folder
    // the same as the specs folder
    if (searchOptions.fixturesFolder !== searchFolderPath) {
      fixturesFolderPath = path.join(
        searchOptions.fixturesFolder,
        '**',
        '*',
      )
    }
  }

  const supportFilePath = searchOptions.supportFile || []

  // map all of the javascripts to the project root
  // TODO: think about moving this into config
  // and mapping each of the javascripts into an
  // absolute path
  const javascriptsPaths = _.map(searchOptions.javascripts, (js) => {
    return path.join(searchOptions.projectRoot, js)
  })

  // ignore fixtures + javascripts
  const options = {
    sort: true,
    absolute: true,
    nodir: true,
    cwd: searchFolderPath,
    ignore: _.compact(_.flatten([
      javascriptsPaths,
      supportFilePath,
      fixturesFolderPath,
    ])),
  }

  // example of resolved paths in the returned spec object
  // filePath                          = /Users/bmann/Dev/my-project/cypress/integration/foo.js
  // integrationFolderPath             = /Users/bmann/Dev/my-project/cypress/integration
  // relativePathFromSearchFolder      = foo.js
  // relativePathFromProjectRoot       = cypress/integration/foo.js

  const relativePathFromSearchFolder = (file) => {
    return path.relative(searchFolderPath, file).replace(/\\/g, '/')
  }

  const relativePathFromProjectRoot = (file) => {
    return path.relative(searchOptions.projectRoot, file).replace(/\\/g, '/')
  }

  const setNameParts = (file) => {
    debug('found spec file %s', file)

    if (!path.isAbsolute(file)) {
      throw new Error(`Cannot set parts of file from non-absolute path ${file}`)
    }

    return {
      name: relativePathFromSearchFolder(file),
      relative: relativePathFromProjectRoot(file),
      absolute: file,
    }
  }

  const ignorePatterns = [].concat(searchOptions.ignoreTestFiles)

  // a function which returns true if the file does NOT match
  // all of our ignored patterns
  const doesNotMatchAllIgnoredPatterns = (file) => {
    // using {dot: true} here so that folders with a '.' in them are matched
    // as regular characters without needing an '.' in the
    // using {matchBase: true} here so that patterns without a globstar **
    // match against the basename of the file
    return _.every(ignorePatterns, (pattern) => {
      return !minimatch(file, pattern, MINIMATCH_OPTIONS)
    })
  }

  const matchesSpecPattern = (file) => {
    if (!specPattern) {
      return true
    }

    const matchesPattern = (pattern) => {
      return minimatch(file, pattern, MINIMATCH_OPTIONS)
    }

    // check to see if the file matches
    // any of the spec patterns array
    return _
    .chain([])
    .concat(specPattern)
    .some(matchesPattern)
    .value()
  }

  // grab all the files
  debug('globbing test files "%s"', searchOptions.testFiles)
  debug('glob options %o', options)

  // ensure we handle either a single string or a list of strings the same way
  const testFilesPatterns = [].concat(searchOptions.testFiles)

  /**
   * Finds matching files for the given pattern, filters out specs to be ignored.
   */
  const findOnePattern = (pattern) => {
    return glob(pattern, options)
    .tap(debug)

    // filter out anything that matches our
    // ignored test files glob
    .filter(doesNotMatchAllIgnoredPatterns)
    .filter(matchesSpecPattern)
    .map(setNameParts)
    .tap((files) => {
      return debug('found %s: %o', pluralize('spec file', files.length, true), files)
    })
  }

  return Bluebird.mapSeries(testFilesPatterns, findOnePattern).then(_.flatten)
}

/**
 * First, finds all integration specs, then finds all component specs.
 * Resolves with an array of objects. Each object has a "testType" property
 * with one of TEST_TYPES values.
 */
const find = (config, specPattern) => {
  const commonSearchOptions = ['fixturesFolder', 'supportFile', 'projectRoot', 'javascripts', 'testFiles', 'ignoreTestFiles']

  const componentTestingEnabled = _.get(config, 'resolved.testingType.value', 'e2e') === 'component'

  debug('componentTesting %o', componentTestingEnabled)
  if (componentTestingEnabled) {
    debug('component folder %o', config.componentFolder)
    // component tests are new beasts, and they change how we mount the
    // code into the test frame.
    SPEC_TYPES.COMPONENT = 'component'
  }

  /**
   * Sets "testType: integration|component" on each object in a list
  */
  const setTestType = (testType) => R.map(R.set(R.lensProp('specType'), testType))

  const findIntegrationSpecs = () => {
    const searchOptions = _.pick(config, commonSearchOptions)

    // ? should we always use config.resolved instead of config?
    searchOptions.searchFolder = config.integrationFolder

    return findSpecsOfType(searchOptions, specPattern)
    .then(setTestType(SPEC_TYPES.INTEGRATION))
  }

  const findComponentSpecs = () => {
    // ? should we always use config.resolved instead of config?
    if (!config.componentFolder) {
      return []
    }

    const searchOptions = _.pick(config, commonSearchOptions)

    searchOptions.searchFolder = config.componentFolder

    return findSpecsOfType(searchOptions, specPattern)
    .then(setTestType(SPEC_TYPES.COMPONENT))
  }

  const printFoundSpecs = (foundSpecs) => {
    const table = new Table({
      head: ['relative', 'specType'],
    })

    foundSpecs.forEach((spec) => {
      table.push([spec.relative, spec.specType])
    })

    /* eslint-disable no-console */
    console.error(table.toString())
  }

  return Bluebird.resolve(
    componentTestingEnabled ?
      findComponentSpecs() :
      findIntegrationSpecs(),
  ).tap((foundSpecs) => {
    if (debug.enabled) {
      printFoundSpecs(foundSpecs)
    }
  })
}

module.exports = {
  find,
  findSpecsOfType,

  getPatternRelativeToProjectRoot,

  TEST_TYPES: SPEC_TYPES,
}