test: add and improve tests in Lua

Remove `test.sh`.

Vendor the lester test framework.

Author: dbohdan

.github/workflows/ci.yml

@@ -35,4 +35,4 @@ jobs:
           version: ${{ matrix.os.version }}
           shell: bash
           run: |
-            sudo ./test.sh
+            sudo ./tests.lua

Makefile

@@ -1,4 +1,4 @@
-FILES := lsblk.lua
+FILES := lsblk.lua tests.lua
 
 .PHONY: check
 check: format lint

test.sh

@@ -0,0 +1,113 @@
+#! /usr/libexec/flua
+-- Tests for lsblk.lua.
+--
+-- Copyright (c) 2025 D. Bohdan
+--
+-- Redistribution and use in source and binary forms, with or without
+-- modification, are permitted provided that the following conditions
+-- are met:
+-- 1. Redistributions of source code must retain the above copyright
+--    notice, this list of conditions and the following disclaimer.
+-- 2. Redistributions in binary form must reproduce the above copyright
+--    notice, this list of conditions and the following disclaimer in the
+--    documentation and/or other materials provided with the distribution.
+--
+-- THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+-- ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+-- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+-- ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+-- FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+-- DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+-- OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+-- HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+-- LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+-- OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+-- SUCH DAMAGE.
+
+local lester = require("vendor/lester/lester")
+local describe, it, expect = lester.describe, lester.it, lester.expect
+
+lester.parse_args()
+
+local function run(cmd)
+	local f = io.popen(cmd .. " 2>&1", "r")
+	local output = f:read("*a")
+	local _, _, code = f:close()
+	return code, output
+end
+
+describe("lsblk.lua", function()
+	describe("CLI options", function()
+		it("should show help", function()
+			local code, output = run("./lsblk.lua -h")
+
+			expect.equal(code, 0)
+			expect.truthy(output:find("List information about block devices"))
+			expect.truthy(output:find("--help"))
+			expect.truthy(output:find("--version"))
+		end)
+
+		it("should show version", function()
+			local code, output = run("./lsblk.lua -V")
+
+			expect.equal(code, 0)
+			expect.truthy(output:match("^%d+%.%d+%.%d+\n$"))
+		end)
+
+		it("should reject invalid options", function()
+			local code, output = run("./lsblk.lua -Q")
+
+			expect.equal(code, 2)
+			expect.truthy(output:find("invalid option"))
+		end)
+
+		it("should reject positional arguments", function()
+			local code, output = run("./lsblk.lua /dev/ada0")
+
+			expect.equal(code, 2)
+			expect.truthy(output:find("arguments"))
+		end)
+	end)
+
+	describe("output formats", function()
+		it("should show default output", function()
+			local code, output = run("./lsblk.lua")
+
+			expect.equal(code, 0)
+			expect.truthy(
+				output:find("NAME +MAJ:MIN +SIZE +TYPE +FSTYPE +MOUNTPOINTS\n")
+			)
+			expect.truthy(output:find("disk"))
+			expect.truthy(output:find("part"))
+		end)
+
+		it("should show byte output", function()
+			local code, output = run("./lsblk.lua -b")
+
+			expect.equal(code, 0)
+			expect.truthy(output:find(" %d+ disk"))
+		end)
+
+		it("should show geom output", function()
+			local code, output = run("./lsblk.lua -g")
+
+			expect.equal(code, 0)
+			expect.truthy(output:find("NAME"))
+			expect.truthy(output:find("disk"))
+			-- Should filter out ZFS.
+			expect.falsy(output:find("zfs"))
+		end)
+
+		it("should show ZFS output", function()
+			local code, output = run("./lsblk.lua -z")
+
+			-- Only compare the code and the header
+			-- because the test machine may not have ZFS pools.
+			expect.equal(code, 0)
+			expect.truthy(output:find("NAME"))
+		end)
+	end)
+end)
+
+lester.report()
+lester.exit()

tests.lua

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021-2023 Eduardo Bart (https://github.com/edubart)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

vendor/lester/LICENSE

@@ -0,0 +1,120 @@
+# Lester
+
+Minimal Lua test framework.
+
+Lester is a minimal unit testing framework for Lua with a focus on being simple to use.
+
+It is highly inspired by
+[Busted](http://olivinelabs.com/busted/) and [Lust](https://github.com/bjornbytes/lust).
+It was mainly created to replace Busted without dependencies in the
+[Nelua](https://github.com/edubart/nelua-lang) compiler.
+
+[![asciicast](https://asciinema.org/a/GihfI07vCt9Q7cvL6xCtnoNl1.svg)](https://asciinema.org/a/GihfI07vCt9Q7cvL6xCtnoNl1)
+
+## Features
+
+* Minimal, just one file.
+* Self contained, no external dependencies.
+* Simple and hackable when needed.
+* Use `describe` and `it` blocks to describe tests.
+* Supports `before` and `after` handlers.
+* Supports marking tests as disabled to be skipped.
+* Colored output.
+* Configurable via the script or with environment variables.
+* Quiet mode, to use in live development.
+* Optionally filter tests by name.
+* Show traceback on errors.
+* Show time to complete tests.
+* Works with Lua 5.1+.
+* Efficient.
+
+## Usage
+
+Copy `lester.lua` file to a project and require it,
+which returns a table that includes all of the functionality:
+
+```lua
+local lester = require 'lester'
+local describe, it, expect = lester.describe, lester.it, lester.expect
+
+-- Customize lester configuration.
+lester.show_traceback = false
+
+describe('my project', function()
+  lester.before(function()
+    -- This function is run before every test.
+  end)
+
+  describe('module1', function() -- Describe blocks can be nested.
+    it('feature1', function()
+      expect.equal('something', 'something') -- Pass.
+    end)
+
+    it('feature2', function()
+      expect.truthy(false) -- Fail.
+    end)
+
+    local feature3_test_enabled = false
+    it('feature3', function() -- This test will be skipped.
+      expect.truthy(false) -- Fail.
+    end, feature3_test_enabled)
+  end)
+end)
+
+lester.report() -- Print overall statistic of the tests run.
+lester.exit() -- Exit with success if all tests passed.
+```
+
+## Customizing output with environment variables
+
+To customize the output of lester externally,
+you can set the following environment variables before running a test suite:
+
+* `LESTER_QUIET="true"`, omit print of passed tests.
+* `LESTER_COLORED="false"`, disable colored output.
+* `LESTER_SHOW_TRACEBACK="false"`, disable traceback on test failures.
+* `LESTER_SHOW_ERROR="false"`, omit print of error description of failed tests.
+* `LESTER_STOP_ON_FAIL="true"`, stop on first test failure.
+* `LESTER_UTF8TERM="false"`, disable printing of UTF-8 characters.
+* `LESTER_FILTER="some text"`, filter the tests that should be run.
+
+Note that these configurations can be changed via script too, check the documentation.
+
+## Customizing output with command line arguments
+
+You can also customize output using command line arguments
+if `lester.parse_args()` is called at startup.
+
+The following command line arguments are available:
+
+* `--quiet`, omit print of passed tests.
+* `--no-quiet`, show print of passed tests.
+* `--no-color`, disable colored output.
+* `--no-show-traceback`, disable traceback on test failures.
+* `--no-show-error`, omit print of error description of failed tests.
+* `--stop-on-fail`, stop on first test failure.
+* `--no-utf8term`, disable printing of UTF-8 characters.
+* `--filter="some text"`, filter the tests that should be run.
+
+## Documentation
+
+The full API reference and documentation can be viewed in the
+[documentation website](https://edubart.github.io/lester/).
+
+## Install
+
+You can use luarocks to install quickly:
+
+```bash
+luarocks install lester
+```
+
+Or just copy the `lester.lua` file, the library is self contained in this single file with no dependencies.
+
+## Tests
+
+To check if everything is working as expected under your machine run `lua tests.lua` or `make test`.
+
+## License
+
+MIT, see LICENSE for details.