Added Polarion documentation (integration chapter) support (#1)

Author: Alexander.Golyshkin

DbcCheckMain.py

@@ -1,10 +1,10 @@
 import threading
 
-from ui.DbcCheckUiApplication import *
 from checkers.DbcMsgDuplicatesChecker import *
+from checkers.DbcMsgCheckWithPolarionIntegration import DbcMsgCheckWithPolarionIntegration
 from checkers.DbcNodesChecker import *
 from checkers.DbcSigDuplicatesChecker import DbcSigDuplicatesChecker
-from common.DbcCheckUtils import LOGGER
+from ui.DbcCheckUiApplication import *
 
 def onStartCheckCallback( aSelectedPath: str ):
     thread = threading.Thread( target=startDBCCheckThread, args=[ aSelectedPath ] )
@@ -25,6 +25,9 @@ def startDBCCheckThread( aSelectedPath: str ):
     if DbcCheckConfig.CONF_CHECK_SIG_SPN_DUPLICATION:
         dbcCheckEngine.addChecker( DbcSigDuplicatesChecker() )
 
+    if DbcCheckConfig.CONF_USE_POLARION_INTEGRATIONS_FOR_CHECK_SIGNALS:
+        dbcCheckEngine.addChecker( DbcMsgCheckWithPolarionIntegration() )
+
     dbcCheckEngine.startCheck()
 
 def outputCallback( textOutput ):

checkers/DbcMsgCheckWithPolarionIntegration.py

@@ -0,0 +1,52 @@
+import xml.etree.ElementTree as ET
+from os import path
+
+from common import DbcCheckConfig
+from common.DbcCheckUtils import LOGGER
+from interfaces.DbcCheckerInterface import *
+
+class DbcMsgCheckWithPolarionIntegration( DbcCheckerInterface ):
+    CONFIG: dict = { }
+
+    def __init__( self ):
+        DbcMsgCheckWithPolarionIntegration.initConfig()
+
+    @staticmethod
+    def initConfig() -> None:
+        """
+        Process configuration.xml file
+
+        :return dictionary
+        """
+        if path.exists( DbcCheckConfig.APP_CONFIG_XML_PATH ):
+            rootNode = ET.parse( DbcCheckConfig.APP_CONFIG_XML_PATH ).getroot()
+
+            DbcMsgCheckWithPolarionIntegration.CONFIG[ "polarionUrl" ] = rootNode.findtext( "polarionUrl" )
+            DbcMsgCheckWithPolarionIntegration.CONFIG[ "polarionLogin" ] = rootNode.findtext( "polarionLogin" )
+            DbcMsgCheckWithPolarionIntegration.CONFIG[ "polarionPwd" ] = rootNode.findtext( "polarionPwd" )
+
+            documentLocations = [ ]
+            for documentLocation in rootNode.findall( 'documentLocations/documentLocation' ):
+                documentLocations.append( documentLocation.text )
+
+            DbcMsgCheckWithPolarionIntegration.CONFIG[ "documentLocations" ] = documentLocations
+        else:
+            LOGGER.error( f"{DbcCheckConfig.APP_CONFIG_XML_PATH} is not exists" )
+
+    def processDbcFile( self, aDataBase: candb.Database, aDbcPath: str ) -> None:
+        pass
+
+    def processMessage( self, aMessage: Message ) -> None:
+        pass
+
+    def processSignal( self, aSignal: Signal ) -> None:
+        pass
+
+    def printReport( self ) -> None:
+        pass
+
+    def onFinish( self ) -> None:
+        pass
+
+    def onStart( self ) -> None:
+        LOGGER.info( "DBC Polarion Integrations Checker Registered." )

common/DbcCheckConfig.py

@@ -1,9 +1,9 @@
 # Configuration file for Vector DBCChecker
-import logging
 
 APP_VER: float = 1.2
 APP_TITLE: str = "Vector DBCChecker Application"
 APP_ABOUT_INFO: str = "This is application checks a vector based DBC files on consistency and messages duplicates.\n\n(c) Alexander.Golyshkin 2023"
+APP_CONFIG_XML_PATH: str = "configuration.xml"
 APP_WIN_SIZE_APP_WIDTH: int = 800
 APP_WIN_SIZE_APP_HEIGHT: int = 600
 APP_WIN_SIZE_SETTINGS_WIDTH: int = 380
@@ -15,9 +15,9 @@
 CONF_CHECK_OVERLAP_SIGNALS: bool = True
 CONF_CHECK_MISSED_NETWORK_NODES: bool = True
 CONF_CHECK_DB_VERSION: bool = True
+CONF_USE_POLARION_INTEGRATIONS_FOR_CHECK_SIGNALS: bool = False
 CONF_LOG_FILE_NAME: str = "dbc-check.log"
 CONF_PAD_DX: int = 5
 CONF_PAD_DY: int = 5
 # By default, is expected an Intel byte order in signals
 SIGNAL_BYTE_ORDER: str = "little_endian"
-

common/DbcCheckUtils.py

@@ -1,3 +1,4 @@
+import logging
 from tkinter import Wm, Misc
 
 from common.DbcCheckConfig import *
@@ -13,4 +14,7 @@ def centerWindow( aRoot: (Misc, Wm), width=300, height=200 ):
     # calculate position x and y coordinates
     x = (screen_width / 2) - (width / 2)
     y = (screen_height / 2) - (height / 2)
-    aRoot.geometry( '%dx%d+%d+%d' % (width, height, x, y) )
+    # Change size & position
+    # aRoot.geometry( '%dx%d+%d+%d' % (width, height, x, y) )
+    # Just change a position
+    aRoot.geometry( '+%d+%d' % (x, y) )

configuration.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration ver="1.0">
+    <polarionUrl>http://polarion.arrival.dc/polarion</polarionUrl>
+    <polarionLogin>[email protected]</polarionLogin>
+    <polarionPwd>****</polarionPwd>
+    <documentLocations>
+        <!--
+        <documentLocation>features_DomainHMI_SAFENOTIFY_Architecture_Specification/SAFENOTIFY_Architecture_Specification</documentLocation>
+        -->
+        <documentLocation>features_DomainHMI_NAV_Architecture_Specification/NAV_Architecture_Specification</documentLocation>
+    </documentLocations>
+</configuration>

requirements.txt

@@ -1,2 +1,2 @@
 cantools
-polarion~=1.0.0
+polarion~=1.1.0

ui/DbcCheckUiSettings.py

@@ -20,6 +20,7 @@ def __init__( self, aRoot: Tk ):
         self.isCheckSigSpnDuplicationValue = BooleanVar( value=DbcCheckConfig.CONF_CHECK_SIG_SPN_DUPLICATION )
         self.isCheckDbVersionValue = BooleanVar( value=DbcCheckConfig.CONF_CHECK_DB_VERSION )
         self.signalByteOrder = StringVar( value=DbcCheckConfig.SIGNAL_BYTE_ORDER )
+        self.usePolarionFasIntegrationsForCheckSignalsValue = BooleanVar( value=DbcCheckConfig.CONF_USE_POLARION_INTEGRATIONS_FOR_CHECK_SIGNALS )
 
     def configureUi( self ) -> None:
         self.checkMsgDuplicationCheckBox = Checkbutton( master=self.frame, text="Check Messages Duplication", variable=self.isCheckMsgDuplicationValue, command=self.onSettingsChange )
@@ -40,6 +41,9 @@ def configureUi( self ) -> None:
         self.ignoreMsgDupWithSameSignalsCheckBox = Checkbutton( master=self.frame, text="Ignore Messages Duplication for the Same Signals", variable=self.isIgnoreMsgDupWithSameSignalsValue, command=self.onSettingsChange )
         self.ignoreMsgDupWithSameSignalsCheckBox.grid( row=5, column=0, padx=DbcCheckConfig.CONF_PAD_DX, sticky="W" )
 
+        self.usePolarionFasIntegrationsForCheckSignalsCheckBox = Checkbutton( master=self.frame, text="Use Polarion Integration Info for check signals", variable=self.usePolarionFasIntegrationsForCheckSignalsValue, command=self.onSettingsChange )
+        self.usePolarionFasIntegrationsForCheckSignalsCheckBox.grid( row=6, column=0, padx=DbcCheckConfig.CONF_PAD_DX, sticky="W" )
+
         radioFrame = Frame( self.frame )
         radioFrame.grid( sticky="NEWS" )
 
@@ -68,6 +72,7 @@ def onSettingsChange( self ) -> None:
         DbcCheckConfig.CONF_CHECK_SIG_SPN_DUPLICATION = self.isCheckSigSpnDuplicationValue.get()
         DbcCheckConfig.isCheckDbVersionValue = self.isCheckDbVersionValue.get()
         DbcCheckConfig.SIGNAL_BYTE_ORDER = self.signalByteOrder.get()
+        DbcCheckConfig.CONF_USE_POLARION_INTEGRATIONS_FOR_CHECK_SIGNALS = self.usePolarionFasIntegrationsForCheckSignalsValue.get()
 
     def onApplySettings( self ) -> None:
         # Do nothing all things are applied automatically now