component class validator

Author: xiangu-batw

bazel/rules/rules_score/examples/seooc/unit_2/docs/unit_2_class_diagram.puml

@@ -15,13 +15,20 @@
 
 namespace unit_1 {
     class Foo {
+        {final}
+        --
         + GetNumber() : uint8_t
         + SetNumber(value : uint8_t) : void
     }
 }
 
 namespace unit_2 {
     class Bar {
+        {final}
+        --
+        - foo_ : unique_ptr<unit_1::Foo>
+        --
+        + Bar(foo : unique_ptr<unit_1::Foo>)
         + AssertNumber() : bool
     }
 }

bazel/rules/rules_score/private/dependable_element.bzl

@@ -629,13 +629,14 @@ def _collect_architecture_components(ctx):
 
     return all_components
 
-def _run_validation(ctx, arch_json, static_fbs_files):
+def _run_validation(ctx, arch_json, static_fbs_files, unit_static_fbs_files):
     """Run the architecture verifier tool against a pre-built JSON file.
 
     Args:
         ctx: Rule context
         arch_json: The architecture JSON File object (already declared and written)
-        static_fbs_files: List of static FlatBuffer files to verify against
+        static_fbs_files: List of static component-diagram FlatBuffer files
+        unit_static_fbs_files: List of static class-diagram FlatBuffer files
 
     Returns:
         validation_log File object
@@ -646,14 +647,15 @@ def _run_validation(ctx, arch_json, static_fbs_files):
     validation_args = ctx.actions.args()
     validation_args.add("--architecture-json", arch_json)
     validation_args.add_all("--component-fbs", static_fbs_files)
+    validation_args.add_all("--class-fbs", unit_static_fbs_files)
     validation_args.add("--output", validation_log)
     validation_args.add("--log-level", get_log_level(ctx))
     if ctx.attr.maturity == "development":
         validation_args.add("--warn-on-errors")
 
     # ctx.actions.run will fail the build if validation_cli returns non-zero exit code
     ctx.actions.run(
-        inputs = [arch_json] + static_fbs_files,
+        inputs = [arch_json] + static_fbs_files + unit_static_fbs_files,
         outputs = [validation_log],
         executable = ctx.executable._validation_cli,
         arguments = [validation_args],
@@ -819,8 +821,14 @@ def _dependable_element_index_impl(ctx):
         if ArchitecturalDesignInfo in ad:
             static_fbs_files.extend(ad[ArchitecturalDesignInfo].static.to_list())
 
+    # Collect class-diagram FBS files produced by unit_design targets.
+    unit_static_fbs_files = []
+    for unit_target in all_units.values():
+        unit_info = unit_target[UnitInfo]
+        unit_static_fbs_files.extend(unit_info.unit_design_static_fbs.to_list())
+
     # Run validation; build fails automatically on non-zero exit
-    validation_log = _run_validation(ctx, arch_json, static_fbs_files)
+    validation_log = _run_validation(ctx, arch_json, static_fbs_files, unit_static_fbs_files)
 
     # Both outputs are included so validation always runs in a default build.
     # validation_log is also exposed in the debug output group for explicit access.

validation/core/BUILD

@@ -36,6 +36,7 @@ rust_library(
     deps = [
         "//plantuml/parser/puml_serializer/src/fbs:class_fbs",
         "//plantuml/parser/puml_serializer/src/fbs:component_fbs",
+        "//tools/metamodel:class_diagram",
         "@crates//:flatbuffers",
         "@crates//:serde",
         "@crates//:serde_json",

validation/core/src/lib.rs

@@ -16,20 +16,18 @@
 //! This crate contains the shared models, readers, and validators used by the
 //! CLI entrypoints for architecture and design verification.
 
-pub mod models;
-pub mod readers;
-pub mod validators;
+mod models;
+mod readers;
+mod validators;
 
 pub use models::{
-    BazelArchitecture, BazelInput, BazelInputEntry, ClassDiagramEntityInput, ClassDiagramIndex,
-    ClassDiagramInput, ClassDiagramInputs, ClassDiagramRelationshipInput,
-    ComponentDiagramArchitecture, ComponentDiagramInput, ComponentDiagramInputs, EntityKey, Errors,
+    BazelArchitecture, BazelInput, ClassDiagramIndex, ClassDiagramInputs,
+    ComponentDiagramArchitecture, ComponentDiagramInputs, Errors,
 };
 
 pub use readers::{BazelReader, ClassDiagramReader, ComponentDiagramReader, Reader};
 
 pub use validators::{
-    validate_bazel_component, validate_component_class, validate_component_sequence,
-    BazelComponentValidator, ComponentClassValidator, RequiredInput, SelectedValidator,
-    ValidatorSpec, ALL_VALIDATORS,
+    validate_bazel_component, validate_component_class, validate_component_sequence, RequiredInput,
+    SelectedValidator, ValidatorSpec, ALL_VALIDATORS,
 };

validation/core/src/main.rs

@@ -200,7 +200,7 @@ fn build_validation_context(inputs: ValidationCliInputs) -> Result<ValidationCon
     let class = read_and_convert::<ClassDiagramReader, ClassDiagramIndex>(
         inputs.class_fbs.as_slice(),
         &mut errors,
-        |raw: ClassDiagramInputs, errs| raw.to_class_diagram_index(errs),
+        |raw: ClassDiagramInputs, errs| ClassDiagramIndex::build_index(&raw, errs),
     )?;
 
     Ok(ValidationContext {

validation/core/src/models/class_diagram_models.rs

@@ -15,72 +15,34 @@
 
 use std::collections::BTreeSet;
 
-use super::Errors;
-
-/// A single class-diagram entity such as a class, struct, enum, or interface.
-#[derive(Debug, Clone, PartialEq)]
-pub struct ClassDiagramEntityInput {
-    pub id: String,
-    pub name: Option<String>,
-    pub alias: Option<String>,
-    pub parent_id: Option<String>,
-    pub entity_type: String,
-    pub stereotypes: Vec<String>,
-    pub template_params: Vec<String>,
-    pub source_file: Option<String>,
-    pub source_line: u32,
-}
+use class_diagram::ClassDiagram as ClassDiagramInput;
 
-/// A relationship edge between two class-diagram entities.
-#[derive(Debug, Clone, PartialEq)]
-pub struct ClassDiagramRelationshipInput {
-    pub source: String,
-    pub target: String,
-    pub relation_type: String,
-    pub label: Option<String>,
-    pub stereotype: Option<String>,
-    pub source_multiplicity: Option<String>,
-    pub target_multiplicity: Option<String>,
-    pub source_role: Option<String>,
-    pub target_role: Option<String>,
-}
-
-/// One parsed class diagram, including entities, containers, and
-/// relationships.
-#[derive(Debug, Clone, PartialEq)]
-pub struct ClassDiagramInput {
-    pub name: String,
-    pub entities: Vec<ClassDiagramEntityInput>,
-    pub relationships: Vec<ClassDiagramRelationshipInput>,
-    pub source_files: Vec<String>,
-    pub version: Option<String>,
-}
+use super::Errors;
 
 /// Collection of class diagrams loaded from one or more FlatBuffer files.
-#[derive(Debug, Clone, PartialEq)]
-pub struct ClassDiagramInputs {
-    pub diagrams: Vec<ClassDiagramInput>,
+pub type ClassDiagramInputs = Vec<ClassDiagramInput>;
+
+/// Indexed class-diagram data prepared for validators.
+pub struct ClassDiagramIndex {
+    observed_enclosing_namespace_ids: BTreeSet<String>,
 }
 
-impl ClassDiagramInputs {
+impl ClassDiagramIndex {
     /// Build a [`ClassDiagramIndex`] from class diagram inputs.
-    pub fn to_class_diagram_index(&self, _errors: &mut Errors) -> ClassDiagramIndex {
-        let observed_namespace_names = self
-            .diagrams
+    pub fn build_index(diagrams: &[ClassDiagramInput], _errors: &mut Errors) -> Self {
+        let observed_enclosing_namespace_ids = diagrams
             .iter()
             .flat_map(|diagram| diagram.entities.iter())
-            .filter_map(|entity| entity.parent_id.clone())
-            .filter(|parent_id| !parent_id.is_empty())
+            .filter_map(|entity| entity.enclosing_namespace_id.clone())
+            .filter(|namespace_id| !namespace_id.is_empty())
             .collect();
 
-        ClassDiagramIndex {
-            observed_namespace_names,
+        Self {
+            observed_enclosing_namespace_ids,
         }
     }
-}
 
-/// Indexed names derived from class-diagram entities.
-#[derive(Clone)]
-pub struct ClassDiagramIndex {
-    pub observed_namespace_names: BTreeSet<String>,
+    pub fn enclosing_namespace_ids(&self) -> &BTreeSet<String> {
+        &self.observed_enclosing_namespace_ids
+    }
 }

validation/core/src/models/mod.rs

@@ -20,13 +20,13 @@ mod component_diagram_models;
 mod error_models;
 mod shared;
 
-pub use bazel_models::{BazelArchitecture, BazelInput, BazelInputEntry};
-pub use class_diagram_models::{
-    ClassDiagramEntityInput, ClassDiagramIndex, ClassDiagramInput, ClassDiagramInputs,
-    ClassDiagramRelationshipInput,
-};
+use shared::EntityKey;
+
+#[cfg(test)]
+pub use bazel_models::BazelInputEntry;
+pub use bazel_models::{BazelArchitecture, BazelInput};
+pub use class_diagram_models::{ClassDiagramIndex, ClassDiagramInputs};
 pub use component_diagram_models::{
     ComponentDiagramArchitecture, ComponentDiagramInput, ComponentDiagramInputs,
 };
 pub use error_models::Errors;
-pub use shared::EntityKey;