Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor TestGetPersonByUuid To Use A Real Postgres DB For The Test #1720

Closed
6 tasks
elraphty opened this issue Jun 21, 2024 · 3 comments · Fixed by #1729
Closed
6 tasks

Refactor TestGetPersonByUuid To Use A Real Postgres DB For The Test #1720

elraphty opened this issue Jun 21, 2024 · 3 comments · Fixed by #1729
Assignees
Labels

Comments

@elraphty
Copy link
Contributor

elraphty commented Jun 21, 2024

Context

Currently, we test the TestGetPersonByUuid with a mock database.

Design

We want to refactor the tests to use a real Postgres DB spun up on docker, follow the instructions in the Unit Testing section of README.md to run spin up a database in docker, and change the test_config.go configuration.

After spinning up the Postgres DB container:

  • Add this line of code on the first line and second of the test function TestGetPersonByUuid to connect to the Test DB
    teardownSuite := SetupSuite(t)
    defer teardownSuite(t)

The test will throw a dereference error if not connected to a DB.

  • Remove all mock database functions in the TestGetPersonByUuid test cases e.g. mockDb.On("GetPersonByPubkey", "test-key").Return(db.Person{}).Once().
  • Change the database parameter in pHandler := NewPeopleHandler(mockDb) to pHandler := NewPeopleHandler(db.TestDB)
  • Create a person using this db function db.TestDb.CreateOrEditPerson() e.g
person := db.Person{
     Uuid:        "perosn_101_uuid",
     OwnerAlias:  "person101",
     UniqueName:  "person101",
     OwnerPubKey: "person_101_pubkey",
     PriceToMeet: 0,
     Description: "this is test user 1",
}
db.TestDb.CreateOrEditPerson(person)
  • Get the people created by using person := db.TestDb.GetPerson(person.ID)
  • Assert that the person created is returned
  • Update the URL uuid param to the listed person's uuid person.Uuid req, err := http.NewRequestWithContext(context.WithValue(context.Background(), chi.RouteCtxKey, rctx), http.MethodGet, "/uuid", nil) assert.NoError(t, err)
  • Update the string uuid value rctx.URLParams.Add("uuid", "uuid") to rctx.URLParams.Add("uuid", person.Uuid)

Assertions

  • Assert that all the test passes

Acceptance Criteria

  • Do not delete any of the existing test cases on the TestGetPersonByUuid
  • All test cases after the TestGetPersonByUuid refactor passes
  • The Refactoring of TestGetPersonByUuid should not break existing test flows.
  • I have rebased and tested locally before submitting my PR
  • I can submit a PR within 1 day of taking the bounty

Here is an example Real DB Test

@MuhammadUmer44
Copy link
Contributor

MuhammadUmer44 commented Jun 21, 2024

@elraphty assign me?

@MirzaHanan
Copy link
Contributor

MirzaHanan commented Jun 21, 2024

@elraphty Please assign me?

@AbdulWahab3181
Copy link
Contributor

AbdulWahab3181 commented Jun 21, 2024

@elraphty Could you please assign me?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: ✅ Done
Development

Successfully merging a pull request may close this issue.

4 participants