Skip to content

Commit 45c722b

Browse files
RichardKnopRichardKnop
authored
Merge pull request #464 from RichardKnop/fix-mongodb-backend-factory-test-issue
fix: fixed a unit test which actually tried to connect to mongo
2 parents 7b1dc90 + a819600 commit 45c722b

3 files changed

Lines changed: 52 additions & 32 deletions

File tree

‎v1/backends/mongo/mongodb.go‎

Lines changed: 41 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,33 +6,36 @@ import (
66
"fmt"
77
"reflect"
88
"strings"
9+
"sync"
910
"time"
1011

12+
"go.mongodb.org/mongo-driver/bson"
13+
"go.mongodb.org/mongo-driver/mongo"
14+
"go.mongodb.org/mongo-driver/mongo/options"
15+
1116
"github.com/RichardKnop/machinery/v1/backends/iface"
1217
"github.com/RichardKnop/machinery/v1/common"
1318
"github.com/RichardKnop/machinery/v1/config"
1419
"github.com/RichardKnop/machinery/v1/log"
1520
"github.com/RichardKnop/machinery/v1/tasks"
16-
"go.mongodb.org/mongo-driver/bson"
17-
"go.mongodb.org/mongo-driver/mongo"
18-
"go.mongodb.org/mongo-driver/mongo/options"
1921
)
2022

2123
// Backend represents a MongoDB result backend
2224
type Backend struct {
2325
common.Backend
24-
client *mongo.Client
25-
tasksCollection *mongo.Collection
26-
groupMetasCollection *mongo.Collection
26+
client *mongo.Client
27+
tc *mongo.Collection
28+
gmc *mongo.Collection
29+
once sync.Once
2730
}
2831

2932
// New creates Backend instance
3033
func New(cnf *config.Config) (iface.Backend, error) {
31-
backend := &Backend{Backend: common.NewBackend(cnf)}
32-
err := backend.connect()
33-
if err != nil {
34-
return nil, err
34+
backend := &Backend{
35+
Backend: common.NewBackend(cnf),
36+
once: sync.Once{},
3537
}
38+
3639
return backend, nil
3740
}
3841

@@ -43,7 +46,7 @@ func (b *Backend) InitGroup(groupUUID string, taskUUIDs []string) error {
4346
TaskUUIDs: taskUUIDs,
4447
CreatedAt: time.Now().UTC(),
4548
}
46-
_, err := b.groupMetasCollection.InsertOne(context.Background(), groupMeta)
49+
_, err := b.groupMetasCollection().InsertOne(context.Background(), groupMeta)
4750
return err
4851
}
4952

@@ -94,7 +97,7 @@ func (b *Backend) TriggerChord(groupUUID string) (bool, error) {
9497
},
9598
}
9699

97-
_, err := b.groupMetasCollection.UpdateOne(context.Background(), query, change, options.Update())
100+
_, err := b.groupMetasCollection().UpdateOne(context.Background(), query, change, options.Update())
98101

99102
if err != nil {
100103
if err == mongo.ErrNoDocuments {
@@ -175,7 +178,7 @@ func (b *Backend) SetStateFailure(signature *tasks.Signature, err string) error
175178
// GetState returns the latest task state
176179
func (b *Backend) GetState(taskUUID string) (*tasks.TaskState, error) {
177180
state := &tasks.TaskState{}
178-
err := b.tasksCollection.FindOne(context.Background(), bson.M{"_id": taskUUID}).Decode(state)
181+
err := b.tasksCollection().FindOne(context.Background(), bson.M{"_id": taskUUID}).Decode(state)
179182

180183
if err != nil {
181184
return nil, err
@@ -185,13 +188,13 @@ func (b *Backend) GetState(taskUUID string) (*tasks.TaskState, error) {
185188

186189
// PurgeState deletes stored task state
187190
func (b *Backend) PurgeState(taskUUID string) error {
188-
_, err := b.tasksCollection.DeleteOne(context.Background(), bson.M{"_id": taskUUID})
191+
_, err := b.tasksCollection().DeleteOne(context.Background(), bson.M{"_id": taskUUID})
189192
return err
190193
}
191194

192195
// PurgeGroupMeta deletes stored group meta data
193196
func (b *Backend) PurgeGroupMeta(groupUUID string) error {
194-
_, err := b.groupMetasCollection.DeleteOne(context.Background(), bson.M{"_id": groupUUID})
197+
_, err := b.groupMetasCollection().DeleteOne(context.Background(), bson.M{"_id": groupUUID})
195198
return err
196199
}
197200

@@ -207,15 +210,15 @@ func (b *Backend) lockGroupMeta(groupUUID string) error {
207210
},
208211
}
209212

210-
_, err := b.groupMetasCollection.UpdateOne(context.Background(), query, change, options.Update().SetUpsert(true))
213+
_, err := b.groupMetasCollection().UpdateOne(context.Background(), query, change, options.Update().SetUpsert(true))
211214

212215
return err
213216
}
214217

215218
// unlockGroupMeta releases lock on groupUUID document
216219
func (b *Backend) unlockGroupMeta(groupUUID string) error {
217220
update := bson.M{"$set": bson.M{"lock": false}}
218-
_, err := b.groupMetasCollection.UpdateOne(context.Background(), bson.M{"_id": groupUUID}, update, options.Update())
221+
_, err := b.groupMetasCollection().UpdateOne(context.Background(), bson.M{"_id": groupUUID}, update, options.Update())
219222
return err
220223
}
221224

@@ -224,7 +227,7 @@ func (b *Backend) getGroupMeta(groupUUID string) (*tasks.GroupMeta, error) {
224227
groupMeta := &tasks.GroupMeta{}
225228
query := bson.M{"_id": groupUUID}
226229

227-
err := b.groupMetasCollection.FindOne(context.Background(), query).Decode(groupMeta)
230+
err := b.groupMetasCollection().FindOne(context.Background(), query).Decode(groupMeta)
228231
if err != nil {
229232
return nil, err
230233
}
@@ -234,7 +237,7 @@ func (b *Backend) getGroupMeta(groupUUID string) (*tasks.GroupMeta, error) {
234237
// getStates returns multiple task states
235238
func (b *Backend) getStates(taskUUIDs ...string) ([]*tasks.TaskState, error) {
236239
states := make([]*tasks.TaskState, 0, len(taskUUIDs))
237-
cur, err := b.tasksCollection.Find(context.Background(), bson.M{"_id": bson.M{"$in": taskUUIDs}})
240+
cur, err := b.tasksCollection().Find(context.Background(), bson.M{"_id": bson.M{"$in": taskUUIDs}})
238241
if err != nil {
239242
return nil, err
240243
}
@@ -256,10 +259,26 @@ func (b *Backend) getStates(taskUUIDs ...string) ([]*tasks.TaskState, error) {
256259
// updateState saves current task state
257260
func (b *Backend) updateState(signature *tasks.Signature, update bson.M) error {
258261
update = bson.M{"$set": update}
259-
_, err := b.tasksCollection.UpdateOne(context.Background(), bson.M{"_id": signature.UUID}, update, options.Update().SetUpsert(true))
262+
_, err := b.tasksCollection().UpdateOne(context.Background(), bson.M{"_id": signature.UUID}, update, options.Update().SetUpsert(true))
260263
return err
261264
}
262265

266+
func (b *Backend) tasksCollection() *mongo.Collection {
267+
b.once.Do(func() {
268+
b.connect()
269+
})
270+
271+
return b.tc
272+
}
273+
274+
func (b *Backend) groupMetasCollection() *mongo.Collection {
275+
b.once.Do(func() {
276+
b.connect()
277+
})
278+
279+
return b.gmc
280+
}
281+
263282
// connect creates the underlying mgo connection if it doesn't exist
264283
// creates required indexes for our collections
265284
func (b *Backend) connect() error {
@@ -275,8 +294,8 @@ func (b *Backend) connect() error {
275294
database = b.GetConfig().MongoDB.Database
276295
}
277296

278-
b.tasksCollection = b.client.Database(database).Collection("tasks")
279-
b.groupMetasCollection = b.client.Database(database).Collection("group_metas")
297+
b.tc = b.client.Database(database).Collection("tasks")
298+
b.gmc = b.client.Database(database).Collection("group_metas")
280299

281300
err = b.createMongoIndexes(database)
282301
if err != nil {

‎v1/factories.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ import (
2020
amqpbackend "github.com/RichardKnop/machinery/v1/backends/amqp"
2121
dynamobackend "github.com/RichardKnop/machinery/v1/backends/dynamodb"
2222
eagerbackend "github.com/RichardKnop/machinery/v1/backends/eager"
23-
nullbackend "github.com/RichardKnop/machinery/v1/backends/null"
2423
backendiface "github.com/RichardKnop/machinery/v1/backends/iface"
2524
memcachebackend "github.com/RichardKnop/machinery/v1/backends/memcache"
2625
mongobackend "github.com/RichardKnop/machinery/v1/backends/mongo"
26+
nullbackend "github.com/RichardKnop/machinery/v1/backends/null"
2727
redisbackend "github.com/RichardKnop/machinery/v1/backends/redis"
2828
)
2929

‎v1/factories_test.go‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ import (
1717
redisbroker "github.com/RichardKnop/machinery/v1/brokers/redis"
1818
sqsbroker "github.com/RichardKnop/machinery/v1/brokers/sqs"
1919

20+
mongobackend "github.com/RichardKnop/machinery/v1/backends/mongo"
2021
amqpbackend "github.com/RichardKnop/machinery/v1/backends/amqp"
2122
memcachebackend "github.com/RichardKnop/machinery/v1/backends/memcache"
2223
redisbackend "github.com/RichardKnop/machinery/v1/backends/redis"
@@ -374,16 +375,16 @@ func TestBackendFactory(t *testing.T) {
374375
ResultsExpireIn: 30,
375376
}
376377

377-
_, err = machinery.BackendFactory(&cnf)
378+
actual, err = machinery.BackendFactory(&cnf)
378379
if assert.NoError(t, err) {
379-
//expected, err := mongobackend.New(&cnf)
380-
//if assert.NoError(t, err) {
381-
// assert.True(
382-
// t,
383-
// reflect.DeepEqual(actual, expected),
384-
// fmt.Sprintf("conn = %v, want %v", actual, expected),
385-
// )
386-
//}
380+
expected, err := mongobackend.New(&cnf)
381+
if assert.NoError(t, err) {
382+
assert.True(
383+
t,
384+
reflect.DeepEqual(actual, expected),
385+
fmt.Sprintf("conn = %v, want %v", actual, expected),
386+
)
387+
}
387388
}
388389
}
389390

0 commit comments

Comments
 (0)