weaponregex.model.mutation.TokenMutator.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of weapon-regex_2.12 Show documentation

Weapon regeX mutates regular expressions for use in mutation testing.

The newest version!

package weaponregex.model.mutation

import weaponregex.internal.model.regextree.RegexTree
import weaponregex.model.Location

trait TokenMutator {

  /** The name of the mutator
    */
  val name: String

  /** The mutation levels that the token mutator falls under
    */
  val levels: Seq[Int]

  /** Generate the default description for the mutants of this mutator
    * @param original
    *   The original token string being mutated
    * @param mutated
    *   The mutated string
    * @param location
    *   The [[weaponregex.model.Location]] where the mutation occurred
    */
  def description(original: String, mutated: String, location: Location): String =
    s"${location.show} Mutate $original to $mutated"

  /** Mutate the given token
    * @param token
    *   Target token
    * @return
    *   Sequence of [[weaponregex.model.mutation.Mutant]]
    */
  def mutate(token: RegexTree): Seq[Mutant]

}