wip(api,cli): first entity

heiytor · heiytor · commit 9bff9bf2ce63 · 2025-03-24T16:24:05.000-03:00
diff --git a/api/go.mod b/api/go.mod
@@ -20,8 +20,11 @@ require (
 	github.com/spf13/cobra v1.9.1
 	github.com/square/mongo-lock v0.0.0-20230808145049-cfcf499f6bf0
 	github.com/stretchr/testify v1.10.0
+	github.com/testcontainers/testcontainers-go v0.35.0
 	github.com/testcontainers/testcontainers-go/modules/mongodb v0.35.0
+	github.com/testcontainers/testcontainers-go/modules/postgres v0.35.0
 	github.com/uptrace/bun v1.2.11
+	github.com/uptrace/bun/dbfixture v1.2.11
 	github.com/uptrace/bun/dialect/pgdialect v1.2.11
 	github.com/xakep666/mongo-migrate v0.3.2
 	go.mongodb.org/mongo-driver v1.17.3
@@ -112,7 +115,6 @@ require (
 	github.com/spf13/cast v1.3.1 // indirect
 	github.com/spf13/pflag v1.0.6 // indirect
 	github.com/stretchr/objx v0.5.2 // indirect
-	github.com/testcontainers/testcontainers-go v0.35.0 // indirect
 	github.com/therootcompany/xz v1.0.1 // indirect
 	github.com/tklauser/go-sysconf v0.3.13 // indirect
 	github.com/tklauser/numcpus v0.7.0 // indirect
diff --git a/api/go.sum b/api/go.sum
@@ -246,6 +246,8 @@ github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWE
 github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
 github.com/mattn/go-runewidth v0.0.13/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w=
 github.com/mattn/goveralls v0.0.9/go.mod h1:FRbM1PS8oVsOe9JtdzAAXM+DsvDMMHcM1C7drGJD8HY=
+github.com/mdelapenya/tlscert v0.1.0 h1:YTpF579PYUX475eOL+6zyEO3ngLTOUWck78NBuJVXaM=
+github.com/mdelapenya/tlscert v0.1.0/go.mod h1:wrbyM/DwbFCeCeqdPX/8c6hNOqQgbf0rUDErE1uD+64=
 github.com/mholt/archiver/v4 v4.0.0-alpha.8 h1:tRGQuDVPh66WCOelqe6LIGh0gwmfwxUrSSDunscGsRM=
 github.com/mholt/archiver/v4 v4.0.0-alpha.8/go.mod h1:5f7FUYGXdJWUjESffJaYR4R60VhnHxb2X3T1teMyv5A=
 github.com/moby/docker-image-spec v1.3.1 h1:jMKff3w6PgbfSa69GfNg+zN/XLhfXJGnEx3Nl2EsFP0=
@@ -361,6 +363,8 @@ github.com/testcontainers/testcontainers-go v0.35.0 h1:uADsZpTKFAtp8SLK+hMwSaa+X
 github.com/testcontainers/testcontainers-go v0.35.0/go.mod h1:oEVBj5zrfJTrgjwONs1SsRbnBtH9OKl+IGl3UMcr2B4=
 github.com/testcontainers/testcontainers-go/modules/mongodb v0.35.0 h1:i1Kh9fmXgHG9z3uzJv5Arz7pDKVaaNpLrqyd+0xhYMA=
 github.com/testcontainers/testcontainers-go/modules/mongodb v0.35.0/go.mod h1:SD8nVMK1m7b/K2YJqYjYNzfHmZfqHtqNOlI44nfxjdg=
+github.com/testcontainers/testcontainers-go/modules/postgres v0.35.0 h1:eEGx9kYzZb2cNhRbBrNOCL/YPOM7+RMJiy3bB+ie0/I=
+github.com/testcontainers/testcontainers-go/modules/postgres v0.35.0/go.mod h1:hfH71Mia/WWLBgMD2YctYcMlfsbnT0hflweL1dy8Q4s=
 github.com/testcontainers/testcontainers-go/modules/redis v0.32.0 h1:HW5Qo9qfLi5iwfS7cbXwG6qe8ybXGePcgGPEmVlVDlo=
 github.com/testcontainers/testcontainers-go/modules/redis v0.32.0/go.mod h1:5kltdxVKZG0aP1iegeqKz4K8HHyP0wbkW5o84qLyMjY=
 github.com/therootcompany/xz v1.0.1 h1:CmOtsn1CbtmyYiusbfmhmkpAAETj0wBIH6kCYaX+xzw=
@@ -384,6 +388,8 @@ github.com/ulikunitz/xz v0.5.11/go.mod h1:nbz6k7qbPmH4IRqmfOplQw/tblSgqTqBwxkY0o
 github.com/uptrace/bun v0.3.9/go.mod h1:aL6D9vPw8DXaTQTwGrEPtUderBYXx7ShUmPfnxnqscw=
 github.com/uptrace/bun v1.2.11 h1:l9dTymsdZZAoSZ1+Qo3utms0RffgkDbIv+1UGk8N1wQ=
 github.com/uptrace/bun v1.2.11/go.mod h1:ww5G8h59UrOnCHmZ8O1I/4Djc7M/Z3E+EWFS2KLB6dQ=
+github.com/uptrace/bun/dbfixture v1.2.11 h1:9rKYVDwQCLdXtPkgzMgvDsHKHXelNlXmnpuNHvFz2w0=
+github.com/uptrace/bun/dbfixture v1.2.11/go.mod h1:E2H4A4/dx6+xB61qGsjVqV17Pqyb+Gg5QTmswy4hUpk=
 github.com/uptrace/bun/dialect/pgdialect v1.2.11 h1:n0VKWm1fL1dwJK5TRxYYLaRKRe14BOg2+AQgpvqzG/M=
 github.com/uptrace/bun/dialect/pgdialect v1.2.11/go.mod h1:NvV1S/zwtwBnW8yhJ3XEKAQEw76SkeH7yUhfrx3W1Eo=
 github.com/valyala/bytebufferpool v1.0.0 h1:GqA5TC/0021Y/b9FG4Oi9Mr3q7XYx6KllzawFIhcdPw=
diff --git a/api/server.go b/api/server.go
@@ -84,7 +84,7 @@ func (s *Server) Setup(ctx context.Context) error {
 	log.Debug("Redis cache initialized successfully")
 
 	uri := pg.URI(s.env.PostgresHost, s.env.PostgresPort, s.env.PostgresUser, s.env.PostgresPassword, s.env.PostgresDB)
-	store, err := pg.New(ctx, uri, options.Migrate(), options.Log("DEBUG", true))
+	store, err := pg.New(ctx, uri, options.Migrate("/"), options.Log("DEBUG", true))
 	if err != nil {
 		return err
 	}
diff --git a/api/store/entity/user.go b/api/store/entity/user.go
@@ -0,0 +1,11 @@
+package entity
+
+import (
+	"github.com/shellhub-io/shellhub/pkg/models"
+	"github.com/uptrace/bun"
+)
+
+type User struct {
+	bun.BaseModel `bun:"table:users"`
+	models.User   `bun:"embed:"`
+}
diff --git a/api/store/pg/internal/dbtest/dbtest.go b/api/store/pg/internal/dbtest/dbtest.go
@@ -0,0 +1,54 @@
+package dbtest
+
+import (
+	"context"
+	"io"
+	"log"
+	"time"
+
+	"github.com/testcontainers/testcontainers-go"
+	"github.com/testcontainers/testcontainers-go/modules/postgres"
+	"github.com/testcontainers/testcontainers-go/wait"
+)
+
+// Server represents a Postgres test server instance.
+type Server struct {
+	container *postgres.PostgresContainer
+}
+
+// Up starts a new Postgres container. Use [Server.ConnectionString] to access the connection string.
+func (srv *Server) Up(ctx context.Context, verbose bool) error {
+	if !verbose {
+		testcontainers.Logger = log.New(io.Discard, "", 0)
+	}
+
+	opts := []testcontainers.ContainerCustomizer{
+		postgres.WithDatabase("test"),
+		postgres.WithUsername("admin"),
+		postgres.WithPassword("admin"),
+		testcontainers.WithWaitStrategy(wait.ForLog("database system is ready to accept connections").WithOccurrence(2).WithStartupTimeout(5 * time.Second)),
+	}
+
+	container, err := postgres.Run(ctx, "postgres:17", opts...)
+	if err != nil {
+		return err
+	}
+
+	srv.container = container
+
+	return nil
+}
+
+// Down gracefully terminates the Postgres container.
+func (srv *Server) Down(ctx context.Context) error {
+	return srv.container.Terminate(ctx)
+}
+
+func (srv *Server) ConnectionString(ctx context.Context) (string, error) {
+	cIP, err := srv.container.ContainerIP(ctx)
+	if err != nil {
+		return "", err
+	}
+
+	return "postgres://admin:admin@" + cIP + ":5432/test", nil
+}
diff --git a/api/store/pg/internal/dbtest/fixtures.go b/api/store/pg/internal/dbtest/fixtures.go
@@ -0,0 +1,12 @@
+package dbtest
+
+import (
+	"path/filepath"
+	"runtime"
+)
+
+func FixturesPath() string {
+	_, file, _, _ := runtime.Caller(0)
+
+	return filepath.Join(filepath.Dir(file), "fixtures")
+}
diff --git a/api/store/pg/internal/dbtest/fixtures/users.yaml b/api/store/pg/internal/dbtest/fixtures/users.yaml
@@ -0,0 +1,12 @@
+- model: User
+  rows:
+    - id: USR|9afd8f41-7920-45e2-90e0-88bd581fcd05
+      created_at: 2025-01-15T10:30:00+00:00
+      updated_at: 2025-01-15T10:30:00+00:00
+      status: confirmed
+      origin: local
+      external_id: ""
+      name: Jonh Doe
+      email: john.doe@test.com
+      password: "$2y$12$VVm2ETx7AvaGlfMYqNYK9uzU2M45YZ70YnT..O.s1o2zdE1pekhq6"
+
diff --git a/api/store/pg/options/apply-fixtures.go b/api/store/pg/options/apply-fixtures.go
@@ -0,0 +1,35 @@
+package options
+
+import (
+	"context"
+	"io/fs"
+	"os"
+
+	"github.com/uptrace/bun"
+	"github.com/uptrace/bun/dbfixture"
+)
+
+func ApplyFixtures(dir string) Option {
+	return func(ctx context.Context, db *bun.DB) error {
+		println("path: ", dir)
+
+		fixture := dbfixture.New(db)
+
+		fsys := os.DirFS(dir)
+		files, err := fs.ReadDir(fsys, ".")
+		if err != nil {
+			return err
+		}
+
+		names := make([]string, 0)
+		for _, file := range files {
+			println("\tname: ", file.Name)
+
+			if !file.IsDir() {
+				names = append(names, file.Name())
+			}
+		}
+
+		return fixture.Load(ctx, fsys, names...)
+	}
+}
diff --git a/api/store/pg/options/migrate.go b/api/store/pg/options/migrate.go
@@ -19,14 +19,14 @@ var (
 	ErrFilePathEmpty = errors.New("no migration files found in directory")
 )
 
-func Migrate() Option {
+func Migrate(basePath string) Option {
 	return func(ctx context.Context, db *bun.DB) error {
 		driver, err := postgres.WithInstance(db.DB, &postgres.Config{})
 		if err != nil {
 			return err
 		}
 
-		migrationsPath, err := fetchMigrationsPath()
+		migrationsPath, err := fetchMigrationsPath(basePath)
 		if err != nil {
 			return err
 		}
@@ -61,30 +61,21 @@ func Migrate() Option {
 	}
 }
 
-func fetchMigrationsPath() (string, error) {
-	migrationsPath := filepath.Join("/", "migrations")
-
-	_, err := os.Stat(migrationsPath)
-	if err != nil {
-		if !os.IsNotExist(err) {
-			return "", err
-		}
-
-		log.WithField("path", migrationsPath).Info("Migrations directory not found, creating it")
-		if err := os.MkdirAll(migrationsPath, 0755); err != nil {
-			return "", errors.New("failed to create migrations directory: " + err.Error())
-		}
+func fetchMigrationsPath(basePath string) (string, error) {
+	path := filepath.Join(basePath, "migrations")
+	if _, err := os.Stat(path); err != nil {
+		return "", err
 	}
 
-	files, err := os.ReadDir(migrationsPath)
+	files, err := os.ReadDir(path)
 	if err != nil {
-		log.WithError(err).WithField("path", migrationsPath).Error("failed to read migrations directory")
+		log.WithError(err).WithField("path", path).Error("failed to read migrations directory")
 		return "", err
 	}
 
 	if len(files) == 0 {
 		return "", ErrFilePathEmpty
 	}
 
-	return migrationsPath, nil
+	return path, nil
 }
diff --git a/api/store/pg/pg.go b/api/store/pg/pg.go
@@ -9,6 +9,7 @@ import (
 	"github.com/jackc/pgx/v5/stdlib"
 	"github.com/shellhub-io/shellhub/api/store"
 	"github.com/shellhub-io/shellhub/api/store/pg/options"
+	"github.com/shellhub-io/shellhub/pkg/models"
 	"github.com/uptrace/bun"
 	"github.com/uptrace/bun/dialect/pgdialect"
 )
@@ -39,6 +40,9 @@ func New(ctx context.Context, uri string, opts ...options.Option) (store.Store,
 		return nil, err
 	}
 
+	// We need to register models so we can apply fixtures and relations later
+	pg.driver.RegisterModel((*models.User)(nil))
+
 	for _, opt := range opts {
 		if err := opt(ctx, pg.driver); err != nil {
 			return nil, err
diff --git a/api/store/pg/pg_test.go b/api/store/pg/pg_test.go
@@ -0,0 +1,85 @@
+package pg_test
+
+import (
+	"context"
+	"os"
+	"path/filepath"
+	"runtime"
+	"testing"
+
+	"github.com/jackc/pgx/v5"
+	"github.com/jackc/pgx/v5/pgxpool"
+	"github.com/jackc/pgx/v5/stdlib"
+	"github.com/shellhub-io/shellhub/api/store"
+	"github.com/shellhub-io/shellhub/api/store/pg"
+	"github.com/shellhub-io/shellhub/api/store/pg/internal/dbtest"
+	"github.com/shellhub-io/shellhub/api/store/pg/options"
+	log "github.com/sirupsen/logrus"
+	"github.com/uptrace/bun"
+	"github.com/uptrace/bun/dialect/pgdialect"
+)
+
+var (
+	srv    = (*dbtest.Server)(nil)
+	s      store.Store
+	driver = (*bun.DB)(nil)
+)
+
+func TestMain(m *testing.M) {
+	log.Info("Starting store tests")
+
+	ctx := context.Background()
+
+	srv = &dbtest.Server{}
+
+	if err := srv.Up(ctx, false); err != nil {
+		log.WithError(err).Error("Failed to UP the postgres container")
+		os.Exit(1)
+	}
+
+	c, err := srv.ConnectionString(ctx)
+	if err != nil {
+		log.WithError(err).Error("Failed to parse postgres connection string")
+	}
+
+	log.Info("Connecting to ", c)
+
+	_, file, _, _ := runtime.Caller(0)
+	s, err = pg.New(ctx, c, options.Migrate(filepath.Dir(file)), options.ApplyFixtures(dbtest.FixturesPath()))
+	if err != nil {
+		log.WithError(err).Error("Failed to create the postgres store")
+		os.Exit(1)
+	}
+
+	driver, err = connectBun(ctx, c)
+	if err != nil {
+		log.WithError(err).Error("Failed to create a test driver")
+		os.Exit(1)
+	}
+
+	code := m.Run()
+
+	log.Info("Stopping store tests")
+	if err := srv.Down(ctx); err != nil {
+		log.WithError(err).Error("Failed to DOWN the postgres container")
+		os.Exit(1)
+	}
+
+	os.Exit(code)
+}
+
+func connectBun(ctx context.Context, uri string) (*bun.DB, error) {
+	config, err := pgxpool.ParseConfig(uri)
+	if err != nil {
+		return nil, err
+	}
+
+	config.ConnConfig.DefaultQueryExecMode = pgx.QueryExecModeSimpleProtocol
+
+	pool, err := pgxpool.NewWithConfig(ctx, config)
+	if err != nil {
+		return nil, err
+	}
+
+	return bun.NewDB(stdlib.OpenDBFromPool(pool), pgdialect.New()), nil
+}
diff --git a/api/store/pg/user.go b/api/store/pg/user.go
@@ -3,32 +3,33 @@ package pg
 import (
 	"context"
 
+	"github.com/shellhub-io/shellhub/api/store/entity"
 	"github.com/shellhub-io/shellhub/pkg/api/query"
 	"github.com/shellhub-io/shellhub/pkg/clock"
 	"github.com/shellhub-io/shellhub/pkg/models"
 	"github.com/shellhub-io/shellhub/pkg/uuid"
 )
 
-func (pg *pg) UserCreate(ctx context.Context, user *models.User) (insertedID string, err error) {
+func (pg *pg) UserCreate(ctx context.Context, user *models.User) (string, error) {
 	user.ID = "USR|" + uuid.Generate()
 	user.CreatedAt = clock.Now()
 	user.UpdatedAt = clock.Now()
 
-	if _, err := pg.driver.NewInsert().Model(user).Exec(ctx); err != nil {
+	if _, err := pg.driver.NewInsert().Model(&entity.User{User: *user}).Exec(ctx); err != nil {
 		return "", err
 	}
 
 	return user.ID, nil
 }
 
-func (pg *pg) UserCreateInvited(ctx context.Context, email string) (insertedID string, err error) {
+func (pg *pg) UserCreateInvited(ctx context.Context, email string) (string, error) {
 	// TODO: unify create methods
 	return "", nil
 }
 
 func (pg *pg) UserConflicts(ctx context.Context, target *models.UserConflicts) ([]string, bool, error) {
 	users := make([]map[string]any, 0)
-	if err := pg.driver.NewSelect().Model((*models.User)(nil)).Column("email").Where("email = ?", target.Email).Scan(ctx, &users); err != nil {
+	if err := pg.driver.NewSelect().Model((*entity.User)(nil)).Column("email").Where("email = ?", target.Email).Scan(ctx, &users); err != nil {
 		return nil, false, err
 	}
 
@@ -57,8 +58,12 @@ func (pg *pg) UserGetByUsername(ctx context.Context, username string) (*models.U
 }
 
 func (pg *pg) UserGetByEmail(ctx context.Context, email string) (*models.User, error) {
-	// TODO: unify get methods
-	return nil, nil
+	u := new(models.User)
+	if err := pg.driver.NewSelect().Model(u).Where("email = ?", email).Scan(ctx); err != nil {
+		return nil, fromSqlError(err)
+	}
+
+	return u, nil
 }
 
 func (pg *pg) UserGetInfo(ctx context.Context, id string) (userInfo *models.UserInfo, err error) {
diff --git a/api/store/pg/user_test.go b/api/store/pg/user_test.go
diff --git a/api/store/pg/utils.go b/api/store/pg/utils.go
diff --git a/cli/go.mod b/cli/go.mod
diff --git a/cli/go.sum b/cli/go.sum
diff --git a/pkg/models/user.go b/pkg/models/user.go

Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ func (s *Server) Setup(ctx context.Context) error {`
`84`	`84`	`log.Debug("Redis cache initialized successfully")`
`85`	`85`
`86`	`86`	`uri := pg.URI(s.env.PostgresHost, s.env.PostgresPort, s.env.PostgresUser, s.env.PostgresPassword, s.env.PostgresDB)`
`87`		`- store, err := pg.New(ctx, uri, options.Migrate(), options.Log("DEBUG", true))`
	`87`	`+ store, err := pg.New(ctx, uri, options.Migrate("/"), options.Log("DEBUG", true))`
`88`	`88`	`if err != nil {`
`89`	`89`	`return err`
`90`	`90`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,14 +19,14 @@ var (`
`19`	`19`	`ErrFilePathEmpty = errors.New("no migration files found in directory")`
`20`	`20`	`)`
`21`	`21`
`22`		`-func Migrate() Option {`
	`22`	`+func Migrate(basePath string) Option {`
`23`	`23`	`return func(ctx context.Context, db *bun.DB) error {`
`24`	`24`	`driver, err := postgres.WithInstance(db.DB, &postgres.Config{})`
`25`	`25`	`if err != nil {`
`26`	`26`	`return err`
`27`	`27`	`}`
`28`	`28`
`29`		`- migrationsPath, err := fetchMigrationsPath()`
	`29`	`+ migrationsPath, err := fetchMigrationsPath(basePath)`
`30`	`30`	`if err != nil {`
`31`	`31`	`return err`
`32`	`32`	`}`
`@@ -61,30 +61,21 @@ func Migrate() Option {`
`61`	`61`	`}`
`62`	`62`	`}`
`63`	`63`
`64`		`-func fetchMigrationsPath() (string, error) {`
`65`		`- migrationsPath := filepath.Join("/", "migrations")`
`66`		`-`
`67`		`- _, err := os.Stat(migrationsPath)`
`68`		`- if err != nil {`
`69`		`- if !os.IsNotExist(err) {`
`70`		`- return "", err`
`71`		`- }`
`72`		`-`
`73`		`- log.WithField("path", migrationsPath).Info("Migrations directory not found, creating it")`
`74`		`- if err := os.MkdirAll(migrationsPath, 0755); err != nil {`
`75`		`- return "", errors.New("failed to create migrations directory: " + err.Error())`
`76`		`- }`
	`64`	`+func fetchMigrationsPath(basePath string) (string, error) {`
	`65`	`+ path := filepath.Join(basePath, "migrations")`
	`66`	`+ if _, err := os.Stat(path); err != nil {`
	`67`	`+ return "", err`
`77`	`68`	`}`
`78`	`69`
`79`		`- files, err := os.ReadDir(migrationsPath)`
	`70`	`+ files, err := os.ReadDir(path)`
`80`	`71`	`if err != nil {`
`81`		`- log.WithError(err).WithField("path", migrationsPath).Error("failed to read migrations directory")`
	`72`	`+ log.WithError(err).WithField("path", path).Error("failed to read migrations directory")`
`82`	`73`	`return "", err`
`83`	`74`	`}`
`84`	`75`
`85`	`76`	`if len(files) == 0 {`
`86`	`77`	`return "", ErrFilePathEmpty`
`87`	`78`	`}`
`88`	`79`
`89`		`- return migrationsPath, nil`
	`80`	`+ return path, nil`
`90`	`81`	`}`