CI Updates

.github/workflows/backend.yml

@@ -46,21 +46,21 @@ jobs:
   lint:
     name: Lint
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: read
+      checks: write
     steps:
-      - name: Checkout Repository
-        uses: actions/checkout@v3
-      - name: Set up Go
-        uses: actions/setup-go@v3
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v4
         with:
           go-version: "1.21"
-      - name: Enforce linting
-        run: |
-          cd ./backend/ && lint_output=$(go vet ./...)
-          if [[ -n "$lint_output" ]]; then
-            echo "$lint_output"
-            echo "::error::Linting issues found"
-            exit 1
-          fi
+          cache: false
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          version: latest
+          working-directory: ./backend/
   test:
     name: Test
     runs-on: ubuntu-latest

.github/workflows/cli.yml

@@ -46,18 +46,18 @@ jobs:
   lint:
     name: Lint
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: read
+      checks: write
     steps:
-      - name: Checkout Repository
-        uses: actions/checkout@v3
-      - name: Set up Go
-        uses: actions/setup-go@v3
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v4
         with:
           go-version: "1.21"
-      - name: Enforce linting
-        run: |
-          cd ./cli/ && lint_output=$(go vet ./...)
-          if [[ -n "$lint_output" ]]; then
-            echo "$lint_output"
-            echo "::error::Linting issues found"
-            exit 1
-          fi
+          cache: false
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          version: latest
+          working-directory: ./cli/

README.md

@@ -3,7 +3,10 @@
 <br />
 
 <div align="center">
-  <!-- Github Actions -->
+  <a href="https://goreportcard.com/report/github.com/GenerateNU/sac/backend">
+    <img src="https://goreportcard.com/badge/github.com/GenerateNU/sac/backend"
+      alt="Backend Go Report" />
+  </a>
   <a href="https://github.com/GenerateNU/sac/actions/workflows/backend.yml">
     <img src="https://github.com/GenerateNU/sac/actions/workflows/backend.yml/badge.svg"
       alt="Backend Workflow Status" />
@@ -16,6 +19,10 @@
 
   <br />
 
+  <a href="https://goreportcard.com/report/github.com/GenerateNU/sac/cli">
+    <img src="https://goreportcard.com/badge/github.com/GenerateNU/sac/cli"
+      alt="CLI Go Report" />
+  </a>
   <a href="https://github.com/GenerateNU/sac/actions/workflows/cli.yml">
     <img src="https://github.com/GenerateNU/sac/actions/workflows/cli.yml/badge.svg"
       alt="CLI Workflow Status" />

backend/.golangci.yml

@@ -0,0 +1,23 @@
+linters:
+  enable:
+    - cyclop
+    - exportloopref
+    - gocritic
+    - gosec
+    - ineffassign
+    - misspell
+    - prealloc
+    - unconvert
+    - unparam
+    - goimports
+    - whitespace
+
+linters-settings:
+  whitespace:
+    multi-func: true
+
+issues:
+  exclude-rules:
+    - path: tests/api/helpers/
+      linters:
+        - cyclop

backend/src/database/db.go

@@ -141,7 +141,6 @@ func createSuperUser(settings config.Settings, db *gorm.DB) error {
 		}
 
 		return tx.Commit().Error
-
 	}
 	return nil
 }

backend/src/database/super.go

@@ -35,7 +35,7 @@ func SuperClub() models.Club {
 		Description:      "SAC",
 		NumMembers:       0,
 		IsRecruiting:     true,
-		RecruitmentCycle: models.RecruitmentCycle(models.Always),
+		RecruitmentCycle: models.Always,
 		RecruitmentType:  models.Application,
 		ApplicationLink:  "https://generatenu.com/apply",
 		Logo:             "https://aws.amazon.com/s3",

backend/src/main.go

@@ -35,5 +35,8 @@ func main() {
 
 	app := server.Init(db, config)
 
-	app.Listen(fmt.Sprintf("%s:%d", config.Application.Host, config.Application.Port))
+	err = app.Listen(fmt.Sprintf("%s:%d", config.Application.Host, config.Application.Port))
+	if err != nil {
+		panic(err)
+	}
 }

backend/src/middleware/auth.go

@@ -23,7 +23,7 @@ func SuperSkipper(h fiber.Handler) fiber.Handler {
 	return skip.New(h, func(c *fiber.Ctx) bool {
 		claims, err := types.From(c)
 		if err != nil {
-			err.FiberError(c)
+			_ = err.FiberError(c)
 			return false
 		}
 		if claims == nil {

backend/src/server/server.go

@@ -26,7 +26,11 @@ import (
 func Init(db *gorm.DB, settings config.Settings) *fiber.App {
 	app := newFiberApp()
 
-	validate := utilities.RegisterCustomValidators()
+	validate, err := utilities.RegisterCustomValidators()
+	if err != nil {
+		panic(err)
+	}
+
 	middlewareService := middleware.NewMiddlewareService(db, validate, settings.Auth)
 
 	apiv1 := app.Group("/api/v1")

backend/src/services/auth.go

@@ -75,7 +75,7 @@ func (a *AuthService) GetRole(id string) (*models.UserRole, *errors.Error) {
 		return nil, &errors.UserNotFound
 	}
 
-	role := models.UserRole(user.Role)
+	role := user.Role
 
 	return &role, nil
 }

backend/src/transactions/club.go

@@ -17,7 +17,7 @@ func GetAdminIDs(db *gorm.DB, clubID uuid.UUID) ([]uuid.UUID, *errors.Error) {
 		return nil, &errors.FailedtoGetAdminIDs
 	}
 
-	var adminUUIDs []uuid.UUID
+	adminUUIDs := make([]uuid.UUID, 0)
 	for _, adminID := range adminIDs {
 		adminUUIDs = append(adminUUIDs, adminID.ClubID)
 	}

backend/src/utilities/validator.go

@@ -13,18 +13,32 @@ import (
 	"github.com/go-playground/validator/v10"
 )
 
-func RegisterCustomValidators() *validator.Validate {
+func RegisterCustomValidators() (*validator.Validate, error) {
 	validate := validator.New(validator.WithRequiredStructEnabled())
 
-	validate.RegisterValidation("neu_email", validateEmail)
-	validate.RegisterValidation("password", validatePassword)
-	validate.RegisterValidation("mongo_url", validateMongoURL)
-	validate.RegisterValidation("s3_url", validateS3URL)
-	validate.RegisterValidation("contact_pointer", func(fl validator.FieldLevel) bool {
+	if err := validate.RegisterValidation("neu_email", validateEmail); err != nil {
+		return nil, err
+	}
+
+	if err := validate.RegisterValidation("password", validatePassword); err != nil {
+		return nil, err
+	}
+
+	if err := validate.RegisterValidation("mongo_url", validateMongoURL); err != nil {
+		return nil, err
+	}
+
+	if err := validate.RegisterValidation("s3_url", validateS3URL); err != nil {
+		return nil, err
+	}
+
+	if err := validate.RegisterValidation("contact_pointer", func(fl validator.FieldLevel) bool {
 		return validateContactPointer(validate, fl)
-	})
+	}); err != nil {
+		return nil, err
+	}
 
-	return validate
+	return validate, nil
 }
 
 func validateEmail(fl validator.FieldLevel) bool {

backend/tests/api/club_test.go

@@ -206,8 +206,8 @@ func TestGetClubsWorks(t *testing.T) {
 				assert.Equal("SAC", dbClub.Description)
 				assert.Equal(1, dbClub.NumMembers)
 				assert.Equal(true, dbClub.IsRecruiting)
-				assert.Equal(models.RecruitmentCycle(models.Always), dbClub.RecruitmentCycle)
-				assert.Equal(models.RecruitmentType(models.Application), dbClub.RecruitmentType)
+				assert.Equal(models.Always, dbClub.RecruitmentCycle)
+				assert.Equal(models.Application, dbClub.RecruitmentType)
 				assert.Equal("https://generatenu.com/apply", dbClub.ApplicationLink)
 				assert.Equal("https://aws.amazon.com/s3", dbClub.Logo)
 			},
@@ -303,7 +303,7 @@ func TestCreateClubFailsOnInvalidLogo(t *testing.T) {
 		[]interface{}{
 			"Not an URL",
 			"@#139081#$Ad_Axf",
-			//"https://google.com", <-- TODO uncomment once we figure out s3 url validation
+			// "https://google.com", <-- TODO uncomment once we figure out s3 url validation
 		},
 	)
 }
@@ -343,6 +343,7 @@ func TestUpdateClubFailsOnInvalidBody(t *testing.T) {
 		{"application_link": "Not an URL"},
 		{"logo": "@12394X_2"},
 	} {
+		invalidData := invalidData
 		appAssert.TestOnErrorAndDB(
 			h.TestRequest{
 				Method: fiber.MethodPatch,

backend/tests/api/helpers/requests.go

@@ -24,6 +24,7 @@ type TestRequest struct {
 	TestUserIDReplaces *string
 }
 
+//gocyclo:ignore
 func (app TestApp) Send(request TestRequest) (*http.Response, error) {
 	address := fmt.Sprintf("%s%s", app.Address, request.Path)
 

backend/tests/api/tag_test.go

@@ -115,6 +115,7 @@ func TestCreateTagFailsBadRequest(t *testing.T) {
 	}
 
 	for _, badBody := range badBodys {
+		badBody := badBody
 		appAssert.TestOnErrorAndDB(
 			h.TestRequest{
 				Method: fiber.MethodPost,
@@ -146,6 +147,7 @@ func TestCreateTagFailsValidation(t *testing.T) {
 	}
 
 	for _, badBody := range badBodys {
+		badBody := badBody
 		appAssert.TestOnErrorAndDB(
 			h.TestRequest{
 				Method: fiber.MethodPost,

backend/tests/api/user_tag_test.go

@@ -66,6 +66,7 @@ func CreateSetOfTags(t *testing.T, appAssert *h.ExistingAppAssert) ([]uuid.UUID,
 
 	categoryIDs := []uuid.UUID{}
 	for _, category := range *categories {
+		category := category
 		appAssert.TestOnStatusAndDB(
 			h.TestRequest{
 				Method: fiber.MethodPost,
@@ -92,6 +93,7 @@ func CreateSetOfTags(t *testing.T, appAssert *h.ExistingAppAssert) ([]uuid.UUID,
 
 	tagIDs := []uuid.UUID{}
 	for _, tag := range *tags {
+		tag := tag
 		appAssert.TestOnStatusAndDB(
 			h.TestRequest{
 				Method: fiber.MethodPost,
@@ -212,6 +214,7 @@ func TestCreateUserTagsFailsOnInvalidKey(t *testing.T) {
 	}
 
 	for _, body := range invalidBody {
+		body := body
 		h.InitTest(t).TestOnError(
 			h.TestRequest{
 				Method:             fiber.MethodPost,

backend/tests/api/user_test.go

@@ -216,6 +216,7 @@ func TestUpdateUserFailsOnInvalidBody(t *testing.T) {
 		{"year": 1963},
 		{"college": "UT-Austin"},
 	} {
+		invalidData := invalidData
 		h.InitTest(t).TestOnErrorAndDB(
 			h.TestRequest{
 				Method:             fiber.MethodPatch,

cli/.golangci.yml

@@ -0,0 +1,17 @@
+linters:
+  enable:
+    - cyclop
+    - exportloopref
+    - gocritic
+    - gosec
+    - ineffassign
+    - misspell
+    - prealloc
+    - unconvert
+    - unparam
+    - goimports
+    - whitespace
+
+linters-settings:
+  whitespace:
+    multi-func: true

cli/commands/drop.go

@@ -70,8 +70,7 @@ func DropData() error {
 			return fmt.Errorf("error scanning table name: %w", err)
 		}
 
-		deleteStmt := fmt.Sprintf("DELETE FROM \"%s\"", tablename)
-		_, err := db.Exec(deleteStmt)
+		_, err := db.Exec("DELETE FROM $1", tablename)
 		if err != nil {
 			return fmt.Errorf("error deleting rows from table %s: %w", tablename, err)
 		}
@@ -82,7 +81,9 @@ func DropData() error {
 		return fmt.Errorf("error in rows handling: %w", err)
 	}
 
-	Migrate()
+	if Migrate() != nil {
+		return fmt.Errorf("error migrating database: %w", err)
+	}
 
 	fmt.Println("All rows removed successfully.")
 	return nil

cli/commands/format.go

@@ -39,7 +39,10 @@ func FormatCommand() *cli.Command {
 			runFrontend := folder != ""
 			runBackend := c.Bool("backend")
 
-			Format(folder, runFrontend, runBackend)
+			err := Format(folder, runFrontend, runBackend)
+			if err != nil {
+				return cli.Exit(err.Error(), 1)
+			}
 
 			return nil
 		},
@@ -56,7 +59,10 @@ func Format(folder string, runFrontend bool, runBackend bool) error {
 		wg.Add(1)
 		go func() {
 			defer wg.Done()
-			BackendFormat()
+			err := BackendFormat()
+			if err != nil {
+				fmt.Println(err)
+			}
 		}()
 	}
 
@@ -65,7 +71,10 @@ func Format(folder string, runFrontend bool, runBackend bool) error {
 		wg.Add(1)
 		go func() {
 			defer wg.Done()
-			FrontendFormat(folder)
+			err := FrontendFormat(folder)
+			if err != nil {
+				fmt.Println(err)
+			}
 		}()
 	}