Merge pull request #26 from invenia/bc/enabled

Add function to get enabled checkpoints

Project.toml

@@ -1,7 +1,7 @@
 name = "Checkpoints"
 uuid = "b4a3413d-e481-5afc-88ff-bdfbd6a50dce"
 authors = "Invenia Technical Computing Corporation"
-version = "0.3.8"
+version = "0.3.9"
 
 [deps]
 AWSS3 = "1c724243-ef5b-51ab-93f4-b0a88ac62a95"

src/Checkpoints.jl

@@ -18,6 +18,7 @@ using Memento
 using OrderedCollections
 
 export checkpoint, with_checkpoint_tags  # creating stuff
+export enabled_checkpoints
 # indexing stuff
 export IndexEntry, index_checkpoint_files
 export checkpoint_name, checkpoint_path, prefixes, tags
@@ -68,6 +69,13 @@ Returns a vector of all available (registered) checkpoints.
 """
 available() = collect(keys(CHECKPOINTS))
 
+"""
+    enabled_checkpoints() -> Vector{String}
+
+Returns a vector of all enabled ([`config`](@ref)ured) checkpoints.
+"""
+enabled_checkpoints() = filter(k -> CHECKPOINTS[k] !== nothing, available())
+
 """
     checkpoint([prefix], name, data)
     checkpoint([prefix], name, data::Pair...)

test/runtests.jl

@@ -17,6 +17,20 @@ Distributed.addprocs(5)
 @testset "Checkpoints" begin
     @everywhere include("testpkg.jl")
 
+    @testset "enabled" begin
+        mktempdir() do path
+            @test enabled_checkpoints() == []
+            Checkpoints.register(["c1", "c2", "c3"])
+            @test enabled_checkpoints() == []
+
+            Checkpoints.config("c1", path)
+            @test enabled_checkpoints() == ["c1"]
+
+            Checkpoints.config("c2", path)
+            @test enabled_checkpoints() == ["c1", "c2"]
+        end
+    end
+
     x = reshape(collect(1:100), 10, 10)
     y = reshape(collect(101:200), 10, 10)
     a = collect(1:10)