Compare commits

..

22 Commits

Author SHA1 Message Date
176fadbceb Merge branch 'filter-joins' 2024-07-14 13:34:33 +02:00
86f4550b08 Finish 2024-07-14 13:17:04 +02:00
f50aaca44d ApplyQuery interface 2024-06-29 15:37:59 +02:00
f7cf63c2bf Change separator 2024-06-27 13:49:28 +02:00
30714bb3da Delete method working example 2024-06-27 13:33:05 +02:00
8a81173fc8 Update method tests 2024-06-26 16:15:33 +02:00
43824af97c Tests 2024-06-26 11:41:01 +02:00
326866dc49 Update method 2024-06-26 11:24:58 +02:00
450345ba6b Save method 2024-06-26 11:20:26 +02:00
bdc978aec1 Save method 2024-06-26 01:55:33 +02:00
3dc8d0d79f Count method 2024-06-25 01:52:50 +02:00
4615d55309 Repo options 2024-06-25 01:19:40 +02:00
c2bcbea5d2 Tests 2024-06-25 00:49:13 +02:00
ff51420b71 Merge branch 'support-uuid' 2024-06-24 16:18:21 +02:00
9958e9103b Support uuids 2024-06-24 16:18:10 +02:00
bd510d958b Only option 2024-06-24 01:08:39 +02:00
295e915f89 Pagination and ordering 2024-06-24 00:45:54 +02:00
642ac4fba7 Repo tests 2024-06-23 23:33:53 +02:00
39757cde34 Cleanup 2024-06-23 18:44:50 +02:00
c371cbf042 CLeanup postgres tests 2024-06-23 18:39:35 +02:00
0fda3f6ef6 Mock with postgres 2024-06-23 18:35:52 +02:00
13fe2222dd Filter field names 2024-06-23 18:16:32 +02:00
32 changed files with 1383 additions and 571 deletions

View File

@ -8,7 +8,9 @@ import (
"repo-pattern/app/models"
"repo-pattern/app/repository"
"repo-pattern/app/repository/smartfilter"
"time"
"github.com/google/uuid"
"gorm.io/gorm"
)
@ -17,6 +19,34 @@ var (
FALSE = false
)
type CertFilter struct {
Alive *bool `filterfield:"field=alive;operator=EQ"`
SerialNumber *string `filterfield:"field=serial_number;operator=NE"`
SerialNumberContains *string `filterfield:"field=serial_number;operator=LIKE"`
IssuerContains *string `filterfield:"field=issuer;operator=ILIKE"`
Id *uuid.UUID `filterfield:"field=id;operator=EQ"`
Ids *[]uuid.UUID `filterfield:"field=id;operator=IN"`
IdsNot *[]string `filterfield:"field=id;operator=NOT_IN"`
CreatedAt_Lt *time.Time `filterfield:"field=created_at;operator=LT"`
Timestamps *[]time.Time `filterfield:"field=created_at;operator=IN"`
CompanyIsActive *bool
}
func (f CertFilter) ApplyQuery(query *gorm.DB) *gorm.DB {
if f.CompanyIsActive != nil {
query = query.Joins(
fmt.Sprintf(
"JOIN companies ON certificates.company_id = companies.id WHERE companies.is_active = %t",
*f.CompanyIsActive,
))
}
return query
}
type CompanyFilter struct {
IsActive *bool `filterfield:"field=is_active;operator=EQ"`
}
func doMagic(db *gorm.DB) {
var err error
query := db
@ -25,18 +55,23 @@ func doMagic(db *gorm.DB) {
// serialNumber := "222"
// serialNumberContains := "323"
// issuer := "FINA"
// location, _ := time.LoadLocation("UTC")
// createdTime := time.Date(2024, 5, 26, 16, 8, 0, 0, location)
ids := []string{"eb2bcac6-5173-4dbb-93b7-e7c03b924a03", "db9fb837-3483-4736-819d-f427dc8cda23", "1fece5e7-8e8d-4828-8298-3b1f07fd29ff"}
location, _ := time.LoadLocation("UTC")
createdTime := time.Date(2024, 5, 26, 16, 8, 0, 0, location)
filter := smartfilter.CertFilter{
id1, _ := uuid.Parse("eb2bcac6-5173-4dbb-93b7-e7c03b924a03")
id2, _ := uuid.Parse("db9fb837-3483-4736-819d-f427dc8cda23")
id3, _ := uuid.Parse("1fece5e7-8e8d-4828-8298-3b1f07fd29ff")
ids := []uuid.UUID{id1, id2, id3}
filter := CertFilter{
// Alive: &FALSE,
// Id: &id,
// SerialNumber: &serialNumber,
// SerialNumberContains: &serialNumberContains,
Ids: &ids,
// IssuerContains: &issuer,
// CreatedAt_Lt: &createdTime,
CreatedAt_Lt: &createdTime,
}
query, err = smartfilter.ToQuery(models.Cert{}, filter, query)
@ -54,13 +89,13 @@ func doMagic(db *gorm.DB) {
func doList(db *gorm.DB) {
repo := repository.RepoBase[models.Cert]{}
repo.Init(db)
repo.Init(db, nil)
filter := smartfilter.CertFilter{
filter := CertFilter{
Alive: &TRUE,
}
certs, err := repo.List(filter)
certs, err := repo.List(filter, nil)
if err != nil {
panic(err)
}
@ -70,30 +105,97 @@ func doList(db *gorm.DB) {
}
}
func doListWithJoins(db *gorm.DB) {
repo := repository.RepoBase[models.Cert]{}
repo.Init(db, nil)
filter := CertFilter{
CompanyIsActive: &FALSE,
}
certs, err := repo.List(filter, nil)
if err != nil {
panic(err)
}
for n, cert := range *certs {
fmt.Printf(">> [%d] %+v %s (alive %t)\n", n, cert.Id, cert.CreatedAt, cert.Alive)
}
}
func doCount(db *gorm.DB) {
repo := repository.RepoBase[models.Cert]{}
repo.Init(db, nil)
filter := CertFilter{
Alive: &TRUE,
}
count, err := repo.Count(filter)
if err != nil {
panic(err)
}
fmt.Printf(">>> count: %d\n", count)
}
func doGet(db *gorm.DB) {
repo := repository.RepoBase[models.Cert]{}
repo.Init(db)
repo.Init(db, nil)
id := "db9fb837-3483-4736-819d-f427dc8cda23"
id, _ := uuid.Parse("db9fb837-3483-4736-819d-f427dc8cda23")
filter := smartfilter.CertFilter{
filter := CertFilter{
Id: &id,
}
cert, err := repo.Get(filter)
cert, err := repo.Get(filter, nil)
if err != nil {
panic(err)
}
fmt.Printf(">> %+v %s (alive %t)\n", cert.Id, cert.CreatedAt, cert.Alive)
}
func doSave(db *gorm.DB) {
repo := repository.RepoBase[models.Company]{}
repo.Init(db, nil)
company := models.Company{
Name: "Test company",
Address: "Some address",
City: "Some city",
Email: "email@example.org",
Oib: "123456",
}
_, err := repo.Save(&company)
if err != nil {
panic(err)
}
fmt.Printf("New company id: %s\n", company.Id.String())
}
func doDelete(db *gorm.DB) {
repo := repository.RepoBase[models.Company]{}
repo.Init(db, nil)
filter := CompanyFilter{
IsActive: &FALSE,
}
deletedCount, err := repo.Delete(filter)
if err != nil {
panic(err)
}
fmt.Printf(">> DELETED: %d\n", deletedCount)
}
func doExists(db *gorm.DB) {
repo := repository.RepoBase[models.Cert]{}
repo.Init(db)
repo.Init(db, nil)
id := "db9fb837-3483-4736-819d-f427dc8cda23"
id, _ := uuid.Parse("db9fb837-3483-4736-819d-f427dc8cda23")
filter := smartfilter.CertFilter{
filter := CertFilter{
Id: &id,
}
@ -110,10 +212,13 @@ func main() {
defer logging.Log.Sync()
db := db.InitDB()
repository.Dao = repository.CreateDAO(db)
doMagic(db)
// doMagic(db)
// doList(db)
doListWithJoins(db)
// doCount(db)
// doSave(db)
// doDelete(db)
// doGet(db)
// doExists(db)
// inheritance.DoInheritanceTest()

View File

@ -1,23 +0,0 @@
package models
import (
"time"
"github.com/google/uuid"
)
type ApiKey struct {
Key uuid.UUID `gorm:"type(uuid);unique;default:uuid_generate_v4()"`
CompanyId uuid.UUID `gorm:"type(uuid)" faker:"-"`
ActiveFrom *time.Time `faker:"-"`
ActiveTo *time.Time `faker:"-"`
LastUsed *time.Time
CreatedAt time.Time `faker:"-"`
UpdatedAt time.Time `faker:"-"`
Company Company `faker:"-"`
}
func (m *ApiKey) TableName() string {
return "api_keys"
}

View File

@ -21,7 +21,7 @@ type Company struct {
UpdatedAt time.Time `faker:"-"`
}
func (m *Company) TableName() string {
func (m Company) TableName() string {
return "companies"
}

View File

@ -1,27 +0,0 @@
package models
import (
"time"
"github.com/google/uuid"
"gorm.io/datatypes"
)
type FiskLogItem struct {
Id uuid.UUID `gorm:"type(uuid);unique"`
ApiKeyId uuid.UUID `gorm:"type(uuid)"`
CompanyId uuid.UUID `gorm:"type(uuid)"`
IsDemo bool
RequestData datatypes.JSONMap `gorm:"type:jsonb;not null"`
ResponseData *datatypes.JSONMap `gorm:"type:jsonb"`
IznosUkupno int
Zki *string
Jir *uuid.UUID `gorm:"type(uuid)"`
CreatedAt time.Time
UpdatedAt time.Time
}
func (m *FiskLogItem) TableName() string {
return "fisk_log"
}

View File

@ -1,89 +0,0 @@
package repository
import (
"repo-pattern/app/lib/helpers"
"repo-pattern/app/models"
"github.com/google/uuid"
"gorm.io/gorm"
)
type ApiKeysRepository struct {
db *gorm.DB
}
type ApiKeysFilter struct {
Key *uuid.UUID
CompanyId *uuid.UUID
IsActive *bool
CompanyIsActive *bool
}
func CreateApiKeysRepository(db *gorm.DB) *ApiKeysRepository {
return &ApiKeysRepository{db}
}
func applyApiKeyFilter(db *gorm.DB, query *gorm.DB, filter *ApiKeysFilter) *gorm.DB {
if filter.Key != nil {
query.Where("key = ?", *filter.Key)
}
if filter.IsActive != nil {
now := helpers.UTCNow()
if *filter.IsActive {
query.Where("active_from IS NULL OR active_from <= ?", now)
query.Where("active_to IS NULL OR active_to >= ?", now)
} else {
query.Where(
"active_from IS NOT NULL AND active_from >= ?", now,
).Or(
"active_to IS NOT NULL AND active_to =< ?", now,
)
}
}
if filter.CompanyId != nil {
query.Where("company_id = ?", *filter.CompanyId)
}
if filter.CompanyIsActive != nil {
query.Joins("Company").Where(
map[string]interface{}{"Company.is_active": *filter.CompanyIsActive},
)
}
return query
}
func (r *ApiKeysRepository) New(companyId uuid.UUID) *models.ApiKey {
now := helpers.UTCNow()
return &models.ApiKey{
CompanyId: companyId,
ActiveFrom: &now,
CreatedAt: now,
UpdatedAt: now,
}
}
func (r *ApiKeysRepository) Get(filter *ApiKeysFilter) *models.ApiKey {
var api_key models.ApiKey
query := r.db.Model(&models.ApiKey{})
applyApiKeyFilter(r.db, query, filter)
result := query.First(&api_key).Joins("Company")
if result.Error != nil {
return nil
}
return &api_key
}
func (r *ApiKeysRepository) Save(model *models.ApiKey) {
model.UpdatedAt = helpers.UTCNow()
// we don't have standard model Id, but Key as primary key.
// this could be possible reason for save not assigning generated key uuid
// to model.Key. but this works.
if model.Key == uuid.Nil {
r.db.Create(model)
} else {
r.db.Save(model)
}
}

View File

@ -1,101 +0,0 @@
package repository
import (
"errors"
"repo-pattern/app/lib/helpers"
"repo-pattern/app/models"
"github.com/google/uuid"
"gorm.io/gorm"
)
type CertRepository struct {
db *gorm.DB
}
type CertFilter struct {
Alive *bool
Id *uuid.UUID
CompanyId *uuid.UUID
CompanyIsActive *bool
}
func CreateCertRepository(db *gorm.DB) *CertRepository {
return &CertRepository{db}
}
func applyCertFilter(db *gorm.DB, query *gorm.DB, filter *CertFilter) *gorm.DB {
if filter.Id != nil {
query.Where("certificates.id = ?", *filter.Id)
}
if filter.Alive == nil {
query.Where("certificates.alive = TRUE")
} else {
query.Where("certificates.alive = ?", *filter.Alive)
}
if filter.CompanyId != nil {
query.Where("certificates.company_id = ?", *filter.CompanyId)
}
if filter.CompanyIsActive != nil {
query.Joins("LEFT JOIN companies on companies.is_active = TRUE")
// query.Joins("Company").Where(
// map[string]interface{}{"Company.is_active": *filter.CompanyIsActive},
// )
}
return query
}
func (r *CertRepository) New(companyId uuid.UUID) *models.Cert {
now := helpers.UTCNow()
return &models.Cert{
Alive: true,
CompanyId: companyId,
CreatedAt: now,
UpdatedAt: now,
}
}
func (r *CertRepository) Get(filter *CertFilter) *models.Cert {
var cert models.Cert
query := r.db.Model(&models.Cert{})
applyCertFilter(r.db, query, filter)
result := query.First(&cert).Joins("Company")
if result.Error != nil {
return nil
}
return &cert
}
func (r *CertRepository) GetForCompany(companyId uuid.UUID) *models.Cert {
isAlive := true
filter := CertFilter{
Alive: &isAlive,
CompanyId: &companyId,
}
return r.Get(&filter)
}
func (r *CertRepository) Save(model *models.Cert) {
model.UpdatedAt = helpers.UTCNow()
r.db.Save(model)
}
func (r *CertRepository) Exists(filter *CertFilter) bool {
var row models.Cert
query := r.db.Model(&models.Cert{})
query = applyCertFilter(r.db, query, filter)
result := query.Select("certificates.id").First(&row)
return !errors.Is(result.Error, gorm.ErrRecordNotFound) && result.Error == nil
}
func (r *CertRepository) Delete(filter *CertFilter) {
query := r.db.Model(&models.Cert{})
applyCertFilter(r.db, query, filter)
query.Update("alive", false).Joins("Company")
}

View File

@ -1,57 +0,0 @@
package repository
import (
"repo-pattern/app/lib/helpers"
"repo-pattern/app/models"
"github.com/google/uuid"
"gorm.io/gorm"
)
type CompanyRepository struct {
db *gorm.DB
}
type CompanyFilter struct {
Id *uuid.UUID
}
func CreateCompanyRepository(db *gorm.DB) *CompanyRepository {
return &CompanyRepository{db}
}
func applyCompanyFilter(db *gorm.DB, query *gorm.DB, filter *CompanyFilter) *gorm.DB {
if filter.Id != nil {
query.Where("id = ?", *filter.Id)
}
query.Where("is_active = ?", true)
return query
}
func (r *CompanyRepository) New() *models.Company {
now := helpers.UTCNow()
return &models.Company{
IsActive: true,
CreatedAt: now,
UpdatedAt: now,
}
}
func (r *CompanyRepository) Get(filter *CompanyFilter) *models.Company {
var company models.Company
query := r.db.Model(&models.Company{})
applyCompanyFilter(r.db, query, filter)
result := query.First(&company)
if result.Error != nil {
return nil
}
return &company
}
func (r *CompanyRepository) Save(model *models.Company) {
model.UpdatedAt = helpers.UTCNow()
r.db.Save(model)
}

View File

@ -1,23 +0,0 @@
package repository
import "gorm.io/gorm"
type DAO struct {
db *gorm.DB
ApiKeysRepository *ApiKeysRepository
CertRepository *CertRepository
CompanyRepository *CompanyRepository
FiskLogRepository *FiskLogRepository
}
var Dao DAO
func CreateDAO(db *gorm.DB) DAO {
return DAO{
db: db,
ApiKeysRepository: CreateApiKeysRepository(db),
CertRepository: CreateCertRepository(db),
CompanyRepository: CreateCompanyRepository(db),
FiskLogRepository: CreateFiskLogRepository(db),
}
}

View File

@ -1,29 +0,0 @@
package repository
import (
"repo-pattern/app/lib/helpers"
"repo-pattern/app/models"
"gorm.io/gorm"
)
type FiskLogRepository struct {
db *gorm.DB
}
func CreateFiskLogRepository(db *gorm.DB) *FiskLogRepository {
return &FiskLogRepository{db}
}
func (r *FiskLogRepository) New(model models.FiskLogItem) *models.FiskLogItem {
now := helpers.UTCNow()
model.CreatedAt = now
model.UpdatedAt = now
return &model
}
func (r *FiskLogRepository) Save(model *models.FiskLogItem) error {
model.UpdatedAt = helpers.UTCNow()
result := r.db.Save(model)
return result.Error
}

View File

@ -0,0 +1,32 @@
package repository
import (
"repo-pattern/app/repository/smartfilter"
"gorm.io/gorm/schema"
)
type CountMethod[T schema.Tabler] struct {
repo *RepoBase[T]
}
func (m *CountMethod[T]) Init(repo *RepoBase[T]) {
m.repo = repo
}
func (m CountMethod[T]) Count(filter interface{}) (int64, error) {
var (
model T
count int64
)
query := m.repo.dbConn.Model(model)
query, err := smartfilter.ToQuery(model, filter, query)
if err != nil {
return 0, err
}
query.Count(&count)
return count, nil
}

View File

@ -0,0 +1,60 @@
package repository
import (
"fmt"
"regexp"
"testing"
"github.com/google/uuid"
"github.com/stretchr/testify/assert"
)
func TestCountMethod(t *testing.T) {
t.Run("Count without filter", func(t *testing.T) {
sqldb, db, mock := NewMockDB()
defer sqldb.Close()
repo := RepoBase[MyModel]{}
repo.Init(db, nil)
filter := MyModelFilter{}
sql := "SELECT count(*) FROM my_models"
mock.ExpectQuery(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql)))
result, err := repo.Count(filter)
assert.Equal(t, result, int64(0))
assert.Nil(t, err)
if err := mock.ExpectationsWereMet(); err != nil {
t.Errorf("there were unfulfilled expectations: %s", err)
}
})
t.Run("Count with filter", func(t *testing.T) {
sqldb, db, mock := NewMockDB()
defer sqldb.Close()
repo := RepoBase[MyModel]{}
repo.Init(db, nil)
id1 := uuid.New()
id2 := uuid.New()
id3 := uuid.New()
filter := MyModelFilter{
Ids: &[]uuid.UUID{id1, id2, id3},
}
sql := "SELECT count(*) FROM my_models WHERE my_models.id IN ($1,$2,$3)"
mock.ExpectQuery(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql))).
WithArgs(id1, id2, id3)
result, err := repo.Count(filter)
assert.Equal(t, result, int64(0))
assert.Nil(t, err)
if err := mock.ExpectationsWereMet(); err != nil {
t.Errorf("there were unfulfilled expectations: %s", err)
}
})
}

View File

@ -0,0 +1,31 @@
package repository
import (
"repo-pattern/app/repository/smartfilter"
"gorm.io/gorm/schema"
)
type DeleteMethod[T schema.Tabler] struct {
repo *RepoBase[T]
}
func (m *DeleteMethod[T]) Init(repo *RepoBase[T]) {
m.repo = repo
}
func (m DeleteMethod[T]) Delete(filter interface{}) (int64, error) {
var (
model T
)
query, err := smartfilter.ToQuery(model, filter, m.repo.dbConn)
if err != nil {
return 0, err
}
result := query.Delete(&model)
if result.Error != nil {
return 0, result.Error
}
return result.RowsAffected, nil
}

View File

@ -0,0 +1,73 @@
package repository
import (
"fmt"
"regexp"
"testing"
"github.com/DATA-DOG/go-sqlmock"
"github.com/google/uuid"
"github.com/stretchr/testify/assert"
)
func TestDeleteMethod(t *testing.T) {
t.Run("With filter", func(t *testing.T) {
sqldb, db, mock := NewMockDB()
defer sqldb.Close()
repo := RepoBase[MyModel]{}
repo.Init(db, nil)
id := uuid.New()
filter := MyModelFilter{
Id: &id,
}
sql := "DELETE FROM my_models WHERE my_models.id = $1"
mock.ExpectBegin()
mock.ExpectExec(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql))).
WithArgs(id).
WillReturnResult(sqlmock.NewResult(1, 111))
mock.ExpectCommit()
deleted, err := repo.Delete(filter)
assert.Equal(t, int64(111), deleted)
assert.Nil(t, err)
if err := mock.ExpectationsWereMet(); err != nil {
t.Errorf("there were unfulfilled expectations: %s", err)
}
})
t.Run("With multiple filters", func(t *testing.T) {
sqldb, db, mock := NewMockDB()
defer sqldb.Close()
repo := RepoBase[MyModel]{}
repo.Init(db, nil)
id1 := uuid.New()
id2 := uuid.New()
id3 := uuid.New()
cnt := 3456
filter := MyModelFilter{
Ids: &[]uuid.UUID{id1, id2, id3},
CntGT: &cnt,
}
sql := "DELETE FROM my_models WHERE my_models.id IN ($1,$2,$3) AND my_models.cnt > $4"
mock.ExpectBegin()
mock.ExpectExec(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql))).
WithArgs(id1, id2, id3, cnt).
WillReturnResult(sqlmock.NewResult(1, 123))
mock.ExpectCommit()
deleted, err := repo.Delete(filter)
assert.Equal(t, int64(123), deleted)
assert.Nil(t, err)
if err := mock.ExpectationsWereMet(); err != nil {
t.Errorf("there were unfulfilled expectations: %s", err)
}
})
}

View File

@ -0,0 +1,35 @@
package repository
import (
"errors"
"repo-pattern/app/repository/smartfilter"
"gorm.io/gorm"
"gorm.io/gorm/schema"
)
type ExistsMethod[T schema.Tabler] struct {
repo *RepoBase[T]
}
func (m *ExistsMethod[T]) Init(repo *RepoBase[T]) {
m.repo = repo
}
func (m ExistsMethod[T]) Exists(filter interface{}) (bool, error) {
var (
model T
)
query := m.repo.dbConn.Model(model)
query, err := smartfilter.ToQuery(model, filter, query)
if err != nil {
return false, err
}
result := query.Select(m.repo.IdField).Take(&model)
exists := !errors.Is(result.Error, gorm.ErrRecordNotFound) && result.Error == nil
return exists, nil
}

View File

@ -0,0 +1,60 @@
package repository
import (
"fmt"
"regexp"
"testing"
"github.com/google/uuid"
"github.com/stretchr/testify/assert"
)
func TestExistsMethod(t *testing.T) {
t.Run("Without repo options", func(t *testing.T) {
sqldb, db, mock := NewMockDB()
defer sqldb.Close()
repo := RepoBase[MyModel]{}
repo.Init(db, nil)
id := uuid.New()
filter := MyModelFilter{
Id: &id,
}
sql := "SELECT id FROM my_models WHERE my_models.id = $1 LIMIT $2"
mock.ExpectQuery(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql))).WithArgs(id, 1)
result, err := repo.Exists(filter)
assert.False(t, result)
assert.Nil(t, err)
if err := mock.ExpectationsWereMet(); err != nil {
t.Errorf("there were unfulfilled expectations: %s", err)
}
})
t.Run("With id field set in repo options", func(t *testing.T) {
sqldb, db, mock := NewMockDB()
defer sqldb.Close()
repo := RepoBase[MyModel]{}
repo.Init(db, &RepoOptions{IdField: "some_other_pk"})
id := uuid.New()
filter := MyModelFilter{
Id: &id,
}
sql := "SELECT some_other_pk FROM my_models WHERE my_models.id = $1 LIMIT $2"
mock.ExpectQuery(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql))).WithArgs(id, 1)
result, err := repo.Exists(filter)
assert.False(t, result)
assert.Nil(t, err)
if err := mock.ExpectationsWereMet(); err != nil {
t.Errorf("there were unfulfilled expectations: %s", err)
}
})
}

View File

@ -0,0 +1,45 @@
package repository
import (
"repo-pattern/app/repository/smartfilter"
"gorm.io/gorm/schema"
)
type GetOptions struct {
Only *[]string
RaiseError *bool
}
type GetMethod[T schema.Tabler] struct {
repo *RepoBase[T]
}
func (m *GetMethod[T]) Init(repo *RepoBase[T]) {
m.repo = repo
}
func (m GetMethod[T]) Get(filter interface{}, options *GetOptions) (*T, error) {
var (
model T
)
query, err := smartfilter.ToQuery(model, filter, m.repo.dbConn)
if err != nil {
return nil, err
}
if options != nil {
query = applyOptionOnly(query, options.Only)
}
result := query.First(&model)
if result.Error == nil {
return &model, nil
}
if options != nil && options.RaiseError != nil && *options.RaiseError {
return nil, result.Error
}
return nil, nil
}

View File

@ -0,0 +1,67 @@
package repository
import (
"fmt"
"regexp"
"testing"
"github.com/google/uuid"
"github.com/stretchr/testify/assert"
)
func TestGetMethod(t *testing.T) {
t.Run("With id filter, suppress errors", func(t *testing.T) {
sqldb, db, mock := NewMockDB()
defer sqldb.Close()
repo := RepoBase[MyModel]{}
repo.Init(db, nil)
id := uuid.New()
filter := MyModelFilter{
Id: &id,
}
options := GetOptions{}
sql := "SELECT * FROM my_models WHERE my_models.id = $1 ORDER BY my_models.id LIMIT $2"
mock.ExpectQuery(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql))).WithArgs(id, 1)
result, err := repo.Get(filter, &options)
assert.Nil(t, result)
assert.Nil(t, err)
if err := mock.ExpectationsWereMet(); err != nil {
t.Errorf("there were unfulfilled expectations: %s", err)
}
})
t.Run("With id filter, raise error", func(t *testing.T) {
sqldb, db, mock := NewMockDB()
defer sqldb.Close()
repo := RepoBase[MyModel]{}
repo.Init(db, nil)
id := uuid.New()
raiseError := true
filter := MyModelFilter{
Id: &id,
}
options := GetOptions{
RaiseError: &raiseError,
}
sql := "SELECT * FROM my_models WHERE my_models.id = $1 ORDER BY my_models.id LIMIT $2"
mock.ExpectQuery(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql))).
WithArgs(id, 1).
WillReturnError(nil)
result, err := repo.Get(filter, &options)
assert.Nil(t, result)
assert.NotNil(t, err)
if err := mock.ExpectationsWereMet(); err != nil {
t.Errorf("there were unfulfilled expectations: %s", err)
}
})
}

View File

@ -0,0 +1,42 @@
package repository
import (
"repo-pattern/app/repository/smartfilter"
"gorm.io/gorm/schema"
)
type ListOptions struct {
Only *[]string
Ordering *[]Order
Pagination *Pagination
}
type ListMethod[T schema.Tabler] struct {
repo *RepoBase[T]
}
func (m *ListMethod[T]) Init(repo *RepoBase[T]) {
m.repo = repo
}
func (m ListMethod[T]) List(filter interface{}, options *ListOptions) (*[]T, error) {
var (
model T
models []T
)
query, err := smartfilter.ToQuery(model, filter, m.repo.dbConn)
if err != nil {
return nil, err
}
if options != nil {
query = applyOptionOnly(query, options.Only)
query = applyOptionOrdering(query, options.Ordering)
query = applyOptionPagination(query, options.Pagination)
}
query.Find(&models)
return &models, nil
}

View File

@ -0,0 +1,275 @@
package repository
import (
"database/sql"
"fmt"
"log"
"regexp"
"testing"
"github.com/DATA-DOG/go-sqlmock"
"github.com/google/uuid"
"github.com/stretchr/testify/assert"
"gorm.io/driver/postgres"
"gorm.io/gorm"
)
func NewMockDB() (*sql.DB, *gorm.DB, sqlmock.Sqlmock) {
sqldb, mock, err := sqlmock.New()
if err != nil {
log.Fatalf("An error '%s' was not expected when opening a stub database connection", err)
}
gormdb, err := gorm.Open(postgres.New(postgres.Config{
WithoutQuotingCheck: true,
Conn: sqldb,
}), &gorm.Config{})
if err != nil {
log.Fatalf("An error '%s' was not expected when opening gorm database", err)
}
return sqldb, gormdb, mock
}
type MyModel struct {
Id *uuid.UUID `gorm:"type(uuid);unique"`
Value string
Cnt int
}
func (m MyModel) TableName() string {
return "my_models"
}
type MyModelFilter struct {
Id *uuid.UUID `filterfield:"field=id;operator=EQ"`
Ids *[]uuid.UUID `filterfield:"field=id;operator=IN"`
Value *string `filterfield:"field=value;operator=EQ"`
CntGT *int `filterfield:"field=cnt;operator=GT"`
}
func TestListMethod(t *testing.T) {
t.Run("With ordering", func(t *testing.T) {
sqldb, db, mock := NewMockDB()
defer sqldb.Close()
repo := RepoBase[MyModel]{}
repo.Init(db, nil)
filter := MyModelFilter{}
options := ListOptions{
Ordering: &[]Order{
{
Field: "id",
Direction: OrderASC,
},
{
Field: "cnt",
Direction: OrderDESC,
},
},
}
sql := "SELECT * FROM my_models ORDER BY id,cnt DESC"
mock.ExpectQuery(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql)))
_, err := repo.List(filter, &options)
assert.Nil(t, err)
if err := mock.ExpectationsWereMet(); err != nil {
t.Errorf("there were unfulfilled expectations: %s", err)
}
})
t.Run("With limit", func(t *testing.T) {
sqldb, db, mock := NewMockDB()
defer sqldb.Close()
repo := RepoBase[MyModel]{}
repo.Init(db, nil)
filter := MyModelFilter{}
options := ListOptions{
Pagination: &Pagination{
Limit: 111,
},
}
sql := "SELECT * FROM my_models LIMIT $1"
mock.ExpectQuery(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql))).
WithArgs(options.Pagination.Limit)
_, err := repo.List(filter, &options)
assert.Nil(t, err)
if err := mock.ExpectationsWereMet(); err != nil {
t.Errorf("there were unfulfilled expectations: %s", err)
}
})
t.Run("With offset", func(t *testing.T) {
sqldb, db, mock := NewMockDB()
defer sqldb.Close()
repo := RepoBase[MyModel]{}
repo.Init(db, nil)
filter := MyModelFilter{}
options := ListOptions{
Pagination: &Pagination{
Offset: 222,
},
}
sql := "SELECT * FROM my_models OFFSET $1"
mock.ExpectQuery(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql))).
WithArgs(options.Pagination.Offset)
_, err := repo.List(filter, &options)
assert.Nil(t, err)
if err := mock.ExpectationsWereMet(); err != nil {
t.Errorf("there were unfulfilled expectations: %s", err)
}
})
t.Run("With limit and offset", func(t *testing.T) {
sqldb, db, mock := NewMockDB()
defer sqldb.Close()
repo := RepoBase[MyModel]{}
repo.Init(db, nil)
filter := MyModelFilter{}
options := ListOptions{
Pagination: &Pagination{
Limit: 111,
Offset: 222,
},
}
sql := "SELECT * FROM my_models LIMIT $1 OFFSET $2"
mock.ExpectQuery(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql))).
WithArgs(options.Pagination.Limit, options.Pagination.Offset)
_, err := repo.List(filter, &options)
assert.Nil(t, err)
if err := mock.ExpectationsWereMet(); err != nil {
t.Errorf("there were unfulfilled expectations: %s", err)
}
})
t.Run("Simple filter", func(t *testing.T) {
sqldb, db, mock := NewMockDB()
defer sqldb.Close()
repo := RepoBase[MyModel]{}
repo.Init(db, nil)
id := uuid.New()
filter := MyModelFilter{
Id: &id,
}
sql := "SELECT * FROM my_models WHERE my_models.id = $1"
mock.ExpectQuery(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql))).
WithArgs(id)
_, err := repo.List(filter, nil)
assert.Nil(t, err)
if err := mock.ExpectationsWereMet(); err != nil {
t.Errorf("there were unfulfilled expectations: %s", err)
}
})
t.Run("Multiple filter values", func(t *testing.T) {
sqldb, db, mock := NewMockDB()
defer sqldb.Close()
repo := RepoBase[MyModel]{}
repo.Init(db, nil)
id := uuid.New()
count := 456
value := "some value"
filter := MyModelFilter{
Id: &id,
Value: &value,
CntGT: &count,
}
sql := "SELECT * FROM my_models WHERE my_models.id = $1 AND my_models.value = $2 AND my_models.cnt > $3"
mock.ExpectQuery(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql))).
WithArgs(id, value, count)
_, err := repo.List(filter, nil)
assert.Nil(t, err)
if err := mock.ExpectationsWereMet(); err != nil {
t.Errorf("there were unfulfilled expectations: %s", err)
}
})
t.Run("Multiple filter values and pagination", func(t *testing.T) {
sqldb, db, mock := NewMockDB()
defer sqldb.Close()
repo := RepoBase[MyModel]{}
repo.Init(db, nil)
id := uuid.New()
count := 456
value := "some value"
filter := MyModelFilter{
Id: &id,
Value: &value,
CntGT: &count,
}
options := ListOptions{
Pagination: &Pagination{
Offset: 111,
Limit: 222,
},
}
sql := "SELECT * FROM my_models WHERE my_models.id = $1 AND my_models.value = $2 AND my_models.cnt > $3 LIMIT $4 OFFSET $5"
mock.ExpectQuery(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql))).
WithArgs(id, value, count, options.Pagination.Limit, options.Pagination.Offset)
_, err := repo.List(filter, &options)
assert.Nil(t, err)
if err := mock.ExpectationsWereMet(); err != nil {
t.Errorf("there were unfulfilled expectations: %s", err)
}
})
t.Run("Only id and count", func(t *testing.T) {
sqldb, db, mock := NewMockDB()
defer sqldb.Close()
repo := RepoBase[MyModel]{}
repo.Init(db, nil)
filter := MyModelFilter{}
options := ListOptions{
Only: &[]string{
"id",
"cnt",
},
}
sql := "SELECT id,cnt FROM my_models"
mock.ExpectQuery(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql)))
_, err := repo.List(filter, &options)
assert.Nil(t, err)
if err := mock.ExpectationsWereMet(); err != nil {
t.Errorf("there were unfulfilled expectations: %s", err)
}
})
}

View File

@ -0,0 +1,18 @@
package repository
import (
"gorm.io/gorm/schema"
)
type SaveMethod[T schema.Tabler] struct {
repo *RepoBase[T]
}
func (m *SaveMethod[T]) Init(repo *RepoBase[T]) {
m.repo = repo
}
func (m SaveMethod[T]) Save(model *T) (*T, error) {
result := m.repo.dbConn.Save(model)
return model, result.Error
}

View File

@ -0,0 +1,69 @@
package repository
import (
"fmt"
"regexp"
"testing"
"github.com/DATA-DOG/go-sqlmock"
"github.com/google/uuid"
"github.com/stretchr/testify/assert"
)
func TestSaveMethod(t *testing.T) {
t.Run("Save new model", func(t *testing.T) {
sqldb, db, mock := NewMockDB()
defer sqldb.Close()
repo := RepoBase[MyModel]{}
repo.Init(db, nil)
model := MyModel{
Value: "some value",
Cnt: 123,
}
sql := "INSERT INTO my_models (id,value,cnt) VALUES ($1,$2,$3)"
mock.ExpectBegin()
mock.ExpectExec(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql))).
WithArgs(model.Id, model.Value, model.Cnt).
WillReturnResult(sqlmock.NewResult(1, 1))
mock.ExpectCommit()
_, err := repo.Save(&model)
assert.Nil(t, err)
if err := mock.ExpectationsWereMet(); err != nil {
t.Errorf("there were unfulfilled expectations: %s", err)
}
})
t.Run("Update existing model", func(t *testing.T) {
sqldb, db, mock := NewMockDB()
defer sqldb.Close()
repo := RepoBase[MyModel]{}
repo.Init(db, nil)
id := uuid.New()
model := MyModel{
Id: &id,
Value: "some value",
Cnt: 123,
}
sql := "UPDATE my_models SET value=$1,cnt=$2 WHERE id = $3"
mock.ExpectBegin()
mock.ExpectExec(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql))).
WithArgs(model.Value, model.Cnt, model.Id).
WillReturnResult(sqlmock.NewResult(1, 1))
mock.ExpectCommit()
_, err := repo.Save(&model)
assert.Nil(t, err)
if err := mock.ExpectationsWereMet(); err != nil {
t.Errorf("there were unfulfilled expectations: %s", err)
}
})
}

View File

@ -0,0 +1,31 @@
package repository
import (
"repo-pattern/app/repository/smartfilter"
"gorm.io/gorm/schema"
)
type UpdateMethod[T schema.Tabler] struct {
repo *RepoBase[T]
}
func (m *UpdateMethod[T]) Init(repo *RepoBase[T]) {
m.repo = repo
}
func (m UpdateMethod[T]) Update(filter interface{}, values map[string]any) (int64, error) {
var (
model T
)
query, err := smartfilter.ToQuery(model, filter, m.repo.dbConn)
if err != nil {
return 0, err
}
result := query.Model(&model).Updates(values)
if result.Error != nil {
return 0, result.Error
}
return result.RowsAffected, nil
}

View File

@ -0,0 +1,43 @@
package repository
import (
"fmt"
"regexp"
"testing"
"github.com/DATA-DOG/go-sqlmock"
"github.com/stretchr/testify/assert"
)
func TestUpdateMethod(t *testing.T) {
t.Run("Update", func(t *testing.T) {
sqldb, db, mock := NewMockDB()
defer sqldb.Close()
repo := RepoBase[MyModel]{}
repo.Init(db, nil)
cnt := 10
filter := MyModelFilter{
CntGT: &cnt,
}
values := map[string]any{
"cnt": 111,
"value": 222,
}
sql := "UPDATE my_models SET cnt=$1,value=$2 WHERE my_models.cnt > $3"
mock.ExpectBegin()
mock.ExpectExec(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql))).
WithArgs(values["cnt"], values["value"], cnt).
WillReturnResult(sqlmock.NewResult(1, 1))
mock.ExpectCommit()
_, err := repo.Update(filter, values)
assert.Nil(t, err)
if err := mock.ExpectationsWereMet(); err != nil {
t.Errorf("there were unfulfilled expectations: %s", err)
}
})
}

View File

@ -1,84 +0,0 @@
package repository
import (
"errors"
"repo-pattern/app/repository/smartfilter"
"gorm.io/gorm"
"gorm.io/gorm/schema"
)
type ListMethod[T schema.Tabler] struct {
DbConn *gorm.DB
}
func (m *ListMethod[T]) Init(dbConn *gorm.DB) {
m.DbConn = dbConn
}
func (m ListMethod[T]) List(filter interface{}) (*[]T, error) {
var (
model T
models []T
)
query, err := smartfilter.ToQuery(model, filter, m.DbConn)
if err != nil {
return nil, err
}
query.Find(&models)
return &models, nil
}
type GetMethod[T schema.Tabler] struct {
DbConn *gorm.DB
}
func (m *GetMethod[T]) Init(dbConn *gorm.DB) {
m.DbConn = dbConn
}
func (m GetMethod[T]) Get(filter interface{}) (*T, error) {
var (
model T
)
query, err := smartfilter.ToQuery(model, filter, m.DbConn)
if err != nil {
return nil, err
}
result := query.First(&model)
if result.Error != nil {
return nil, result.Error
}
return &model, nil
}
type ExistsMethod[T schema.Tabler] struct {
DbConn *gorm.DB
}
func (m *ExistsMethod[T]) Init(dbConn *gorm.DB) {
m.DbConn = dbConn
}
func (m ExistsMethod[T]) Exists(filter interface{}) (bool, error) {
var (
model T
)
query := m.DbConn.Model(model)
query, err := smartfilter.ToQuery(model, filter, query)
if err != nil {
return false, err
}
result := query.Select("*").First(&model)
exists := !errors.Is(result.Error, gorm.ErrRecordNotFound) && result.Error == nil
return exists, nil
}

61
app/repository/options.go Normal file
View File

@ -0,0 +1,61 @@
package repository
import (
"fmt"
"gorm.io/gorm"
)
type Pagination struct {
Offset int
Limit int
}
type OrderDirection string
const (
OrderASC OrderDirection = "ASC"
OrderDESC OrderDirection = "DESC"
)
type Order struct {
Field string
Direction OrderDirection
}
func applyOptionOnly(query *gorm.DB, only *[]string) *gorm.DB {
if only == nil || len(*only) == 0 {
return query
}
query = query.Select(*only)
return query
}
func applyOptionOrdering(query *gorm.DB, ordering *[]Order) *gorm.DB {
if ordering == nil || len(*ordering) == 0 {
return query
}
for _, order := range *ordering {
if len(order.Direction) == 0 || order.Direction == OrderASC {
query = query.Order(order.Field)
} else {
query = query.Order(fmt.Sprintf("%s %s", order.Field, order.Direction))
}
}
return query
}
func applyOptionPagination(query *gorm.DB, pagination *Pagination) *gorm.DB {
if pagination == nil {
return query
}
if pagination.Limit != 0 {
query = query.Limit(pagination.Limit)
}
if pagination.Offset != 0 {
query = query.Offset(pagination.Offset)
}
return query
}

View File

@ -5,25 +5,55 @@ import (
"gorm.io/gorm/schema"
)
type MethodInitInterface interface {
Init(dbConn *gorm.DB)
const DEFAULT_ID_FIELD = "id"
type MethodInitInterface[T schema.Tabler] interface {
Init(repo *RepoBase[T])
}
type RepoOptions struct {
IdField string
}
type RepoBase[T schema.Tabler] struct {
DbConn int
IdField string
dbConn *gorm.DB
ListMethod[T]
GetMethod[T]
ExistsMethod[T]
methods []MethodInitInterface
CountMethod[T]
SaveMethod[T]
UpdateMethod[T]
DeleteMethod[T]
}
func (b *RepoBase[T]) InitMethods(dbConn *gorm.DB) {
for _, method := range b.methods {
method.Init(dbConn)
func (repo *RepoBase[T]) InitMethods(methods []MethodInitInterface[T]) {
for _, method := range methods {
method.Init(repo)
}
}
func (m *RepoBase[T]) Init(dbConn *gorm.DB) {
m.methods = []MethodInitInterface{&m.ListMethod, &m.GetMethod, &m.ExistsMethod}
m.InitMethods(dbConn)
func (m *RepoBase[T]) Init(dbConn *gorm.DB, options *RepoOptions) {
m.dbConn = dbConn
if options == nil {
// no options provided? set defaults
m.IdField = DEFAULT_ID_FIELD
} else {
if len(options.IdField) > 0 {
m.IdField = options.IdField
}
}
methods := []MethodInitInterface[T]{
&m.ListMethod,
&m.GetMethod,
&m.ExistsMethod,
&m.CountMethod,
&m.SaveMethod,
&m.UpdateMethod,
&m.DeleteMethod,
}
m.InitMethods(methods)
}

View File

@ -4,6 +4,8 @@ import (
"fmt"
"reflect"
"time"
"github.com/google/uuid"
)
type FilterField struct {
@ -131,17 +133,41 @@ func strValueGetter(ff *FilterField, v reflect.Value) error {
}
func timeValueGetter(ff *FilterField, v reflect.Value) error {
timeValue, ok := v.Interface().(time.Time)
if !ok {
return fmt.Errorf("error converting interface to time")
value, err := timeValueToStr(v)
if err != nil {
return err
}
value := timeValue.Format(time.RFC3339)
ff.strValue = &value
ff.valueKind = reflect.String
return nil
}
func uuidValueGetter(ff *FilterField, v reflect.Value) error {
value, err := uuidValueToStr(v)
if err != nil {
return err
}
ff.strValue = &value
ff.valueKind = reflect.String
return nil
}
func timeValueToStr(v reflect.Value) (string, error) {
value, ok := v.Interface().(time.Time)
if !ok {
return "", fmt.Errorf("error converting interface to time")
}
return value.Format(time.RFC3339), nil
}
func uuidValueToStr(v reflect.Value) (string, error) {
value, ok := v.Interface().(uuid.UUID)
if !ok {
return "", fmt.Errorf("error converting interface to uuid")
}
return value.String(), nil
}
func unsupportedValueGetter(ff *FilterField, v reflect.Value) error {
return fmt.Errorf("unsupported type: %v", v.Type())
}
@ -183,16 +209,18 @@ func newTypeGetter(t reflect.Type, allowAddr bool) valueGetterFunc {
// return interfaceEncoder
case reflect.Struct:
// check if value type is time
timeType := reflect.TypeOf(time.Time{})
if t == timeType {
if t == reflect.TypeOf(time.Time{}) {
return timeValueGetter
}
// case reflect.Map:
// return newMapEncoder(t)
case reflect.Slice:
return newSliceGetter(t)
// case reflect.Array:
// return newArrayGetter(t)
case reflect.Array:
if t == reflect.TypeOf(uuid.UUID{}) {
return uuidValueGetter
}
return newArrayGetter(t)
case reflect.Pointer:
return newPtrValueGetter(t)
}
@ -234,7 +262,6 @@ type sliceGetter struct {
func (sg sliceGetter) getValue(ff *FilterField, v reflect.Value) error {
for n := range v.Len() {
element := v.Index(n)
fmt.Printf("ELEMENT: %+v\n", element)
switch element.Kind() {
case reflect.Bool:
@ -247,6 +274,22 @@ func (sg sliceGetter) getValue(ff *FilterField, v reflect.Value) error {
ff.appendFloat(element.Float())
case reflect.String:
ff.appendStr(element.String())
case reflect.Struct:
if element.Type() == reflect.TypeOf(time.Time{}) {
value, err := timeValueToStr(element)
if err != nil {
return err
}
ff.appendStr(value)
}
case reflect.Array:
if element.Type() == reflect.TypeOf(uuid.UUID{}) {
value, err := uuidValueToStr(element)
if err != nil {
return err
}
ff.appendStr(value)
}
}
}
return nil

View File

@ -7,7 +7,7 @@ import (
"github.com/DATA-DOG/go-sqlmock"
"github.com/go-playground/assert"
"gorm.io/driver/mysql"
"gorm.io/driver/postgres"
"gorm.io/gorm"
)
@ -17,9 +17,9 @@ func NewMockDB() (*gorm.DB, sqlmock.Sqlmock) {
log.Fatalf("An error '%s' was not expected when opening a stub database connection", err)
}
gormDB, err := gorm.Open(mysql.New(mysql.Config{
Conn: db,
SkipInitializeWithVersion: true,
gormDB, err := gorm.Open(postgres.New(postgres.Config{
WithoutQuotingCheck: true,
Conn: db,
}), &gorm.Config{})
if err != nil {
@ -38,7 +38,7 @@ func (m MyModel) TableName() string {
return "my_models"
}
type TestCase struct {
type HandleOperatorTestCase struct {
name string
filterField FilterField
expected string
@ -63,7 +63,7 @@ func TestHandleOperatorEQ(t *testing.T) {
db, _ := NewMockDB()
testFunc := handleOperatorEQ
testCases := []TestCase{
testCases := []HandleOperatorTestCase{
{
name: "handleOperatorEQ bool true",
filterField: FilterField{
@ -71,7 +71,7 @@ func TestHandleOperatorEQ(t *testing.T) {
boolValue: &boolTrue,
valueKind: reflect.Bool,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field = true ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field = true ORDER BY my_models.id LIMIT 1",
},
{
name: "handleOperatorEQ bool false",
@ -80,7 +80,7 @@ func TestHandleOperatorEQ(t *testing.T) {
boolValue: &boolFalse,
valueKind: reflect.Bool,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field = false ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field = false ORDER BY my_models.id LIMIT 1",
},
{
name: "handleOperatorEQ int64",
@ -89,7 +89,7 @@ func TestHandleOperatorEQ(t *testing.T) {
intValue: &int64Value,
valueKind: reflect.Int64,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field = -123456 ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field = -123456 ORDER BY my_models.id LIMIT 1",
},
{
name: "handleOperatorEQ uint64",
@ -98,7 +98,7 @@ func TestHandleOperatorEQ(t *testing.T) {
uintValue: &uint64Value,
valueKind: reflect.Uint64,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field = 123456 ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field = 123456 ORDER BY my_models.id LIMIT 1",
},
{
name: "handleOperatorEQ float",
@ -107,7 +107,7 @@ func TestHandleOperatorEQ(t *testing.T) {
floatValue: &floatValue,
valueKind: reflect.Float64,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field = -123456.789 ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field = -123456.789 ORDER BY my_models.id LIMIT 1",
},
{
name: "handleOperatorEQ string",
@ -116,7 +116,7 @@ func TestHandleOperatorEQ(t *testing.T) {
strValue: &strValue,
valueKind: reflect.String,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field = 'Some Value' ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field = 'Some Value' ORDER BY my_models.id LIMIT 1",
},
}
@ -136,7 +136,7 @@ func TestHandleOperatorNE(t *testing.T) {
db, _ := NewMockDB()
testFunc := handleOperatorNE
testCases := []TestCase{
testCases := []HandleOperatorTestCase{
{
name: "handleOperatorNE bool true",
filterField: FilterField{
@ -144,7 +144,7 @@ func TestHandleOperatorNE(t *testing.T) {
boolValue: &boolTrue,
valueKind: reflect.Bool,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field != true ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field != true ORDER BY my_models.id LIMIT 1",
},
{
name: "handleOperatorNE bool false",
@ -153,7 +153,7 @@ func TestHandleOperatorNE(t *testing.T) {
boolValue: &boolFalse,
valueKind: reflect.Bool,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field != false ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field != false ORDER BY my_models.id LIMIT 1",
},
{
name: "handleOperatorNE int64",
@ -162,7 +162,7 @@ func TestHandleOperatorNE(t *testing.T) {
intValue: &int64Value,
valueKind: reflect.Int64,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field != -123456 ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field != -123456 ORDER BY my_models.id LIMIT 1",
},
{
name: "handleOperatorNE uint64",
@ -171,7 +171,7 @@ func TestHandleOperatorNE(t *testing.T) {
uintValue: &uint64Value,
valueKind: reflect.Uint64,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field != 123456 ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field != 123456 ORDER BY my_models.id LIMIT 1",
},
{
name: "handleOperatorNE float",
@ -180,7 +180,7 @@ func TestHandleOperatorNE(t *testing.T) {
floatValue: &floatValue,
valueKind: reflect.Float64,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field != -123456.789 ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field != -123456.789 ORDER BY my_models.id LIMIT 1",
},
{
name: "handleOperatorNE string",
@ -189,7 +189,7 @@ func TestHandleOperatorNE(t *testing.T) {
strValue: &strValue,
valueKind: reflect.String,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field != 'Some Value' ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field != 'Some Value' ORDER BY my_models.id LIMIT 1",
},
}
@ -209,7 +209,7 @@ func TestHandleOperatorLIKE(t *testing.T) {
db, _ := NewMockDB()
testFunc := handleOperatorLIKE
testCases := []TestCase{
testCases := []HandleOperatorTestCase{
{
name: "handleOperatorLIKE",
filterField: FilterField{
@ -217,7 +217,7 @@ func TestHandleOperatorLIKE(t *testing.T) {
strValue: &strValue,
valueKind: reflect.String,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field LIKE '%Some Value%' ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field LIKE '%Some Value%' ORDER BY my_models.id LIMIT 1",
},
}
@ -237,7 +237,7 @@ func TestHandleOperatorILIKE(t *testing.T) {
db, _ := NewMockDB()
testFunc := handleOperatorILIKE
testCases := []TestCase{
testCases := []HandleOperatorTestCase{
{
name: "handleOperatorILIKE",
filterField: FilterField{
@ -245,7 +245,7 @@ func TestHandleOperatorILIKE(t *testing.T) {
strValue: &strValue,
valueKind: reflect.String,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field ILIKE '%Some Value%' ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field ILIKE '%Some Value%' ORDER BY my_models.id LIMIT 1",
},
}
@ -265,7 +265,7 @@ func TestHandleOperatorGT(t *testing.T) {
db, _ := NewMockDB()
testFunc := handleOperatorGT
testCases := []TestCase{
testCases := []HandleOperatorTestCase{
{
name: "handleOperatorGT int64",
filterField: FilterField{
@ -273,7 +273,7 @@ func TestHandleOperatorGT(t *testing.T) {
intValue: &int64Value,
valueKind: reflect.Int64,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field > -123456 ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field > -123456 ORDER BY my_models.id LIMIT 1",
},
{
name: "handleOperatorGT uint64",
@ -282,7 +282,7 @@ func TestHandleOperatorGT(t *testing.T) {
uintValue: &uint64Value,
valueKind: reflect.Uint64,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field > 123456 ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field > 123456 ORDER BY my_models.id LIMIT 1",
},
{
name: "handleOperatorGT float",
@ -291,7 +291,7 @@ func TestHandleOperatorGT(t *testing.T) {
floatValue: &floatValue,
valueKind: reflect.Float64,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field > -123456.789 ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field > -123456.789 ORDER BY my_models.id LIMIT 1",
},
{
name: "handleOperatorGT string",
@ -300,7 +300,7 @@ func TestHandleOperatorGT(t *testing.T) {
strValue: &strValue,
valueKind: reflect.String,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field > 'Some Value' ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field > 'Some Value' ORDER BY my_models.id LIMIT 1",
},
}
@ -320,7 +320,7 @@ func TestHandleOperatorGE(t *testing.T) {
db, _ := NewMockDB()
testFunc := handleOperatorGE
testCases := []TestCase{
testCases := []HandleOperatorTestCase{
{
name: "handleOperatorGE int64",
filterField: FilterField{
@ -328,7 +328,7 @@ func TestHandleOperatorGE(t *testing.T) {
intValue: &int64Value,
valueKind: reflect.Int64,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field >= -123456 ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field >= -123456 ORDER BY my_models.id LIMIT 1",
},
{
name: "handleOperatorGE uint64",
@ -337,7 +337,7 @@ func TestHandleOperatorGE(t *testing.T) {
uintValue: &uint64Value,
valueKind: reflect.Uint64,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field >= 123456 ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field >= 123456 ORDER BY my_models.id LIMIT 1",
},
{
name: "handleOperatorGE float",
@ -346,7 +346,7 @@ func TestHandleOperatorGE(t *testing.T) {
floatValue: &floatValue,
valueKind: reflect.Float64,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field >= -123456.789 ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field >= -123456.789 ORDER BY my_models.id LIMIT 1",
},
{
name: "handleOperatorGE string",
@ -355,7 +355,7 @@ func TestHandleOperatorGE(t *testing.T) {
strValue: &strValue,
valueKind: reflect.String,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field >= 'Some Value' ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field >= 'Some Value' ORDER BY my_models.id LIMIT 1",
},
}
@ -375,7 +375,7 @@ func TestHandleOperatorLT(t *testing.T) {
db, _ := NewMockDB()
testFunc := handleOperatorLT
testCases := []TestCase{
testCases := []HandleOperatorTestCase{
{
name: "handleOperatorLT int64",
filterField: FilterField{
@ -383,7 +383,7 @@ func TestHandleOperatorLT(t *testing.T) {
intValue: &int64Value,
valueKind: reflect.Int64,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field < -123456 ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field < -123456 ORDER BY my_models.id LIMIT 1",
},
{
name: "handleOperatorLT uint64",
@ -392,7 +392,7 @@ func TestHandleOperatorLT(t *testing.T) {
uintValue: &uint64Value,
valueKind: reflect.Uint64,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field < 123456 ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field < 123456 ORDER BY my_models.id LIMIT 1",
},
{
name: "handleOperatorLT float",
@ -401,7 +401,7 @@ func TestHandleOperatorLT(t *testing.T) {
floatValue: &floatValue,
valueKind: reflect.Float64,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field < -123456.789 ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field < -123456.789 ORDER BY my_models.id LIMIT 1",
},
{
name: "handleOperatorLT string",
@ -410,7 +410,7 @@ func TestHandleOperatorLT(t *testing.T) {
strValue: &strValue,
valueKind: reflect.String,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field < 'Some Value' ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field < 'Some Value' ORDER BY my_models.id LIMIT 1",
},
}
@ -430,7 +430,7 @@ func TestHandleOperatorLE(t *testing.T) {
db, _ := NewMockDB()
testFunc := handleOperatorLE
testCases := []TestCase{
testCases := []HandleOperatorTestCase{
{
name: "handleOperatorLE int64",
filterField: FilterField{
@ -438,7 +438,7 @@ func TestHandleOperatorLE(t *testing.T) {
intValue: &int64Value,
valueKind: reflect.Int64,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field <= -123456 ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field <= -123456 ORDER BY my_models.id LIMIT 1",
},
{
name: "handleOperatorLE uint64",
@ -447,7 +447,7 @@ func TestHandleOperatorLE(t *testing.T) {
uintValue: &uint64Value,
valueKind: reflect.Uint64,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field <= 123456 ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field <= 123456 ORDER BY my_models.id LIMIT 1",
},
{
name: "handleOperatorLE float",
@ -456,7 +456,7 @@ func TestHandleOperatorLE(t *testing.T) {
floatValue: &floatValue,
valueKind: reflect.Float64,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field <= -123456.789 ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field <= -123456.789 ORDER BY my_models.id LIMIT 1",
},
{
name: "handleOperatorLE string",
@ -465,7 +465,7 @@ func TestHandleOperatorLE(t *testing.T) {
strValue: &strValue,
valueKind: reflect.String,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field <= 'Some Value' ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field <= 'Some Value' ORDER BY my_models.id LIMIT 1",
},
}
@ -485,7 +485,7 @@ func TestHandleOperatorIN(t *testing.T) {
db, _ := NewMockDB()
testFunc := handleOperatorIN
testCases := []TestCase{
testCases := []HandleOperatorTestCase{
{
name: "handleOperatorIN bool",
filterField: FilterField{
@ -493,7 +493,7 @@ func TestHandleOperatorIN(t *testing.T) {
boolValues: &boolValues,
valueKind: reflect.Bool,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field IN (true,false) ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field IN (true,false) ORDER BY my_models.id LIMIT 1",
},
{
name: "handleOperatorIN int64",
@ -502,7 +502,7 @@ func TestHandleOperatorIN(t *testing.T) {
intValues: &int64Values,
valueKind: reflect.Int64,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field IN (-123456,1,123456) ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field IN (-123456,1,123456) ORDER BY my_models.id LIMIT 1",
},
{
name: "handleOperatorIN uint64",
@ -511,7 +511,7 @@ func TestHandleOperatorIN(t *testing.T) {
uintValues: &uint64Values,
valueKind: reflect.Uint64,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field IN (123456,1234567,1234568) ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field IN (123456,1234567,1234568) ORDER BY my_models.id LIMIT 1",
},
{
name: "handleOperatorIN float",
@ -520,7 +520,7 @@ func TestHandleOperatorIN(t *testing.T) {
floatValues: &floatValues,
valueKind: reflect.Float64,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field IN (-123456.789,-1,123456.789) ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field IN (-123456.789,-1,123456.789) ORDER BY my_models.id LIMIT 1",
},
{
name: "handleOperatorIN string",
@ -529,7 +529,7 @@ func TestHandleOperatorIN(t *testing.T) {
strValues: &strValues,
valueKind: reflect.String,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field IN ('First Value','Second Value','Third Value') ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field IN ('First Value','Second Value','Third Value') ORDER BY my_models.id LIMIT 1",
},
}
@ -549,7 +549,7 @@ func TestHandleOperatorNOT_IN(t *testing.T) {
db, _ := NewMockDB()
testFunc := handleOperatorNOT_IN
testCases := []TestCase{
testCases := []HandleOperatorTestCase{
{
name: "handleOperatorNOT_IN bool",
filterField: FilterField{
@ -557,7 +557,7 @@ func TestHandleOperatorNOT_IN(t *testing.T) {
boolValues: &boolValues,
valueKind: reflect.Bool,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field NOT IN (true,false) ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field NOT IN (true,false) ORDER BY my_models.id LIMIT 1",
},
{
name: "handleOperatorNOT_IN int64",
@ -566,7 +566,7 @@ func TestHandleOperatorNOT_IN(t *testing.T) {
intValues: &int64Values,
valueKind: reflect.Int64,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field NOT IN (-123456,1,123456) ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field NOT IN (-123456,1,123456) ORDER BY my_models.id LIMIT 1",
},
{
name: "handleOperatorNOT_IN uint64",
@ -575,7 +575,7 @@ func TestHandleOperatorNOT_IN(t *testing.T) {
uintValues: &uint64Values,
valueKind: reflect.Uint64,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field NOT IN (123456,1234567,1234568) ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field NOT IN (123456,1234567,1234568) ORDER BY my_models.id LIMIT 1",
},
{
name: "handleOperatorNOT_IN float",
@ -584,7 +584,7 @@ func TestHandleOperatorNOT_IN(t *testing.T) {
floatValues: &floatValues,
valueKind: reflect.Float64,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field NOT IN (-123456.789,-1,123456.789) ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field NOT IN (-123456.789,-1,123456.789) ORDER BY my_models.id LIMIT 1",
},
{
name: "handleOperatorNOT_IN string",
@ -593,7 +593,7 @@ func TestHandleOperatorNOT_IN(t *testing.T) {
strValues: &strValues,
valueKind: reflect.String,
},
expected: "SELECT * FROM `my_models` WHERE my_table.my_field NOT IN ('First Value','Second Value','Third Value') ORDER BY `my_models`.`id` LIMIT 1",
expected: "SELECT * FROM my_models WHERE my_table.my_field NOT IN ('First Value','Second Value','Third Value') ORDER BY my_models.id LIMIT 1",
},
}

View File

@ -5,17 +5,22 @@ import (
"reflect"
"slices"
"strings"
"time"
"gorm.io/gorm"
"gorm.io/gorm/schema"
)
const TAG_NAME = "filterfield"
const TAG_VALUE_SEPARATOR = ","
const TAG_PAIRS_SEPARATOR = ";"
const TAG_LIST_SEPARATOR = ","
const TAG_KEYVALUE_SEPARATOR = "="
type handlerFunc func(query *gorm.DB, tableName string, filterField *FilterField) *gorm.DB
type QueryApplier interface {
ApplyQuery(query *gorm.DB) *gorm.DB
}
var operatorHandlers = map[Operator]handlerFunc{
OperatorEQ: handleOperatorEQ,
OperatorNE: handleOperatorNE,
@ -29,17 +34,6 @@ var operatorHandlers = map[Operator]handlerFunc{
OperatorNOT_IN: handleOperatorNOT_IN,
}
type CertFilter struct {
Alive *bool `filterfield:"alive,EQ"`
SerialNumber *string `filterfield:"serial_number,NE"`
SerialNumberContains *string `filterfield:"serial_number,LIKE"`
IssuerContains *string `filterfield:"issuer,ILIKE"`
Id *string `filterfield:"id,EQ"`
Ids *[]string `filterfield:"id,IN"`
IdsNot *[]string `filterfield:"id,NOT_IN"`
CreatedAt_Lt *time.Time `filterfield:"created_at,LT"`
}
type ReflectedStructField struct {
name string
value reflect.Value
@ -78,15 +72,20 @@ func getFilterFields(filter interface{}) []ReflectedStructField {
return res
}
func getQueryApplierInterface(filter interface{}) QueryApplier {
queryApplier, ok := filter.(QueryApplier)
if ok {
return queryApplier
}
return nil
}
func ToQuery(model schema.Tabler, filter interface{}, query *gorm.DB) (*gorm.DB, error) {
st := reflect.TypeOf(filter)
tableName := model.TableName()
modelName := st.Name()
fmt.Printf("Table name: %s\n", tableName)
fmt.Printf("Model name: %s\n", modelName)
fields := getFilterFields(filter)
for _, field := range fields {
filterField, err := newFilterField(field.tagValue)
@ -108,23 +107,57 @@ func ToQuery(model schema.Tabler, filter interface{}, query *gorm.DB) (*gorm.DB,
}
}
// apply custom filters, if interface exists
queryApplier := getQueryApplierInterface(filter)
if queryApplier != nil {
query = queryApplier.ApplyQuery(query)
}
return query, nil
}
func newFilterField(tagValue string) (*FilterField, error) {
values := strings.Split(tagValue, TAG_VALUE_SEPARATOR)
if len(values) != 2 {
return nil, fmt.Errorf("incorrect number of tag values: %s", tagValue)
func splitTrim(value string, separator string) []string {
var out []string = []string{}
for _, s := range strings.Split(value, separator) {
if len(s) == 0 {
continue
}
out = append(out, strings.TrimSpace(s))
}
operator := Operator(values[1])
if !slices.Contains(OPERATORS, operator) {
return nil, fmt.Errorf("unknown operator: %s", operator)
}
f := FilterField{
Name: values[0],
Operator: operator,
}
return &f, nil
return out
}
func newFilterField(tagValue string) (*FilterField, error) {
filterField := FilterField{}
for _, pair := range splitTrim(tagValue, TAG_PAIRS_SEPARATOR) {
kvs := splitTrim(pair, TAG_KEYVALUE_SEPARATOR)
if len(kvs) != 2 {
return nil, fmt.Errorf("invalid tag value: %s", strings.TrimSpace(pair))
}
key := kvs[0]
value := kvs[1]
switch key {
case "field":
filterField.Name = value
case "operator":
operator := Operator(value)
if !slices.Contains(OPERATORS, operator) {
return nil, fmt.Errorf("unknown operator: %s", operator)
}
filterField.Operator = operator
default:
return nil, fmt.Errorf("invalid value key: %s", key)
}
}
if len(filterField.Name) == 0 {
return nil, fmt.Errorf("missing field name in tag: %s", tagValue)
}
if len(filterField.Operator) == 0 {
return nil, fmt.Errorf("missing operator in tag: %s", tagValue)
}
return &filterField, nil
}

View File

@ -6,6 +6,7 @@ import (
"time"
"github.com/stretchr/testify/assert"
"gorm.io/gorm"
)
func TestGetFilterFields(t *testing.T) {
@ -101,11 +102,11 @@ func TestGetFilterFields(t *testing.T) {
t.Run("Skip nil fields", func(t *testing.T) {
type TestFilter struct {
Alive *bool `filterfield:"alive,EQ"`
Id *int64 `filterfield:"id,EQ"`
Ids *[]uint `filterfield:"id,IN"`
IdsNot *[]uint `filterfield:"id,NOT_IN"`
FirstName *string `filterfield:"first_name,EQ"`
Alive *bool `filterfield:"alive;EQ"`
Id *int64 `filterfield:"id;EQ"`
Ids *[]uint `filterfield:"id;IN"`
IdsNot *[]uint `filterfield:"id;NOT_IN"`
FirstName *string `filterfield:"first_name;EQ"`
}
filter := TestFilter{}
result := getFilterFields(filter)
@ -119,7 +120,7 @@ func TestGetFilterFields(t *testing.T) {
)
type TestFilter struct {
Alive *bool
Id *int64 `funnytag:"created_at,LT"`
Id *int64 `funnytag:"created_at;LT"`
}
filter := TestFilter{
Alive: &alive,
@ -129,3 +130,100 @@ func TestGetFilterFields(t *testing.T) {
assert.Equal(t, 0, len(result))
})
}
type TagParseTestCase struct {
name string
tagValue string
expected FilterField
}
func TestFilterField(t *testing.T) {
testCases := []TagParseTestCase{
{
name: "Parse without spaces",
tagValue: "field=field_1;operator=EQ",
expected: FilterField{
Name: "field_1",
Operator: OperatorEQ,
},
},
{
name: "Parse spaces between pairs",
tagValue: " field=field_2 ; operator=LT ",
expected: FilterField{
Name: "field_2",
Operator: OperatorLT,
},
},
{
name: "Parse spaces between around keys and values",
tagValue: "operator = LIKE ; field = field_3",
expected: FilterField{
Name: "field_3",
Operator: OperatorLIKE,
},
},
}
for _, testCase := range testCases {
t.Run(testCase.name, func(t *testing.T) {
filterField, err := newFilterField(testCase.tagValue)
assert.Nil(t, err)
assert.Equal(t, testCase.expected.Name, filterField.Name)
assert.Equal(t, testCase.expected.Operator, filterField.Operator)
})
}
t.Run("Fail on invalid tag value", func(t *testing.T) {
filterField, err := newFilterField("field=field_1=fail; operator=EQ")
assert.Nil(t, filterField)
assert.EqualError(t, err, "invalid tag value: field=field_1=fail")
})
t.Run("Fail on invalid operator", func(t *testing.T) {
filterField, err := newFilterField("field=field_1; operator=FAIL")
assert.Nil(t, filterField)
assert.EqualError(t, err, "unknown operator: FAIL")
})
t.Run("Fail on invalid value key", func(t *testing.T) {
filterField, err := newFilterField("failkey=field_1; operator=FAIL")
assert.Nil(t, filterField)
assert.EqualError(t, err, "invalid value key: failkey")
})
t.Run("Fail on missing field name", func(t *testing.T) {
filterField, err := newFilterField("operator=EQ")
assert.Nil(t, filterField)
assert.EqualError(t, err, "missing field name in tag: operator=EQ")
})
t.Run("Fail on missing operator", func(t *testing.T) {
filterField, err := newFilterField("field=field_1")
assert.Nil(t, filterField)
assert.EqualError(t, err, "missing operator in tag: field=field_1")
})
}
type filterWithoutQueryApplier struct{}
type filterWithQueryApplier struct{}
func (f filterWithQueryApplier) ApplyQuery(query *gorm.DB) *gorm.DB {
return query
}
func TestSmartfilterApplyQuery(t *testing.T) {
t.Run("Get query applier interface - without interface", func(t *testing.T) {
f := filterWithoutQueryApplier{}
queryApplier := getQueryApplierInterface(f)
assert.Nil(t, queryApplier)
})
t.Run("Get query applier interface - with interface", func(t *testing.T) {
f := filterWithQueryApplier{}
queryApplier := getQueryApplierInterface(f)
assert.NotNil(t, queryApplier)
})
}

4
go.mod
View File

@ -3,6 +3,8 @@ module repo-pattern
go 1.22.3
require (
github.com/DATA-DOG/go-sqlmock v1.5.2
github.com/go-playground/assert v1.2.1
github.com/google/uuid v1.6.0
github.com/kelseyhightower/envconfig v1.4.0
github.com/mozillazg/go-slugify v0.2.0
@ -16,9 +18,7 @@ require (
require (
filippo.io/edwards25519 v1.1.0 // indirect
github.com/DATA-DOG/go-sqlmock v1.5.2 // indirect
github.com/davecgh/go-spew v1.1.1 // indirect
github.com/go-playground/assert v1.2.1 // indirect
github.com/go-sql-driver/mysql v1.8.1 // indirect
github.com/jackc/pgpassfile v1.0.0 // indirect
github.com/jackc/pgservicefile v0.0.0-20231201235250-de7065d80cb9 // indirect

6
go.sum
View File

@ -48,14 +48,8 @@ github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZN
github.com/rogpeppe/go-internal v1.12.0 h1:exVL4IDcn6na9z1rAb56Vxr+CgyK3nn3O+epU5NdKM8=
github.com/rogpeppe/go-internal v1.12.0/go.mod h1:E+RYuTGaKKdloAfM02xzb0FW3Paa99yedzYV+kq4uf4=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto=