Rename local var for luatest from lt to t (#11)

This rock should suggest the way of writing tests and follow them itself.

Author: printercu

README.md

@@ -21,33 +21,33 @@ Define tests.
 
 ```lua
 -- test/feature_test.lua
-local luatest = require('luatest')
-local t = luatest.group('feature')
+local t = require('luatest')
+local g = t.group('feature')
 
 -- Define suite hooks. can be called multiple times to define hooks from different files
-luatest.before_suite(function() ... end)
-luatest.before_suite(function() ... end)
+t.before_suite(function() ... end)
+t.before_suite(function() ... end)
 
 -- Hooks to run once for tests group
 -- This hooks run always when test class is changed.
 -- So it may run multiple times when --shuffle otion is used.
-t.before_all = function() ... end
-t.after_all = function() ... end
+g.before_all = function() ... end
+g.after_all = function() ... end
 
 -- Hooks to run for each test in group
-t.setup = function() ... end
-t.teardown = function() ... end
+g.setup = function() ... end
+g.teardown = function() ... end
 
 -- Tests. All properties with name staring with `test` are treated as test cases.
-t.test_example_1 = function() ... end
-t.test_example_n = function() ... end
+g.test_example_1 = function() ... end
+g.test_example_n = function() ... end
 
 -- test/other_test.lua
-local luatest = require('luatest')
-local t = luatest.group('other')
+local t = require('luatest')
+local g = t.group('other')
 -- ...
-t.test_example_2 = function() ... end
-t.test_example_m = function() ... end
+g.test_example_2 = function() ... end
+g.test_example_m = function() ... end
 ```
 
 Run them.

test/capture_test.lua

@@ -1,34 +1,34 @@
-local lt = require('luatest')
-local t = lt.group('capture')
+local t = require('luatest')
+local g = t.group('capture')
 
 local Capture = require('luatest.capture')
 local capture = Capture:new()
 
-t.setup = function() capture:enable() end
-t.teardown = function()
+g.setup = function() capture:enable() end
+g.teardown = function()
     capture:flush()
     capture:disable()
 end
 
-t.test_flush = function()
-    lt.assertEquals(capture:flush(), {stdout = '', stderr = ''})
+g.test_flush = function()
+    t.assertEquals(capture:flush(), {stdout = '', stderr = ''})
     io.stdout:write('test-out')
     io.stderr:write('test-err')
-    lt.assertEquals(capture:flush(), {stdout = 'test-out', stderr = 'test-err'})
-    lt.assertEquals(capture:flush(), {stdout = '', stderr = ''})
+    t.assertEquals(capture:flush(), {stdout = 'test-out', stderr = 'test-err'})
+    t.assertEquals(capture:flush(), {stdout = '', stderr = ''})
 end
 
-t.test_flush_large_strings = function()
-    lt.skip('no support for large strings yet')
+g.test_flush_large_strings = function()
+    t.skip('no support for large strings yet')
     local buffer_size = 65536
     local out = ('a'):rep(buffer_size)
     local err = ('a'):rep(buffer_size + 1)
     io.stdout:write(out)
     io.stderr:write(err)
-    lt.assertEquals(capture:flush(), {stdout = out, stderr = err})
+    t.assertEquals(capture:flush(), {stdout = out, stderr = err})
 end
 
-t.test_wrap = function()
+g.test_wrap = function()
     local test_capture = Capture:new()
     assert(not test_capture.enabled)
     local result = {test_capture:wrap(true, function()
@@ -37,14 +37,14 @@ t.test_wrap = function()
         io.stderr:write('test-err')
         return 'result'
     end)}
-    lt.assertEquals(result, {true, 'result'})
+    t.assertEquals(result, {true, 'result'})
     assert(not test_capture.enabled)
-    lt.assertEquals(capture:flush(), {stdout = '', stderr = ''})
-    lt.assertEquals(test_capture:flush(), {stdout = 'test-out', stderr = 'test-err'})
-    lt.assertEquals(capture:flush(), {stdout = '', stderr = ''})
+    t.assertEquals(capture:flush(), {stdout = '', stderr = ''})
+    t.assertEquals(test_capture:flush(), {stdout = 'test-out', stderr = 'test-err'})
+    t.assertEquals(capture:flush(), {stdout = '', stderr = ''})
 end
 
-t.test_wrap_with_error = function()
+g.test_wrap_with_error = function()
     local test_capture = Capture:new()
     assert(not test_capture.enabled)
     local result = {test_capture:wrap(true, function()
@@ -54,18 +54,18 @@ t.test_wrap_with_error = function()
         invalid() -- luacheck: ignore
         return 'result'
     end)}
-    lt.assertEquals(result, {false})
+    t.assertEquals(result, {false})
     assert(not test_capture.enabled)
     local captured = capture:flush()
-    lt.assertEquals(captured.stdout, '')
-    lt.assertNotStrContains(captured.stderr, 'test-err')
-    lt.assertStrContains(captured.stderr, "attempt to call global 'invalid'")
-    lt.assertStrContains(captured.stderr, 'stack traceback:')
-    lt.assertEquals(test_capture:flush(), {stdout = 'test-out', stderr = 'test-err'})
-    lt.assertEquals(capture:flush(), {stdout = '', stderr = ''})
+    t.assertEquals(captured.stdout, '')
+    t.assertNotStrContains(captured.stderr, 'test-err')
+    t.assertStrContains(captured.stderr, "attempt to call global 'invalid'")
+    t.assertStrContains(captured.stderr, 'stack traceback:')
+    t.assertEquals(test_capture:flush(), {stdout = 'test-out', stderr = 'test-err'})
+    t.assertEquals(capture:flush(), {stdout = '', stderr = ''})
 end
 
-t.test_wrap_nested = function()
+g.test_wrap_nested = function()
     local test_capture = Capture:new()
     assert(not test_capture.enabled)
     test_capture:wrap(true, function()
@@ -80,6 +80,6 @@ t.test_wrap_nested = function()
         assert(test_capture.enabled)
     end)
     assert(not test_capture.enabled)
-    lt.assertEquals(capture:flush(), {stdout = 'test-out-2', stderr = 'test-err-2'})
-    lt.assertEquals(test_capture:flush(), {stdout = 'test-out', stderr = 'test-err'})
+    t.assertEquals(capture:flush(), {stdout = 'test-out-2', stderr = 'test-err-2'})
+    t.assertEquals(test_capture:flush(), {stdout = 'test-out', stderr = 'test-err'})
 end

test/capturing_test.lua

@@ -1,38 +1,38 @@
-local lt = require('luatest')
-local t = lt.group('capturing')
+local t = require('luatest')
+local g = t.group('capturing')
 
 local helper = require('test.helper')
 local Capture = require('luatest.capture')
 local capture = Capture:new()
 
-t.setup = function() capture:enable() end
-t.teardown = function()
+g.setup = function() capture:enable() end
+g.teardown = function()
     capture:flush()
     capture:disable()
 end
 
 local function assert_captured(fn)
     helper.run_suite(fn)
     local captured = capture:flush()
-    lt.assertNotStrContains(captured.stdout, '-test-')
-    lt.assertNotStrContains(captured.stderr, '-test-')
+    t.assertNotStrContains(captured.stdout, '-test-')
+    t.assertNotStrContains(captured.stderr, '-test-')
 end
 
 local function assert_shown(fn)
     helper.run_suite(fn)
     local captured = capture:flush()
-    lt.assertStrContains(captured.stdout, 'Captured stdout:\ntest-out')
-    lt.assertStrContains(captured.stdout, 'Captured stderr:\ntest-err')
-    lt.assertEquals(captured.stderr, '')
+    t.assertStrContains(captured.stdout, 'Captured stdout:\ntest-out')
+    t.assertStrContains(captured.stdout, 'Captured stderr:\ntest-err')
+    t.assertEquals(captured.stderr, '')
 end
 
 local function assert_error(fn)
-    lt.assertEquals(helper.run_suite(fn), 1)
+    t.assertEquals(helper.run_suite(fn), 1)
     local captured = capture:flush()
-    lt.assertStrContains(captured.stderr, 'custom-error')
+    t.assertStrContains(captured.stderr, 'custom-error')
 end
 
-t.test_example = function()
+g.test_example = function()
     assert_captured(function(lu2)
         lu2.group('test').test = function()
             io.stdout:write('-test-')
@@ -41,7 +41,7 @@ t.test_example = function()
     end)
 end
 
-t.test_example_failed = function()
+g.test_example_failed = function()
     assert_shown(function(lu2)
         lu2.group('test').test = function()
             io.stdout:write('test-out')
@@ -51,7 +51,7 @@ t.test_example_failed = function()
     end)
 end
 
-t.test_example_hook = function()
+g.test_example_hook = function()
     assert_captured(function(lu2)
         local group = lu2.group('test')
         group.setup = function()
@@ -63,7 +63,7 @@ t.test_example_hook = function()
     end)
 end
 
-t.test_example_hook_failed = function()
+g.test_example_hook_failed = function()
     assert_shown(function(lu2)
         local group = lu2.group('test')
         group.setup = function()
@@ -95,7 +95,7 @@ t.test_example_hook_failed = function()
 end
 
 
-t.test_class_hook = function()
+g.test_class_hook = function()
     assert_captured(function(lu2)
         local group = lu2.group('test')
         group.before_all = function()
@@ -115,7 +115,7 @@ t.test_class_hook = function()
     end)
 end
 
-t.test_class_hook_failed = function()
+g.test_class_hook_failed = function()
     assert_error(function(lu2)
         local group = lu2.group('test')
         group.before_all = function()
@@ -137,7 +137,7 @@ t.test_class_hook_failed = function()
     end)
 end
 
-t.test_suite_hook = function()
+g.test_suite_hook = function()
     assert_captured(function(lu2)
         local group = lu2.group('test')
         local hook = function()
@@ -150,7 +150,7 @@ t.test_suite_hook = function()
     end)
 end
 
-t.test_suite_hook_failed = function()
+g.test_suite_hook_failed = function()
     assert_error(function(lu2)
         lu2.group('test').test = function() end
         lu2.before_suite(function()

test/helpers_test.lua

@@ -1,40 +1,40 @@
-local lt = require('luatest')
-local t = lt.group('helpers')
+local t = require('luatest')
+local g = t.group('helpers')
 
-local helpers = lt.helpers
+local helpers = t.helpers
 
-t.test_uuid = function()
-    lt.assertEquals(helpers.uuid('a'), 'aaaaaaaa-0000-0000-0000-000000000000')
-    lt.assertEquals(helpers.uuid('ab', 1), 'abababab-0000-0000-0000-000000000001')
-    lt.assertEquals(helpers.uuid(1, 2, 3), '00000001-0002-0000-0000-000000000003')
-    lt.assertEquals(helpers.uuid('1', '2', '3'), '11111111-2222-0000-0000-333333333333')
-    lt.assertEquals(helpers.uuid('12', '34', '56', '78', '90'), '12121212-3434-5656-7878-909090909090')
+g.test_uuid = function()
+    t.assertEquals(helpers.uuid('a'), 'aaaaaaaa-0000-0000-0000-000000000000')
+    t.assertEquals(helpers.uuid('ab', 1), 'abababab-0000-0000-0000-000000000001')
+    t.assertEquals(helpers.uuid(1, 2, 3), '00000001-0002-0000-0000-000000000003')
+    t.assertEquals(helpers.uuid('1', '2', '3'), '11111111-2222-0000-0000-333333333333')
+    t.assertEquals(helpers.uuid('12', '34', '56', '78', '90'), '12121212-3434-5656-7878-909090909090')
 end
 
-t.test_rescuing = function()
+g.test_rescuing = function()
     local retry = 0
     local result = helpers.retrying({}, function(a, b)
-        lt.assertEquals(a, 1)
-        lt.assertEquals(b, 2)
+        t.assertEquals(a, 1)
+        t.assertEquals(b, 2)
         retry = retry + 1
         if (retry < 3) then
             error('test')
         end
         return 'result'
     end, 1, 2)
-    lt.assertEquals(retry, 3)
-    lt.assertEquals(result, result)
+    t.assertEquals(retry, 3)
+    t.assertEquals(result, result)
 end
 
-t.test_rescuing_failure = function()
+g.test_rescuing_failure = function()
     local retry = 0
-    lt.assertErrorMsgContains('test-error', function()
+    t.assertErrorMsgContains('test-error', function()
         helpers.retrying({delay = 0.1, timeout = 0.5}, function(a, b)
-            lt.assertEquals(a, 1)
-            lt.assertEquals(b, 2)
+            t.assertEquals(a, 1)
+            t.assertEquals(b, 2)
             retry = retry + 1
             error('test-error')
         end, 1, 2)
     end)
-    lt.assertAlmostEquals(retry, 6, 1)
+    t.assertAlmostEquals(retry, 6, 1)
 end