CUBA Petclinic Example: Using Sneferu

This repository contains example test cases that show how to use Sneferu through the example application of the CUBA Petclinic.

Test Cases

The different test cases can be found in the test directory of the web module: modules/web/test/com/haulmont/sample/petclinic/web

Those test cases show different usages of Sneferu.

JUnit 5

An example using JUnit 5 can be found in the VisitBrowseToEditTest.java

public class VisitBrowseToEditTest {

  @RegisterExtension
  public SneferuTestUiEnvironment environment =
      new SneferuTestUiEnvironment(PetclinicWebTestContainer.Common.INSTANCE)
          .withScreenPackages(
              "com.haulmont.cuba.web.app.main",
              "com.haulmont.sample.petclinic.web"
          )
          .withUserLogin("admin")
          .withMainScreen(MainScreen.class);

  @Test
  public void aVisitCanBeCreated_whenAllFieldsAreFilled(
      @StartScreen StandardLookupTestAPI<Visit,VisitBrowse> visitBrowse,
      @SubsequentScreen StandardEditorTestAPI<Visit, VisitEdit> visitEdit,
      @NewEntity Pet pikachu
  ) {

    // given:
    pikachu.setName("Pikachu");

    // and:
    visitBrowse.interact(click(button("createBtn")));

    // when:
    OperationResult outcome = (OperationResult) visitEdit
        .interact(enter(dateField("visitDateField"), new Date()))
        .interact(enter(textField("descriptionField"), "Regular Visit"))
        .interact(select(lookupField("petField"), pikachu))
        .andThenGet(closeEditor());

    // then:
    assertThat(outcome).isEqualTo(OperationResult.success());

    // and:
    assertThat(environment.getUiTestAPI().isActive(visitEdit))
      .isFalse();

  }

  @AfterEach
  public void closeAllScreens() {
      environment.getUiTestAPI().closeAllScreens();
      TestServiceProxy.clear();
  }
}

Spock Example

CreateOwnerSpec.groovy

class CreateOwnerSpec extends PetclinicWebIntegrationSpec {

  def "an Owner can be created when all attributes are provided in the Editor"() {

    given:
    def ownerEdit = OwnerEditScreenObject.newEntity(uiTestAPI)

    when:
    OperationResult operationResult = ownerEdit
        .saveOwnerWithDetails(
            "Ash",
            "Ketchum",
            "Miastreet 134",
            "Alabastia")

    then:
    operationResult == OperationResult.success()
  }

  def "an Owner cannot be created when first name is missing"() {

    given:
    def ownerEdit = OwnerEditScreenObject.newEntity(uiTestAPI)

    when:
    OperationResult operationResult = ownerEdit
        .saveOwnerWithDetails(
            null,
            "Ketchum",
            "Miastreet 134",
            "Alabastia")

    then:
    operationResult == OperationResult.fail()
  }
}

Spock using Screen Objects

There is also an example on how to use ScreenObjects.

The Screen Object for the OwnerEdit screen looks like this:

public class OwnerEditScreenObject implements ScreenObject<StandardEditorTestAPI<OwnerEdit>> {

  private StandardEditorTestAPI<OwnerEdit> delegate;

  static OwnerEditScreenObject newEntity(
      UiTestAPI uiTestAPI
  ) {

    StandardEditorTestAPI<OwnerEdit> standardLookupTestAPI = uiTestAPI.openStandardEditor(
        Owner.class,
        OwnerEdit.class
    );

    return new OwnerEditScreenObject(
        standardLookupTestAPI
    );
  }

  static OwnerEditScreenObject forEntity(
      UiTestAPI uiTestAPI,
      Owner entity
  ) {

    StandardEditorTestAPI<OwnerEdit> standardLookupTestAPI = uiTestAPI.openStandardEditor(
        Owner.class,
        OwnerEdit.class,
        entity
    );

    return new OwnerEditScreenObject(
        standardLookupTestAPI
    );
  }

  private OwnerEditScreenObject(
      StandardEditorTestAPI<OwnerEdit> delegate) {
    this.delegate = delegate;
  }

  @Override
  public StandardEditorTestAPI<OwnerEdit> delegate() {
    return delegate;
  }

  public OperationResult saveOwnerWithDetails(
      String firstName,
      String lastName,
      String address,
      String city
  ) {
    return (OperationResult) delegate
        .interact(enter(textField("firstNameField"), firstName))
        .andThen(enter(textField("lastNameField"), lastName))
        .andThen(enter(textField("addressField"), address))
        .andThen(enter(textField("cityField"), city))
        .andThenGet(closeEditor());
  }

  public boolean addressIsSetTo(String expectedAddress) {
    return delegate.component(textField("addressField"))
        .rawComponent()
        .getValue().equals(expectedAddress);
  }
}

Its usage in a Spock based test case:

class EditOwnerSpec extends PetclinicWebIntegrationSpec {

  private Owner existingOwner

  def setup() {
    existingOwner = metadata.create(Owner)
  }

  def "the address attribute of the Owner entity is correctly bound to the Address Field"() {

    given:
    existingOwner.address = "Miastreet 134"

    and:
    def ownerEdit = OwnerEditScreenObject.forEntity(uiTestAPI, existingOwner)

    expect:
    ownerEdit.addressIsSetTo("Miastreet 134")
  }

  def "the city attribute is correctly bound to the city field"() {

    given:
    existingOwner.city = "Alabastia"

    and:
    def ownerEdit = OwnerEditScreenObject.forEntity(uiTestAPI, existingOwner)

    expect:
    def city = ownerEdit.delegate()
                        .verify(componentValue(textField("cityField")))

    city == "Alabastia"
  }
}