https://github.com/vercel/busted

Elegant Lua unit testing.
https://github.com/vercel/busted

Last synced: 3 months ago
JSON representation

Elegant Lua unit testing.

• Host: GitHub
• URL: https://github.com/vercel/busted
• Owner: vercel
• License: mit
• Fork: true (lunarmodules/busted)
• Created: 2020-08-11T12:37:25.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-04-20T19:11:31.000Z (over 3 years ago)
• Last Synced: 2024-09-18T03:38:01.406Z (4 months ago)
• Language: Lua
• Homepage: http://olivinelabs.com/busted/
• Size: 1.65 MB
• Stars: 5
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
busted

======

[![travis-ci status](https://secure.travis-ci.org/Olivine-Labs/busted.png)](http://travis-ci.org/Olivine-Labs/busted/builds)

[![Join the chat at https://gitter.im/Olivine-Labs/busted](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/Olivine-Labs/busted?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

busted is a unit testing framework with a focus on being **easy to

use**. Supports Lua >= 5.1, luajit >= 2.0.0, and moonscript.

Check out the [official docs](http://olivinelabs.com/busted) for

extended info.

busted test specs read naturally without being too verbose. You can even

chain asserts and negations, such as `assert.not.equals`. Nest blocks of

tests with contextual descriptions using `describe`, and add tags to

blocks so you can run arbitrary groups of tests.

An extensible assert library allows you to extend and craft your own

assert functions specific to your case with method chaining. A modular

output library lets you add on your own output format, along with the

default pretty and plain terminal output, JSON with and without

streaming, and TAP-compatible output that allows you to run busted specs

within most CI servers.

```lua

describe('Busted unit testing framework', function()

  describe('should be awesome', function()

    it('should be easy to use', function()

      assert.truthy('Yup.')

    end)

    it('should have lots of features', function()

      -- deep check comparisons!

      assert.same({ table = 'great'}, { table = 'great' })

      -- or check by reference!

      assert.is_not.equals({ table = 'great'}, { table = 'great'})

      assert.falsy(nil)

      assert.error(function() error('Wat') end)

    end)

    it('should provide some shortcuts to common functions', function()

      assert.unique({{ thing = 1 }, { thing = 2 }, { thing = 3 }})

    end)

    it('should have mocks and spies for functional tests', function()

      local thing = require('thing_module')

      spy.spy_on(thing, 'greet')

      thing.greet('Hi!')

      assert.spy(thing.greet).was.called()

      assert.spy(thing.greet).was.called_with('Hi!')

    end)

  end)

end)

```

Contributing

------------

See [CONTRIBUTING.md](https://github.com/Olivine-Labs/busted/blob/master/CONTRIBUTING.md).

All issues, suggestions, and most importantly pull requests are welcome.

Testing

-------

You'll need `libev` to run async tests. Then do the following, assuming you

have luarocks installed:

Install these dependencies for core testing:

```

luarocks install copas

luarocks install lua-ev scm --server=http://luarocks.org/repositories/rocks-scm/

luarocks install moonscript

```

(Note: you must have `libev` installed to run `lua-ev`; you can `brew install libev` or `apt-get install libev-dev`)

Then to reinstall and run tests:

```

luarocks remove busted --force

luarocks make

busted spec

```

License

-------

Copyright 2012-2020 Olivine Labs, LLC.

MIT licensed. See [LICENSE for details](https://github.com/Olivine-Labs/busted/blob/master/LICENSE).