improve testing

Author: Affie

Project.toml

@@ -64,7 +64,7 @@ SHA = "0.7, 1"
 SparseArrays = "1.11"
 StaticArrays = "1"
 Statistics = "1.11"
-Tables = "v1.11.1"
+Tables = "1.11.1"
 Tar = "1.9"
 TensorCast = "0.3.3, 0.4"
 Test = "1.11"

src/DistributedFactorGraphs.jl

@@ -263,32 +263,44 @@ export getId
 ##------------------------------------------------------------------------------
 ## Types
 ##------------------------------------------------------------------------------
-export InMemoryDFGTypes
-export LocalDFG
-export FolderStore
+public InMemoryDFGTypes
+public LocalDFG
+public FolderStore
 
 ##------------------------------------------------------------------------------
 ## Tags
 ##------------------------------------------------------------------------------
 # tags is a set: get/list, merge, empty, and remove (we don't have add but merge)
-export getTags
-export listTags
-export mergeTags!
-export emptyTags!
-export removeTags! #TODO do we want this one
+
+export listVariableTags
+export listFactorTags
+export listGraphTags
+export listAgentTags
+
+export mergeVariableTags!
+export mergeFactorTags!
+export mergeGraphTags!
+export mergeAgentTags!
+
+public listTags
+public mergeTags!
+public emptyTags!
+public deleteTags! #TODO do we want this one
 
 ##------------------------------------------------------------------------------
 ## Bloblets
 ##------------------------------------------------------------------------------
 # currently these refer to variable Bloblets
 #TODO Bloblet CRUD
-# export getVariableBloblet
-# export addVariableBloblet!
-# export deleteVariableBloblet!
-# export listVariableBloblets
+export Bloblet
+export getVariableBloblet
+export addVariableBloblet!
+export mergeVariableBloblet!
+export deleteVariableBloblet!
+export listVariableBloblets
 
-# export getAgentBloblet
-# export getGraphBloblet
+export getAgentBloblet
+export getGraphBloblet
 
 ##------------------------------------------------------------------------------
 ## FileDFG
@@ -331,10 +343,12 @@ export @format_str # exported from FileIO
 
 export @defStateType #TODO Should this be exported?
 
+public refStates
+
 # list of unstable functions not exported any more
 # will move to public or deprecate over time
 const unstable_functions::Vector{Symbol} = [
-    :refStates, #internal maybe make public
+    :getTags,
     :InMemoryBlobstore,
     :getFactorState, # FIXME getFactorState were questioned and being reviewed again for name, other than that they are checked.
     :exists,

src/GraphsDFG/GraphsDFG.jl

@@ -22,7 +22,10 @@ using ...DistributedFactorGraphs:
     getGraphLabel,
     isInitialized,
     Bloblets,
-    Blobentries
+    Blobentries,
+    FolderStore,
+    refTags,
+    listTags
 
 # import DFG functions to extend
 import ...DistributedFactorGraphs:

src/GraphsDFG/services/GraphsDFG.jl

@@ -173,7 +173,7 @@ function getVariables(
             "tags kwarg is deprecated, use kwarg `tagsFilter = !isdisjoint(tags)` instead", #v0.28
             :getVariables,
         )
-        filterDFG!(variables, x -> !isdisjoint(x, tags), getTags)
+        filterDFG!(variables, x -> !isdisjoint(x, tags), refTags)
     end
     if !isnothing(solvable)
         #TODO review. just one solvableFilter or keep solvable as well.
@@ -186,7 +186,7 @@ function getVariables(
 
     filterDFG!(variables, labelFilter, getLabel)
     filterDFG!(variables, solvableFilter, getSolvable)
-    filterDFG!(variables, tagsFilter, getTags)
+    filterDFG!(variables, tagsFilter, refTags)
     filterDFG!(variables, typeFilter, getVariableType)
 
     return variables
@@ -254,7 +254,7 @@ function getFactors(
             "tags kwarg is deprecated, use kwarg `tagsFilter = !isdisjoint(tags)` instead", #v0.28
             :getFactors,
         )
-        filterDFG!(factors, x -> !isdisjoint(x, tags), getTags)
+        filterDFG!(factors, x -> !isdisjoint(x, tags), refTags)
     end
     if !isnothing(solvable)
         #TODO review. just one solvableFilter or keep solvable as well.
@@ -267,7 +267,7 @@ function getFactors(
 
     filterDFG!(factors, labelFilter, getLabel)
     filterDFG!(factors, solvableFilter, getSolvable)
-    filterDFG!(factors, tagsFilter, getTags)
+    filterDFG!(factors, tagsFilter, refTags)
     filterDFG!(factors, typeFilter, typeof ∘ getObservation)
     return factors
 end
@@ -357,7 +357,7 @@ function listNeighbors(
     # Additional filtering
     # solvable != 0 && filter!(lbl -> _isSolvable(dfg, lbl, solvable), neighbors_ll)
     filterDFG!(neighbors_ll, solvableFilter, l->getSolvable(dfg, l))
-    filterDFG!(neighbors_ll, tagsFilter, l->getTags(dfg, l))
+    filterDFG!(neighbors_ll, tagsFilter, l->listTags(dfg, l))
 
     # Variable sorting (order is important)
     if haskey(dfg.g.factors, label)

src/entities/Bloblet.jl

@@ -3,6 +3,23 @@ struct Bloblet
     val::String
 end
 
+function Bloblet(
+    label::Symbol,
+    val::Union{
+        Int,
+        Float64,
+        Bool,
+        Vector{Int},
+        Vector{Float64},
+        Vector{String},
+        Vector{Bool},
+        Missing, 
+        Nothing,
+    },
+)
+    return Bloblet(label, JSON.json(val))
+end
+
 const Bloblets = LittleDict{Symbol, Bloblet}
 
 StructUtils.structlike(::Type{Bloblets}) = false

src/entities/DFGFactor.jl

@@ -60,7 +60,7 @@ StructUtils.@kwarg struct FactorDFG{T <: AbstractObservation, N} <: AbstractGrap
     Accessor: [`getLabel`](@ref)"""
     label::Symbol
     """Factor tags, e.g [:FACTOR].
-    Accessors: [`getTags`](@ref), [`mergeTags!`](@ref), and [`removeTags!`](@ref)"""
+    Accessors: [`getTags`](@ref), [`mergeTags!`](@ref), and [`deleteTags!`](@ref)"""
     tags::Set{Symbol} = Set{Symbol}([:FACTOR])
     """Ordered list of the neighbor variables.
     Accessors: [`getVariableOrder`](@ref)"""
@@ -218,7 +218,7 @@ Base.@kwdef struct FactorSummary <: AbstractGraphFactor
     Accessor: [`getLabel`](@ref)"""
     label::Symbol
     """Factor tags, e.g [:FACTOR].
-    Accessors: [`getTags`](@ref), [`mergeTags!`](@ref), and [`removeTags!`](@ref)"""
+    Accessors: [`getTags`](@ref), [`mergeTags!`](@ref), and [`deleteTags!`](@ref)"""
     tags::Set{Symbol}
     """Ordered list of the neighbor variables.
     Accessors: [`getVariableOrder`](@ref)"""
@@ -254,7 +254,7 @@ Base.@kwdef struct FactorSkeleton <: AbstractGraphFactor
     Accessor: [`getLabel`](@ref)"""
     label::Symbol
     """Factor tags, e.g [:FACTOR].
-    Accessors: [`getTags`](@ref), [`mergeTags!`](@ref), and [`removeTags!`](@ref)"""
+    Accessors: [`getTags`](@ref), [`mergeTags!`](@ref), and [`deleteTags!`](@ref)"""
     tags::Set{Symbol}
     """Ordered list of the neighbor variables.
     Accessors: [`getVariableOrder`](@ref)"""

src/entities/DFGVariable.jl

@@ -152,7 +152,7 @@ $(TYPEDFIELDS)
     steadytime::Union{Nothing, Nanosecond} = nothing #NOTE changed to TimeDateZone in v0.29
     #nstime::String = "0" #NOTE different uses, as 0-999_999 nanosecond part of timestamp now in timestamp, as steady timestamp now in steadytime
     """Variable tags, e.g [:POSE, :VARIABLE, and :LANDMARK].
-    Accessors: [`getTags`](@ref), [`mergeTags!`](@ref), and [`removeTags!`](@ref)"""
+    Accessors: [`getTags`](@ref), [`mergeTags!`](@ref), and [`deleteTags!`](@ref)"""
     tags::Set{Symbol} = Set{Symbol}()
     """Dictionary of state data. May be a subset of all solutions if a solver label was specified in the get call.
     Accessors: [`addState!`](@ref), [`mergeState!`](@ref), and [`deleteState!`](@ref)"""
@@ -297,7 +297,7 @@ $(TYPEDFIELDS)
     Accessors: [`getTimestamp`](@ref)"""
     timestamp::TimeDateZone
     """Variable tags, e.g [:POSE, :VARIABLE, and :LANDMARK].
-    Accessors: [`getTags`](@ref), [`mergeTags!`](@ref), and [`removeTags!`](@ref)"""
+    Accessors: [`getTags`](@ref), [`mergeTags!`](@ref), and [`deleteTags!`](@ref)"""
     tags::Set{Symbol}
     """Symbol for the state type for the underlying variable.
     Accessor: [`getStateType`](@ref)"""
@@ -324,7 +324,7 @@ Base.@kwdef struct VariableSkeleton <: AbstractGraphVariable
     Accessor: [`getLabel`](@ref)"""
     label::Symbol
     """Variable tags, e.g [:POSE, :VARIABLE, and :LANDMARK].
-    Accessors: [`getTags`](@ref), [`mergeTags!`](@ref), and [`removeTags!`](@ref)"""
+    Accessors: [`getTags`](@ref), [`mergeTags!`](@ref), and [`deleteTags!`](@ref)"""
     tags::Set{Symbol} = Set{Symbol}()
 end
 

src/services/CustomPrinting.jl

@@ -41,7 +41,7 @@ function printVariable(
         printstyled(ioc, vert.label; bold = true)
         println(ioc)
         println(ioc, "  solvable:   ", getSolvable(vert))
-        println(ioc, "  tags:       ", getTags(vert))
+        println(ioc, "  tags:       ", listTags(vert))
         solk = listStates(vert)
         lsolk = length(solk)
         smsk = lsolk > 0 ? (rand(1:lsolk, 100) |> unique)[1:minimum([4, lsolk])] : nothing

src/services/Tags.jl

@@ -16,25 +16,33 @@ end
 ## TAGS as a set, list, merge, remove, empty
 ##==============================================================================
 
-listTags(node) = node.tags
+listTags(node) = collect(refTags(node))
+
 """
     $SIGNATURES
 
 Merge add tags to a variable or factor (union)
 """
-mergeTags!(node, tags::Vector{Symbol}) = union!(node.tags, tags)
+function mergeTags!(node, tags)
+    union!(refTags(node), tags)
+    return length(tags)
+end
 """
 $SIGNATURES
 
 Remove the tags from the node (setdiff)
 """
-removeTags!(node, tags::Vector{Symbol}) = setdiff!(node.tags, tags)
+function deleteTags!(node, tags)
+    setdiff!(refTags(node), tags)
+    return length(tags)
+end
+
 """
 $SIGNATURES
 
 Empty all tags from the node (empty)
 """
-emptyTags!(node) = empty!(node.tags)
+emptyTags!(node) = empty!(refTags(node))
 
 """
 $SIGNATURES
@@ -43,7 +51,7 @@ Return the tags for a variable or factor.
 """
 
 #alias for completeness #TODO keep or remove getTags?
-const getTags = listTags
+const getTags = refTags
 
 function listVariableTags(dfg::AbstractDFG, sym::Symbol)
     return listTags(getVariable(dfg, sym))
@@ -105,7 +113,7 @@ function mergeTags!(dfg::InMemoryDFGTypes, sym::Symbol, tags)
     return union!(refTags(getFnc(dfg, sym)), tags)
 end
 
-function removeTags!(dfg::InMemoryDFGTypes, sym::Symbol, tags)
+function deleteTags!(dfg::InMemoryDFGTypes, sym::Symbol, tags)
     getFnc = isVariable(dfg, sym) ? getVariable : getFactor
     return setdiff!(refTags(getFnc(dfg, sym)), tags)
 end

test/interfaceTests.jl

@@ -116,9 +116,9 @@ end
 end
 
 #FIXME replace with Bloblets tests
-# @testset "Metadata CRUD" begin
-#     smallDataTestBlock!(fg1)
-# end
+@testset "Bloblet CRUD" begin
+    blobletTestBlock!(fg1)
+end
 
 @testset "Data Entries and Blobs" begin
     if typeof(fg1) <: InMemoryDFGTypes