Merge pull request #5 from dan13ram/dev

Added e2e tests

Author: dan13ram

.gitignore

@@ -22,10 +22,7 @@ go.work
 *.sw[a-z]
 
 # config
-*.yml
-!config.sample.yml
-!docker-compose.yml
-!defaults.yml
+config.local.yml
 
 # env
 .env*

README.md

@@ -102,6 +102,27 @@ docker run -d --env-file .env docker.io/dan13ram/wpokt-validator:latest
 
 Ensure you have set the required environment variables in the `.env` file or directly in the command above.
 
+## Running End-to-End Tests
+
+To test the core functionalities of the wPOKT Validator in a controlled environment, follow these steps:
+
+1. **Navigate to E2E Directory:**
+   - Open your terminal and move to the `./e2e` directory in the project.
+
+2. **Start Local Network:**
+   - Within the `./e2e` directory, execute the following commands to set up the local network:
+     ```shell
+     make clean
+     make network
+     ```
+   - Please allow up to 5 minutes for the local network to be fully operational.
+
+3. **Run Tests:**
+   - Once the local network is ready, initiate the end-to-end tests using the command:
+     ```shell
+     make test
+     ```
+
 ## License
 
 This project is licensed under the MIT License.

app/config_test.go

@@ -24,7 +24,7 @@ func TestReadConfigFromConfigFile(t *testing.T) {
 
 		assert.Equal(t, read, true)
 		assert.Equal(t, Config.MongoDB.Database, "mongodb-database")
-		assert.Equal(t, Config.MongoDB.TimeoutMillis, 2000)
+		assert.Equal(t, Config.MongoDB.TimeoutMillis, int64(2000))
 	})
 
 	t.Run("No Config File Provided", func(t *testing.T) {

app/database.go

@@ -3,7 +3,6 @@ package app
 import (
 	"context"
 	"crypto/rand"
-	"errors"
 	"time"
 
 	"github.com/dan13ram/wpokt-validator/models"
@@ -28,18 +27,17 @@ type Database interface {
 	UpdateOne(collection string, filter interface{}, update interface{}) error
 	UpsertOne(collection string, filter interface{}, update interface{}) error
 
-	XLock(collection string, resourceId string) (string, error)
-	SLock(collection string, resourceId string) (string, error)
-	Unlock(collection string, lockId string) error
+	XLock(resourceId string) (string, error)
+	SLock(resourceId string) (string, error)
+	Unlock(lockId string) error
 }
 
 // mongoDatabase is a wrapper around the mongo database
 type mongoDatabase struct {
 	db       *mongo.Database
-	timeout  time.Duration
 	uri      string
 	database string
-	lockers  map[string]*lock.Client
+	locker   *lock.Client
 }
 
 var (
@@ -49,9 +47,9 @@ var (
 // Connect connects to the database
 func (d *mongoDatabase) Connect() error {
 	log.Debug("[DB] Connecting to database")
-	wcMajority := writeconcern.New(writeconcern.WMajority(), writeconcern.WTimeout(d.timeout))
+	wcMajority := writeconcern.New(writeconcern.WMajority(), writeconcern.WTimeout(time.Duration(Config.MongoDB.TimeoutMillis)*time.Millisecond))
 
-	ctx, cancel := context.WithTimeout(context.Background(), d.timeout)
+	ctx, cancel := context.WithTimeout(context.Background(), time.Duration(Config.MongoDB.TimeoutMillis)*time.Millisecond)
 	defer cancel()
 
 	client, err := mongo.Connect(ctx, options.Client().ApplyURI(d.uri).SetWriteConcern(wcMajority))
@@ -67,36 +65,14 @@ func (d *mongoDatabase) Connect() error {
 // SetupLocker sets up the locker
 func (d *mongoDatabase) SetupLockers() error {
 	log.Debug("[DB] Setting up locker")
-	d.lockers = make(map[string]*lock.Client)
 	var locker *lock.Client
 
-	ctx, cancel := context.WithTimeout(context.Background(), d.timeout)
+	ctx, cancel := context.WithTimeout(context.Background(), time.Duration(Config.MongoDB.TimeoutMillis)*time.Millisecond)
 	defer cancel()
 
-	locker = lock.NewClient(d.db.Collection(models.CollectionMints))
+	locker = lock.NewClient(d.db.Collection("locks"))
 	locker.CreateIndexes(ctx)
-	d.lockers[models.CollectionMints] = locker
-
-	ctx, cancel = context.WithTimeout(context.Background(), d.timeout)
-	defer cancel()
-
-	locker = lock.NewClient(d.db.Collection(models.CollectionInvalidMints))
-	locker.CreateIndexes(ctx)
-	d.lockers[models.CollectionInvalidMints] = locker
-
-	ctx, cancel = context.WithTimeout(context.Background(), d.timeout)
-	defer cancel()
-
-	locker = lock.NewClient(d.db.Collection(models.CollectionBurns))
-	locker.CreateIndexes(ctx)
-	d.lockers[models.CollectionBurns] = locker
-
-	ctx, cancel = context.WithTimeout(context.Background(), d.timeout)
-	defer cancel()
-
-	locker = lock.NewClient(d.db.Collection(models.CollectionHealthChecks))
-	locker.CreateIndexes(ctx)
-	d.lockers[models.CollectionHealthChecks] = locker
+	d.locker = locker
 
 	log.Info("[DB] Locker setup")
 	return nil
@@ -113,46 +89,31 @@ func randomString(n int) string {
 }
 
 // XLock locks a resource for exclusive access
-func (d *mongoDatabase) XLock(collection string, resourceId string) (string, error) {
-	locker := d.lockers[collection]
-	if locker == nil {
-		return "", errors.New("Locker not found")
-	}
-
-	ctx, cancel := context.WithTimeout(context.Background(), d.timeout)
+func (d *mongoDatabase) XLock(resourceId string) (string, error) {
+	ctx, cancel := context.WithTimeout(context.Background(), time.Duration(Config.MongoDB.TimeoutMillis)*time.Millisecond)
 	defer cancel()
 
 	lockId := randomString(32)
-	err := locker.XLock(ctx, resourceId, lockId, lock.LockDetails{})
+	err := d.locker.XLock(ctx, resourceId, lockId, lock.LockDetails{})
 	return lockId, err
 }
 
 // SLock locks a resource for shared access
-func (d *mongoDatabase) SLock(collection string, resourceId string) (string, error) {
-	locker := d.lockers[collection]
-	if locker == nil {
-		return "", errors.New("Locker not found")
-	}
-
-	ctx, cancel := context.WithTimeout(context.Background(), d.timeout)
+func (d *mongoDatabase) SLock(resourceId string) (string, error) {
+	ctx, cancel := context.WithTimeout(context.Background(), time.Duration(Config.MongoDB.TimeoutMillis)*time.Millisecond)
 	defer cancel()
 
 	lockId := randomString(32)
-	err := locker.SLock(ctx, resourceId, lockId, lock.LockDetails{}, -1)
+	err := d.locker.SLock(ctx, resourceId, lockId, lock.LockDetails{}, -1)
 	return lockId, err
 }
 
 // Unlock unlocks a resource
-func (d *mongoDatabase) Unlock(collection string, lockId string) error {
-	locker := d.lockers[collection]
-	if locker == nil {
-		return errors.New("Locker not found")
-	}
-
-	ctx, cancel := context.WithTimeout(context.Background(), d.timeout)
+func (d *mongoDatabase) Unlock(lockId string) error {
+	ctx, cancel := context.WithTimeout(context.Background(), time.Duration(Config.MongoDB.TimeoutMillis)*time.Millisecond)
 	defer cancel()
 
-	_, err := locker.Unlock(ctx, lockId)
+	_, err := d.locker.Unlock(ctx, lockId)
 	return err
 }
 
@@ -162,7 +123,7 @@ func (d *mongoDatabase) SetupIndexes() error {
 
 	// setup unique index for mints
 	log.Debug("[DB] Setting up indexes for mints")
-	ctx, cancel := context.WithTimeout(context.Background(), d.timeout)
+	ctx, cancel := context.WithTimeout(context.Background(), time.Duration(Config.MongoDB.TimeoutMillis)*time.Millisecond)
 	defer cancel()
 	_, err := d.db.Collection(models.CollectionMints).Indexes().CreateOne(ctx, mongo.IndexModel{
 		Keys:    bson.D{{Key: "transaction_hash", Value: 1}},
@@ -174,7 +135,7 @@ func (d *mongoDatabase) SetupIndexes() error {
 
 	// setup unique index for invalid mints
 	log.Debug("[DB] Setting up indexes for invalid mints")
-	ctx, cancel = context.WithTimeout(context.Background(), d.timeout)
+	ctx, cancel = context.WithTimeout(context.Background(), time.Duration(Config.MongoDB.TimeoutMillis)*time.Millisecond)
 	defer cancel()
 	_, err = d.db.Collection(models.CollectionInvalidMints).Indexes().CreateOne(ctx, mongo.IndexModel{
 		Keys:    bson.D{{Key: "transaction_hash", Value: 1}},
@@ -186,7 +147,7 @@ func (d *mongoDatabase) SetupIndexes() error {
 
 	// setup unique index for burns
 	log.Debug("[DB] Setting up indexes for burns")
-	ctx, cancel = context.WithTimeout(context.Background(), d.timeout)
+	ctx, cancel = context.WithTimeout(context.Background(), time.Duration(Config.MongoDB.TimeoutMillis)*time.Millisecond)
 	defer cancel()
 	_, err = d.db.Collection(models.CollectionBurns).Indexes().CreateOne(ctx, mongo.IndexModel{
 		Keys:    bson.D{{Key: "transaction_hash", Value: 1}, {Key: "log_index", Value: 1}},
@@ -198,7 +159,7 @@ func (d *mongoDatabase) SetupIndexes() error {
 
 	// setup unique index for healthchecks
 	log.Debug("[DB] Setting up indexes for healthchecks")
-	ctx, cancel = context.WithTimeout(context.Background(), d.timeout)
+	ctx, cancel = context.WithTimeout(context.Background(), time.Duration(Config.MongoDB.TimeoutMillis)*time.Millisecond)
 	defer cancel()
 	_, err = d.db.Collection(models.CollectionHealthChecks).Indexes().CreateOne(ctx, mongo.IndexModel{
 		Keys:    bson.D{{Key: "validator_id", Value: 1}, {Key: "hostname", Value: 1}},
@@ -216,7 +177,7 @@ func (d *mongoDatabase) SetupIndexes() error {
 // Disconnect disconnects from the database
 func (d *mongoDatabase) Disconnect() error {
 	log.Debug("[DB] Disconnecting from database")
-	ctx, cancel := context.WithTimeout(context.Background(), d.timeout)
+	ctx, cancel := context.WithTimeout(context.Background(), time.Duration(Config.MongoDB.TimeoutMillis)*time.Millisecond)
 	defer cancel()
 	err := d.db.Client().Disconnect(ctx)
 	log.Info("[DB] Disconnected from database")
@@ -225,23 +186,23 @@ func (d *mongoDatabase) Disconnect() error {
 
 // method for insert single value in a collection
 func (d *mongoDatabase) InsertOne(collection string, data interface{}) error {
-	ctx, cancel := context.WithTimeout(context.Background(), d.timeout)
+	ctx, cancel := context.WithTimeout(context.Background(), time.Duration(Config.MongoDB.TimeoutMillis)*time.Millisecond)
 	defer cancel()
 	_, err := d.db.Collection(collection).InsertOne(ctx, data)
 	return err
 }
 
 // method for find single value in a collection
 func (d *mongoDatabase) FindOne(collection string, filter interface{}, result interface{}) error {
-	ctx, cancel := context.WithTimeout(context.Background(), d.timeout)
+	ctx, cancel := context.WithTimeout(context.Background(), time.Duration(Config.MongoDB.TimeoutMillis)*time.Millisecond)
 	defer cancel()
 	err := d.db.Collection(collection).FindOne(ctx, filter).Decode(result)
 	return err
 }
 
 // method for find multiple values in a collection
 func (d *mongoDatabase) FindMany(collection string, filter interface{}, result interface{}) error {
-	ctx, cancel := context.WithTimeout(context.Background(), d.timeout)
+	ctx, cancel := context.WithTimeout(context.Background(), time.Duration(Config.MongoDB.TimeoutMillis)*time.Millisecond)
 	defer cancel()
 	cursor, err := d.db.Collection(collection).Find(ctx, filter)
 	if err != nil {
@@ -253,15 +214,15 @@ func (d *mongoDatabase) FindMany(collection string, filter interface{}, result i
 
 //method for update single value in a collection
 func (d *mongoDatabase) UpdateOne(collection string, filter interface{}, update interface{}) error {
-	ctx, cancel := context.WithTimeout(context.Background(), d.timeout)
+	ctx, cancel := context.WithTimeout(context.Background(), time.Duration(Config.MongoDB.TimeoutMillis)*time.Millisecond)
 	defer cancel()
 	_, err := d.db.Collection(collection).UpdateOne(ctx, filter, update)
 	return err
 }
 
 //method for upsert single value in a collection
 func (d *mongoDatabase) UpsertOne(collection string, filter interface{}, update interface{}) error {
-	ctx, cancel := context.WithTimeout(context.Background(), d.timeout)
+	ctx, cancel := context.WithTimeout(context.Background(), time.Duration(Config.MongoDB.TimeoutMillis)*time.Millisecond)
 	defer cancel()
 
 	opts := options.Update().SetUpsert(true)
@@ -272,7 +233,6 @@ func (d *mongoDatabase) UpsertOne(collection string, filter interface{}, update
 // InitDB creates a new database wrapper
 func InitDB() {
 	DB = &mongoDatabase{
-		timeout:  time.Millisecond * time.Duration(Config.MongoDB.TimeoutMillis),
 		uri:      Config.MongoDB.URI,
 		database: Config.MongoDB.Database,
 	}

e2e/.gitignore

@@ -0,0 +1 @@
+data/

e2e/Makefile

@@ -0,0 +1,8 @@
+network:
+	docker-compose up --force-recreate
+
+clean:
+	sudo rm -rf /tmp/data
+
+test:
+	cd tester && yarn install && yarn test