F get value

Summary

See https://gitlab.indiscale.com/caosdb/customers/lfpb/management/-/issues/421. A function that returns the value of entity properties or properties has been implemented. Lists are also supported. The datatype is casted to the corresponding Julia datatype.

Focus

All changes are made in Entity.jl.

Test Environment

Normal Test-setting. Please note: At the moment, the tests will fail. There are two reasons:

• caosdb_entity_entity_get_boolean_list_value_at and caosdb_entity_property_get_boolean_list_value_atare not implemented in the caosdb-cpplib
• set_value(entity/property, integer_list) is not working correctly. Please check if this is an error in the cpp-lib or an julia-error.

Check List for the Author

Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines

• All automated tests pass
• Reference related Issues
• Up-to-date CHANGELOG.md
• Annotations in code (Gitlab comments)
  • Intent of new code
  • Problems with old code
  • Why this implementation?

Check List for the Reviewer

• I understand the intent of this MR
• All automated tests pass
• Up-to-date CHANGELOG.md
• The test environment setup works and the intended behavior is reproducible in the test environment
• In-code documentation and comments are up-to-date.
• Check: Are there spezifications? Are they satisfied?

For further good practices have a look at our review guidelines.

test/runtests.jl

@@ -147,9 +147,9 @@ using CaosDB
         # properties can be accessed as a list
 
         # TODO(henrik, daniel)
-        # @test CaosDB.Entity.get_value(
-        #     CaosDB.Entity.get_properties(rec_with_parent_and_props)[1],
-        # ) == "2"
+        @test CaosDB.Entity.get_value(
+            CaosDB.Entity.get_properties(rec_with_parent_and_props)[1],
+        ) == "2"
         type, is_ref, is_list = CaosDB.Entity.get_datatype(
             CaosDB.Entity.get_properties(rec_with_parent_and_props)[2],
         )
@@ -180,22 +180,31 @@ using CaosDB
             )
             string_prop =
                 CaosDB.Entity.create_property_entity(name = "StringProp", datatype = "TEXT")
+            ref_prop = CaosDB.Entity.create_property_entity(
+                name = "RefProp",
+                datatype = "MyRefType",
+                is_reference = true,
+            )
             CaosDB.Entity.set_value(int_prop, 123)
             CaosDB.Entity.set_value(double_prop, 10.246)
             CaosDB.Entity.set_value(bool_prop, true)
             CaosDB.Entity.set_value(string_prop, "Hello World")
+            CaosDB.Entity.set_value(ref_prop, "some_id")
             @test CaosDB.Entity.get_value(int_prop) == 123
             @test CaosDB.Entity.get_value(double_prop) == 10.246
             @test CaosDB.Entity.get_value(bool_prop) === true
             @test CaosDB.Entity.get_value(string_prop) == "Hello World"
+            @test CaosDB.Entity.get_value(ref_prop) == "some_id"
             @test isa(CaosDB.Entity.get_value(int_prop), Integer)
             @test isa(CaosDB.Entity.get_value(double_prop), Number)
             @test isa(CaosDB.Entity.get_value(bool_prop), Bool)
             @test isa(CaosDB.Entity.get_value(string_prop), String)
+            @test isa(CaosDB.Entity.get_value(ref_prop), String)
             @test CaosDB.Entity.get_datatype(int_prop) == ("INTEGER", false, false)
             @test CaosDB.Entity.get_datatype(double_prop) == ("DOUBLE", false, false)
             @test CaosDB.Entity.get_datatype(bool_prop) == ("BOOLEAN", false, false)
             @test CaosDB.Entity.get_datatype(string_prop) == ("TEXT", false, false)
+            @test CaosDB.Entity.get_datatype(ref_prop) == ("MyRefType", true, false)
 
             """ Test lists """
             int_list_prop = CaosDB.Entity.create_property_entity(
@@ -218,22 +227,32 @@ using CaosDB
                 datatype = "TEXT",
                 is_list = true,
             )
+            ref_list_prop = CaosDB.Entity.create_property_entity(
+                name = "RefListProp",
+                datatype = "MyRefType",
+                is_list = true,
+                is_reference = true,
+            )
             CaosDB.Entity.set_value(int_list_prop, [123, 456])
             CaosDB.Entity.set_value(double_list_prop, [10.246, 3.14])
             CaosDB.Entity.set_value(bool_list_prop, [true, false])
             CaosDB.Entity.set_value(string_list_prop, ["Hello", "World"])
+            CaosDB.Entity.set_value(ref_list_prop, ["some_id", "another_id"])
             @test CaosDB.Entity.get_value(int_list_prop) == [123, 456]
             @test CaosDB.Entity.get_value(double_list_prop) == [10.246, 3.14]
             @test CaosDB.Entity.get_value(bool_list_prop) === [true, false]
             @test CaosDB.Entity.get_value(string_list_prop) == ["Hello", "World"]
+            @test CaosDB.Entity.get_value(ref_list_prop) == ["some_id", "another_id"]
             @test isa(CaosDB.Entity.get_value(int_list_prop), Vector{Cint})
             @test isa(CaosDB.Entity.get_value(double_list_prop), Vector{Cdouble})
             @test isa(CaosDB.Entity.get_value(bool_list_prop), Vector{Bool})
             @test isa(CaosDB.Entity.get_value(string_list_prop), Vector{String})
+            @test isa(CaosDB.Entity.get_value(ref_list_prop), Vector{String})
             @test CaosDB.Entity.get_datatype(int_list_prop) == ("INTEGER", false, true)
             @test CaosDB.Entity.get_datatype(double_list_prop) == ("DOUBLE", false, true)
             @test CaosDB.Entity.get_datatype(bool_list_prop) == ("BOOLEAN", false, true)
             @test CaosDB.Entity.get_datatype(string_list_prop) == ("TEXT", false, true)
+            @test CaosDB.Entity.get_datatype(ref_list_prop) == ("MyRefType", true, true)
         end
         @testset "Property properties" begin
             int_prop = CaosDB.Entity.create_property(name = "IntProp", datatype = "INTEGER")
@@ -243,22 +262,31 @@ using CaosDB
                 CaosDB.Entity.create_property(name = "BoolProp", datatype = "BOOLEAN")
             string_prop =
                 CaosDB.Entity.create_property(name = "StringProp", datatype = "TEXT")
+            ref_prop = CaosDB.Entity.create_property(
+                name = "RefProp",
+                datatype = "MyRefType",
+                is_reference = true,
+            )
             CaosDB.Entity.set_value(int_prop, 123)
             CaosDB.Entity.set_value(double_prop, 10.246)
             CaosDB.Entity.set_value(bool_prop, true)
             CaosDB.Entity.set_value(string_prop, "Hello World")
+            CaosDB.Entity.set_value(ref_prop, "some_id")
             @test CaosDB.Entity.get_value(int_prop) == 123
             @test CaosDB.Entity.get_value(double_prop) == 10.246
             @test CaosDB.Entity.get_value(bool_prop) === true
             @test CaosDB.Entity.get_value(string_prop) == "Hello World"
+            @test CaosDB.Entity.get_value(ref_prop) == "some_id"
             @test isa(CaosDB.Entity.get_value(int_prop), Integer)
             @test isa(CaosDB.Entity.get_value(double_prop), Number)
             @test isa(CaosDB.Entity.get_value(bool_prop), Bool)
             @test isa(CaosDB.Entity.get_value(string_prop), String)
+            @test isa(CaosDB.Entity.get_value(ref_prop), String)
             @test CaosDB.Entity.get_datatype(int_prop) == ("INTEGER", false, false)
             @test CaosDB.Entity.get_datatype(double_prop) == ("DOUBLE", false, false)
             @test CaosDB.Entity.get_datatype(bool_prop) == ("BOOLEAN", false, false)
             @test CaosDB.Entity.get_datatype(string_prop) == ("TEXT", false, false)
+            @test CaosDB.Entity.get_datatype(ref_prop) == ("MyRefType", true, false)
 
             """ Test lists """
             int_list_prop = CaosDB.Entity.create_property(
@@ -281,22 +309,32 @@ using CaosDB
                 datatype = "TEXT",
                 is_list = true,
             )
+            ref_list_prop = CaosDB.Entity.create_property(
+                name = "RefListProp",
+                datatype = "MyRefType",
+                is_list = true,
+                is_reference = true,
+            )
             CaosDB.Entity.set_value(int_list_prop, [123, 456])
             CaosDB.Entity.set_value(double_list_prop, [10.246, 3.14])
             CaosDB.Entity.set_value(bool_list_prop, [true, false])
             CaosDB.Entity.set_value(string_list_prop, ["Hello", "World"])
+            CaosDB.Entity.set_value(ref_list_prop, ["some_id", "another_id"])
             @test CaosDB.Entity.get_value(int_list_prop) == [123, 456]
             @test CaosDB.Entity.get_value(double_list_prop) == [10.246, 3.14]
             @test CaosDB.Entity.get_value(bool_list_prop) === [true, false]
             @test CaosDB.Entity.get_value(string_list_prop) == ["Hello", "World"]
+            @test CaosDB.Entity.get_value(ref_list_prop) == ["some_id", "another_id"]
             @test isa(CaosDB.Entity.get_value(int_list_prop), Vector{Cint})
             @test isa(CaosDB.Entity.get_value(double_list_prop), Vector{Cdouble})
             @test isa(CaosDB.Entity.get_value(bool_list_prop), Vector{Bool})
             @test isa(CaosDB.Entity.get_value(string_list_prop), Vector{String})
+            @test isa(CaosDB.Entity.get_value(ref_list_prop), Vector{String})
             @test CaosDB.Entity.get_datatype(int_list_prop) == ("INTEGER", false, true)
             @test CaosDB.Entity.get_datatype(double_list_prop) == ("DOUBLE", false, true)
             @test CaosDB.Entity.get_datatype(bool_list_prop) == ("BOOLEAN", false, true)
             @test CaosDB.Entity.get_datatype(string_list_prop) == ("TEXT", false, true)
+            @test CaosDB.Entity.get_datatype(ref_list_prop) == ("MyRefType", true, true)
         end
     end
 end