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 TestGetTribesByAppUrl To Use A Real Postgres DB For The Test #1766

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

Refactor TestGetTribesByAppUrl To Use A Real Postgres DB For The Test #1766

elraphty opened this issue Jun 26, 2024 · 3 comments · Fixed by #1768
Assignees
Labels

Comments

@elraphty
Copy link
Contributor

elraphty commented Jun 26, 2024

Context

Currently, we test the TestGetTribesByAppUrl 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 TestGetTribesByAppUrl 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 TestGetTribesByAppUrl test cases e.g. mockDb.On("GetTribe", mock.Anything).Return(db.Tribe{ UUID: mockUUID, OwnerPubKey: mockPubKey, }).Once().
  • Change the database parameter in tHandler := NewTribeHandler(mockDb) to tHandler := NewTribeHandler(db.TestDb)
  • Create a tribe using the db.TestDb.CreateOrEditTribe() function e.g
tribe := db.Tribe{
    UUID: ${tribe_uuid}, 
    OwnerPubKey:  ${pubkey},
    Name:  ${name},
    Description: ${description}
    Tags: []string{"tag3", "tag4"}
    AppUrl: ${AppURl}
}
db.TestDb.CreateOrEditTribe(tribe)
  • Update the mockAppURL values from mockAppURL:= "valid_uuid" to mockAppURL := tribe.AppURL
  • Assert that the tribe created is equal to the one returned from the response
  • Assert that the response length is equal to 1

Assertions

  • Assert that all the test passes

Acceptance Criteria

  • Do not delete any of the existing test cases on the TestGetTribesByAppUrl
  • All test cases after the TestGetTribesByAppUrl refactor passes
  • The Refactoring of TestGetTribesByAppUrl 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

@AbdulWahab3181
Copy link
Contributor

AbdulWahab3181 commented Jun 26, 2024

@elraphty Could you please assign me?

@aliraza556
Copy link
Contributor

@elraphty please assign me next one?

@saithsab877
Copy link
Contributor

Hi @elraphty please assign me next ?

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