6.2.5.11. Architecture-GravisArchitectureProject

Architecture check using a Gravis architecture project

Required inputs: RFG

This rule is preferred over the traditional Architecture-GravisArchitecture rule. It performs an architecture analysis based on a Gravis Architecture Project. An Architecture Project keeps all files and settings in one place and ensures that the CI performs exactly the same analysis as Gravis. Steps for using it:

  • set up an architecture project in Gravis,
  • reference the project file from this rule.

Architecture projects can contain several architecture checks. You can select which check(s) to run or whether to run all checks.

Possible Messages

This rule has no predefined messages.

Options

append_check_name

append_check_name : bool = True

Whether the name of the check that found a violation is appended to its error number to disambiguate the findings in the Dashboard.
 

architecture_project_file

architecture_project_file : bauhaus.analysis.config.LayerRelativePath = 'None (value must be set)'

Path of the Gravis architecture project (.gaproj) file.
 

checks

checks : set[str] | None = None

The checks to be executed or None to execute all checks.
 

csv_output_file

csv_output_file : bauhaus.analysis.config.LayerRelativePath | None = None

Optional CSV file in which architecture check results are additionally written.
 

export_warnings

export_warnings : bool = True

Export output messages to the analysis database.
 

generate_violation_previews

generate_violation_previews : bool = True

Whether to generate images of the architecture violations to be shown in the dashboard. This is an expensive operation and can be skipped to shorten the runtime of this rule. This option requires a minimal or full browsable mapping, therefore it automatically overwrites the option 'browsable_mapping' to 'Minimal' if no browsable mapping has been chosen.
 

loglevel

loglevel : LogLevel = 'WARNING'

Logging mode. WARNING only outputs errors and warnings, INFO additionally prints info messages, DEBUG additionally outputs info and debug messages.
 

preprocessing_step

preprocessing_step : typing.Callable[[_dg.Graph], typing.Optional[_dg.Graph]] | None = None

User-defined function that gets the RFG graph after importing the GXL files as argument; allowing preparation steps before checking the architecture. The returned RFG is used for the architecture check, if None is returned, the analysis aborts.
 

preview_generation_limit

preview_generation_limit : int = 10000

Limit for generating architecture violation previews. If the number of causing edges exceeds this limit, then no images are generated at all. This protects the analysis run from spending a disproportionate amount of processing time on generating previews in case of an incomplete or accidentally broken architecture.
 

result_types_to_report

result_types_to_report

Type: set[ArchitectureAnalysisResultType]

Default: {'Absence', 'Divergence'}

Result types that should be reported; currently possible values are "Absence", "Divergence", and "Convergence".
 

Option Types

These types are used by options listed above:

ArchitectureAnalysisResultType

Types of possible architecture result edges.
 
  • Absence

  • Convergence

  • Divergence

LogLevel

  • WARNING

  • INFO

  • DEBUG