Run install before zipping FMU (#10729)

* Run install before zipping FMU - Renamed FMU custom target `create_zip` to `create_fmu` - Ensure that target install is executed before generating zip - Test `create_fmu` target
OpenModelica · May 24, 2023 · ef47e87 · ef47e87
1 parent 157f31f
commit ef47e87
Show file tree

Hide file tree

Showing 6 changed files with 35 additions and 12 deletions.
diff --git a/OMCompiler/Compiler/SimCode/SimCode.mo b/OMCompiler/Compiler/SimCode/SimCode.mo
@@ -141,8 +141,9 @@ uniontype SimCode
     SpatialDistributionInfo spatialInfo;
     list<JacobianMatrix> jacobianMatrices;
     Option<SimulationSettings> simulationSettingsOpt;
-    String fileNamePrefix, fullPathPrefix "Used in FMI where files are generated in a special directory";
-    String fmuTargetName;
+    String fileNamePrefix "Prefix for all enerated C files. Usually the model name with dots replaced by underscores.";
+    String fullPathPrefix "Used in FMI where files are generated in a special directory";
+    String fmuTargetName "Name of FMU file <fmuTargetName>.fmu";
     HpcOmSimCode.HpcOmData hpcomData;
     AvlTreeCRToInt.Tree valueReferences "Used in FMI";
     //maps each variable to an array of storage indices (with this information, arrays must not be unrolled) and a list for the array-dimensions

diff --git a/OMCompiler/Compiler/SimCode/SimCodeMain.mo b/OMCompiler/Compiler/SimCode/SimCodeMain.mo
@@ -926,7 +926,8 @@ algorithm
         System.copyFile(source = install_share_buildproject_dir + "CMakeLists.txt.in",
                         destination = fmu_tmp_sources_dir + "CMakeLists.txt");
         cmakelistsStr := System.readFile(fmu_tmp_sources_dir + "CMakeLists.txt");
-        cmakelistsStr := System.stringReplace(cmakelistsStr, "@FMU_NAME_IN@", simCode.fileNamePrefix);
+        cmakelistsStr := System.stringReplace(cmakelistsStr, "@FMU_NAME_IN@", simCode.fileNamePrefix);     // Name with underscored instead of dots
+        cmakelistsStr := System.stringReplace(cmakelistsStr, "@FMU_TARGET_NAME@", simCode.fmuTargetName);  // Name with dots
 
         // Set CMake runtime dependencies level
         _ := match (Flags.getConfigString(Flags.FMU_RUNTIME_DEPENDS))

diff --git a/OMCompiler/SimulationRuntime/fmi/export/buildproject/CMakeLists.txt.in b/OMCompiler/SimulationRuntime/fmi/export/buildproject/CMakeLists.txt.in
@@ -181,10 +181,11 @@ else()
 endif()
 
 # Zip target creating modelname.fmu
-add_custom_target(create_zip COMMAND
-    ${CMAKE_COMMAND} -E tar "cfv" "../${CMAKE_PROJECT_NAME}.fmu" --format=zip
-    "binaries/"
-    "resources/"
-    "sources/"
-    "modelDescription.xml"
+add_custom_target(create_fmu
+    COMMAND "${CMAKE_COMMAND}" --build ${CMAKE_BINARY_DIR} --target install
+    COMMAND "${CMAKE_COMMAND}" -E tar "cfv" "../@FMU_TARGET_NAME@.fmu" --format=zip
+      "binaries/"
+      "resources/"
+      "sources/"
+      "modelDescription.xml"
     WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/../")
diff --git a/doc/UsersGuide/source/fmitlm.rst b/doc/UsersGuide/source/fmitlm.rst
@@ -165,7 +165,7 @@ The CMake compilation accepts the following settings:
 
 
 Then use CMake to configure, build and install the FMU.
-To repack the FMU after installation use custom target ``create_zip``.
+To repack the FMU after installation use custom target ``create_fmu``.
 
 For example to re-compile the FMU with cmake and runtime dependencies use:
 
@@ -176,7 +176,7 @@ For example to re-compile the FMU with cmake and runtime dependencies use:
     $ cmake -S . -B build_cmake \
       -D RUNTIME_DEPENDENCIES_LEVEL=modelica \
       -D CMAKE_C_COMPILER=clang -D CMAKE_CXX_COMPILER=clang++
-    $ cmake --build build_cmake --target install create_zip --parallel
+    $ cmake --build build_cmake --target create_fmu --parallel
 
 .. _fmitlm-export-options :
 

diff --git a/testsuite/omsimulator/.gitignore b/testsuite/omsimulator/.gitignore
@@ -1,2 +1,13 @@
 *.bin
+*.c
+*.fmu
+*.fmutmp
+*.h
+*.libs
 *.log
+*.lua
+*.makefile
+*.mat
+*.xml
+DualMassOscillator.CoupledSystem
+temp-*/
diff --git a/testsuite/openmodelica/fmi/CoSimulation/2.0/RecompileSourceCodeFMU.mos b/testsuite/openmodelica/fmi/CoSimulation/2.0/RecompileSourceCodeFMU.mos
@@ -1,7 +1,7 @@
 // name:     RecompileSourceCodeFMU
 // keywords: fmu export simulation flags
 // status: correct
-// teardown_command: rm -rf Test_SinSource* reCompile.log Test.SinSource.fmu
+// teardown_command: rm -rf Test_SinSource* Test.SinSource* reCompile.log Test.SinSource.fmu
 //
 // Export SinSource as 2.0 CS FMU with CVODE solver and re-compile FMU with static library
 
@@ -34,6 +34,11 @@ system("cd Test_SinSource_FMU/sources/build_cmake && cmake .. -DBUILD_SHARED_LIB
 // Has to return "Test_SinSource_fmi2GetReal"
 system("nm Test_SinSource_FMU/binaries/linux64/Test_SinSource.a | grep -wo Test_SinSource_fmi2GetReal"); getErrorString();
 
+// Repack Test.SinSource.fmu
+system("rm -rf Test.SinSource.fmu && cd Test_SinSource_FMU/sources/build_cmake && cmake --build . && make create_fmu", outputFile="reCompile.log"); getErrorString();
+//readFile("reCompile.log");
+regularFileExists("Test.SinSource.fmu"); getErrorString();
+
 // Result:
 // true
 // ""
@@ -50,4 +55,8 @@ system("nm Test_SinSource_FMU/binaries/linux64/Test_SinSource.a | grep -wo Test_
 // Test_SinSource_fmi2GetReal
 // 0
 // ""
+// 0
+// ""
+// true
+// ""
 // endResult