Merge pull request #4 from vectorgrp/release-v1.8.x

OCS Domain Plugin Release v1.8.0

Author: BeckLaura

README.md

@@ -47,18 +47,18 @@ customization of the gradle properties.
 ### Customization of the Gradle properties
 Within the `ocs-domain-plugins` folder you can find the `gradle.properties` file:
 ```
-//localSipStore=path/to/sip/store/directory
-//localSip=path/to/used/sip/external
+#localSipStore=path/to/sip/store/directory
+#localSip=path/to/used/sip/external
 ocsRepo=../repository
 
-vOcsCore=1.6.0
-vPluginsCommon=1.4.0
-vOcsCom=1.7.0
-vOcsDiag=1.7.0
-vOcsNvM=1.7.0
-vOcsEcuState=1.7.0
-vOcsRuntime=1.7.0
-vOcsSecurity=1.5.0
+vOcsCore=1.7.0
+vPluginsCommon=1.5.0
+vOcsCom=1.8.0
+vOcsDiag=1.8.0
+vOcsNvM=1.8.0
+vOcsEcuState=1.8.0
+vOcsRuntime=1.8.0
+vOcsSecurity=1.6.0
 ```
 Based on the folder structure example above the explanation of the properties becomes easier. 
 Adapt the properties as following:
@@ -67,14 +67,14 @@ localSipStore=D:/dev/ocs/BswPackages
 localSip=MICROSAR_Classic_R31
 ocsRepo=../repository
 
-vOcsCore=1.6.0
-vPluginsCommon=my-company-1.4.0
-vOcsCom=my-company-1.7.0
-vOcsDiag=my-company-1.7.0
-vOcsNvM=my-company-1.7.0
-vOcsEcuState=my-company-1.7.0
-vOcsRuntime=my-company-1.7.0
-vOcsSecurity=my-company-1.5.0
+vOcsCore=1.7.0
+vPluginsCommon=my-company-1.5.0
+vOcsCom=my-company-1.8.0
+vOcsDiag=my-company-1.8.0
+vOcsNvM=my-company-1.8.0
+vOcsEcuState=my-company-1.8.0
+vOcsRuntime=my-company-1.8.0
+vOcsSecurity=my-company-1.6.0
 ```
 The `localSipStore` should point to the root directory of the BSW Packages while the `localSip` itself mentions a 
 dedicated BSW Package against which the source code will be compiled. The gradle project of the `ocs-custom-app` and
@@ -120,18 +120,18 @@ C:\Users\<your user account>\.m2\repository\com\vector\ocs\plugins\ocs-communica
 This step will look quite familiar to you. In the root folder of the `ocs-custom-app` you find the `gradle.properties`
 file: 
 ```
-//localSipStore=path/to/sip/store/directory
-//localSip=path/to/used/sip/
+#localSipStore=path/to/sip/store/directory
+#localSip=path/to/used/sip/
 ocsRepo=../repository
 
-vOcsCore=2.1.0
-vPluginsCommon=1.4.0
-vOcsCom=1.7.0
-vOcsDiag=1.7.0
-vOcsNvM=1.7.0
-vOcsEcuState=1.7.0
-vOcsRuntime=1.7.0
-vOcsSecurity=1.5.0
+vOcsCore=2.2.0
+vPluginsCommon=1.5.0
+vOcsCom=1.8.0
+vOcsDiag=1.8.0
+vOcsNvM=1.8.0
+vOcsEcuState=1.8.0
+vOcsRuntime=1.8.0
+vOcsSecurity=1.6.0
 ```
 The `localSipStore`, `localSip` and `ocsRepo` should be configured in the same way as for the `ocs-domain-plugins`.
 If you keep the other version numbers as stated in the file you would build the OCS Custom App based on the Vector
@@ -142,14 +142,14 @@ localSipStore=D:/dev/ocs/BswPackages
 localSip=MICROSAR_Classic_R31
 ocsRepo=../repository
 
-vOcsCore=1.6.0
-vPluginsCommon=my-company-1.4.0
-vOcsCom=my-company-1.7.0
-vOcsDiag=my-company-1.7.0
-vOcsNvM=my-company-1.7.0
-vOcsEcuState=my-company-1.7.0
-vOcsRuntime=my-company-1.7.0
-vOcsSecurity=my-company-1.5.0
+vOcsCore=1.7.0
+vPluginsCommon=my-company-1.5.0
+vOcsCom=my-company-1.8.0
+vOcsDiag=my-company-1.8.0
+vOcsNvM=my-company-1.8.0
+vOcsEcuState=my-company-1.8.0
+vOcsRuntime=my-company-1.8.0
+vOcsSecurity=my-company-1.6.0
 ```
 Please note that the gradle project of the OCS Custom App is prepared in a way that it handles the ocsRepo as well as
 the local maven repository.
@@ -179,6 +179,7 @@ Beside the mentioned dependencies the shared gradle project may point to additio
 |---------|--------------------------------|------------------------------------|
 | v1.6.0  | MICROSAR Automation SDK v1.5.0 | R31 - R34                          |
 | v1.7.0  | MICROSAR Automation SDK v1.6.0 | R31 - R34                          |
+| v1.8.0  | MICROSAR Automation SDK v1.7.0 | R31 - R34                          |
 
 ## Abbreviations
 | Abbreviation | Description                       |

gradle.properties

@@ -2,15 +2,15 @@ org.gradle.parallel=true
 org.gradle.caching=true
 org.gradle.daemon=true
 
-//localSipStore=path/to/sip/store/directory
-//localSip=path/to/used/sip/external
+#localSipStore=path/to/sip/store/directory
+#localSip=path/to/used/sip/external
 ocsRepo=../repository
 
-vOcsCore=1.6.0
-vPluginsCommon=1.4.0
-vOcsCom=1.7.0
-vOcsDiag=1.7.0
-vOcsNvM=1.7.0
-vOcsEcuState=1.7.0
-vOcsRuntime=1.7.0
-vOcsSecurity=1.5.0
+vOcsCore=1.7.0
+vPluginsCommon=1.5.0
+vOcsCom=1.8.0
+vOcsDiag=1.8.0
+vOcsNvM=1.8.0
+vOcsEcuState=1.8.0
+vOcsRuntime=1.8.0
+vOcsSecurity=1.6.0

plugins/ocs-diagnostics-plugin/src/main/kotlin/com/vector/ocs/plugins/diagnostics/application/service/ConfigureDiagnosticsService.kt

@@ -42,7 +42,6 @@ import com.vector.ocs.plugins.diagnostics.EDefaultDcmBuffer
 import com.vector.ocs.plugins.diagnostics.EDefaultDebouncingStrategy
 import com.vector.ocs.plugins.diagnostics.application.port.`in`.ConfigureDiagnosticsUseCase
 import com.vector.ocs.plugins.diagnostics.application.port.out.cfgAPI.ConfigServiceAPI
-import com.vector.ocs.plugins.diagnostics.constants.DcmDefRefs
 import com.vector.ocs.plugins.diagnostics.constants.DiagnosticConstants
 import com.vector.ocs.plugins.diagnostics.constants.NvMDefRefs
 import com.vector.ocs.plugins.diagnostics.domain.ComM.ComM
@@ -97,8 +96,15 @@ class ConfigureDiagnosticsService(
 
             // Set reference to DcmDsdServiceTable
             if (model.defaultDcmServiceTableAssignment == true) {
-                currentProtocolRow.dcmDsdServiceTableRef = dcm.dcmDsdServiceTableList[index]
-                logger.infoMessage("Setting default Service Table " + dcm.dcmDsdServiceTableList[index].shortName + " set as reference for protocol row " + currentProtocolRow.shortName + ".")
+                val serviceTableRef = if (index < dcm.dcmDsdServiceTableList.size) {
+                    dcm.dcmDsdServiceTableList[index]
+                } else {
+                    // Fallback to the first service table if index exceeds the list size
+                    dcm.dcmDsdServiceTableList.first()
+                }
+
+                currentProtocolRow.dcmDsdServiceTableRef = serviceTableRef
+                logger.infoMessage("Setting Service Table " + serviceTableRef.shortName + " as reference for protocol row " + currentProtocolRow.shortName + ".")
             }
 
             // Add DcmDslBuffer

plugins/ocs-ecustatemanagement-plugin/src/main/groovy/com/vector/ocs/plugins/ecustatemanagement/EcuStateManagementScript.groovy

@@ -357,20 +357,28 @@ class EcuStateManagementScript {
                     modeManagement { modeMngt ->
                         if (bswMConfigs.size() > 0) {
                             try {
-                                getBswMAutoConfigDomains(bswMConfigs.first).each { autoConfigurationDomain ->
+                                MIContainer bswMConfigContainer
+                                if (!distinctNewModeManagementApiUsage()) {
+                                    // Former API usage
+                                    bswMConfigContainer = bswMConfigs.first
+                                } else {
+                                    // New API usage
+                                    bswMConfigContainer = null
+                                }
+                                getBswMAutoConfigDomains(bswMConfigContainer).each { autoConfigurationDomain ->
                                     if (null != autoConfigurationDomain.identifier && "Module Initialization" != autoConfigurationDomain.identifier) {
                                         switch (autoConfigurationDomain.identifier) {
                                             case "Communication Control":
                                                 logger.info("Processing Communication Control domain.")
-                                                CommunicationControl.initializeAndProcessDomain(model, modeMngt, autoConfigurationDomain.identifier, bswMConfigs.first, logger)
+                                                CommunicationControl.initializeAndProcessDomain(model, modeMngt, autoConfigurationDomain.identifier, bswMConfigContainer, logger)
                                                 break
                                             case "Ecu State Handling":
                                                 logger.info("Processing Ecu State Handling domain.")
-                                                EcuStateHandling.initializeAndProcessDomain(model, modeMngt, autoConfigurationDomain.identifier, bswMConfigs.first, logger)
+                                                EcuStateHandling.initializeAndProcessDomain(model, modeMngt, autoConfigurationDomain.identifier, bswMConfigContainer, logger)
                                                 break
                                             case "Service Discovery Control":
                                                 logger.info("Processing Service Discovery Control domain.")
-                                                ServiceDiscoveryControl.initializeAndProcessDomain(model, modeMngt, autoConfigurationDomain.identifier, bswMConfigs.first, logger)
+                                                ServiceDiscoveryControl.initializeAndProcessDomain(model, modeMngt, autoConfigurationDomain.identifier, bswMConfigContainer, logger)
                                                 break
                                             default:
                                                 logger.info("Unknown AutoConfigurationDomain identifier detected '$autoConfigurationDomain.identifier'")
@@ -427,4 +435,21 @@ class EcuStateManagementScript {
         }
         initItem.ecuMModuleServiceOrCreate.value = initFunction.shortname
     }
+
+    /**
+     * Certain DaVinci Configurator Service Pack versions require distinct ways to call the Mode Management comfort APIs.
+     * This method checks the corresponding minor version and service pack version.
+     * @return true if new API handling is required, otherwise false.
+     */
+    static boolean distinctNewModeManagementApiUsage() {
+        Number minorVersion = PluginsCommon.Cfg5MinorVersion()
+        Number cfg5ServicePackVersion = PluginsCommon.Cfg5ServicePackVersion()
+        boolean useNewApi = false
+        if ((minorVersion == 29 && cfg5ServicePackVersion >= 5) || /* R32 */
+            (minorVersion == 30 && cfg5ServicePackVersion >= 4) || /* R33 */
+            (minorVersion == 31 && cfg5ServicePackVersion >= 2)) { /* R34 */
+            useNewApi = true
+        }
+        return useNewApi
+    }
 }

plugins/ocs-plugins-shared-lib/src/main/groovy/com/vector/ocs/lib/shared/PluginsCommon.groovy

@@ -165,4 +165,20 @@ class PluginsCommon {
         int cfgMinorVersion = daVinciVersion.substring(2, 4).toInteger()
         return cfgMinorVersion
     }
+
+    /**
+     * Determines the service pack version of the DaVinci Configurator Classic (CFG5)
+     * @return cfgServicePackVersion is the service pack version of the DaVinci Configurator Classic (CFG5), or 0 for major version
+     */
+    static Number Cfg5ServicePackVersion() {
+        int cfgServicePackVersion = 0
+        String versionString = ScriptApi.scriptCode.getInstance(IProductVersionApiEntryPoint.class).versions.daVinciConfiguratorVersion
+        String daVinciVersion = versionString.replace("DaVinciConfigurator\t", "")
+        String[] cfgServicePackVersionSplit = daVinciVersion.split(" ")
+        // Example: 5.29.50 SP5 > [5.29.50, SP5]
+        if (cfgServicePackVersionSplit.size() > 1) {
+            cfgServicePackVersion = cfgServicePackVersionSplit[1].replace("SP", "").toInteger()
+        }
+        return cfgServicePackVersion
+    }
 }

plugins/ocs-runtimesystem-plugin/src/main/groovy/com/vector/ocs/plugins/runtimesystem/RuntimeSystemConnectAndMap.groovy

@@ -244,20 +244,21 @@ class RuntimeSystemConnectAndMap {
             handleInterruptMapping(model.interruptMapping.userDefinedMapping, model.interruptMapping.defaultIsrApplication, logger)
 
             // 4. Map runnables to tasks
+            logger.debug("Check that Rte module is available.")
+            Boolean isRtePresent = PluginsCommon.ConfigPresent(RuntimeSystemConstants.RTE_DEFREF)
+            if (isRtePresent) {
+                triggerRteSolvingActionForCreationOfMissingBswEventContainer(logger)
+            }
             handleTaskMapping(model.taskMapping.userDefinedMapping, model.taskMapping.defaultBswTask, model.cores, logger)
 
             // 5. Trigger RTE solving action to fix the runnable order
-            logger.debug("Check that Rte module is available.")
-            Boolean isRtePresent = PluginsCommon.ConfigPresent(RuntimeSystemConstants.RTE_DEFREF)
             if (isRtePresent) {
                 triggerRteSolvingActionForRunnableOrder(logger)
-            }
 
             // 6. Trigger calculation phase of the Rte to create additional Os configuration
             // Currently it is not clear if this operation could be also done in another context, e.g. individual file
             // which address the Rte configuration parts. Therefore for not it is kept here but the Rte.DefRef is not
             // directly used. instead the DefRef is created itself in the triggerRteCalculation()
-            if (isRtePresent) {
                 triggerRteCalculation(logger)
             }
 
@@ -918,6 +919,37 @@ class RuntimeSystemConnectAndMap {
         }
     }
 
+    /**
+     * Trigger the following solving action of the RTE BSW module.<br>
+     * <ul>
+     *     <li>RTE1009</li>
+     * </ul>
+     * @param logger
+     */
+    private static void triggerRteSolvingActionForCreationOfMissingBswEventContainer(OcsLogger logger) {
+        activeProject() { IProject project ->
+            PluginsCommon.modelSynchronization(project, logger)
+            // Justify missing return statement because it could be the case that no solving action appears
+            //noinspection GroovyMissingReturnStatement
+            validation {
+                final String RTE = "RTE"
+                Collection<IValidationResultUI> rte1009Results = validationResults.findAll { IValidationResultUI iValidationResults ->
+                    iValidationResults.isId(RTE, 1009) && iValidationResults.isActive()
+                }
+                if (!rte1009Results.isEmpty()) {
+                    solver.solve {
+                        result {
+                            isId(RTE, 1009)
+                        }.withAction {
+                            logger.info("Trigger RTE1009 solving action.")
+                            solvingActions.first
+                        }
+                    }
+                }
+            }
+        }
+    }
+
     /**
      * Trigger the following solving action of the COM BSW module.<br>
      * <ul>