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

Closed
6 tasks
elraphty opened this issue Jun 28, 2024 · 4 comments · Fixed by #1796
Closed
6 tasks

Refactor TestMetricsBountiesCount To Use A Real Postgres DB For The Test #1794

elraphty opened this issue Jun 28, 2024 · 4 comments · Fixed by #1796
Assignees
Labels

Comments

@elraphty
Copy link
Contributor

elraphty commented Jun 28, 2024

Context

Currently, we test the TestMetricsBountiesCount 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 TestMetricsBountiesCount 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 TestMetricsBountiesCount test cases e.g. mockDb.On("GetBountiesByDateRangeCount", dateRange, req).Return(int64(100)).Once().
  • Change the database parameter in mh := NewMetricHandler(mockDb) to mh := NewMetricHandler(db.TestDb)
  • Create 4 bounties using this db function db.TestDb.CreateOrEditBounty() e.g
now := time.Now()
bounty  :=  db.NewBounty{
	Type:          "coding",
	Title:         "Bounty With ID",
	Description:   "Bounty ID Description",
	WorkspaceUuid: "",
	Assignee:      "",
	OwnerID:       bountyOwner.OwnerPubKey,
	Show:          true,
        Created: &now,
        Paid: true
}
db.TestDb.CreateOrEditBounty(bounty)
bounty2  :=  db.NewBounty{
	Type:          "coding",
	Title:         "Bounty With ID",
	Description:   "Bounty ID Description",
	WorkspaceUuid: "",
	Assignee:      "",
	OwnerID:       bountyOwner.OwnerPubKey,
	Show:          true,
        Created: &now,
}
db.TestDb.CreateOrEditBounty(bounty2)

2 Bounties, should be set to Paid: true, while the Other 2 should be set as Paid: false, and the Created time value of the 4 bounties should be within 30 days i.e, the first bounty and the last bounties should be 30 days apart, use Golang Date manipulation to achieve this.

  • Change the dateRange StartDate and EndDate values to be the Created date of the first bounty and the Created date of the last bounty e.g.
dateRange := db.PaymentDateRange{
   StartDate:  bounty.Created,
   EndDate:   bounty4.Created,
}
  • Get all the total count of the bounties created using the GetBountiesByDateRangeCount function
  • Assert that the API call response matches the value returned from the DB.

Assertions

  • Assert that the API call returned value matches the bounties fetched from the DB.

Acceptance Criteria

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

@MahtabBukhari
Copy link
Contributor

MahtabBukhari commented Jun 28, 2024

@elraphty could you please assign me?

@saithsab877
Copy link
Contributor

saithsab877 commented Jun 28, 2024

@elraphty Please assign me?

@MahtabBukhari
Copy link
Contributor

@elraphty could you please assign me?

@elraphty please assign please next one

@MuhammadUmer44
Copy link
Contributor

@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