io.gatling.core.structure.StructureBuilder.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gatling-core Show documentation
gatling-core
The newest version!
/*
 * Copyright 2011-2024 GatlingCorp (https://gatling.io)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.gatling.core.structure

import io.gatling.core.action.builder.{ ActionBuilder, Executable }
import io.gatling.core.controller.inject.{ InjectionProfile, InjectionProfileFactory }

/**
 * This trait defines most of the scenario related DSL
 */
trait StructureBuilder[B <: StructureBuilder[B]]
    extends Execs[B]
    with Pauses[B]
    with Feeds[B]
    with Loops[B]
    with ConditionalStatements[B]
    with Errors[B]
    with Groups[B]

object ChainBuilder {
  val Empty: ChainBuilder = new ChainBuilder(Nil)
}

/**
 * This class defines chain related methods
 *
 * @param actionBuilders
 *   the builders that represent the chain of actions of a scenario/chain
 */
final class ChainBuilder(val actionBuilders: List[ActionBuilder]) extends StructureBuilder[ChainBuilder] with BuildAction with Executable {
  override protected def chain(newActionBuilders: Seq[ActionBuilder]): ChainBuilder =
    new ChainBuilder(newActionBuilders.toList ::: actionBuilders)

  override def toChainBuilder: ChainBuilder = this
}

/**
 * The scenario builder is used in the DSL to define the scenario
 *
 * @param name
 *   the name of the scenario
 * @param actionBuilders
 *   the list of all the actions that compose the scenario
 */
final class ScenarioBuilder(val name: String, val actionBuilders: List[ActionBuilder])
    extends StructureBuilder[ScenarioBuilder]
    with BuildAction
    with Executable {
  override protected def chain(newActionBuilders: Seq[ActionBuilder]): ScenarioBuilder =
    new ScenarioBuilder(name, actionBuilders = newActionBuilders.toList ::: actionBuilders)

  def inject[T: InjectionProfileFactory](is: T, moreIss: T*): PopulationBuilder = inject[T](Seq(is) ++ moreIss)

  def inject[T: InjectionProfileFactory](iss: Iterable[T]): PopulationBuilder = {
    require(iss.nonEmpty, "Calling inject with empty injection steps")
    inject(implicitly[InjectionProfileFactory[T]].profile(iss))
  }

  private[gatling] def inject(injectionProfile: InjectionProfile): PopulationBuilder =
    PopulationBuilder(
      scenarioBuilder = this,
      injectionProfile = injectionProfile,
      scenarioProtocols = Map.empty,
      scenarioThrottleSteps = Nil,
      pauseType = None,
      children = Nil,
      shard = true
    )

  override private[core] def toChainBuilder = new ChainBuilder(actionBuilders)

  override def toString = s"ScenarioBuilder($name)"
}

trait StructureSupport extends StructureBuilder[ChainBuilder] {
  override protected def actionBuilders: List[ActionBuilder] = Nil

  override protected def chain(newActionBuilders: Seq[ActionBuilder]): ChainBuilder =
    new ChainBuilder(newActionBuilders.toList)
}