io.hyperfoil.hotrod.steps.HotRodRequestBuilder Maven / Gradle / Ivy

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

import java.util.Arrays;
import java.util.List;

import org.kohsuke.MetaInfServices;

import io.hyperfoil.api.config.BenchmarkDefinitionException;
import io.hyperfoil.api.config.Locator;
import io.hyperfoil.api.config.Name;
import io.hyperfoil.api.config.Step;
import io.hyperfoil.api.config.StepBuilder;
import io.hyperfoil.api.session.Session;
import io.hyperfoil.core.builders.BaseStepBuilder;
import io.hyperfoil.core.generators.StringGeneratorBuilder;
import io.hyperfoil.core.generators.StringGeneratorImplBuilder;
import io.hyperfoil.core.metric.MetricSelector;
import io.hyperfoil.core.metric.PathMetricSelector;
import io.hyperfoil.core.metric.ProvidedMetricSelector;
import io.hyperfoil.core.steps.StatisticsStep;
import io.hyperfoil.function.SerializableFunction;
import io.hyperfoil.hotrod.api.HotRodOperation;
import io.hyperfoil.hotrod.resource.HotRodResource;

/**
 * Issues a HotRod request and registers handlers for the response.
 */
@MetaInfServices(StepBuilder.class)
@Name("hotrodRequest")
public class HotRodRequestBuilder extends BaseStepBuilder {

   private HotRodOperationBuilder operation;
   private StringGeneratorBuilder cacheName;
   private MetricSelector metricSelector;
   private StringGeneratorBuilder key;
   private StringGeneratorBuilder value;

   @Override
   public void prepareBuild() {
      if (metricSelector == null) {
         String sequenceName = Locator.current().sequence().name();
         metricSelector = new ProvidedMetricSelector(sequenceName);
      }
   }

   @Override
   public List build() {
      int stepId = StatisticsStep.nextId();
      HotRodResource.Key key = new HotRodResource.Key();
      SerializableFunction keyGenerator = this.key != null ? this.key.build() : null;
      SerializableFunction valueGenerator = this.value != null ? this.value.build() : null;
      HotRodRequestStep step = new HotRodRequestStep(stepId, key, operation.build(), cacheName.build(), metricSelector,
            keyGenerator, valueGenerator);
      HotRodResponseStep secondHotRodStep = new HotRodResponseStep(key);
      return Arrays.asList(step, secondHotRodStep);
   }

   /**
    * Requests statistics will use this metric name.
    *
    * @param name Metric name.
    * @return Self.
    */
   public HotRodRequestBuilder metric(String name) {
      return metric(new ProvidedMetricSelector(name));
   }

   public HotRodRequestBuilder metric(ProvidedMetricSelector selector) {
      this.metricSelector = selector;
      return this;
   }

   /**
    * Allows categorizing request statistics into metrics based on the request path.
    *
    * @return Builder.
    */
   public PathMetricSelector metric() {
      PathMetricSelector selector = new PathMetricSelector();
      this.metricSelector = selector;
      return selector;
   }

   public StringGeneratorImplBuilder cacheName() {
      StringGeneratorImplBuilder builder = new StringGeneratorImplBuilder<>(this);
      cacheName(builder);
      return builder;
   }

   public HotRodRequestBuilder cacheName(StringGeneratorBuilder builder) {
      if (this.cacheName != null) {
         throw new BenchmarkDefinitionException("CacheName generator already set.");
      }
      this.cacheName = builder;
      return this;
   }

   /**
    * Name of the cache used for the operation. This can be a pattern.
    *
    * @param pattern Cache name (my-cache) or a pattern (cache-${index}).
    * @return Self.
    */
   public HotRodRequestBuilder cacheName(String pattern) {
      return cacheName().pattern(pattern).end();
   }

   public HotRodRequestBuilder operation(HotRodOperation operation) {
      return operation(() -> new HotRodOperationBuilder.Provided(operation));
   }

   public HotRodRequestBuilder operation(HotRodOperationBuilder operation) {
      this.operation = operation;
      return this;
   }

   public StringGeneratorImplBuilder key() {
      StringGeneratorImplBuilder builder = new StringGeneratorImplBuilder<>(this);
      key(builder);
      return builder;
   }

   public HotRodRequestBuilder key(StringGeneratorBuilder builder) {
      if (this.key != null) {
         throw new BenchmarkDefinitionException("Key generator already set.");
      }
      this.key = builder;
      return this;
   }

   /**
    * Key used for the operation. This can be a pattern.
    *
    * @param pattern The key.
    * @return Self.
    */
   public HotRodRequestBuilder key(String pattern) {
      return key().pattern(pattern).end();
   }

   public StringGeneratorImplBuilder value() {
      StringGeneratorImplBuilder builder = new StringGeneratorImplBuilder<>(this);
      value(builder);
      return builder;
   }

   public HotRodRequestBuilder value(StringGeneratorBuilder builder) {
      if (this.value != null) {
         throw new BenchmarkDefinitionException("Value generator already set.");
      }
      this.value = builder;
      return this;
   }

   /**
    * Value for the operation. This can be a pattern.
    *
    * @param pattern The value.
    * @return Self.
    */
   public HotRodRequestBuilder value(String pattern) {
      return value().pattern(pattern).end();
   }

   /**
    * Adds or overrides each specified entry in the remote cache.
    *
    * @param cacheName Name of cache to put data. This can be a pattern.
    * @return
    */
   public HotRodRequestBuilder put(String cacheName) {
      return operation(HotRodOperation.PUT).cacheName(cacheName);
   }

   /**
    * Get specified entry in the remote cache.
    *
    * @param cacheName Name of cache to put data. This can be a pattern.
    * @return
    */
   public HotRodRequestBuilder get(String cacheName) {
      return operation(HotRodOperation.GET).cacheName(cacheName);
   }
}