The luamock from filmaj

Testing Framework for Lua - LuaMock

The one lua testing framework that mocks classes, runs with real classes from your project, has nginx embeded methods for openresty individual testing. Has a suite of libraries preinstalled and you can specify libraries to install.

LuaMock runs better in docker than in standalone - all you need to do is pull the image and run it like so

Installing
Usage inside test classes
Dependencies
Contributing

Installing

sudo luarocks make mocka-1.0-1.rockspec
sudo luarocks install luacov

Optional:

sudo luarocks install luacov-coveralls
lua -lluacov run_tests.lua
luacov
luacov-cobertura -o coverage_report.xml

Sugest using:

GitHub Pull Request Coverage Status and Cobertura Plugin

Usage inside test classes

spy(...) - spying and stubbing

Spy whatever classes you want. Spies are reset after each test. And loose whatever stubbing you did. That is why if any stub is needed than it should be declared at beforeEach level. T2 is a global required field in this example - required somewhere else.

Stubs treat even the async nature of nginx - ran on demand

    beforeEach(function()
        spy("test2", "run", function()
            print "Ok"
        end)
    end)
    test('it is', function()
        t2:run()
        calls(spy("test2").run, 1)
    end)

mock(...) - Mocking

Mock whatever methods you want

    local classToMock = mock("path.to.class", {"method1", "method2"})

or mock all the methods dynamic

    local classToMock = mock("path.to.class")

Alter mock behaviour

    local classToMock = mock("path.to.class", {"method1", "method2"})
    when(classToMock).method1.fake(function(arg1, arg2)
        return arg1
    end)

    local classToMock = mock("path.to.class", {"method1", "method2"})
    when(classToMock).method1.doReturn = function(arg1, arg2)
            return arg1
    end

    local classToMock = mock("path.to.class", {"method1", "method2"})
    classToMock.__method1.doReturn = function(arg1, arg2)
        return arg1
    end

The only method that you don't want to alter if you mock is the new function.

test(...) and xtest(...) - Running and Skipping

Running a test

    test('describe what you are testing', function()
        assertEquals(true, true)
    end)

Running a test that throws exception or you know it will fail

    test('describe what you are testing', function()
        assertEquals(true, false)
    end, true)

Skipping a test

    xtest('describe what you are testing', function()
        assertEquals(true, true)
    end)

Assertions

assertEquals

    assertEquals(true, true)

    local one_object = {
        one = 1,
        two = 2
    }
    local second_object = {
        two = 2,
        one = 1
    }
    
    assertEquals(one_object, second_object)

    assertEqualse("string", "string")

    assertEquals(1,1)

    local first_array = {1, 2, 3}
    local second_array = {1, 2, 3}
    assertEquals(first_array, second_array)

assertNotEquals

    local first_array = {1, 2, 3}
    local second_array = {2, 1, 3}
    assertNotEquals(first_array, second_array)

assertNil

    assertNil(x)

assertNotNil

    local x = "string"
    assertNotNil(x)

calls(...) - verify a mock has been called

    local classToMock = mock("class", {"method"})
    calls(classToMock.__method, 1)

    local classToMock = mock("class", {"method"})
    calls(classToMock.__method, 1, arg2, arg1)

Dependencies

This dependencies apply for docker

luacov-cobertura - MIT
luacheck - MIT
ldoc
jsonpath - MIT
lua-cjson - MIT
luabitop - MIT
lua-resty-iputils - MIT

filmaj / luamock Goto Github PK

luamock's Introduction