Activating tests, adding diffSimulationResults (OpenModelica#112)

  - Tests for `ModelicaSystem` and `API` added to `runtests.jl`.
  - Added API function `diffSimulationResults` to `OMJulia.API`.
  - Added error handling for `API.loadModel`.
  - Bumped version of OMJulia to v0.3.0.

Author: AnHeuermann

Project.toml

@@ -1,7 +1,7 @@
 name = "OMJulia"
 uuid = "0f4fe800-344e-11e9-2949-fb537ad918e1"
 authors = ["Martin Sjölund <[email protected]>", "Arunkumar Palanisamy <[email protected]>"]
-version = "0.2.2"
+version = "0.3.0"
 
 [deps]
 DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"

docs/Manifest.toml

@@ -2,7 +2,7 @@
 
 julia_version = "1.9.1"
 manifest_format = "2.0"
-project_hash = "d7be50ff01e3cc91c96d7b9f8edaa162fd007a28"
+project_hash = "ff4eb59ea758b735f7ededf0323b4b573c479c73"
 
 [[deps.ANSIColoredPrinters]]
 git-tree-sha1 = "574baf8110975760d391c710b6341da1afa48d8c"
@@ -368,7 +368,7 @@ version = "1.2.0"
 deps = ["DataFrames", "DataStructures", "LightXML", "Random", "ZMQ"]
 path = ".."
 uuid = "0f4fe800-344e-11e9-2949-fb537ad918e1"
-version = "0.2.2"
+version = "0.3.0"
 
 [[deps.Observables]]
 git-tree-sha1 = "6862738f9796b3edc1c09d0890afce4eca9e7e93"

docs/Project.toml

@@ -8,4 +8,4 @@ PlotlyJS = "f0f68f2c-4968-5e81-91da-67840de0976a"
 
 [compat]
 Documenter = "^0.27"
-OMJulia = "^0.2.1"
+OMJulia = "^0.3.0"

src/api.jl

@@ -62,6 +62,8 @@ module API
 
             if isnothing(errorString) && !isnothing(omc)
                 errorString = strip(OMJulia.sendExpression(omc, "getErrorString()"))
+            elseif isnothing(errorString)
+                errorString = ""
             end
             return new(msg, errorString)
         end
@@ -82,16 +84,25 @@ module API
         return replace(formattedString, "\\" => "/")
     end
 
-    function makeVectorString(args)
-        if length(args) == 0
+    """
+        modelicaString(vec)
+
+    Wrappes array in brackets and for each elemetn add quotes and replaces Windows style path seperation `\\` with `/`.
+    """
+    function modelicaString(vec::Vector{String})
+        return "{" .* join(modelicaString.(vec), ", ") .* "}"
+    end
+
+    """
+        makeVectorString(vec)
+
+    Add quotes around each string element.
+    """
+    function makeVectorString(vec::Vector{String})
+        if length(vec) == 0
             return "\"\""
         end
-        s = []
-        for item in args
-            args = join(["\"", item , "\""])
-            push!(s, args)
-        end
-        return join(s, ", ")
+        return join("\"" .* vec .* "\"", ", ")
     end
 
     """
@@ -104,7 +115,7 @@ module API
     Load file `fileName` (*.mo) and merge it with the loaded AST.
     See [OpenModelica scripting API `loadFile`](https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/scripting_api.html#loadfile).
     """
-    function loadFile(omc,
+    function loadFile(omc::OMJulia.OMCSession,
         fileName::String;
         encoding::String = "",
         uses::Bool = true,
@@ -132,15 +143,21 @@ module API
 
     See [OpenModelica scripting API `loadModel`](https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/scripting_api.html#loadmodel).
     """
-    function loadModel(omc,
+    function loadModel(omc::OMJulia.OMCSession,
         className::String;
         priorityVersion::Vector{String} = String[],
         notify::Bool = false,
         languageStandard::String = "",
         requireExactVersion::Bool = false
         )
         exp = join(["loadModel", "(", "className", "=", className, ",", "priorityVersion", "=", "{", makeVectorString(priorityVersion), "}", ",", "notify", "=", notify,",", "languageStandard", "=", modelicaString(languageStandard), ",", "requireExactVersion", "=", requireExactVersion,")"])
-        return OMJulia.sendExpression(omc, exp)
+        
+        success = OMJulia.sendExpression(omc, exp)
+
+        if !success
+            throw(ScriptingError(omc, msg = "Failed to load model $(className)."))
+        end
+        return success
     end
 
     """
@@ -161,7 +178,7 @@ module API
 
     See [OpenModelica scripting API `simulate`](https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/scripting_api.html#simulate).
     """
-    function simulate(omc,
+    function simulate(omc::OMJulia.OMCSession,
         className::String;
         startTime::Float64 = 0.0,
         stopTime::Union{Float64, Nothing} = nothing,
@@ -222,7 +239,7 @@ module API
 
     See [OpenModelica scripting API `buildModel`](https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/scripting_api.html#buildmodel).
     """
-    function buildModel(omc,
+    function buildModel(omc::OMJulia.OMCSession,
         className::String;
         startTime::Float64 = 0.0,
         stopTime::Float64 = 1.0,
@@ -255,7 +272,7 @@ module API
 
     See [OpenModelica scripting API `getClassNames`](https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/scripting_api.html#getclassnames).
     """
-    function getClassNames(omc;
+    function getClassNames(omc::OMJulia.OMCSession;
                            class_::String = "",
                            recursive::Bool = false,
                            qualified::Bool = false,
@@ -272,11 +289,7 @@ module API
 
         exp = "getClassNames($args)"
 
-        try
-            return OMJulia.sendExpression(omc, exp)
-        finally
-            return OMJulia.sendExpression(omc, exp, parsed=false)
-        end
+        return OMJulia.sendExpression(omc, exp)
     end
 
     """
@@ -288,7 +301,7 @@ module API
 
     See [OpenModelica scripting API `readSimulationResult`](https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/scripting_api.html#readsimulationresult).
     """
-    function readSimulationResult(omc,
+    function readSimulationResult(omc::OMJulia.OMCSession,
         filename::String,
         variables::Vector{String} = String[],
         size::Int64 = 0
@@ -305,7 +318,7 @@ module API
 
     See [OpenModelica scripting API `readSimulationResultSize`](https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/scripting_api.html#readsimulationresultsize).
     """
-    function readSimulationResultSize(omc,
+    function readSimulationResultSize(omc::OMJulia.OMCSession,
         fileName::String
         )
 
@@ -322,7 +335,7 @@ module API
 
     See [OpenModelica scripting API `readSimulationResultVars`](https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/scripting_api.html#readsimulationresultvars).
     """
-    function readSimulationResultVars(omc,
+    function readSimulationResultVars(omc::OMJulia.OMCSession,
         fileName::String;
         readParameters::Bool = true,
         openmodelicaStyle::Bool = false
@@ -342,7 +355,7 @@ module API
 
     See [OpenModelica scripting API `closeSimulationResultFile`](https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/scripting_api.html#closesimulationresultfile).
     """
-    function closeSimulationResultFile(omc)
+    function closeSimulationResultFile(omc::OMJulia.OMCSession)
         return OMJulia.sendExpression(omc, "closeSimulationResultFile()")
     end
 
@@ -353,7 +366,7 @@ module API
 
     See [OpenModelica scripting API `setCommandLineOptions`](https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/scripting_api.html#setcommandlineoptions).
     """
-    function setCommandLineOptions(omc,
+    function setCommandLineOptions(omc::OMJulia.OMCSession,
         option::String
         )
 
@@ -374,7 +387,7 @@ module API
 
     See [OpenModelica scripting API `cd`](https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/scripting_api.html#cd).
     """
-    function cd(omc,
+    function cd(omc::OMJulia.OMCSession,
         newWorkingDirectory::String = "";
         )
 
@@ -392,7 +405,7 @@ module API
 
     See [OpenModelica scripting API `linearize`](https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/scripting_api.html#linearize).
     """
-    function linearize(omc,
+    function linearize(omc::OMJulia.OMCSession,
         className::String;
         startTime::Float64 = 0.0,
         stopTime::Float64 = 1.0,
@@ -425,7 +438,7 @@ module API
 
     See [OpenModelica scripting API `buildModelFMU`](https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/scripting_api.html#buildmodelfmu).
     """
-    function buildModelFMU(omc,
+    function buildModelFMU(omc::OMJulia.OMCSession,
         className::String;
         version::String = "2.0",
         fmuType::String = "me",
@@ -450,7 +463,7 @@ module API
 
     See [OpenModelica scripting API `getErrorString`](https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/scripting_api.html#geterrorstring).
     """
-    function getErrorString(omc;
+    function getErrorString(omc::OMJulia.OMCSession;
         warningsAsErrors::Bool = false
         )
 
@@ -465,7 +478,7 @@ module API
 
     See [OpenModelica scripting API `getVersion`](https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/scripting_api.html#getversion).
     """
-    function getVersion(omc)
+    function getVersion(omc::OMJulia.OMCSession)
         exp = join(["getVersion()"])
         return OMJulia.sendExpression(omc, exp)
     end
@@ -477,8 +490,48 @@ module API
 
     See [OpenModelica scripting API `getInstallationDirectoryPath`](https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/scripting_api.html#getinstallationdirectorypath).
     """
-    function getInstallationDirectoryPath(omc)
+    function getInstallationDirectoryPath(omc::OMJulia.OMCSession)
         exp = join(["getInstallationDirectoryPath()"])
         return OMJulia.sendExpression(omc, exp)
     end
+
+    """
+        diffSimulationResults(omc, actualFile, expectedFile, diffPrefix;
+                              relTol = 1e-3,
+                              relTolDiffMinMax = 1e-4,
+                              rangeDelta = 0.002,
+                              vars = String[],
+                              keepEqualResults = false)
+
+    Compares simulation results.
+
+    See [OpenModelica scripting API `diffSimulationResults`](https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/scripting_api.html#diffsimulationresults).
+    """
+    function diffSimulationResults(omc::OMJulia.OMCSession,
+        actualFile::String,
+        expectedFile::String,
+        diffPrefix::String;
+        relTol::Float64 = 1e-3,
+        relTolDiffMinMax::Float64 = 1e-4,
+        rangeDelta::Float64 = 0.002,
+        vars::Vector{String} = String[],
+        keepEqualResults::Bool = false)
+
+        exp = "diffSimulationResults($(modelicaString(actualFile)),
+                                     $(modelicaString(expectedFile)),
+                                     $(modelicaString(diffPrefix)),
+                                     relTol=$relTol,
+                                     relTolDiffMinMax=$relTolDiffMinMax,
+                                     rangeDelta=$rangeDelta,
+                                     vars=$(modelicaString(vars)),
+                                     keepEqualResults=$keepEqualResults)"
+        @debug "$exp"
+        ret = OMJulia.sendExpression(omc, exp)
+
+        if isnothing(ret)
+            return (true, String[])
+        else
+            return (ret[1], convert(Vector{String}, ret[2]))
+        end
+    end
 end

test/Project.toml

@@ -1,3 +1,6 @@
 [deps]
+CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"
+DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
+OMJulia = "0f4fe800-344e-11e9-2949-fb537ad918e1"
 SafeTestsets = "1bc83da4-3b8d-516f-aca4-4fe02f6d838f"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

test/apiTest.jl

@@ -27,6 +27,8 @@ CONDITIONS OF OSMC-PL.
 =#
 
 using Test
+using CSV
+using DataFrames
 import OMJulia
 
 @testset "API" begin
@@ -38,11 +40,12 @@ import OMJulia
     end
 
     omc = OMJulia.OMCSession()
-    @test OMJulia.API.loadFile(omc, "../docs/testmodels/BouncingBall.mo")
+    @test OMJulia.API.loadFile(omc, joinpath(@__DIR__, "../docs/testmodels/BouncingBall.mo"))
 
     # Enter non-existing directory
-    @test_throws OMJulia.ScriptingError
- OMJulia.API.cd(omc, "this/is/not/a/valid/directory/I/hope/otherwise/our/test/does/some/wild/stuff")
+    @test_throws OMJulia.API.ScriptingError throw(OMJulia.API.ScriptingError(msg = "Test error message."))
+    @test_throws OMJulia.API.ScriptingError throw(OMJulia.API.ScriptingError(omc, msg = "Test error message."))
+    @test_throws OMJulia.API.ScriptingError OMJulia.API.cd(omc, "this/is/not/a/valid/directory/I/hope/otherwise/our/test/does/some/wild/stuff")
 
     dir = OMJulia.API.cd(omc, workdir)
     result2 = OMJulia.API.buildModel(omc, "BouncingBall")
@@ -57,18 +60,30 @@ import OMJulia
     vars = OMJulia.API.readSimulationResultVars(omc, resultfile)
     @test var = "h" in vars
 
-    simres = OMJulia.API.readSimulationResult(omc, resultfile, ["h"])
-    @test simres[1][1] == 1.0
+    simres = OMJulia.API.readSimulationResult(omc, resultfile, ["time", "h", "v"])
+    @test simres[2][1] == 1.0
+
+    df = DataFrame(:time => simres[1], :h => simres[2], :v => simres[3])
+    expectedFile = joinpath(workdir, "BouncingBall_ref.csv")
+    wrongExpectedFile = joinpath(workdir, "BouncingBall_wrong.csv")
+    CSV.write(expectedFile, df)
+    df2 = copy(df)
+    df2[:,2] .= df2[:,2] .* 0.01
+    CSV.write(wrongExpectedFile, df2)
+
+    @test (true, String[]) == OMJulia.API.diffSimulationResults(omc, resultfile, expectedFile, "diff"; vars=String[])
+    @test (true, String[]) == OMJulia.API.diffSimulationResults(omc, resultfile, expectedFile, "diff"; vars=["h", "v"])
+    @test (false, ["h"]) == OMJulia.API.diffSimulationResults(omc, resultfile, wrongExpectedFile, "diff"; vars=["h", "v"])
 
     fmu = joinpath(workdir, "BouncingBall.fmu")
     OMJulia.API.buildModelFMU(omc, "BouncingBall")
     @test isfile(fmu)
 
-    result3 = OMJulia.API.setCommandLineOptions(omc, "--generateSymbolicLinearization")
-    @test result3 == true
+    @test OMJulia.API.setCommandLineOptions(omc, "--generateSymbolicLinearization")
+
+    @test OMJulia.API.loadFile(omc, joinpath(@__DIR__, "../docs/testmodels/ModSeborgCSTRorg.mo"))
 
-    classNames = OMJulia.API.getClassNames()
-    @test classNames == [:BouncingBall]
+    @test [:BouncingBall, :ModSeborgCSTRorg] == sort(OMJulia.API.getClassNames(omc))
 
     OMJulia.quit(omc)
 end

test/runtests.jl

@@ -32,4 +32,6 @@ using Test
 @testset "OMJulia" begin
     @safetestset "Parsing" begin include("parserTest.jl") end
     @safetestset "OMCSession" begin include("omcTest.jl") end
+    @safetestset "ModelicaSystem" begin include("modelicaSystemTest.jl") end
+    @safetestset "API" begin include("apiTest.jl") end
 end