gerrit.o-ran-sc Code Review - smo/teiv.git/blob

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2024 Ericsson
   4  *  Modifications Copyright (C) 2024 OpenInfra Foundation Europe
   5  *  ================================================================================
   6  *  Licensed under the Apache License, Version 2.0 (the "License");
   7  *  you may not use this file except in compliance with the License.
   8  *  You may obtain a copy of the License at
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  *  Unless required by applicable law or agreed to in writing, software
  13  *  distributed under the License is distributed on an "AS IS" BASIS,
  14  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  *  See the License for the specific language governing permissions and
  16  *  limitations under the License.
  17  *
  18  *  SPDX-License-Identifier: Apache-2.0
  19  *  ============LICENSE_END=========================================================
  20  */
  21 package org.oran.smo.teiv.pgsqlgenerator.graphgenerator;
  22
  23 import guru.nidi.graphviz.attribute.Arrow;
  24 import guru.nidi.graphviz.attribute.Attributes;
  25 import guru.nidi.graphviz.attribute.Color;
  26 import guru.nidi.graphviz.attribute.EndLabel;
  27 import guru.nidi.graphviz.attribute.Font;
  28 import guru.nidi.graphviz.attribute.ForAll;
  29 import guru.nidi.graphviz.attribute.Shape;
  30 import guru.nidi.graphviz.attribute.Style;
  31 import guru.nidi.graphviz.model.Factory;
  32 import guru.nidi.graphviz.model.MutableGraph;
  33 import guru.nidi.graphviz.model.MutableNode;
  34 import lombok.extern.slf4j.Slf4j;
  35 import guru.nidi.graphviz.attribute.Label;
  36 import guru.nidi.graphviz.engine.Format;
  37 import guru.nidi.graphviz.engine.Graphviz;
  38 import org.oran.smo.teiv.pgsqlgenerator.Entity;
  39 import org.oran.smo.teiv.pgsqlgenerator.Relationship;
  40 import org.springframework.beans.factory.annotation.Autowired;
  41 import org.springframework.beans.factory.annotation.Value;
  42 import org.springframework.stereotype.Component;
  43
  44 import java.io.File;
  45 import java.io.IOException;
  46 import java.util.List;
  47
  48 @Component
  49 @Slf4j
  50 public class RelationshipGraphGenerator {
  51
  52     @Value("${graphs.generate}")
  53     private boolean generateRelationshipGraph;
  54
  55     @Value("${graphs.output}")
  56     private String graphOutput;
  57
  58     @Autowired
  59     private final HelperFunctions helperFunctions = new HelperFunctions();
  60
  61     public void generate(List<Relationship> relationships, List<Entity> entities) throws IOException {
  62         if (generateRelationshipGraph) {
  63             List<String> moduleNames = relationships.stream().map(Relationship::getModuleReferenceName).distinct().toList();
  64             for (String moduleName : moduleNames) {
  65                 List<Relationship> moduleRelationships = relationships.stream().filter(relationship -> moduleName.equals(
  66                         relationship.getModuleReferenceName())).toList();
  67                 List<Entity> moduleEntities = entities.stream().filter(entity -> moduleName.equals(entity
  68                         .getModuleReferenceName())).toList();
  69                 generateGraph(moduleName, moduleRelationships, moduleEntities);
  70             }
  71             generateGraph("overall", relationships, entities);
  72         } else {
  73             log.info("graphs.generate set to false");
  74         }
  75     }
  76
  77     private void generateGraph(String name, List<Relationship> relationships, List<Entity> entities) throws IOException {
  78         MutableGraph g = prepareGraph(relationships, entities);
  79         File outputFile = new File(graphOutput, name + "-rel");
  80         Graphviz.fromGraph(g).render(Format.SVG).toFile(outputFile);
  81         Graphviz.fromGraph(g).render(Format.DOT).toFile(outputFile);
  82         log.info("Graph rendered to: {}", outputFile.getAbsolutePath());
  83     }
  84
  85     private MutableGraph prepareGraph(List<Relationship> moduleRelationships, List<Entity> moduleEntities) {
  86         Attributes<ForAll> arialFont = Font.name("Arial");
  87         MutableGraph g = Factory.mutGraph("moduleName").setDirected(true).linkAttrs().add(Color.DARKSLATEGRAY4, arialFont)
  88                 .nodeAttrs().add(Shape.BOX, arialFont);
  89         for (Entity moduleEntity : moduleEntities) {
  90             Color fillColour = Color.rgba(helperFunctions.getNodeFillColour(moduleEntity.getModuleReferenceName())).fill();
  91             MutableNode node = Factory.mutNode(moduleEntity.getEntityName()).attrs().add(Style.FILLED, fillColour);
  92             g.add(node);
  93         }
  94         for (Relationship moduleRelationship : moduleRelationships) {
  95             MutableNode nodeA = Factory.mutNode(moduleRelationship.getASideMOType()).attrs().add(Style.FILLED, Color.rgba(
  96                     helperFunctions.getNodeFillColour(moduleRelationship.getASideModule())).fill());
  97             g.add(nodeA);
  98             MutableNode nodeB = Factory.mutNode(moduleRelationship.getBSideMOType()).attrs().add(Style.FILLED, Color.rgba(
  99                     helperFunctions.getNodeFillColour(moduleRelationship.getBSideModule())).fill());
 100             g.add(nodeB);
 101
 102             String label = moduleRelationship.getName().split("_")[1];
 103             Label aSideCardinality = Label.of(helperFunctions.getCardinality(moduleRelationship.getASideMinCardinality(),
 104                     moduleRelationship.getASideMaxCardinality()));
 105             Label bSideCardinality = Label.of(helperFunctions.getCardinality(moduleRelationship.getBSideMinCardinality(),
 106                     moduleRelationship.getBSideMaxCardinality()));
 107
 108             g.add(nodeA.addLink(Factory.to(nodeB).with(Label.of(label), EndLabel.head(aSideCardinality, null, null),
 109                     EndLabel.tail(bSideCardinality, null, null), Arrow.VEE)));
 110         }
 111         return g;
 112     }
 113 }