Pipeline layout

Identica moves a player through pipelines. Each pipeline is made of groups, and each group runs phases in order. Providers add steps and features add phases through a PipelineExtension. Every module lays out its pipeline packages the same way, so a class's package tells you where it runs.

Pipelines and their groupsCopy Anchor Link

Package layoutCopy Anchor Link

In the engine, under me.whereareiam.identica.engine.pipeline:

• prepare/group/<group>/phase/ and completion/group/<group>/... hold the phases of those pipelines.
• scenario/shared/group/<group>/ holds groups that every scenario runs.
• scenario/type/<scenario>/group/<group>/phase/ holds the groups and phases of one scenario.

In a provider, under <provider package>.pipeline:

• the provider's PipelineExtension sits directly in pipeline/
• step/type/<scenario>/ holds steps that belong to one scenario, for example step/type/authentication/
• step/shared/ holds steps that several scenarios use
• step/base/ holds the abstract classes those steps extend

In a feature, under <feature package>.pipeline:

• the feature's PipelineExtension sits directly in pipeline/
• phases mirror the engine path they join, for example prepare/group/policy/phase/ or scenario/type/authentication/group/identity/phase/
• phase/base/ holds the abstract classes those phases extend

Rules the build checksCopy Anchor Link

./gradlew validatePipelineStructure checks these rules over the main sources of the identica-* modules, and every module's check task runs it:

• There is no top-level pipeline/scenario/base/ package. Code that every scenario shares belongs in scenario/shared/.
• A base package under pipeline/ contains only abstract classes.
• In providers and features, a class that implements PipelineExtension or PipelinePhase, or implements Step, lives under pipeline/.

A violation fails the build with the offending file paths.