Структура конвейеров

Identica проводит игрока через конвейеры. Каждый конвейер состоит из групп, а каждая группа по порядку выполняет фазы. Провайдеры добавляют шаги, а функции — фазы через PipelineExtension. Все модули раскладывают пакеты конвейеров одинаково, поэтому по пакету класса видно, где он выполняется.

Конвейеры и их группыСкопировать ссылку на раздел

Структура пакетовСкопировать ссылку на раздел

В движке, в me.whereareiam.identica.engine.pipeline:

• prepare/group/<group>/phase/ и completion/group/<group>/... содержат фазы этих конвейеров.
• scenario/shared/group/<group>/ содержит группы, которые выполняет каждый сценарий.
• scenario/type/<scenario>/group/<group>/phase/ содержит группы и фазы одного сценария.

В провайдере, в <пакет провайдера>.pipeline:

• PipelineExtension провайдера лежит прямо в pipeline/
• step/type/<scenario>/ содержит шаги, которые относятся к одному сценарию, например step/type/authentication/
• step/shared/ содержит шаги, которые используют несколько сценариев
• step/base/ содержит абстрактные классы, от которых наследуются эти шаги

В функции, в <пакет функции>.pipeline:

• PipelineExtension функции лежит прямо в pipeline/
• фазы повторяют путь движка, к которому они подключаются, например prepare/group/policy/phase/ или scenario/type/authentication/group/identity/phase/
• phase/base/ содержит абстрактные классы, от которых наследуются эти фазы

Правила, которые проверяет сборкаСкопировать ссылку на раздел

./gradlew validatePipelineStructure проверяет эти правила в основных исходниках модулей identica-*, а задача check каждого модуля запускает эту проверку:

• Пакета pipeline/scenario/base/ верхнего уровня нет. Код, общий для всех сценариев, относится к scenario/shared/.
• Пакет base внутри pipeline/ содержит только абстрактные классы.
• В провайдерах и функциях класс, который реализует PipelineExtension или PipelinePhase либо реализует Step, лежит внутри pipeline/.

При нарушении сборка завершается ошибкой и перечисляет пути проблемных файлов.