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

Closed
6 tasks
elraphty opened this issue Jun 27, 2024 · 6 comments · Fixed by #1789
Closed
6 tasks

Refactor TestGetListedTribes To Use A Real Postgres DB For The Test #1781

elraphty opened this issue Jun 27, 2024 · 6 comments · Fixed by #1789
Assignees
Labels

Comments

@elraphty
Copy link
Contributor

Context

Currently, we test the TestGetListedTribes 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 TestGetListedTribes 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 TestGetListedTribes test cases e.g. mockDb.On("GetListedTribes", req).Return(expectedTribes).
  • Change the database parameter in tHandler := NewTribeHandler(mockDb) to tHandler := NewTribeHandler(db.TestDb)
  • Create two tribes, one with Unlisted: true, and the other with Unlisted: false using the db.TestDb.CreateOrEditTribe() function e.g
tribe := db.Tribe{
    UUID: ${tribe_uuid}, 
    OwnerPubKey:  person.OwnerPubkey,
    Name:  ${name},
    Description: ${description}
    Tags: []string{"tag3", "tag4"}
    AppUrl: ${AppURl}
    Unlisted: true,
}
tribe2 := db.Tribe{
    UUID: ${tribe_uuid}, 
    OwnerPubKey:  person.OwnerPubkey,
    Name:  ${name},
    Description: ${description}
    Tags: []string{"tag3", "tag4"}
    AppUrl: ${AppURl}
    Unlisted: false,
}

db.TestDb.CreateOrEditTribe(tribe)
db.TestDb.CreateOrEditTribe(tribe2)
  • Assert that only tribes with Unlisted: false are returned from the API request

Assertions

  • Assert that all the test passes

Acceptance Criteria

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

@AhsanFarooqDev
Copy link
Contributor

AhsanFarooqDev commented Jun 27, 2024

@elraphty please assign

@AbdulWahab3181
Copy link
Contributor

AbdulWahab3181 commented Jun 27, 2024

@elraphty Could you please assign me?

@MuhammadUmer44
Copy link
Contributor

@elraphty assign me

@MirzaHanan
Copy link
Contributor

@elraphty PLease assign me?

@aliraza556
Copy link
Contributor

@elraphty Assign me next one?

@AbdulWahab3181
Copy link
Contributor

@elraphty Could you please assign me the next issue?

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.

6 participants