Test all (current) functionality for registration (#4)

* naming tests

* tests for project setup

* remove use of isnothing

* optional git stuff

* allow testing on appveyor

* Removed submodule src/test project

* test at a safe path!!!

Author: Datseris

README.md

@@ -6,6 +6,6 @@
 
 DrWatson is a Julia package created to help people "deal" with their simulations, simulation parameters, where are files saved, experimental data, scripts, existing simulations, project source code and in general their scientific projects.
 
-**DrWatson is in pre-alpha. Wanna help development? Get involed by checking the issues and opening your own feature requests and suggestions.**
+**DrWatson is in beta. Wanna help development? Get involed by checking the issues and opening your own feature requests and suggestions.**
 
 Please read the documentation page for more!

appveyor.yml

@@ -33,6 +33,8 @@ build_script:
 
 test_script:
   - echo "%JL_TEST_SCRIPT%"
+  - git config --global user.name "AppVeyor"
+  - git config --global user.email "app@vey.or"
   - C:\julia\bin\julia -e "%JL_TEST_SCRIPT%"
 
 # # Uncomment to support code coverage upload. Should only be enabled for packages

docs/src/project.md

@@ -33,7 +33,7 @@ Seems like `src` and `scripts` folders have pretty similar functionality. Howeve
 
 1. If upon `include("file.jl")` there is _anything_ being produced, be it data files, plots or even output to the console, then it should be in `scripts`.
 2. If it is functionality used across multiple files or pipelines, it should be in `src`.
-3. `src` should only contain files the define functions or modules but not output anything.
+3. `src` should only contain files the define functions or modules but not output anything. You can also organize `src` to be a Julia package, or contain multiple Julia packages.
 
 ## Initializing a Project
 

docs/src/savenames.md

@@ -2,7 +2,7 @@
 
 ## Naming Schemes
 
-A robust naming scheme allows you to create quick names for simulations, create lists of simulations, check existing simulations, etc. 
+A robust naming scheme allows you to create quick names for simulations, create lists of simulations, check existing simulations, etc.
 
 ```@docs
 savename
@@ -13,6 +13,6 @@ DrWatson.access
 
 Notice that the naming scheme integrates perfectly with Parameters.jl.
 
-## Adding Runs
+## Creating Run Tables
 
 WIP. (Adding simulation runs to a table/csv/dataframe)

src/project_setup.jl

@@ -51,23 +51,26 @@ The new project remains activated for you to immidiately add packages.
   Project.toml file.
 * `force = false` : If the `path` is _not_ empty then throw an error. If however `force`
   is `true` then recursively delete everything in the path and create the project.
+* `git = true` : Make the project a Git repository.
 """
 function initialize_project(path, name = basename(path);
-    force = false, readme = true, authors = nothing)
+    force = false, readme = true, authors = nothing,
+    git = true)
 
-    if !isempty(path)
+    mkpath(path)
+    rd = readdir(path)
+    if length(rd) != 0
         if force
-            for d in readdir(path)
-                rm(d, recursive = true, force = true)
+            for d in rd
+                rm(joinpath(path, d), recursive = true, force = true)
             end
         else
             error("Project path is not empty!")
         end
     end
 
-    mkpath(path)
-    repo = LibGit2.init(path)
-    LibGit2.commit(repo, "Initial commit")
+    if git; repo = LibGit2.init(path); end
+    git && LibGit2.commit(repo, "Initial commit")
     Pkg.activate(path)
     # Pkg.add("DrWatson")#Uncomment when the package is released
     Pkg.add("Pkg")
@@ -77,28 +80,28 @@ function initialize_project(path, name = basename(path);
         mkpath(joinpath(path, p))
     end
 
-    LibGit2.add!(repo, "Project.toml")
-    LibGit2.add!(repo, DEFAULT_PATHS...)
-    LibGit2.commit(repo, "Folder setup by DrWatson")
+    git && LibGit2.add!(repo, "Project.toml")
+    git && LibGit2.add!(repo, DEFAULT_PATHS...)
+    git && LibGit2.commit(repo, "Folder setup by DrWatson")
 
     # Default files
     cp(joinpath(@__DIR__, "defaults", "gitignore.txt"), joinpath(path, ".gitignore"))
     cp(joinpath(@__DIR__, "defaults", "intro.jl"), joinpath(path, "scripts/intro.jl"))
     files = vcat(".gitignore", "/scripts/intro.jl")
     if readme
-        write("README.md", DEFAULT_README)
+        write(joinpath(path, "README.md"), DEFAULT_README)
         push!(files, "README.md")
     end
-    pro = read("Project.toml", String)
+    pro = read(joinpath(path, "Project.toml"), String)
     w = "name = \"$name\"\n"
-    if !isnothing(authors)
+    if !(authors === nothing)
             w *= "authors = "*sprint(show, vecstring(authors))*"\n"
     end
-    write("Project.toml", w, pro)
+    write(joinpath(path, "Project.toml"), w, pro)
     push!(files, "Project.toml")
 
-    LibGit2.add!(repo, files...)
-    LibGit2.commit(repo, "File setup by DrWatson")
+    git && LibGit2.add!(repo, files...)
+    git && LibGit2.commit(repo, "File setup by DrWatson")
     return path
 end
 

test/naming_tests.jl

@@ -0,0 +1,22 @@
+using DrWatson, Test
+
+d = (a = 0.153456453, b = 5.0, mode = "double")
+@test savename(d; digits = 4) == "a=0.1535_b=5_mode=double"
+@test savename(d, (String,)) == "mode=double"
+
+rick = (never = "gonna", give = "you", up = "!");
+@test savename(rick) == "give=you_never=gonna_up=!"
+
+x = 3; y = 5.0;
+d = Dict("x" => x, "y" => y)
+
+@test d == @dict x y
+
+z = "lala"
+d2 = Dict("x" => x, "y" => y, "z" => z)
+
+@test d2 == @dict x y z
+
+@test savename(@dict x y) == "x=3_y=5"
+w = rand(50)
+@test savename(@dict x y w) == savename(@dict x y)

test/project_tests.jl

@@ -0,0 +1,38 @@
+using Test, DrWatson
+
+cd()
+
+path = "test project"
+name = "lala"
+
+initialize_project(path)
+
+@test projectname() == path
+for p in DrWatson.DEFAULT_PATHS
+    @test ispath(joinpath(path, p))
+end
+@test isfile(joinpath(path, ".gitignore"))
+@test isfile(joinpath(path, "README.md"))
+@test isfile(joinpath(path, "Project.toml"))
+
+
+@test_throws ErrorException initialize_project(path, name)
+
+initialize_project(path, name; force = true, authors = ["George", "Nick"])
+
+@test projectname() == name
+for p in DrWatson.DEFAULT_PATHS
+    @test ispath(joinpath(path, p))
+end
+@test isfile(joinpath(path, ".gitignore"))
+@test isfile(joinpath(path, "README.md"))
+@test isfile(joinpath(path, "Project.toml"))
+z = read((path*"/Project.toml"), String)
+@test occursin("[\"George\", \"Nick\"]", z)
+
+initialize_project(path, name; force = true, authors = "Sophia", git = false)
+z = read((path*"/Project.toml"), String)
+@test occursin("[\"Sophia\"]", z)
+
+rm(path, recursive = true, force = true)
+@test !isdir(path)

test/runtests.jl

@@ -1,8 +1,4 @@
 using DrWatson, Test
 
-d = (a = 0.153456453, b = 5.0, mode = "double")
-@test savename(d; digits = 4) == "a=0.1535_b=5_mode=double"
-@test savename(d, (String,)) == "mode=double"
-
-rick = (never = "gonna", give = "you", up = "!");
-@test savename(rick) == "give=you_never=gonna_up=!"
+@testset "Naming" begin include("naming_tests.jl"); end
+@testset "Project Setup" begin include("project_tests.jl"); end