refactor: redis queue backend test cleanup
Summary:
- Move existing test under a `testify` Suite as `baseRedisWithServerTestSuite`
- Those tests require real redis server.
- Add `go.uber.org/mock/mockgen@latest` as dependency
- as a tool (Makefile).
- in the `go.mod` file.
- Mock redis client lives under a `mock` directory under the queue module.
- That mock module has an extra hand-written mock in-memory redis-like struct.
- Add tests using the mock redis client.
- Changed the logic around queue provider creation.
- Now the `getNewQueue` returns a Queue provider directly, not an init
function to create it.
The whole Queue module is close to impossible to test properly because
everything is private, everything goes through a struct route. Because
of that, we can't test for example what keys are used for given queue.
To overcome this, as a first step I removed one step from that hard
route by allowing custom calls to create new queue provider. To achieve
this, I moved the creation logic into the `getNewQueue` (previously it
was `getNewQueueFn`). That changes nothing on that side, everything goes
as before, except the `newXXX` call happens directly in that function
and not outside that.
That made it possible to add extra provider specific parameters to those
function (`newXXX`). For example a client on redis. Calling it through
the `getNewQueue` function, it gets `nil`.
- If the provided client is not `nil`, it will use that instead of the
connection string.
- If it's `nil` (default behaviour), it creates a new redis client as it
did before, no changes to that.
The rest of the provider code is unchanged. All these changes were
required to make it possible to generate mock clients for providers and
use them.
For the tests, the existing two test cases are good with redis server,
and they need some extra helpers, for example to start a new redis
server if required, or waiting on a redis server to be ready to use.
These helpers are only required for test cases using real redis server.
For better isolation, moved existing test under a testify Suite, and
moved them into a new test file called `base_redis_with_server_test.go`
because, well they test the code with server. These tests do exactly the
same as before, calling the same sub-tests the same way as before, the
only change is the structure of the test (remove repetition, scope
server related helper functions).
Finally, we can create unit tests without redis server. The main focus of
this group of tests are higher level overview of operations. With the
mock redis client we can set up expectations about used queue names,
received values, return value to simulate faulty state.
These new unit test functions don't test all functionality, at least
it's not aimed for it now. It's more about the possibility of doing that
and add extra tests around parts we couldn't test before, for example
key.
What extra features can test the new unit test group:
- What is the received key for given queue? For example using `prefix`,
or if all the `SXxx` calls are expected to use `queue_unique` if
it's a unique queue.
- If it's not a unique queue, no `SXxx` functions are called, because
those sets are used only to check if a value is unique or not.
- `HasItem` return `false` always if it's a non-unique queue.
- All functions are called exactly `N` times, and we don't have any
unexpected calls to redis from the code.
Signed-off-by: Victoria Nadasdi <victoria@efertone.me>
2024-05-20 19:13:42 +02:00
|
|
|
package queue
|
|
|
|
|
|
|
|
|
|
import (
|
|
|
|
|
"context"
|
|
|
|
|
"os"
|
|
|
|
|
"os/exec"
|
|
|
|
|
"testing"
|
|
|
|
|
"time"
|
|
|
|
|
|
|
|
|
|
"code.gitea.io/gitea/modules/nosql"
|
|
|
|
|
"code.gitea.io/gitea/modules/setting"
|
2024-05-20 21:07:23 +02:00
|
|
|
|
refactor: redis queue backend test cleanup
Summary:
- Move existing test under a `testify` Suite as `baseRedisWithServerTestSuite`
- Those tests require real redis server.
- Add `go.uber.org/mock/mockgen@latest` as dependency
- as a tool (Makefile).
- in the `go.mod` file.
- Mock redis client lives under a `mock` directory under the queue module.
- That mock module has an extra hand-written mock in-memory redis-like struct.
- Add tests using the mock redis client.
- Changed the logic around queue provider creation.
- Now the `getNewQueue` returns a Queue provider directly, not an init
function to create it.
The whole Queue module is close to impossible to test properly because
everything is private, everything goes through a struct route. Because
of that, we can't test for example what keys are used for given queue.
To overcome this, as a first step I removed one step from that hard
route by allowing custom calls to create new queue provider. To achieve
this, I moved the creation logic into the `getNewQueue` (previously it
was `getNewQueueFn`). That changes nothing on that side, everything goes
as before, except the `newXXX` call happens directly in that function
and not outside that.
That made it possible to add extra provider specific parameters to those
function (`newXXX`). For example a client on redis. Calling it through
the `getNewQueue` function, it gets `nil`.
- If the provided client is not `nil`, it will use that instead of the
connection string.
- If it's `nil` (default behaviour), it creates a new redis client as it
did before, no changes to that.
The rest of the provider code is unchanged. All these changes were
required to make it possible to generate mock clients for providers and
use them.
For the tests, the existing two test cases are good with redis server,
and they need some extra helpers, for example to start a new redis
server if required, or waiting on a redis server to be ready to use.
These helpers are only required for test cases using real redis server.
For better isolation, moved existing test under a testify Suite, and
moved them into a new test file called `base_redis_with_server_test.go`
because, well they test the code with server. These tests do exactly the
same as before, calling the same sub-tests the same way as before, the
only change is the structure of the test (remove repetition, scope
server related helper functions).
Finally, we can create unit tests without redis server. The main focus of
this group of tests are higher level overview of operations. With the
mock redis client we can set up expectations about used queue names,
received values, return value to simulate faulty state.
These new unit test functions don't test all functionality, at least
it's not aimed for it now. It's more about the possibility of doing that
and add extra tests around parts we couldn't test before, for example
key.
What extra features can test the new unit test group:
- What is the received key for given queue? For example using `prefix`,
or if all the `SXxx` calls are expected to use `queue_unique` if
it's a unique queue.
- If it's not a unique queue, no `SXxx` functions are called, because
those sets are used only to check if a value is unique or not.
- `HasItem` return `false` always if it's a non-unique queue.
- All functions are called exactly `N` times, and we don't have any
unexpected calls to redis from the code.
Signed-off-by: Victoria Nadasdi <victoria@efertone.me>
2024-05-20 19:13:42 +02:00
|
|
|
"github.com/stretchr/testify/suite"
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
const defaultTestRedisServer = "127.0.0.1:6379"
|
|
|
|
|
|
|
|
|
|
type baseRedisWithServerTestSuite struct {
|
|
|
|
|
suite.Suite
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func TestBaseRedisWithServer(t *testing.T) {
|
|
|
|
|
suite.Run(t, &baseRedisWithServerTestSuite{})
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func (suite *baseRedisWithServerTestSuite) TestNormal() {
|
|
|
|
|
redisAddress := "redis://" + suite.testRedisHost() + "/0"
|
|
|
|
|
queueSettings := setting.QueueSettings{
|
|
|
|
|
Length: 10,
|
|
|
|
|
ConnStr: redisAddress,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
redisServer, accessible := suite.startRedisServer(redisAddress)
|
|
|
|
|
|
|
|
|
|
// If it's accessible, but redisServer command is nil, that means we are using
|
|
|
|
|
// an already running redis server.
|
|
|
|
|
if redisServer == nil && !accessible {
|
|
|
|
|
suite.T().Skip("redis-server not found in Forgejo test yet")
|
|
|
|
|
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
defer func() {
|
|
|
|
|
if redisServer != nil {
|
|
|
|
|
_ = redisServer.Process.Signal(os.Interrupt)
|
|
|
|
|
_ = redisServer.Wait()
|
|
|
|
|
}
|
|
|
|
|
}()
|
|
|
|
|
|
|
|
|
|
testQueueBasic(suite.T(), newBaseRedisSimple, toBaseConfig("baseRedis", queueSettings), false)
|
|
|
|
|
testQueueBasic(suite.T(), newBaseRedisUnique, toBaseConfig("baseRedisUnique", queueSettings), true)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func (suite *baseRedisWithServerTestSuite) TestWithPrefix() {
|
|
|
|
|
redisAddress := "redis://" + suite.testRedisHost() + "/0?prefix=forgejo:queue:"
|
|
|
|
|
queueSettings := setting.QueueSettings{
|
|
|
|
|
Length: 10,
|
|
|
|
|
ConnStr: redisAddress,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
redisServer, accessible := suite.startRedisServer(redisAddress)
|
|
|
|
|
|
|
|
|
|
// If it's accessible, but redisServer command is nil, that means we are using
|
|
|
|
|
// an already running redis server.
|
|
|
|
|
if redisServer == nil && !accessible {
|
|
|
|
|
suite.T().Skip("redis-server not found in Forgejo test yet")
|
|
|
|
|
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
defer func() {
|
|
|
|
|
if redisServer != nil {
|
|
|
|
|
_ = redisServer.Process.Signal(os.Interrupt)
|
|
|
|
|
_ = redisServer.Wait()
|
|
|
|
|
}
|
|
|
|
|
}()
|
|
|
|
|
|
|
|
|
|
testQueueBasic(suite.T(), newBaseRedisSimple, toBaseConfig("baseRedis", queueSettings), false)
|
|
|
|
|
testQueueBasic(suite.T(), newBaseRedisUnique, toBaseConfig("baseRedisUnique", queueSettings), true)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func (suite *baseRedisWithServerTestSuite) startRedisServer(address string) (*exec.Cmd, bool) {
|
|
|
|
|
var redisServer *exec.Cmd
|
|
|
|
|
|
|
|
|
|
if !suite.waitRedisReady(address, 0) {
|
|
|
|
|
redisServerProg, err := exec.LookPath("redis-server")
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, false
|
|
|
|
|
}
|
|
|
|
|
redisServer = &exec.Cmd{
|
|
|
|
|
Path: redisServerProg,
|
|
|
|
|
Args: []string{redisServerProg, "--bind", "127.0.0.1", "--port", "6379"},
|
|
|
|
|
Dir: suite.T().TempDir(),
|
|
|
|
|
Stdin: os.Stdin,
|
|
|
|
|
Stdout: os.Stdout,
|
|
|
|
|
Stderr: os.Stderr,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
suite.Require().NoError(redisServer.Start())
|
|
|
|
|
|
|
|
|
|
if !suite.True(suite.waitRedisReady(address, 5*time.Second), "start redis-server") {
|
|
|
|
|
// Return with redis server even if it's not available. It was started,
|
|
|
|
|
// even if it's not reachable for any reasons, it's still started, the
|
|
|
|
|
// parent will close it.
|
|
|
|
|
return redisServer, false
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return redisServer, true
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func (suite *baseRedisWithServerTestSuite) waitRedisReady(conn string, dur time.Duration) (ready bool) {
|
|
|
|
|
ctxTimed, cancel := context.WithTimeout(context.Background(), time.Second*5)
|
|
|
|
|
defer cancel()
|
|
|
|
|
for t := time.Now(); ; time.Sleep(50 * time.Millisecond) {
|
|
|
|
|
ret := nosql.GetManager().GetRedisClient(conn).Ping(ctxTimed)
|
|
|
|
|
if ret.Err() == nil {
|
|
|
|
|
return true
|
|
|
|
|
}
|
|
|
|
|
if time.Since(t) > dur {
|
|
|
|
|
return false
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func (suite *baseRedisWithServerTestSuite) testRedisHost() string {
|
|
|
|
|
value := os.Getenv("TEST_REDIS_SERVER")
|
|
|
|
|
if value != "" {
|
|
|
|
|
return value
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return defaultTestRedisServer
|
|
|
|
|
}
|