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 CreateOrEditFeatures #1819

Closed
5 tasks
elraphty opened this issue Jul 2, 2024 · 6 comments · Fixed by #1824
Closed
5 tasks

Write Test For CreateOrEditFeatures #1819

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

Comments

@elraphty
Copy link
Contributor

elraphty commented Jul 2, 2024

Context

Currently, we do not have a test for CreateOrEditFeatures

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

    fHandler := NewFeatureHandler(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 variable feature e.g
feature := db.WorkspaceFeatures {
	Uuid: ${uuid}
	WorkspaceUuid: workspace.UUid,
	Name: ${name},          
	Url: ${url},
        Priority: 0,         
}
  • Create a test route using r.Post("/features", featureHandlers.CreateOrEditFeatures) as a reference, the test route
  • JSON marshal features and pass it as a body to the Endpoint
  • Assert that it throws a 401 error if a user is not authenticated
  • Assert that a 406 error is returned if the wrong body data is sent to the APi endpoint
  • Assert that a 401 is returned if a Workspace UUID that does not exist Is passed to the API body
  • Assert that the user can add a workspace feature when the right conditions are met.

Assertions

  • Assert that the workspace feature is created by using the db.TestDb.GetFeatureByUuid(feature.uuid) function
  • Assert that the feature Name, Prioty, and Url returned matches what was sent in the API body.
  • 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 or the next one as I have completed my previous task?

@elraphty
Copy link
Contributor Author

elraphty commented Jul 2, 2024

@MirzaHanan

@MirzaHanan
Copy link
Contributor

@elraphty Please assign me?

@aliraza556
Copy link
Contributor

@elraphty Please assign me next one?

@elraphty
Copy link
Contributor Author

elraphty commented Jul 2, 2024

@elraphty Please assign me next one?

@aliraza556 You get the next one

@MahtabBukhari
Copy link
Contributor

@elraphty Please assign me next one?

@aliraza556 You get the next one

@elraphty Could you please assign next one?

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.

5 participants