Fix tests when DocStringExtensions is tested in a non-repo (#70)

Fix tests when DocStringExtensions is tested in a non-repo environment:
   - try-catch around LibGit2 operations
   - move testmodule M to its own and setup a repository there
     when testing

Author: fredrikekre

src/utilities.jl

@@ -319,21 +319,26 @@ function url(mod::Module, file::AbstractString, line::Integer)
     else
         if isfile(file)
             local d = dirname(file)
-            return LibGit2.with(LibGit2.GitRepoExt(d)) do repo
-                LibGit2.with(LibGit2.GitConfig(repo)) do cfg
-                    local u = LibGit2.get(cfg, "remote.origin.url", "")
-                    local m = match(LibGit2.GITHUB_REGEX, u)
-                    u = m === nothing ? get(ENV, "TRAVIS_REPO_SLUG", "") : m.captures[1]
-                    local commit = string(LibGit2.head_oid(repo))
-                    local root = LibGit2.path(repo)
-                    if startswith(file, root) || startswith(realpath(file), root)
-                        local base = "https://github.com/$u/tree"
-                        local filename = file[(length(root) + 1):end]
-                        return "$base/$commit/$filename#L$line"
-                    else
-                        return ""
+            try # might not be in a git repo
+                LibGit2.with(LibGit2.GitRepoExt(d)) do repo
+                    LibGit2.with(LibGit2.GitConfig(repo)) do cfg
+                        local u = LibGit2.get(cfg, "remote.origin.url", "")
+                        local m = match(LibGit2.GITHUB_REGEX, u)
+                        u = m === nothing ? get(ENV, "TRAVIS_REPO_SLUG", "") : m.captures[1]
+                        local commit = string(LibGit2.head_oid(repo))
+                        local root = LibGit2.path(repo)
+                        if startswith(file, root) || startswith(realpath(file), root)
+                            local base = "https://github.com/$u/tree"
+                            local filename = file[(length(root) + 1):end]
+                            return "$base/$commit/$filename#L$line"
+                        else
+                            return ""
+                        end
                     end
                 end
+            catch err
+                isa(err, LibGit2.GitError) || rethrow()
+                return ""
             end
         else
             return ""

test/TestModule/M.jl

@@ -0,0 +1,43 @@
+module M
+
+export f
+
+f(x) = x
+
+g(x = 1, y = 2, z = 3; kwargs...) = x
+
+const A{T} = Union{Vector{T}, Matrix{T}}
+
+h_1(x::A) = x
+h_2(x::A{Int}) = x
+h_3(x::A{T}) where {T} = x
+
+i_1(x; y = x) = x * y
+i_2(x::Int; y = x) = x * y
+i_3(x::T; y = x) where {T} = x * y
+i_4(x; y::T = zero(T), z::U = zero(U)) where {T, U} = x + y + z
+
+j_1(x, y) = x * y # two arguments, no keyword arguments
+j_1(x; y = x) = x * y # one argument, one keyword argument
+
+mutable struct T
+    a
+    b
+    c
+end
+
+struct K
+    K(; a = 1) = new()
+end
+
+
+abstract type AbstractType <: Integer end
+
+struct CustomType{S, T <: Integer} <: Integer
+end
+
+primitive type BitType8 8 end
+
+primitive type BitType32 <: Real 32 end
+
+end

test/runtests.jl

@@ -1,5 +1,6 @@
 using DocStringExtensions
 using Test
 import Markdown
+import LibGit2
 
 include("tests.jl")

test/tests.jl

@@ -1,49 +1,20 @@
 const DSE = DocStringExtensions
 
 include("templates.jl")
-
-module M
-
-export f
-
-f(x) = x
-
-g(x = 1, y = 2, z = 3; kwargs...) = x
-
-const A{T} = Union{Vector{T}, Matrix{T}}
-
-h_1(x::A) = x
-h_2(x::A{Int}) = x
-h_3(x::A{T}) where {T} = x
-
-i_1(x; y = x) = x * y
-i_2(x::Int; y = x) = x * y
-i_3(x::T; y = x) where {T} = x * y
-i_4(x; y::T = zero(T), z::U = zero(U)) where {T, U} = x + y + z
-
-j_1(x, y) = x * y # two arguments, no keyword arguments
-j_1(x; y = x) = x * y # one argument, one keyword argument
-
-mutable struct T
-    a
-    b
-    c
-end
-
-struct K
-    K(; a = 1) = new()
-end
-
-
-abstract type AbstractType <: Integer end
-
-struct CustomType{S, T <: Integer} <: Integer
-end
-
-primitive type BitType8 8 end
-
-primitive type BitType32 <: Real 32 end
-
+include("TestModule/M.jl")
+
+# initialize a test repo in test/TestModule which is needed for some tests
+function with_test_repo(f)
+    repo = LibGit2.init(joinpath(@__DIR__, "TestModule"))
+    LibGit2.add!(repo, "M.jl")
+    sig = LibGit2.Signature("zeptodoctor", "[email protected]", round(time()), 0)
+    LibGit2.commit(repo, "M.jl", committer = sig, author = sig)
+    LibGit2.GitRemote(repo, "origin", "https://github.com/JuliaDocs/NonExistent.jl.git")
+    try
+        f()
+    finally
+        rm(joinpath(@__DIR__, "TestModule", ".git"); force = true, recursive = true)
+    end
 end
 
 @testset "DocStringExtensions" begin
@@ -136,11 +107,13 @@ end
                 :typesig => Tuple{Any},
                 :module => M,
             )
-            DSE.format(METHODLIST, buf, doc)
+            with_test_repo() do
+                DSE.format(METHODLIST, buf, doc)
+            end
             str = String(take!(buf))
             @test occursin("```julia", str)
             @test occursin("f(x)", str)
-            @test occursin(joinpath("test", "tests.jl"), str)
+            @test occursin(joinpath("test", "TestModule", "M.jl"), str)
         end
 
         @testset "method signatures" begin
@@ -407,9 +380,10 @@ end
         end
         @testset "url" begin
             @test !isempty(DSE.url(first(methods(sin))))
-            @test !isempty(DSE.url(first(methods(DSE.parsedocs))))
-            @test !isempty(DSE.url(first(methods(M.f))))
-            @test !isempty(DSE.url(first(methods(M.K))))
+            with_test_repo() do
+                @test occursin("github.com/JuliaDocs/NonExistent", DSE.url(first(methods(M.f))))
+                @test occursin("github.com/JuliaDocs/NonExistent", DSE.url(first(methods(M.K))))
+            end
         end
         @testset "comparemethods" begin
             let f = first(methods(M.f)),