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 GetWorkspaceRepoByWorkspaceUuidAndRepoUuid #1809

Closed
4 tasks
elraphty opened this issue Jul 1, 2024 · 3 comments · Fixed by #1812
Closed
4 tasks

Write Test For GetWorkspaceRepoByWorkspaceUuidAndRepoUuid #1809

elraphty opened this issue Jul 1, 2024 · 3 comments · Fixed by #1812
Assignees
Labels

Comments

@elraphty
Copy link
Contributor

elraphty commented Jul 1, 2024

Context

Currently, we do not have a test for GetWorkspaceRepoByWorkspaceUuidAndRepoUuid

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 TestGetWorkspaceRepoByWorkspaceUuidAndRepoUuid 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
repository := db.WorkspaceRepositories{
	Uuid: ${uuid}
	WorkspaceUuid: workspace.UUid,
	Name: ${name},          
	Url: ${url},         
}
db.TestDb.CreateOrEditWorkspaceRepository(repository)
  • Create a test route using r.Get("/{workspace_uuid}/repository/{uuid}", workspaceHandlers.GetWorkspaceRepoByWorkspaceUuidAndRepoUuid) as a reference, the test route
  • Pass the created workspace uuid and the created repository uuid as the URL parameters
  • Assert that it throws a 401 error if a user is not authorized
  • Assert that the repository returned from the API matches the one created.

Assertions

  • Assert that the workspace repository returned from the API responses matches the one 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

@AbdulWahab3181
Copy link
Contributor

@elraphty Can I take this one as I have completed my previous task?

@saithsab877
Copy link
Contributor

@elraphty assign me>

@elraphty
Copy link
Contributor Author

elraphty commented Jul 1, 2024

@AbdulWahab3181 let me give this to @saithsab877, I have not reviewed yours. I will assign the first one to you tomorrow.

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.

3 participants