feat(*): add --name, --exclude-names-file and --log-success options

busted/modules/cli.lua

@@ -129,7 +129,10 @@ return function(options)
   cli:option('-t, --tags=TAGS', 'only run tests with these #tags', {}, processList)
   cli:option('--exclude-tags=TAGS', 'do not run tests with these #tags, takes precedence over --tags', {}, processList)
   cli:option('--filter=PATTERN', 'only run test names matching the Lua pattern', {}, processMultiOption)
+  cli:option('--name=NAME', 'run test with the given full name', {}, processMultiOption)
   cli:option('--filter-out=PATTERN', 'do not run test names matching the Lua pattern, takes precedence over --filter', {}, processMultiOption)
+  cli:option('--exclude-names-file=FILE', 'do not run the tests with names listed in the given file, takes precedence over --filter', nil, processOption)
+  cli:option('--log-success=FILE', 'append the name of each successful test to the given file', nil, processOption)
   cli:option('-m, --lpath=PATH', 'optional path to be prefixed to the Lua module search path', lpathprefix, processPath)
   cli:option('--cpath=PATH', 'optional path to be prefixed to the Lua C module search path', cpathprefix, processPath)
   cli:option('-r, --run=RUN', 'config to run from .busted file', nil, processOption)

busted/modules/filter_loader.lua

@@ -46,6 +46,31 @@ return function()
       return nil, true
     end
 
+    local excludeNames = {}
+    if options.excludeNamesFile then
+      for name in io.lines(options.excludeNamesFile) do
+        table.insert(excludeNames, name)
+      end
+    end
+
+    local excludeNamesFile = function(name)
+      for _, filter in ipairs(excludeNames) do
+        if getFullName(name) == filter then
+          return nil, false
+        end
+      end
+      return nil, true
+    end
+
+    local name = function(name)
+      for _, candidate in pairs(options.name) do
+        if string.find(candidate, getFullName(name), 1, true) then
+          return nil, true
+        end
+      end
+      return nil, (#options.name == 0)
+    end
+
     local filterNames = function(name)
       for _, filter in pairs(options.filter) do
         if getFullName(name):find(filter) ~= nil then
@@ -122,10 +147,12 @@ return function()
     applyFilter({ 'file', 'describe', 'it', 'pending' }, 'nokeepgoing', skipOnError)
 
     -- The following filters are applied in reverse order
-    applyFilter({ 'it', 'pending' }            , 'filter'     , filterNames      )
-    applyFilter({ 'describe', 'it', 'pending' }, 'filterOut'  , filterOutNames   )
-    applyFilter({ 'it', 'pending' }            , 'tags'       , filterTags       )
-    applyFilter({ 'describe', 'it', 'pending' }, 'excludeTags', filterExcludeTags)
+    applyFilter({ 'it', 'pending' }            , 'filter'          , filterNames           )
+    applyFilter({ 'describe', 'it', 'pending' }, 'name'            , name                  )
+    applyFilter({ 'describe', 'it', 'pending' }, 'filterOut'       , filterOutNames        )
+    applyFilter({ 'describe', 'it', 'pending' }, 'excludeNamesFile', excludeNamesFile      )
+    applyFilter({ 'it', 'pending' }            , 'tags'            , filterTags            )
+    applyFilter({ 'describe', 'it', 'pending' }, 'excludeTags'     , filterExcludeTags     )
   end
 
   return filter

busted/runner.lua

@@ -154,12 +154,36 @@ return function(options)
     end
   end
 
+  local getFullName = function(name)
+    local parent = busted.context.get()
+    local names = { name }
+
+    while parent and (parent.name or parent.descriptor) and
+      parent.descriptor ~= 'file' do
+      table.insert(names, 1, parent.name or parent.descriptor)
+      parent = busted.context.parent(parent)
+    end
+
+    return table.concat(names, ' ')
+  end
+
+  if cliArgs['log-success'] then
+    local logFile = assert(io.open(cliArgs['log-success'], 'a'))
+    busted.subscribe({ 'test', 'end' }, function (test, parent, status)
+      if status == "success" then
+        logFile:write(getFullName() .. "\n")
+      end
+    end)
+  end
+
   -- Load tag and test filters
   filterLoader(busted, {
     tags = cliArgs.tags,
     excludeTags = cliArgs['exclude-tags'],
     filter = cliArgs.filter,
+    name = cliArgs.name,
     filterOut = cliArgs['filter-out'],
+    excludeNamesFile = cliArgs['exclude-names-file'],
     list = cliArgs.list,
     nokeepgoing = not cliArgs['keep-going'],
     suppressPending = cliArgs['suppress-pending'],

completions/bash/busted.bash

@@ -136,10 +136,14 @@ _busted() {
       # no completion available
       return 0
       ;;
-    --filter|--filter-out)
+    --filter|--filter-out|--name)
       # no completion available
       return 0
       ;;
+    --exclude-names-file|--log-success)
+      _filedir
+      return 0
+      ;;
     -m|--lpath|--cpath)
       _filedir -d
       return 0
@@ -175,10 +179,13 @@ _busted() {
       --lua=
       --ignore-lua
       --filter= --filter-out=
+      --name=
+      --exclude-names-file=
       --repeat=
       --seed=
       --lang=
       --loaders=
+      --log-success
       --helper=
       -c --coverage --no-coverage
       -s --enable-sound --no-enable-sound

completions/zsh/_busted

@@ -56,6 +56,9 @@ _busted_args=(
 "--exclude-tags=[Do not run tests with these #tags, takes precedence over --tags]: :"
 "--filter=[Only run test names matching the Lua pattern]: :"
 "--filter-out=[Do not run test names matching the Lua pattern, takes precedence over --filter]: :"
+"--exclude-names-file=[Do not run the tests with names listed in the given file, takes precedence over --filter]:files:_files"
+"--name=[Run test with the given full name]:files:_files"
+"--log-success=[Append the name of each successful test to the given file]:file:_files"
 "-e[Execute Lua statement]: :"
 "(-v --verbose --no-verbose)"{-v,--verbose}"[Verbose output of errors]"
 "(-v --verbose --no-verbose)--no-verbose[Disable verbose output of errors]"

spec/cl_spec.lua

@@ -135,6 +135,28 @@ describe('Tests the busted command-line options', function()
     assert.is_true(success)
   end)
 
+  local function count_successes(out)
+    local count = 0
+    for successes in out:gmatch('(%d+) success') do
+      count = count + successes
+    end
+    return count
+  end
+
+  it('tests running with --log-success and --exclude-names-file specified', function ()
+    local logfile = os.tmpname()
+    local success, errcnt, out = executeBusted('--pattern=_filter.lua$ --log-success=' .. logfile .. ' --exclude-names-file=' .. logfile)
+    assert.is_false(success)
+    assert.equals(8, errcnt)
+    assert.equals(2, count_successes(out))
+    -- re-run tests with previously successful tests skipped
+    success, errcnt, out = executeBusted('--pattern=_filter.lua$ --log-success=' .. logfile .. ' --exclude-names-file=' .. logfile)
+    assert.is_false(success)
+    assert.equals(8, errcnt)
+    assert.equals(0, count_successes(out))
+    os.remove(logfile)
+  end)
+
   it('tests running with --filter specified in describe', function ()
     local success, errcnt = executeBusted('--pattern=_filter.lua$ --filter="patt1"')
     assert.is_false(success)

try

@@ -1,4 +1,4 @@
 #!/bin/sh
 luarocks remove busted --force
 luarocks make
-LUA_PATH="./?.lua;./?/init.lua;./src/?/?.lua;./src/?/init.lua;$LUA_PATH" busted $@
+LUA_PATH="./?.lua;./?/init.lua;$LUA_PATH" busted "$@"