WIP: Add server unit testing #73

luca0N · 2026-05-12T23:21:52Z

luca0N commented

2026-05-12 23:21:52 +00:00

Create tests in the server project, as required by issue #11.

account.go
api.go
config.go
crypto.go
db.go
env.go
lib.go
main.go
net.go
ws.go

Create tests in the server project, as required by issue #11. - [x] `account.go` - [ ] `api.go` - [x] `config.go` - [x] `crypto.go` - [x] `db.go` - [x] `env.go` - [ ] `lib.go` - [ ] `main.go` - [x] `net.go` - [x] `ws.go`

luca0N added the

Priority

Low

Kind/Testing

labels

2026-05-12 23:21:52 +00:00

luca0N self-assigned this

2026-05-12 23:21:52 +00:00

luca0N added 1 commit

2026-05-12 23:21:52 +00:00

Add server unit testing for `account.go' a4e2ed0545

Create tests for private functions in the `account.go' source file.

luca0N added 1 commit

2026-05-13 22:35:04 +00:00

Add server unit testing for `net.go' 4142a97b60

Create tests for private functions in the `net.go' source file.  The
`isHostAuthorized()` function has been omitted in the tests for this
commit, as it requires configuration parsing.

luca0N added 1 commit

2026-05-15 11:16:12 +00:00

Add server unit testing for `crypto.go' de0caf1619

Create tests for private functions in the `crypto.go' source file, and
add new variable to `crypto.go' to prevent double initialization via
`initCrypto()'.

luca0N added 1 commit

2026-05-17 16:41:58 +00:00

Add unit testing for `config.go' and fix bug 0e3909aee4

Create tests for private functions in the `config.go' source file, and
fix an issue which caused the default value for the
`config.Accounts.RequireAuth' option to be `true' instead of `false'.

luca0N added 2 commits

2026-05-18 11:26:13 +00:00

Add server unit testing for `ws.go' f8887fc709

Create tests for some functions in the `ws.go' source file.  Functions
that require mocking (those that invoke `net/http', WebSockets, and
`db.go') have not been worked on for now, and will be addressed in a
future commit.

Move server line break to separate print call 042b0a1562

Instead of printing with a `\n' line break at the end of a string when
calling `fmt.Println', remove it and call the function with an empty
string afterwards.  This is needed, as `go test' complains about the
extra line break being unneeded (which, in this case, it wasn't).

luca0N commented

2026-05-18 11:27:45 +00:00

Some testing will require mocks to simulate things like database connections, and WebSocket connections.

luca0N added a new dependency

2026-05-18 11:28:07 +00:00

#11 Add tests

luca0N added 1 commit

2026-05-19 23:12:58 +00:00

Add server unit testing for `env.go' 43a674eb9e

Create a test for a function in the `env.go' source file.  Since
environment key values are retrived using the `os' package from the Go
standard library directly, the main function for the source file was not
included in the test.

luca0N added 1 commit

2026-06-01 23:56:16 +00:00

Add server unit testing for `db.go' 3a10348c08

Create tests for functions in the `db.go' source file by adding
`go-sqlmock' as a new dependency.  SQL statements are now mocked in this
new source file for unit tests.

luca0N reviewed

2026-06-02 11:11:53 +00:00

luca0N left a comment

Some changes are needed in this file.

server/db_test.go

					
				@ -0,0 +63,4 @@

					rows := sqlmock.NewRows([]string{"id"}).

							AddRow(id)

					// FIXME: make this a LIMIT 1!

					mock.ExpectQuery("SELECT id FROM users WHERE username = (.+);").WillReturnRows(rows)

As the comment suggests, this (and the original source file from which this statement was based upon) need to be updated to include LIMIT 1.

As the comment suggests, this (and the original source file from which this statement was based upon) need to be updated to include `LIMIT 1`.

luca0N marked this conversation as resolved

server/db_test.go

					
				@ -0,0 +77,4 @@

					// TODO: actually check the sessionToken in the query

					rows := sqlmock.NewRows([]string{"user_id"}).

							AddRow(userId)

					mock.ExpectQuery(`SELECT user_id FROM sessions WHERE token = UNHEX(\(.+)\) LIMIT 1;`).WillReturnRows(rows)

This whole source file makes use of regular expressions for expected statements. A lot of them could use some work to account for the testing of more issues, with this token being an example. The expected query should contain sessionToken.

This whole source file makes use of regular expressions for expected statements. A lot of them could use some work to account for the testing of more issues, with this `token` being an example. The expected query should contain `sessionToken`.

Fixed by using .WithArgs().

Fixed by using `.WithArgs()`.

luca0N marked this conversation as resolved

server/db_test.go

					
				@ -0,0 +118,4 @@

				func TestCheckSchema(t *testing.T) {

					mock, err := initDatabaseMock()

					if err != nil {

						t.Errorf(`initDatabaseMock() = "%s", want nil`, err)

The possibility of using the %v format for errors should be evaluated. Additionally, having the error message in quotes here is misleading, as it could imply that the function has returned a string type instead of an error.

The possibility of using the `%v` format for errors should be evaluated. Additionally, having the error message in quotes here is misleading, as it could imply that the function has returned a string type instead of an error.

luca0N marked this conversation as resolved

server/db_test.go

					
				@ -0,0 +125,4 @@

					mockCheckDatabaseSchemaExists(mock)

					mockGetDatabaseSchemaVersion(mock)

					checkSchema()

To preserve consistency with the rest of the file, the blank line between the mock functions and checkSchema() must be removed.

To preserve consistency with the rest of the file, the blank line between the mock functions and `checkSchema()` must be removed.

luca0N marked this conversation as resolved

luca0N added 1 commit

2026-06-03 11:18:04 +00:00

Refactor `db.go' unit tests 4d9c4ab45a

Refactor unit tests for the `db.go' source file.  This commit makes SQL
mocks more strict by adding argument constraints (where possible), and
adds `LIMIT 1' to a query statement, which only expects upwards of one
result.

luca0N added 1 commit

2026-06-04 14:08:55 +00:00

Add API preflight response tests bbb374acc1

Add unit testing functions that check the preflight response for API
endpoints in the server.

luca0N added 1 commit

2026-06-05 11:15:22 +00:00

Add API route support tests and header checks 9f736b50b4

Add new unit testing functions to check for API route support (since
some of them may be disabled depending on the server configuration), add
checks for common headers (that must be present in all responses), and
perform some minor code refactoring by creating a new common internal
function (`checkPreflight').

luca0N reviewed

2026-06-05 11:18:27 +00:00

server/api_test.go Outdated

					
				@ -0,0 +84,4 @@

						return fmt.Errorf(`len(data) = %d, want 0`, len(data))

					}

					got := res.Header.Get("Access-Control-Allow-Methods")

This function should check for other preflight headers, such as Access-Control-Allow-Origin, and Access-Control-Allow-Headers.

Additionally, this function should also check for a 204 No Content response status code.

This function should check for other preflight headers, such as `Access-Control-Allow-Origin`, and `Access-Control-Allow-Headers`. Additionally, this function should also check for a 204 No Content response status code.

luca0N changed title from ~~Add server unit testing~~ to WIP: Add server unit testing

2026-06-05 11:19:08 +00:00

luca0N added 1 commit

2026-06-06 23:51:09 +00:00

Test API routes with malformed requests 2a3d557720

Add new test functions that send malformed requests to the API route
handler functions, and checks whether their behavior is expected (which
is to fail with an HTTP 400 Bad Request status code, and the response
should have LANBASSADOR_RESPONSE_CODE_ERROR_MALFORMED_REQUEST as the
`response_code' field).

There were two tests created for both the `/account' and `/session'
routes, one that sends a request with payload but without the
Content-Type header, and another that does the opposite: it sends a
request without a payload, and correctly sets the Content-Type header.

At this time, the two tests that send empty request payloads will fail,
as there seems to be an issue with their respective API route request
handlers.  This issue will be addressed in a separate commit.

luca0N reviewed

2026-06-06 23:52:58 +00:00

server/api_test.go

					
				@ -0,0 +297,4 @@

					if err != nil || !got {

						t.Errorf(`checkEndpointMalformed(%v, "%s", %v) = (%t, %v), want (true, nil)`, http.HandlerFunc(handleEndpointApiSession), contentType, payloadBytes, got, err)

					}

				}

Both the TestEndpointApiAccountPostNoPayload and the TestEndpointApiSessionPostNoPayload tests fail, as explained in the commit message for 2a3d557720.

The issue needs to be investigated.

Both the `TestEndpointApiAccountPostNoPayload` and the `TestEndpointApiSessionPostNoPayload` tests fail, as explained in the commit message for 2a3d557720eee2426b03e425da139d993552dc8e. The issue needs to be investigated.

luca0N added 2 commits

2026-06-07 19:59:02 +00:00

Add test checks for all CORS headers 69df41ff16

Add missing code that checks for all CORS headers set in preflight
requests.

This code does not check for CORS headers set in non-preflight requests.

Fix 500 status code on malformed request JSON payloads 84fc5916cc

Fix an issue which caused the server to incorrectly send API responses
indicating an internal server error to requests with malformed JSON
payloads.

This commit fixes the issue mentioned in
2a3d557720.

This pull request is marked as a work in progress.

This branch is out-of-date with the base branch

View command line instructions