-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4 from Lai-YT/add-tests-of-database-accessor
Test database accessor with in-memory SQLite
- Loading branch information
Showing
3 changed files
with
206 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,200 @@ | ||
| package storage | ||
|
|
||
| import ( | ||
| "io" | ||
| "os" | ||
| "reflect" | ||
| "testing" | ||
| "todolist/core" | ||
|
|
||
| log "github.com/sirupsen/logrus" | ||
| "gorm.io/driver/sqlite" | ||
| "gorm.io/gorm" | ||
| "gorm.io/gorm/logger" | ||
| ) | ||
|
|
||
| func TestMain(m *testing.M) { | ||
| // So that we don't see log messages during tests. | ||
| log.SetOutput(io.Discard) | ||
| code := m.Run() | ||
| os.Exit(code) | ||
| } | ||
|
|
||
| // NOTE: Errors on the database panics because it means the test setup is incorrect. | ||
|
|
||
| func (dba *DatabaseAccessor) initTestDb() { | ||
| var err error | ||
| // NOTE: Using the in-memory SQLite database for testing purposes. | ||
| dba.db, err = gorm.Open(sqlite.Open("file::memory:"), &gorm.Config{ | ||
| Logger: logger.Discard, | ||
| }) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| err = dba.db.AutoMigrate(&TodoItemModel{}) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| } | ||
|
|
||
| func (dba *DatabaseAccessor) closeTestDb() { | ||
| err := dba.db.Migrator().DropTable(&TodoItemModel{}) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| dba.db = nil | ||
| } | ||
|
|
||
| // TestCreate Given a todo item, when Create is called, then the todo item should be created in the database and the id should be set and returned. | ||
| func TestCreate(t *testing.T) { | ||
| // arrange | ||
| dba := DatabaseAccessor{} | ||
| dba.initTestDb() | ||
| defer dba.closeTestDb() | ||
|
|
||
| // act | ||
| todo := core.TodoItem{Description: "Test description", Completed: false} | ||
| id, err := dba.Create(&todo) | ||
|
|
||
| // assert | ||
| if err != nil { | ||
| t.Fatalf("unexpected error: %v", err) | ||
| } | ||
| if todo.Id != id { | ||
| t.Errorf("Id not set on todo item correctly, expected %v, got %v", id, todo.Id) | ||
| } | ||
| want := []TodoItemModel{ | ||
| {Id: id, Description: "Test description", Completed: false}, | ||
| } | ||
| todosInDb := []TodoItemModel{} | ||
| dba.db.Find(&todosInDb) | ||
| if !reflect.DeepEqual(todosInDb, want) { | ||
| t.Errorf("want: %v, got: %v", want, todosInDb) | ||
| } | ||
| } | ||
|
|
||
| // TestRead Given some todo items in the database, when Read is called with a where clause that matches on the description of a todo item, then the todo item should be returned. | ||
| func TestRead(t *testing.T) { | ||
| // arrange | ||
| dba := DatabaseAccessor{} | ||
| dba.initTestDb() | ||
| defer dba.closeTestDb() | ||
| match := "Test description 1" | ||
| dba.db.Create(&[]TodoItemModel{ | ||
| {Id: 1, Description: match, Completed: false}, | ||
| {Id: 2, Description: "Test description 2", Completed: true}, | ||
| }) | ||
|
|
||
| // act | ||
| want := core.TodoItem{Id: 1, Description: "Test description 1", Completed: false} | ||
| got := dba.Read(func(item core.TodoItem) bool { return item.Description == match }) | ||
|
|
||
| // assert | ||
| if len(got) != 1 { | ||
| t.Fatalf("expected 1 item, got %v", len(got)) | ||
| } | ||
| if !reflect.DeepEqual(got[0], want) { | ||
| t.Errorf("want: %v, got: %v", want, got[0]) | ||
| } | ||
| } | ||
|
|
||
| // TestUpdate Given some todo items in the database, when Update is called with the id of a todo item, then the todo item should be updated. | ||
| func TestUpdate(t *testing.T) { | ||
| // arrange | ||
| dba := DatabaseAccessor{} | ||
| dba.initTestDb() | ||
| defer dba.closeTestDb() | ||
| targetId := 2 | ||
| dba.db.Create(&[]TodoItemModel{ | ||
| {Id: 1, Description: "Test description 1", Completed: false}, | ||
| {Id: targetId, Description: "Test description 2", Completed: true}, | ||
| }) | ||
|
|
||
| // act | ||
| updatedTodo := core.TodoItem{Id: targetId, Description: "Updated description", Completed: false} | ||
| err := dba.Update(updatedTodo) | ||
|
|
||
| // assert | ||
| if err != nil { | ||
| t.Fatalf("unexpected error: %v", err) | ||
| } | ||
| want := []TodoItemModel{ | ||
| {Id: 1, Description: "Test description 1", Completed: false}, | ||
| {Id: targetId, Description: updatedTodo.Description, Completed: updatedTodo.Completed}, | ||
| } | ||
| todosInDb := []TodoItemModel{} | ||
| dba.db.Find(&todosInDb) | ||
| if !reflect.DeepEqual(todosInDb, want) { | ||
| t.Errorf("want: %v, got: %v", want, todosInDb) | ||
| } | ||
| } | ||
|
|
||
| // TestUpdateNotFound Given some todo items in the database, when Update is called with an id that does not exist, then an error should be returned. | ||
| func TestUpdateNotFound(t *testing.T) { | ||
| // arrange | ||
| dba := DatabaseAccessor{} | ||
| dba.initTestDb() | ||
| defer dba.closeTestDb() | ||
| dba.db.Create(&[]TodoItemModel{ | ||
| {Id: 1, Description: "Test description 1", Completed: false}, | ||
| {Id: 2, Description: "Test description 2", Completed: true}, | ||
| }) | ||
|
|
||
| // act | ||
| nonExistentTodo := core.TodoItem{Id: 3, Description: "Updated description", Completed: false} | ||
| err := dba.Update(nonExistentTodo) | ||
|
|
||
| // assert | ||
| if err == nil { | ||
| t.Fatalf("expected error, got nil") | ||
| } | ||
| } | ||
|
|
||
| // TestDelete Given some todo items in the database, when Delete is called with the id of a todo item, then the todo item should be deleted. | ||
| func TestDelete(t *testing.T) { | ||
| // arrange | ||
| dba := DatabaseAccessor{} | ||
| dba.initTestDb() | ||
| defer dba.closeTestDb() | ||
| dba.db.Create(&[]TodoItemModel{ | ||
| {Id: 1, Description: "Test description 1", Completed: false}, | ||
| {Id: 2, Description: "Test description 2", Completed: true}, | ||
| }) | ||
|
|
||
| // act | ||
| err := dba.Delete(1) | ||
|
|
||
| // assert | ||
| if err != nil { | ||
| t.Fatalf("unexpected error: %v", err) | ||
| } | ||
| want := []TodoItemModel{ | ||
| {Id: 2, Description: "Test description 2", Completed: true}, | ||
| } | ||
| todosInDb := []TodoItemModel{} | ||
| dba.db.Find(&todosInDb) | ||
| if !reflect.DeepEqual(todosInDb, want) { | ||
| t.Errorf("want: %v, got: %v", want, todosInDb) | ||
| } | ||
| } | ||
|
|
||
| // TestDeleteNotFound Given some todo items in the database, when Delete is called with an id that does not exist, then an error should be returned. | ||
| func TestDeleteNotFound(t *testing.T) { | ||
| // arrange | ||
| dba := DatabaseAccessor{} | ||
| dba.initTestDb() | ||
| defer dba.closeTestDb() | ||
| items := []TodoItemModel{ | ||
| {Id: 1, Description: "Test description 1", Completed: false}, | ||
| {Id: 2, Description: "Test description 2", Completed: true}, | ||
| } | ||
| dba.db.Create(&items) | ||
|
|
||
| // act | ||
| err := dba.Delete(3) | ||
|
|
||
| // assert | ||
| if err == nil { | ||
| t.Fatalf("expected error, got nil") | ||
| } | ||
| } |