SAC-6 Get User GET (#14)

Co-authored-by: edwinliiiii <[email protected]> Co-authored-by: edwinliiiii <[email protected]> Co-authored-by: Garrett Ladley <[email protected]> Co-authored-by: garrettladley <[email protected]>
GenerateNU · Jan 21, 2024 · 5c57959 · 5c57959
1 parent 4ca58e6
commit 5c57959
Show file tree

Hide file tree

Showing 13 changed files with 164 additions and 33 deletions.
diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml
@@ -69,9 +69,8 @@ jobs:
       - name: Install Dependencies
         run: cd backend && go get ./...
       - name: Migrate DB
-        run: |
-          cd backend/src && go run main.go --only-migrate
+        run: cd backend/src && go run main.go --only-migrate
       - name: Run Tests with Coverage
-        run: cd backend && go test -race -coverprofile=coverage.txt -covermode=atomic ./...
+        run: cd backend && go test -failfast -benchmem -race -coverprofile=coverage.txt ./...
       - name: Print Coverage
         run: cd backend && go tool cover -func=coverage.txt
diff --git a/backend/src/controllers/user.go b/backend/src/controllers/user.go
@@ -33,3 +33,24 @@ func (u *UserController) GetAllUsers(c *fiber.Ctx) error {
 
 	return c.Status(fiber.StatusOK).JSON(users)
 }
+
+// GetUser godoc
+//
+// @Summary		Gets specific user
+// @Description	Returns specific user
+// @ID			get-user
+// @Tags      	user
+// @Produce		json
+// @Success		200	  {object}	  models.User
+// @Failure     400   {string}    string "failed to validate id"
+// @Failure     404   {string}    string "failed to find user"
+// @Failure     500   {string}    string
+// @Router		/api/v1/users/  [get]
+func (u *UserController) GetUser(c *fiber.Ctx) error {
+	user, err := u.userService.GetUser(c.Params("id"))
+	if err != nil {
+		return err
+	}
+
+	return c.Status(fiber.StatusOK).JSON(user)
+}
diff --git a/backend/src/models/user.go b/backend/src/models/user.go
@@ -38,7 +38,7 @@ const (
 type User struct {
 	types.Model
 
-	Role         UserRole `gorm:"type:varchar(255);" json:"user_role" validate:"required,max=255"`
+	Role         UserRole `gorm:"type:varchar(255);" json:"user_role,omitempty" validate:"required,max=255"`
 	NUID         string   `gorm:"column:nuid;type:varchar(9);unique" json:"nuid" validate:"required,numeric,len=9"`
 	FirstName    string   `gorm:"type:varchar(255)" json:"first_name" validate:"required,max=255"`
 	LastName     string   `gorm:"type:varchar(255)" json:"last_name" validate:"required,max=255"`

diff --git a/backend/src/server/server.go b/backend/src/server/server.go
@@ -65,6 +65,7 @@ func userRoutes(router fiber.Router, userService services.UserServiceInterface)
 	users := router.Group("/users")
 
 	users.Get("/", userController.GetAllUsers)
+	users.Get("/:id", userController.GetUser)
 }
 
 func categoryRoutes(router fiber.Router, categoryService services.CategoryServiceInterface) {

diff --git a/backend/src/services/user.go b/backend/src/services/user.go
@@ -3,19 +3,30 @@ package services
 import (
 	"github.com/GenerateNU/sac/backend/src/models"
 	"github.com/GenerateNU/sac/backend/src/transactions"
+	"github.com/GenerateNU/sac/backend/src/utilities"
 
 	"gorm.io/gorm"
 )
 
 type UserServiceInterface interface {
 	GetAllUsers() ([]models.User, error)
+	GetUser(string) (*models.User, error)
 }
 
 type UserService struct {
 	DB *gorm.DB
 }
 
-// Gets all users (including soft deleted users) for testing
 func (u *UserService) GetAllUsers() ([]models.User, error) {
 	return transactions.GetAllUsers(u.DB)
 }
+
+func (u *UserService) GetUser(userID string) (*models.User, error) {
+	idAsUint, err := utilities.ValidateID(userID)
+
+	if err != nil {
+		return nil, err
+	}
+
+	return transactions.GetUser(u.DB, *idAsUint)
+}
diff --git a/backend/src/transactions/user.go b/backend/src/transactions/user.go
@@ -1,6 +1,8 @@
 package transactions
 
 import (
+	"errors"
+
 	"github.com/GenerateNU/sac/backend/src/models"
 
 	"github.com/gofiber/fiber/v2"
@@ -10,9 +12,22 @@ import (
 func GetAllUsers(db *gorm.DB) ([]models.User, error) {
 	var users []models.User
 
-	if err := db.Unscoped().Omit("password_hash").Find(&users).Error; err != nil {
+	if err := db.Omit("password_hash").Find(&users).Error; err != nil {
 		return nil, fiber.NewError(fiber.StatusInternalServerError, "failed to get all users")
 	}
 
 	return users, nil
 }
+
+func GetUser(db *gorm.DB, id uint) (*models.User, error) {
+	var user models.User
+
+	if err := db.Omit("password_hash").First(&user, id).Error; err != nil {
+		if errors.Is(err, gorm.ErrRecordNotFound) {
+			return nil, fiber.NewError(fiber.StatusNotFound, "failed to find tag")
+		}
+		return nil, fiber.NewError(fiber.StatusInternalServerError, "failed to get user")
+	}
+
+	return &user, nil
+}
diff --git a/backend/tests/api/README.md b/backend/tests/api/README.md
@@ -40,7 +40,7 @@ Say you want to test hitting the `[APP_ADDRESS]/health` endpoint with a GET requ
 TestRequest{
   Method: "GET",
   Path:   "/health",
- }.TestOnStatus(t, nil, 200)
+ }.TestOnStatus(t, nil, 200).Close()
 ```
 
 ## Testing that a Request Returns a XXX Status Code and Assert Something About the Database
@@ -59,7 +59,7 @@ TestRequest{
    Status:   201,
    DBTester: AssertRespCategorySameAsDBCategory,
   },
- )
+ ).Close()
 ```
 
 ### DBTesters
@@ -114,9 +114,13 @@ TestRequest{
    Status:   201,
    DBTester: AssertRespTagSameAsDBTag,
   },
- )
+ ).Close()
 ```
 
+### Why Close?
+
+This closes the connection to the database. This is important because if you don't close the connection, we will run out of available connections and the tests will fail. **Call this on the last test request of a test**
+
 ## Testing that a Request Returns a XXX Status Code, Assert Something About the Message, and Assert Something About the Database
 
 Say you want to test a bad request to POST `[APP_ADDRESS]/api/v1/categories/` endpoint returns a `400` status code, the message is `failed to process the request`, and that a category was not created.
@@ -136,5 +140,5 @@ TestRequest{
    },
    DBTester: AssertNoCategories,
   },
- )
+ ).Close()
 ```
diff --git a/backend/tests/api/category_test.go b/backend/tests/api/category_test.go
@@ -41,7 +41,7 @@ func CreateSampleCategory(t *testing.T, categoryName string, existingAppAssert *
 }
 
 func TestCreateCategoryWorks(t *testing.T) {
-	CreateSampleCategory(t, "Science", nil)
+	CreateSampleCategory(t, "Science", nil).Close()
 }
 
 func TestCreateCategoryIgnoresid(t *testing.T) {
@@ -57,7 +57,7 @@ func TestCreateCategoryIgnoresid(t *testing.T) {
 			Status:   201,
 			DBTester: AssertRespCategorySameAsDBCategory,
 		},
-	)
+	).Close()
 }
 
 func AssertNoCategories(app TestApp, assert *assert.A, resp *http.Response) {
@@ -89,7 +89,7 @@ func TestCreateCategoryFailsIfNameIsNotString(t *testing.T) {
 			},
 			DBTester: AssertNoCategories,
 		},
-	)
+	).Close()
 }
 
 func TestCreateCategoryFailsIfNameIsMissing(t *testing.T) {
@@ -105,7 +105,7 @@ func TestCreateCategoryFailsIfNameIsMissing(t *testing.T) {
 			},
 			DBTester: AssertNoCategories,
 		},
-	)
+	).Close()
 }
 
 func TestCreateCategoryFailsIfCategoryWithThatNameAlreadyExists(t *testing.T) {
@@ -134,4 +134,6 @@ func TestCreateCategoryFailsIfCategoryWithThatNameAlreadyExists(t *testing.T) {
 			},
 		)
 	}
+
+	existingAppAssert.Close()
 }
diff --git a/backend/tests/api/health_test.go b/backend/tests/api/health_test.go
@@ -10,5 +10,5 @@ func TestHealthWorks(t *testing.T) {
 		Path:   "/health",
 	}.TestOnStatus(t, nil,
 		200,
-	)
+	).Close()
 }
diff --git a/backend/tests/api/helpers.go b/backend/tests/api/helpers.go
@@ -122,6 +122,20 @@ type ExistingAppAssert struct {
 	Assert *assert.A
 }
 
+func (eaa ExistingAppAssert) Close() {
+	db, err := eaa.App.Conn.DB()
+
+	if err != nil {
+		panic(err)
+	}
+
+	err = db.Close()
+
+	if err != nil {
+		panic(err)
+	}
+}
+
 type TestRequest struct {
 	Method  string
 	Path    string

diff --git a/backend/tests/api/tag_test.go b/backend/tests/api/tag_test.go
@@ -45,7 +45,7 @@ func CreateSampleTag(t *testing.T, tagName string, categoryName string, existing
 }
 
 func TestCreateTagWorks(t *testing.T) {
-	CreateSampleTag(t, "Generate", "Science", nil)
+	CreateSampleTag(t, "Generate", "Science", nil).Close()
 }
 
 var AssertNoTags = func(app TestApp, assert *assert.A, resp *http.Response) {
@@ -83,7 +83,7 @@ func TestCreateTagFailsBadRequest(t *testing.T) {
 				},
 				DBTester: AssertNoTags,
 			},
-		)
+		).Close()
 	}
 }
 
@@ -111,7 +111,7 @@ func TestCreateTagFailsValidation(t *testing.T) {
 				},
 				DBTester: AssertNoTags,
 			},
-		)
+		).Close()
 	}
 }
 
@@ -126,7 +126,7 @@ func TestGetTagWorks(t *testing.T) {
 			Status:   200,
 			DBTester: AssertRespTagSameAsDBTag,
 		},
-	)
+	).Close()
 }
 
 func TestGetTagFailsBadRequest(t *testing.T) {
@@ -147,7 +147,7 @@ func TestGetTagFailsBadRequest(t *testing.T) {
 				Status:  400,
 				Message: "failed to validate id",
 			},
-		)
+		).Close()
 	}
 }
 
@@ -160,7 +160,7 @@ func TestGetTagFailsNotFound(t *testing.T) {
 			Status:  404,
 			Message: "failed to find tag",
 		},
-	)
+	).Close()
 }
 
 func TestUpdateTagWorksUpdateName(t *testing.T) {
@@ -178,7 +178,7 @@ func TestUpdateTagWorksUpdateName(t *testing.T) {
 			Status:   200,
 			DBTester: AssertRespTagSameAsDBTag,
 		},
-	)
+	).Close()
 }
 
 func TestUpdateTagWorksUpdateCategory(t *testing.T) {
@@ -197,7 +197,7 @@ func TestUpdateTagWorksUpdateCategory(t *testing.T) {
 			Status:   200,
 			DBTester: AssertRespTagSameAsDBTag,
 		},
-	)
+	).Close()
 }
 
 func TestUpdateTagWorksWithSameDetails(t *testing.T) {
@@ -215,7 +215,7 @@ func TestUpdateTagWorksWithSameDetails(t *testing.T) {
 			Status:   200,
 			DBTester: AssertRespTagSameAsDBTag,
 		},
-	)
+	).Close()
 }
 
 func TestUpdateTagFailsBadRequest(t *testing.T) {
@@ -243,7 +243,7 @@ func TestUpdateTagFailsBadRequest(t *testing.T) {
 				},
 				DBTester: AssertNoTags,
 			},
-		)
+		).Close()
 	}
 }
 
@@ -258,7 +258,7 @@ func TestDeleteTagWorks(t *testing.T) {
 			Status:   204,
 			DBTester: AssertNoTags,
 		},
-	)
+	).Close()
 }
 
 func TestDeleteTagFailsBadRequest(t *testing.T) {
@@ -279,7 +279,7 @@ func TestDeleteTagFailsBadRequest(t *testing.T) {
 				Status:  400,
 				Message: "failed to validate id",
 			},
-		)
+		).Close()
 	}
 }
 
@@ -292,5 +292,5 @@ func TestDeleteTagFailsNotFound(t *testing.T) {
 			Status:  404,
 			Message: "failed to find tag",
 		},
-	)
+	).Close()
 }