jp.co.moneyforward.autotest.actions.web.PageAct Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of insdog-all Show documentation
An action-based testing framework and library
The newest version!
package jp.co.moneyforward.autotest.actions.web;

import com.microsoft.playwright.Page;
import jp.co.moneyforward.autotest.framework.action.Act;
import jp.co.moneyforward.autotest.framework.core.ExecutionEnvironment;

import java.util.function.BiConsumer;

import static com.github.valid8j.classic.Requires.requireNonNull;

///
/// A general-purpose act.
/// Convenient starting point for writing **insdog** based tests.
///
public abstract class PageAct implements Act {
  private final String description;
  
  ///
  /// Creates a new instance of this class.
  ///
  /// It is advised to give a concise and descriptive string to `description` parameter as it is printed the test report.
  /// The `description` should be concise but informative enough for a reader to reproduce the same action that this `Act` performs.
  ///
  /// @param description A string that describes this object.
  ///
  protected PageAct(String description) {
    this.description = requireNonNull(description);
  }
  
  ///
  /// Creates a `PageAct` with a given description and an action
  ///
  /// @param description A string to describe created page act.
  /// @param action      An action to be performed.
  /// @return A page act that performs `action`.
  ///
  public static PageAct pageAct(String description, BiConsumer action) {
    return new PageAct(description) {
      @Override
      protected void action(Page page, ExecutionEnvironment executionEnvironment) {
        action.accept(page, executionEnvironment);
      }
    };
  }
  
  ///
  /// Performs an action defined for this class.
  /// Its execution is delegated to `perform(Page,ExecutionEnvironment)` method.
  ///
  /// @param value                A page object on which this `act` is performed.
  /// @param executionEnvironment An execution environment, in which this act is performed.
  /// @return The `value` itself should be returned, usually.
  ///
  @Override
  public Page perform(Page value, ExecutionEnvironment executionEnvironment) {
    this.action(value, executionEnvironment);
    return value;
  }
  
  ///
  /// A method that defines the `act` to be performed by this object.
  ///
  /// @param page                 A page object on which this `act` is performed.
  /// @param executionEnvironment An execution environment, in which this act is performed.
  ///
  protected abstract void action(Page page, ExecutionEnvironment executionEnvironment);
  
  ///
  /// Returns a name of this object.
  ///
  /// @return A name of this object.
  ///
  @Override
  public String name() {
    return "Page[" + this.description + "]";
  }
}