PMPL
Examples
Sitodo PMPL

Repository

$ java --version
$ javac --version
$ mvn --version
mvn test
mvn package -DskipTests
java -jar sitodo.jar
Feature: Add items into the todo list

  Scenario: Add single item into the list
    Given Alice is looking at the TODO list
    When she adds "Touch grass" to the list
    Then she sees "Touch grass" as an item in the TODO list

  Scenario: Add multiple items into the list
    Given Alice is looking at the TODO list
    When she adds "Buy bread" to the list
    And she adds "Buy candy" to the list
    Then she sees "Buy bread" as an item in the TODO list
    And she sees "Buy candy" as an item in the TODO list
/**
 * Simplified, non-refactored version of a test case in AddTodoItemTest.java functional test suite.
 */
@Test
@DisplayName("A user can create a single todo item")
void example_addTodo_singleItem() {
    // Open the initial page
    open("/");

    // Create a new item
    WebElement inputField = $(By.tagName("input"));
    inputField.sendKeys("Touch grass", Keys.ENTER);

    // See the list for the newly inserted item
    $(By.tagName("tbody")).findAll(By.tagName("tr"))
                          .shouldHave(CollectionCondition.size(expectedItems.size()))
                          .should(CollectionCondition.allMatch("Valid row", (row) -> isRowValid(List.of("Tounch grass"), row)));

    // The page can be accessed at the new, unique URL
    String currentUrl = webdriver().driver().url();
    assertTrue(currentUrl.matches(".+/list/\\d+$"), "The URL was: " + currentUrl);
}

private boolean isRowValid(List<String> expectedItems, WebElement row) {
    List<WebElement> columns = row.findElements(By.tagName("td"));

    assertEquals(DEFAULT_NUMBER_OF_COLUMNS, columns.size(),
                 "There were " + columns.size() + " columns in a row");

    String id = columns.get(0).getText();
    String title = columns.get(1).getText();

    return Pattern.matches("\\d+", id) && expectedItems.contains(title);
}
/**
 * Page object model of the main todo list page,
 * specifically the significant elements of the todo list page.
 *
 * Reference:
 * https://serenity-bdd.github.io/docs/screenplay/screenplay_webdriver#using-the-target-class
 */
public class TodoListPage extends PageObject {

    public static Target ITEM_NAME_FIELD = Target
        .the("item name field")
        .located(By.id("id_new_item"));

    public static Target ENTER_BUTTON = Target
        .the("enter button")
        .located(By.tagName("button"));

    public static Target ITEMS_LIST = Target
        .the("item list")
        .located(By.xpath("//tbody/tr/td[contains(@class, 'todo-item-title')]"));
}
/**
 * A custom interaction class to fill a text input field.
 *
 * Reference: https://serenity-bdd.github.io/docs/screenplay/screenplay_webdriver#interacting-with-elements
 */
public class AddAnItem {

    public static Performable withName(String itemName) {
        return Task
            .where("{0} adds an item with name " + itemName,
                Enter.theValue(itemName) // Uses Serenity's `Enter` interaction class
                    .into(TodoListPage.ITEM_NAME_FIELD)
            )
            .then(Task.where("{0} clicks the enter button",
                Click.on(TodoListPage.ENTER_BUTTON) // Uses Serenity's `CLick` interaction class
            ));
    }
}
public class AddItemStepDefinitions {

    @Given("{actor} is looking at the TODO list")
    public void actor_is_looking_at_her_todo_list(Actor actor) {
        actor.wasAbleTo(NavigateTo.theTodoListPage());
    }

    @When("{actor} adds {string} to the list")
    public void she_adds_to_the_list(Actor actor, String itemName) {
        actor.attemptsTo(AddAnItem.withName(itemName));
    }

    @Then("{actor} sees {string} as an item in the TODO list")
    public void she_sees_as_an_item_in_the_todo_list(Actor actor, String expectedItemName) {
        List<String> todoItems = TodoListPage.ITEMS_LIST.resolveAllFor(actor)
            .textContents();

        actor.attemptsTo(
            Ensure.that(todoItems)
                .contains(expectedItemName)
        );
    }
}
package com.example.sitodo.bdd;

import io.cucumber.junit.CucumberOptions;
import net.serenitybdd.cucumber.CucumberWithSerenity;
import org.junit.runner.RunWith;

/**
 * The test runner class that runs the executable scenarios,
 * i.e. the feature files written in Gherkin format.
 */
@RunWith(CucumberWithSerenity.class) // Runs the test suite using the test runner provided by Serenity
@CucumberOptions(
    plugin = {"pretty"},
    features = "src/test/resources/features"
)
public class CucumberTestSuite { }
serenity {
    take.screenshots = FOR_FAILURES
}

headless.mode = false

webdriver {
  autodownload = true
  base.url = "http://localhost:8080"
  driver = firefox
  capabilities {
    browserName = "firefox"
    acceptInsecureCerts = true
  }
}
mvn spring-boot:run
mvn -P bdd verify