io.hyperfoil.core.steps.LoopStep Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hyperfoil-core Show documentation
The core of Hyperfoil
There is a newer version: 0.27.1
package io.hyperfoil.core.steps;

import java.util.Collections;
import java.util.List;

import org.kohsuke.MetaInfServices;

import io.hyperfoil.api.config.Name;
import io.hyperfoil.api.config.StepBuilder;
import io.hyperfoil.api.session.Access;
import io.hyperfoil.api.session.Session;
import io.hyperfoil.api.config.Step;
import io.hyperfoil.api.session.ResourceUtilizer;
import io.hyperfoil.core.session.SessionFactory;

public class LoopStep implements Step, ResourceUtilizer {
   private final Access counterVar;
   private final int repeats;
   private final String sequence;

   public LoopStep(String counterVar, int repeats, String sequence) {
      this.counterVar = SessionFactory.access(counterVar);
      this.repeats = repeats;
      this.sequence = sequence;
   }

   @Override
   public boolean invoke(Session session) {
      if (!counterVar.isSet(session)) {
         counterVar.setInt(session, 1);
         session.nextSequence(sequence);
      } else if (counterVar.getInt(session) < repeats) {
         counterVar.addToInt(session, 1);
         session.nextSequence(sequence);
      }
      return true;
   }

   @Override
   public void reserve(Session session) {
      counterVar.declareInt(session);
   }

   /**
    * Repeats a sequence fixed-number times.
    * 
    * This step is supposed to be inserted as the last step of a sequence,
    * and the sequence to be matched with current sequence name.
    * 
    * Increments the counterVar and if it is lower than repeats
    * schedules an instance of the sequence.
    */
   @MetaInfServices(StepBuilder.class)
   @Name("loop")
   public static class Builder implements StepBuilder {
      private String counterVar;
      private int repeats;
      private String sequence;

      @Override
      public List build() {
         return Collections.singletonList(new LoopStep(counterVar, repeats, this.sequence));
      }

      /**
       * @param counterVar Variable holding number of iterations.
       * @return Self.
       */
      public Builder counterVar(String counterVar) {
         this.counterVar = counterVar;
         return this;
      }

      /**
       * @param repeats Number of iterations that should be executed.
       * @return Self.
       */
      public Builder repeats(int repeats) {
         this.repeats = repeats;
         return this;
      }

      /**
       * @param sequence Name of the sequence that should be instantiated.
       * @return Self.
       */
      public Builder sequence(String sequence) {
         this.sequence = sequence;
         return this;
      }
   }
}