|
| 1 | +"Tags starting with this identifier are broken. Remove upon fix." |
| 2 | +const brokenidentifiers = ( |
| 3 | + "deprecated_returnsquarepower", |
| 4 | + "deprecated_squarepower", |
| 5 | + "DocTestSetup", |
| 6 | + "printgreeting", |
| 7 | + "returnsquarepower", |
| 8 | +) |
| 9 | +"Kinds that have not been added yet (and are therefore broken). Remove upon fix." |
| 10 | +const brokenkinds = ('m', 's') |
| 11 | + |
| 12 | +"Path to Ctags configuration file (the parser)." |
| 13 | +const ctagsconfigpath = joinpath(@__DIR__, "..", "ctags") |
| 14 | +"Test file to generate the tags from." |
| 15 | +const testfilepath = joinpath(@__DIR__, "testfile.jl") |
| 16 | +"File containing test tags to compare against." |
| 17 | +const testtagspath = joinpath(@__DIR__, "testtags") |
| 18 | + |
| 19 | +"Ctags binaries to sequentially try to call if one is not found." |
| 20 | +const ctagsbins = ( |
| 21 | + "uctags", |
| 22 | + "ectags", |
| 23 | + "universal-ctags", |
| 24 | + "exuberant-ctags", |
| 25 | + "u-ctags", |
| 26 | + "e-ctags", |
| 27 | +) |
| 28 | +"Arguments to pass to a Ctags binary." |
| 29 | +const ctagsargs = ( |
| 30 | + "--options=$ctagsconfigpath", # Include our tags file. |
| 31 | + "-f -" # Write to stdout. |
| 32 | +) |
| 33 | + |
| 34 | + |
| 35 | +"Utility function to convert an `AbstractVector` of tags to a common format." |
| 36 | +function converttags(tags::AbstractVector) |
| 37 | + tags = filter(s -> !isempty(s) && s[1] != '!', tags) |
| 38 | + Set(tags) |
| 39 | +end |
| 40 | + |
| 41 | +"Return tags generatad from the given file and convert them using [`converttags`](@ref)." |
| 42 | +function generatetags(testfile::AbstractString, ctagsbin::AbstractString="ctags") |
| 43 | + ctagscmd = `$ctagsbin $ctagsargs $testfile` |
| 44 | + tags = open(ctagscmd, "r", stdout) do io |
| 45 | + readlines(io) |
| 46 | + end |
| 47 | + return converttags(tags) |
| 48 | +end |
| 49 | + |
| 50 | +function trygeneratetags(testfile::AbstractString) |
| 51 | + local tags |
| 52 | + try |
| 53 | + tags = generatetags(testfile, ctagsbins[1]) |
| 54 | + catch LoadError |
| 55 | + success = false |
| 56 | + ctagsbinindex = 2 |
| 57 | + |
| 58 | + while !success |
| 59 | + try |
| 60 | + tags = generatetags(testfile, ctagsbins[ctagsbinindex]) |
| 61 | + success = true |
| 62 | + catch LoadError |
| 63 | + ctagsbinindex += 1 |
| 64 | + end |
| 65 | + end |
| 66 | + end |
| 67 | + return tags |
| 68 | +end |
| 69 | + |
| 70 | +""" |
| 71 | +Return tags to compare against. |
| 72 | +The desired output of the Ctags program applied to [`testfilepath`](@ref). |
| 73 | +""" |
| 74 | +function gettargettags(testtags::AbstractString) |
| 75 | + tags = readlines(testtags) |
| 76 | + converttags(tags) |
| 77 | +end |
| 78 | + |
| 79 | + |
| 80 | +"Return the path listed in the output tags." |
| 81 | +function getpath(outputs) |
| 82 | + refoutput = pop!(outputs) |
| 83 | + push!(outputs, refoutput) |
| 84 | + path = split(refoutput, '\t')[2] |
| 85 | +end |
| 86 | + |
| 87 | +"Return whether the given tag should be evaluated using [`test_broken`](@ref)." |
| 88 | +function isbroken(target) |
| 89 | + columns = split(target, '\t') |
| 90 | + return columns[1] in brokenidentifiers || columns[4][1] in brokenkinds |
| 91 | +end |
| 92 | + |
| 93 | +"Replace the path listed in the given tag with the given path." |
| 94 | +function replacepath(tag, path) |
| 95 | + arraytag = split(tag, '\t') |
| 96 | + arraytag[2] = path |
| 97 | + return join(arraytag, '\t') |
| 98 | +end |
| 99 | + |
| 100 | + |
| 101 | +""" |
| 102 | +Test whether the given target is in the given outputs. |
| 103 | +The target's listed path is replaced with `outputpath` to ensure static tests. |
| 104 | +""" |
| 105 | +function test_target_in_outputs(target, outputs, outputpath) |
| 106 | + target = replacepath(target, outputpath) |
| 107 | + target_in_outputs = target in outputs |
| 108 | + |
| 109 | + if isbroken(target) |
| 110 | + println("testing broken tag: ", target) |
| 111 | + result = @test_broken target_in_outputs |
| 112 | + else |
| 113 | + println("testing tag: ", target) |
| 114 | + result = @test target_in_outputs |
| 115 | + end |
| 116 | + target_in_outputs && delete!(outputs, target) |
| 117 | +end |
| 118 | + |
| 119 | +"Test the two given tags against each other." |
| 120 | +function testtags(targets, outputs) |
| 121 | + outputpath = getpath(outputs) |
| 122 | + @testset "Tags" begin |
| 123 | + for target in targets |
| 124 | + test_target_in_outputs(target, outputs, outputpath) |
| 125 | + end |
| 126 | + @test_broken isempty(outputs) |
| 127 | + end |
| 128 | +end |
| 129 | + |
0 commit comments