Option to disable Julia pre-compilation

Author: AnHeuermann

.github/workflows/test_julia.yml

@@ -92,7 +92,7 @@ jobs:
         shell: bash
         run: |
           export MY_SANITY_CHECK_DIRECTORY=sanityCheck
-          python test.py --branch="${{ matrix.omc-version }}" --basemodelica-mtk-import --noclean --verbose configs/sanityCheck.json
+          python test.py --branch="${{ matrix.omc-version }}" --basemodelica-mtk-import --no-julia-sys-image --noclean --verbose configs/sanityCheck.json
 
       - name: Generate HTML results
         shell: bash

README.md

@@ -185,3 +185,7 @@ export MY_SANITY_CHECK_DIRECTORY=sanityCheck
 ./test.py --basemodelica-mtk-import --branch=master --noclean --verbose configs/sanityCheck.json
 ./report.py --branches="${{ matrix.omc-version }}" configs/sanityCheck.json
 ```
+
+This will create a Julia system image to speedup tests. This can take a lot of
+time, but will reduce the Julia startup penalty. To disable add
+`--no-julia-sys-image`.

basemodelica.py

@@ -6,6 +6,7 @@
 from omcommon import friendlyStr
 
 def print_julia_version() -> None:
+  """Print Julia `versioninfo()`"""
 
   julia = None
   try:
@@ -17,27 +18,41 @@ def print_julia_version() -> None:
 
   jl.seval("using InteractiveUtils; versioninfo()")
 
-def precompile_testbaesmodelica(systemImage: os.path) -> None:
+def precompile_testbaesmodelica(systemImage: os.PathLike | None = None) -> None:
   """Update and pre-compile TestBaseModelica to `sysimage`.
 
   Update dependencies of TestBaseModelica to get the latest version of
-  BaseModelica.jl from branch main. Create a pre-compile system image of package
-  TestBaseModelica with PackageCompiler.jl. This might take a wile!
+  BaseModelica.jl from branch main.
+  Create a pre-compile system image of package TestBaseModelica with
+  PackageCompiler.jl. Skipping this step if `systemImage` is `None`.
+  This might take a wile!
   """
 
   start = monotonic.monotonic()
-  print("Updating and pre-compiling Julia package TestBaseModelica. This might take a while, hang tight!")
+  print("Updating Julia package TestBaseModelica")
+
   jl.seval('import Pkg;'
-           "Pkg.activate();"
+           'Pkg.activate();'
            'Pkg.add("PackageCompiler");'
            'using PackageCompiler;'
            'Pkg.activate("TestBaseModelica");'
            'Pkg.update();'
-           'Pkg.status();'
-           'create_sysimage(["TestBaseModelica"]; sysimage_path="%s", precompile_execution_file="TestBaseModelica/precompile_skript.jl")'
-           % systemImage)
+           'Pkg.status();')
+
+  if systemImage == None:
+    jl.seval('Pkg.activate();'
+             'Pkg.develop(path="TestBaseModelica");'
+             'Pkg.precompile("TestBaseModelica")')
+  else:
+    print("Pre-compiling Julia system image %s for TestBaseModelica."
+          "This might take a while." % systemImage)
+
+    jl.seval('create_sysimage(["TestBaseModelica"];'
+             'sysimage_path="%s",'
+             'precompile_execution_file="TestBaseModelica/precompile_skript.jl")'
+            % systemImage)
+    if not os.path.isfile(systemImage):
+      raise FileNotFoundError("Something went wrong, couldn't find %s" % systemImage)
+
   execTime = monotonic.monotonic() - start
   print("Done pre-compiling in %s." % friendlyStr(execTime))
-
-  if not os.path.isfile(systemImage):
-    raise FileNotFoundError("Something went wrong, couldn't find %s" % systemImage)

test.py

@@ -28,6 +28,7 @@
 parser.add_argument('--branch', default='master')
 parser.add_argument('--fmi', default=False)
 parser.add_argument('--basemodelica-mtk-import', action="store_true", default=False, help='Activate Base Modelica export and test import with BaseModelica.jl / ModelingToolkit.jl.')
+parser.add_argument('--julia-sys-image', action=argparse.BooleanOptionalAction, default=True, help='Activate pre-compiling Julia system image.')
 parser.add_argument('--output', default='')
 parser.add_argument('--docker', default='')
 parser.add_argument('--libraries', help="Directory omc will search in to load system libraries/libraries to test.", default='')
@@ -67,7 +68,8 @@
 extrasimflags = args.extrasimflags
 ompython_omhome = args.ompython_omhome
 fmisimulator = args.fmisimulator or None
-basemodelica_mtk_import = args.basemodelica_mtk_import or None
+basemodelica_mtk_import = args.basemodelica_mtk_import
+julia_sys_image = args.julia_sys_image
 allTestsFmi = args.fmi
 ulimitMemory = args.ulimitvmem
 docker = args.docker
@@ -314,7 +316,7 @@ def timeSeconds(f):
 sys.stdout.flush()
 
 # Print Julia versions for BaseModelica.jl import
-julia_sysimage = os.path.abspath("TestBaseModelica.so")
+julia_sysimage = os.path.abspath("TestBaseModelica.so") if julia_sys_image else None
 if basemodelica_mtk_import:
   basemodelica.print_julia_version()
   basemodelica.precompile_testbaesmodelica(julia_sysimage)
@@ -516,7 +518,7 @@ def testHelloWorld(cmd):
   if basemodelica_mtk_import:
     c["basemodelica-export"] = True
     c["basemodelica-mtk-import"] = True
-    c["julia-system-image"] = julia_sysimage
+    c["julia-system-image"] = julia_sysimage if julia_sys_image else ""
 
 # Create mos-files
 

testmodel.py

@@ -541,12 +541,18 @@ def sendExpressionOldOrNew(cmd):
 
       juliaCallFile=os.path.normpath("%s_test.jl" % conf["modelName"])
       with open(juliaCallFile,"w") as fp:
-        fp.write("using TestBaseModelica\n")
+        if conf["julia-system-image"] == "":
+          fp.write("using TestBaseModelica\n")
+        else:
+          fp.write("using .TestBaseModelica\n")
         fp.write("solver_settings = SolverSettings(start_time=%g,stop_time=%g,interval=%g,tolerance=%g)\n" %(startTime,stopTime,stepSize,tolerance))
         fp.write("test_settings = TestSettings(modelname=\"%s\", solver_settings=solver_settings)\n" % (conf["fileName"]))
         fp.write("run_test(\"%s.mo\"; settings = test_settings)\n" % (conf["modelName"]))
 
-      cmd = "julia --sysimage=%s %s" % (conf["julia-system-image"], juliaCallFile)
+      cmd = "julia"
+      if conf["julia-system-image"] != "":
+        cmd += " --sysimage=%s" % conf["julia-system-image"]
+      cmd += " %s" % juliaCallFile
       with open(simFile,"w") as fp:
         fp.write("%s\n" % (cmd))
       res = checkOutputTimeout(