Spring data. Все записи#
Может быть выполнено, если интерфейс-репозиторий расширяет один или несколько из перечисленных:
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import java.util.List;
import static ru.tinkoff.qa.neptune.spring.data.SpringDataContext.springData;
import static ru.tinkoff.qa.neptune.spring.data.select.common.CommonSelectStepFactory.all;
@SpringBootTest
public class MyTest {
@Autowired
private TestRepository testRepository;
@Test
public void myTest() {
List<TestEntity> entities = springData().find(
//описание того ЧТО выбирается,
//в свободной форме или бизнес
//терминологии
"Test entities",
all(testRepository)
//можно указать один-несколько критериев,
//которым должны соответствовать отобранные записи
// Так же доступны criteriaOr(criteria...),
// criteriaOnlyOne(criteria...)
// criteriaNot(criteria...)
.criteria(
"Name == 'Some name'",
testEntity -> testEntity.getName().equals("Some name"))
.criteria("ID > 10", testEntity -> testEntity.getId() > 10L)
// можно указать время,
// за которое подходящие записи должны быть выбраны,
// если оно отличается от того,
// что указано в свойствах/переменных окружения
// SPRING_DATA_WAITING_FOR_SELECTION_RESULT_TIME_UNIT
// и SPRING_DATA_WAITING_FOR_SELECTION_RESULT_TIME_VALUE
.timeOut(ofSeconds(5))
//можно указать время интервала между попытками получить
// необходимый результат в рамках отведенного для этого времени,
// если значение этого интервала
//должно отличаться от того,
// что указано в свойствах/переменных окружения
// SPRING_DATA_SLEEPING_TIME_UNIT и
// SPRING_DATA_SLEEPING_TIME_VALUE
.pollingInterval(ofMillis(200))
//другие опциональные параметры
);
}
}
Про свойства / переменные окружения SPRING_DATA_SLEEPING_TIME_UNIT, SPRING_DATA_SLEEPING_TIME_VALUE,
SPRING_DATA_SLEEPING_TIME_UNIT и SPRING_DATA_SLEEPING_TIME_VALUE можно прочитать здесь.
Уточняющие параметры шага, который возвращает лист. Шаг предусматривает время на ожидание
//Можно указать один или несколько критериев,
//которым должен соответствовать
//каждый элемент результирующего листа.
// Так же доступны criteriaOr(criteria...),
// criteriaOnlyOne(criteria...)
// criteriaNot(criteria...)
.criteria("Описание критерия, которому должен соответствовать " +
"каждый элемент, который попадет в результирующий лист", item -> {
/*предикат, как работает критерий*/
})
//-------------------------------------------
// можно указать время,
// за которое нужные элементы должны быть получены
.timeOut(ofSeconds(5))
//-------------------------------------------
//Можно указать, что должно быть выброшено исключение,
// если непустой лист не удалось получить (не было ни одного элемента,
//который бы соответствовал перечисленным критериям,
// или непустой лист просто не был получен)
.throwOnNoResult()
//ТАКЖЕ ЕСТЬ СЛЕДУЮЩИЕ ОПЦИИ:
//-------------------------------------------
//1. можно указать сколько объектов,
//которые соответствуют критериям,
//нужно вернуть
.returnListOfSize(3)
//-------------------------------------------
//2. можно указать, до элемента с каким индексом
//нужно собрать результирующие элементы,
//индекс - индекс объекта в наборе элементов,
//которые соответствуют критериям
.returnBeforeIndex(7)
//.returnAfterIndex(8) либо после какого элемента
//----------------------------------------------
//3. Либо можно перечислить индексы элементов,
// которые следует вернуть.
//Индексы - индексы объектов в наборе элементов,
//которые соответствуют критериям
.returnItemsOfIndexes(0, 3, 5)
//-----------------------------------------------
//4. можно указать, при достижении какого количества
//ВСЕХ объектов, которые соответствуют критериям,
//должен быть возвращен результат
.returnIfEntireSize(isEqual(8))
//----------------------------------------------
//5. можно указать, при достижении каких условий,
//которым должен соответствовать лист ВСЕХ объектов,
//соответствующих критериям,
//можно возвращать результирующий лист/суб-лист
.returnOnCondition("Описание условия", list -> {
/*предикат, как работает критерий*/
})
//так же доступны returnOnConditionOr(criteria...),
// returnOnConditionOnlyOne(criteria...)
// returnOnConditionNot(criteria...)
//------------------------------------------
//Если не нашлось столько подходящих объектов, чтобы вернуть результат,
//или весь суб-лист подходящих по критериям элементов,
// который должен вернуться как результат,
// не соответствует каким-то критериям -
// будет выброшено исключение с подробным описанием
Кроме записей целиком, можно сделать выборку их данных
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import static ru.tinkoff.qa.neptune.spring.data.SpringDataContext.springData;
import static ru.tinkoff.qa.neptune.spring.data.select.common.CommonSelectStepFactory.all;
@SpringBootTest
public class MyTest {
@Autowired
private TestRepository testRepository;
@Test
public void myTest() {
List<String> names = springData().find(
//описание того ЧТО следует получить,
//в свободной форме или бизнес
//терминологии
"Test names",
all(testRepository)
//
//Необходимые параметры
//
//-------------------------------
//Если необходимо вернуть лист,
// составленный из данных найденных записей.
//Указывается, как извлекаются данные из
//каждой записи
.thenGetList(TestEntity::getName)
// далее можно указать опциональные
// уточняющие параметры
);
}
}
Уточняющие параметры шага, который возвращает лист. Шаг не предусматривает время на ожидание
//Можно указать один или несколько критериев,
//которым должен соответствовать
//каждый элемент результирующего листа.
// Так же доступны criteriaOr(criteria...),
// criteriaOnlyOne(criteria...)
// criteriaNot(criteria...)
.criteria("Описание критерия, которому должен соответствовать " +
"каждый элемент, который попадет в результирующий лист", item -> {
/*предикат, как работает критерий*/
})
//-------------------------------------------
//Можно указать, что должно быть выброшено исключение,
// если непустой лист не удалось получить (не было ни одного элемента,
//который бы соответствовал перечисленным критериям,
// или непустой лист просто не был получен)
.throwOnNoResult()
//ТАКЖЕ ЕСТЬ СЛЕДУЮЩИЕ ОПЦИИ:
//-------------------------------------------
//1. можно указать сколько объектов,
//которые соответствуют критериям,
//нужно вернуть
.returnListOfSize(3)
//-------------------------------------------
//2. можно указать, до элемента с каким индексом
//нужно собрать результирующие элементы,
//индекс - индекс объекта в наборе элементов,
//которые соответствуют критериям
.returnBeforeIndex(7)
//.returnAfterIndex(8) либо после какого элемента
//----------------------------------------------
//3. Либо можно перечислить индексы элементов,
// которые следует вернуть.
//Индексы - индексы объектов в наборе элементов,
//которые соответствуют критериям
.returnItemsOfIndexes(0, 3, 5)
//-------------------------------------------
//4. можно указать, при достижении какого количества
//ВСЕХ объектов, которые соответствуют критериям,
//должен быть возвращен результат
.returnIfEntireSize(isEqual(8))
//-------------------------------------------
//5. можно указать, при достижении каких условий,
//которым должен соответствовать лист ВСЕХ объектов,
//соответствующих критериям,
//можно возвращать результирующий лист/суб-лист
.returnOnCondition("Описание условия", list -> {
/*предикат, как работает критерий*/
})
//так же доступны returnOnConditionOr(criteria...),
// returnOnConditionOnlyOne(criteria...)
// returnOnConditionNot(criteria...)
//------------------------------------------
//Если не нашлось столько подходящих объектов, чтобы вернуть результат,
//или весь суб-лист подходящих по критериям элементов,
// который должен вернуться как результат,
// не соответствует каким-то критериям -
// будет выброшено исключение с подробным описанием
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import static ru.tinkoff.qa.neptune.spring.data.SpringDataContext.springData;
import static ru.tinkoff.qa.neptune.spring.data.select.common.CommonSelectStepFactory.byId;
@SpringBootTest
public class MyTest {
@Autowired
private TestRepository testRepository;
@Test
public void myTest() {
String name = springData().find(
"Test name",
all(testRepository)
//
//Необходимые параметры
//
//-------------------------------
//Если необходимо вернуть один объект
//из данных найденных записей, собранных в набор.
//Указывается, как извлекаются данные из
//каждой записи
.thenGetIterableItem(TestEntity::getName)
// далее можно указать опциональные
// уточняющие параметры
);
}
}
Уточняющие параметры шага, который возвращает элемент Iterable. Шаг не предусматривает время на ожидание
//Можно указать один или несколько критериев,
//которым должен соответствовать
//результирующий элемент из набора.
// Так же доступны criteriaOr(criteria...),
// criteriaOnlyOne(criteria...)
// criteriaNot(criteria...)
.criteria("Описание критерия, которому должен соответствовать " +
"результирующий элемент из набора", item -> {
/*предикат, как работает критерий*/
})
//------------------------------------------
//Можно указать, что должно быть выброшено исключение,
// если не был получен результирующий элемент (не было ни одного элемента,
//который бы соответствовал перечисленным критериям,
// или непустой набор просто не был получен)
.throwOnNoResult()
//ТАКЖЕ ЕСТЬ СЛЕДУЮЩИЕ ОПЦИИ:
//------------------------------------------
//1. Можно указать индекс элемента, который следует вернуть.
//Индекс - индекс объекта в наборе элементов,
//которые соответствуют критериям
.returnItemOfIndex(1)
//-----------------------------------------------
//2. можно указать, при достижении какого количества
//ВСЕХ объектов, которые соответствуют критериям,
//должен быть возвращен результат
.returnIfEntireSize(isEqual(8))
//------------------------------------------
//3. можно указать, при достижении каких условий,
//которым должен соответствовать набор ВСЕХ объектов,
//соответствующих критериям,
//можно возвращать результирующий элемент
.returnOnCondition("Описание условия", iterable -> {
/*предикат, как работает критерий*/
})
//так же доступны returnOnConditionOr(criteria...),
// returnOnConditionOnlyOne(criteria...)
// returnOnConditionNot(criteria...)
//------------------------------------------
//Если не нашлось столько подходящих объектов, чтобы вернуть результат,
//или весь набор подходящих по критериям элементов,
// из которого должен быть взят результат,
// не соответствует каким-то критериям -
// будет выброшено исключение с подробным описанием
Так же можно проверить наличие или отсутствие записей
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import static ru.tinkoff.qa.neptune.spring.data.SpringDataContext.springData;
import static ru.tinkoff.qa.neptune.spring.data.select.common.CommonSelectStepFactory.all;
@SpringBootTest
public class MyTest {
@Autowired
private TestRepository testRepository;
@Test
public void presenceTest() {
//Если запись была или появилась через некоторое время - вернется true.
// Иначе - false.
boolean isPresent = springData().presenceOf(
//описание того ЧТО должно
// присутствовать, в свободной форме
// или бизнес терминологии
"Test entities",
all(testRepository)
//можно указать один-несколько критериев,
//которым должны соответствовать записи,
//присутствующие на начало выполнения шага
//или появляющиеся, пока шаг выполняется
.criteria(
"Name == 'Some name'",
testEntity -> testEntity.getName().equals("Some name")
)
.criteria("ID > 10", testEntity -> testEntity.getId() > 10L)
// можно указать время,
// за которое подходящие записи должны появиться,
// если оно отличается от того,
// что указано в свойствах/переменных окружения
// SPRING_DATA_WAITING_FOR_SELECTION_RESULT_TIME_UNIT
// и SPRING_DATA_WAITING_FOR_SELECTION_RESULT_TIME_VALUE
.timeOut(ofSeconds(5))
//Прочие описанные выше
//настройки и параметры игнорируются здесь
);
//Если запись была или появилась в течение - вернется true. Иначе - выбросится исключение.
var isPresent2 = springData().presenceOfOrThrow(
"Test entities",
//опционально критерии и время
all(testRepository));
}
@Test
public void absenceTest() {
//Если записи не было или она перестала определяться
// через некоторое время - вернется true
// Иначе - false.
boolean isAbsent = springData().absenceOf(
//описание того ЧТО должно
// отсутствовать, в свободной форме
// или бизнес терминологии
"Test entities",
all(testRepository)
//можно указать один-несколько критериев,
//которым должны соответствовать записи,
//отсутствующие на начало выполнения шага
//или исчезающие, пока шаг выполняется
.criteria(
"Name == 'Some name'",
testEntity -> testEntity.getName().equals("Some name"))
.criteria("ID > 10", testEntity -> testEntity.getId() > 10L),
//Прочие описанные выше
//настройки и параметры игнорируются здесь
//----------------------------------------
//время, за которое записи должны исчезнуть
ofSeconds(10));
//Если записи не было или она перестала определяться
// через некоторое время - вернется true
// Иначе - выбросится исключение.
boolean isAbsent2 = springData().absenceOfOrThrow(
"Test entities",
all(testRepository),
//опционально,
//можно указать критерии
ofSeconds(10));
}
}