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

Write Test For GetFeatureByUuid #1825

Closed
4 tasks
elraphty opened this issue Jul 2, 2024 · 2 comments · Fixed by #1829
Closed
4 tasks

Write Test For GetFeatureByUuid #1825

elraphty opened this issue Jul 2, 2024 · 2 comments · Fixed by #1829
Assignees
Labels

Comments

@elraphty
Copy link
Contributor

elraphty commented Jul 2, 2024

Context

Currently, we do not have a test for GetFeatureByUuid

Design

We want to write 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 TestGetFeatureByUuid to connect to the Test DB
    teardownSuite := SetupSuite(t)
    defer teardownSuite(t)

    oHandler := NewWorkspaceHandler(mockDb)` to `oHandler := NewWorkspaceHandler(db.TestDb)

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

  • Create a person using the db.TestDb.CreateOrPerson() function e.g
person := db.Person{
     Uuid:        ${uuid},
     OwnerAlias:  ${alias},
     UniqueName:  ${unique_name},
     OwnerPubKey:  ${pubkey},
     PriceToMeet: 0,
     Description:  ${description},
}

db.TestDb.CreateOrEditPerson(person)
  • Create a workspace by using the db.TestDb.CreateOrEditWorkspace() function e.g
workspace := db.Workspace{
   Uuid:   ${workspace_uuid},
   Name:   ${workspace_name},
   OwnerPubKey:  ${person.OwnerPubkey},
   Github: ${gtihub},
   Website: ${website},
   Description: ${description},
}
db.TestDB.CreateOrEditWorkspace(workspace)
  • Get the workspace created by using workspace:= db.TestDb.GetWorkspaceByUuid(workspace.Uuid)
  • Create a workspace repository using the db.TestDb.CreateOrEditWorkspaceRepository(workspaceRepositoru) e.g
  • Create a workspace feature using the db.TestDb.CreateOrEditFeature(feature) function e.g
feature := db.WorkspaceFeatures {
	Uuid: ${uuid}
	WorkspaceUuid: workspace.UUid,
	Name: ${name},          
	Url: ${url},
        Priority: 0,         
}
db.TestDb.CreateOrEditFeature(feature)
  • Create a test route using r.Get("features/{uuid}", featureHandlers.GetFeatureByUuid) as a reference, the test route
  • Pass the created feature Uuid as the URL parameter
  • Assert that it throws a 401 error if a user is not authorized
  • Assert that the feature created equals what is returned from the API.

Assertions

  • Assert that the feature returned from the API is the feature created that was created
  • Assert that all the test passes

Acceptance Criteria

  • 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

@elraphty
Copy link
Contributor Author

elraphty commented Jul 2, 2024

@saithsab877

@saithsab877
Copy link
Contributor

@elraphty Assign?

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.

2 participants