Add some handler tests

[Yiling-J]

What is this feature?

• Add some handler tests.
• Fix swagger doc.
• Fix deploy resource check bug.

Why do we need this feature?

[Add a description of the problem the feature is trying to solve.]

Who is this feature for?

[Add information on what kind of user the feature is for.]

Which issue(s) does this PR fix?:

Fixes #

Special notes for your reviewer:

MR Summary:

The summary is added by @codegpt.

The Merge Request introduces several updates across multiple files, focusing on enhancing features, fixing bugs, and improving code quality. Key changes include:

1. Implemented new features and enhancements in various components such as Discussion, Space, Tag, and Runtime Architecture.
2. Fixed bugs and made improvements in the Deployer component, including adjustments to resource checking and deployment processes.
3. Updated test cases to align with the changes in the components and ensure code reliability.
4. Refactored code for better readability and maintainability, including modifications in the API handlers and router configuration.
5. Updated documentation and Swagger definitions to reflect the new changes and ensure accurate API documentation.

These updates aim to enhance the platform's functionality, improve user experience, and maintain high code quality standards.

[starship-github]

Linter Issue Report

During the code review, a list issues were found. These issues could affect the code quality, maintainability, and consistency. Below is the detailed Linter issue report:

common/types/discussion.go

Lint Issue: undefined: RepositoryType

• Location: Line 11, Column 14
• Code Snippet:

  RepoType    RepositoryType `json:"-"` 

• Suggestion: Ensure that RepositoryType is defined within the package or imported correctly. If it's defined in another package, make sure to import that package. If it's missing, you'll need to define it or remove references to it if it's not needed.

Lint Issue: undefined: RepositoryType

• Location: Line 86, Column 14
• Code Snippet:

  RepoType    RepositoryType `json:"-"` 

• Suggestion: Similar to the previous issue, check that RepositoryType is properly defined or imported. Ensure consistency across your project regarding how types are declared and referenced.

Lint Issue: undefined: SensitiveRequestV2

• Location: Line 18, Column 7
• Code Snippet:

  var _ SensitiveRequestV2 = (*CreateRepoDiscussionRequest)(nil)

• Suggestion: Verify that SensitiveRequestV2 is defined in your codebase or in the imported packages. If it's supposed to be part of an external library, ensure that the library is correctly imported. Otherwise, define the SensitiveRequestV2 interface as needed.

Lint Issue: undefined: SensitiveField

• Location: Line 20, Column 64
• Code Snippet:

  return []SensitiveField{

• Suggestion: Check if SensitiveField is defined within your project or if it needs to be imported from an external package. If it's missing, you will need to define this type to match your project's requirements.

Lint Issue: undefined: SensitiveRequestV2

• Location: Line 56, Column 7
• Code Snippet:

  var _ SensitiveRequestV2 = (*UpdateDiscussionRequest)(nil)

• Suggestion: This issue is similar to the previous SensitiveRequestV2 issue. Ensure that the interface is correctly defined or imported from the appropriate package.

Lint Issue: undefined: SensitiveField

• Location: Line 58, Column 60
• Code Snippet:

  return []SensitiveField{

• Suggestion: As with the earlier SensitiveField issue, confirm that SensitiveField is defined or imported correctly. This type must be available in your codebase for your structs to implement it properly.

Lint Issue: undefined: SensitiveRequestV2

• Location: Line 104, Column 7
• Code Snippet:

  var _ SensitiveRequestV2 = (*CreateCommentRequest)(nil)

• Suggestion: Ensure the SensitiveRequestV2 interface is defined or imported. This recurring issue suggests a missing interface or type that is critical to your project's structure.

Lint Issue: undefined: SensitiveField

• Location: Line 106, Column 57
• Code Snippet:

  return []SensitiveField{

• Suggestion: This is another instance where SensitiveField is referenced but not defined. Ensure that all types and interfaces your project relies on are correctly declared or imported.

api/handler/accounting_test.go

Lint Issue: undefined: GinTester

• Location: Line 12, Column 3
• Code Snippet:

  type AccountingTester struct {
  	*GinTester
  	handler *AccountingHandler

• Suggestion: Ensure that GinTester is defined within the project or imported correctly. If it's a third-party package, verify that it's included in your go.mod file.

Lint Issue: undefined: NewGinTester

• Location: Line 20, Column 41
• Code Snippet:

  tester := &AccountingTester{GinTester: NewGinTester()}

• Suggestion: Confirm that the function NewGinTester() exists and is accessible from this package. If it's supposed to be part of an external module, check the import paths and module definitions.

Lint Issue: tester.WithParam undefined (type *AccountingTester has no field or method WithParam)

• Location: Line 27, Column 9 and Line 28, Column 9
• Code Snippet:

  tester.WithParam("namespace", "u")
  tester.WithParam("name", "r")

• Suggestion: It appears that WithParam is not defined for *AccountingTester. Consider implementing this method in the AccountingTester struct or verify if the intended method name is correct.

Lint Issue: t.ginHandler undefined (type *AccountingTester has no field or method ginHandler)

• Location: Line 33, Column 4
• Code Snippet:

  func (t *AccountingTester) WithHandleFunc(fn func(h *AccountingHandler) gin.HandlerFunc) *AccountingTester {
  	t.ginHandler = fn(t.handler)

• Suggestion: The field or method ginHandler is not present in the AccountingTester struct. Ensure you have correctly named the field or method and that it is properly defined within the struct.

Lint Issue: tester.RequireUser undefined (type *AccountingTester has no field or method RequireUser)

• Location: Line 41, Column 9
• Code Snippet:

  tester.RequireUser(t)

• Suggestion: The method RequireUser seems to be missing from *AccountingTester. You might need to define this method or correct its usage if it's named differently.

Lint Issue: tester.ctx undefined (type *AccountingTester has no field or method ctx)

• Location: Line 44, Column 10
• Code Snippet:

  tester.ctx, types.ACCT_STATEMENTS_REQ{

• Suggestion: The ctx field or method does not exist in *AccountingTester. Ensure that the context is properly initialized and accessible within the struct.

Lint Issue: tester.AddPagination undefined (type *AccountingTester has no field or method AddPagination)

• Location: Line 55, Column 9
• Code Snippet:

  tester.AddPagination(1, 10).WithParam("id", "1")

• Suggestion: The method AddPagination is not defined for *AccountingTester. If pagination is required, consider implementing this functionality within the struct.

Lint Issue: tester.WithQuery undefined (type *AccountingTester has no field or method WithQuery)

• Location: Line 56, Column 9 and Line 57, Column 9
• Code Snippet:

  WithQuery("instance_name", "in").WithQuery("scene", "2")

• Suggestion: The method WithQuery does not exist for *AccountingTester. Verify the method's name and ensure it's correctly implemented within the struct.

Lint Issue: tester.Execute undefined (type *AccountingTester has no field or method Execute)

• Location: Line 57, Column 9
• Code Snippet:

  tester.Execute()

• Suggestion: It looks like the Execute method is missing from *AccountingTester. Ensure that this method is properly defined to execute the test cases.

Lint Issue: tester.ResponseEq undefined (type *AccountingTester has no field or method ResponseEq)

• Location: Line 59, Column 9
• Code Snippet:

  tester.ResponseEq(t, 200, tester.OKText, "go")

• Suggestion: The ResponseEq method is not present in *AccountingTester. This method needs to be defined to compare expected and actual responses in tests.

api/handler/collection_test.go

Lint Issue: undefined: GinTester

• Location: Line 15, Column 3
• Suggestion: It seems like GinTester is not defined within the scope of your test file. Ensure that you have defined GinTester or imported the package where GinTester is defined. If it's part of an external package, make sure the package is correctly imported.

Lint Issue: undefined: NewGinTester

• Location: Line 24, Column 41
• Suggestion: The function NewGinTester is not recognized. Verify that you have correctly implemented or imported NewGinTester. If it's supposed to be a constructor for GinTester, ensure that it is correctly defined in the scope.

Lint Issue: tester.WithParam undefined (type *CollectionTester has no field or method WithParam)

• Location: Lines 32 and 33, Column 9
• Suggestion: The method WithParam is not defined for *CollectionTester. Ensure you have correctly implemented WithParam in the CollectionTester struct. If it's inherited or should be part of another struct, verify the struct composition or method embedding.

Lint Issue: t.ginHandler undefined (type *CollectionTester has no field or method ginHandler)

• Location: Line 38, Column 4
• Suggestion: The field or method ginHandler is missing in *CollectionTester. If ginHandler is intended to handle HTTP requests, ensure that you have correctly defined it within CollectionTester or consider embedding an appropriate struct that provides ginHandler.

Lint Issue: tester.ctx undefined (type *CollectionTester has no field or method ctx)

• Location: Line 59, Column 60; Line 88, Column 56; Line 89, Column 59
• Suggestion: The context ctx is not defined in *CollectionTester. Context is crucial for managing request lifecycles. Ensure you define ctx within CollectionTester or initialize it appropriately before use.

Lint Issue: tester.AddPagination undefined (type *CollectionTester has no field or method AddPagination)

• Location: Line 67, Column 11
• Suggestion: The method AddPagination seems to be missing from *CollectionTester. If pagination is a required feature, implement AddPagination to handle pagination logic within your tests.

Lint Issue: tester.response undefined (type *CollectionTester has no field or method response)

• Location: Line 71, Column 34
• Suggestion: The response field or method is not present in *CollectionTester. For testing HTTP handlers, you need to capture the response. Ensure that response is correctly defined and accessible within CollectionTester.

Lint Issue: tester.ResponseEqSimple undefined (type *CollectionTester has no field or method ResponseEqSimple)

• Location: Line 73, Column 12
• Suggestion: It appears that ResponseEqSimple is not a method of *CollectionTester. If you intend to compare responses easily, define ResponseEqSimple within CollectionTester or adjust your test logic to not rely on this method.

Lint Issue: tester.RequireUser undefined (type *CollectionTester has no field or method RequireUser)

• Location: Line 86, Column 9; Line 116, Column 9; Line 132, Column 9
• Suggestion: The method RequireUser is missing from *CollectionTester. This method is likely intended to simulate a user requirement. Implement RequireUser or adjust your test setup to ensure user requirements are met.

Lint Issue: tester.WithBody undefined (type *CollectionTester has no field or method WithBody)

• Location: Line 92, Column 9
• Suggestion: The WithBody method does not exist in *CollectionTester. If you need to include a body in your test requests, ensure that WithBody is correctly implemented to set the request body.

Lint Issue: tester.ResponseEq undefined (type *CollectionTester has no field or method ResponseEq)

• Location: Line 94, Column 9; Line 108, Column 9; Line 124, Column 9
• Suggestion: The method ResponseEq is undefined in *CollectionTester. This method is likely used for asserting test responses. Define ResponseEq within CollectionTester to compare expected and actual responses in your tests.

Lint Issue: tester.WithParam undefined (type *CollectionTester has no field or method WithParam)

• Location: Line 122, Column 9
• Suggestion: As previously mentioned, WithParam is not defined for *CollectionTester. Ensure this method is implemented to allow parameter setting in your test requests.

api/handler/dataset_test.go

Lint Issue: undefined: GinTester

• Location: Line 14, Column 3
• Code Snippet:

  type DatasetTester struct {
  	*GinTester
  	handler *DatasetHandler

• Suggestion: Ensure that GinTester is defined within the project or imported correctly. If it's a third-party package, verify that it's included in your go.mod file.

Lint Issue: undefined: NewGinTester

• Location: Line 24, Column 38
• Code Snippet:

  tester := &DatasetTester{GinTester: NewGinTester()}

• Suggestion: Check if the function NewGinTester() is defined and exported correctly. If it's part of an external package, ensure the package is imported and the function is accessible.

Lint Issue: tester.WithParam undefined (type *DatasetTester has no field or method WithParam)

• Location: Line 34, Column 9 and Line 35, Column 9
• Code Snippet:

  tester.WithParam("namespace", "u")
  tester.WithParam("name", "r")

• Suggestion: It appears WithParam method is not defined for *DatasetTester. You should implement this method in the DatasetTester struct to handle parameter setting as intended.

Lint Issue: t.ginHandler undefined (type *DatasetTester has no field or method ginHandler)

• Location: Line 40, Column 4
• Code Snippet:

  func (t *DatasetTester) WithHandleFunc(fn func(h *DatasetHandler) gin.HandlerFunc) *DatasetTester {
  	t.ginHandler = fn(t.handler)

• Suggestion: The ginHandler field is not present in the DatasetTester struct. Add this field or correct the method to use an existing field or method for handling the gin handler function.

Lint Issue: tester.RequireUser undefined (type *DatasetTester has no field or method RequireUser)

• Location: Line 51, Column 10
• Code Snippet:

  tester.RequireUser(t)

• Suggestion: The method RequireUser seems to be missing from *DatasetTester. Ensure you have this method defined to enforce user requirement checks in your tests.

Lint Issue: tester.ctx undefined (type *DatasetTester has no field or method ctx)

• Location: Line 53, Column 57 and Line 56, Column 47
• Code Snippet:

  tester.mocks.sensitive.EXPECT().CheckRequestV2(tester.ctx, &types.CreateDatasetReq{

  tester.mocks.dataset.EXPECT().Create(tester.ctx, &types.CreateDatasetReq{

• Suggestion: The ctx field or method is not defined in *DatasetTester. You might need to add a context field to the struct or pass the context directly to methods requiring it.

Lint Issue: tester.WithBody undefined (type *DatasetTester has no field or method WithBody)

• Location: Line 59, Column 10
• Code Snippet:

  tester.WithBody(t, &types.CreateDatasetReq{

• Suggestion: Similar to previous issues, WithBody method is not found in *DatasetTester. Implement this method to allow setting the request body in your test setup.

---

Please make the suggested changes to improve the code quality.

[starship-github]

Possible Issues And Suggestions:

• api/handler/space.go

  • Comments:
    • Error messages should be consistent. Some error messages start with a lowercase letter, while others start with an uppercase letter.
  • Suggestions:

    slog.Error("Failed to check sensitive request", slog.Any("error", err))
    

• Line 132 in common/types/discussion.go

  • Comments:
    • Implementing SensitiveRequestV2 interface without actually using sensitive data detection in UpdateCommentRequest.

• api/handler/discussion.go

  • Comments:
    • Direct use of "strconv.ParseInt" without checking for negative values could lead to unintended behavior. Ensure ID is positive.
  • Suggestions:

    if idInt < 0 {
        httpbase.BadRequest(ctx, "invalid discussion id: must be positive")
        return
    }
    

• api/handler/mirror_source.go

  • Comments:
    • The currentUser variable is redundantly checked for an empty string multiple times in each function. This check can be abstracted into a middleware to avoid code duplication and improve readability.
  • Suggestions:

    // Suggested to implement a middleware function for currentUser validation
    func currentUserCheckMiddleware() gin.HandlerFunc {
        return func(c *gin.Context) {
            currentUser := httpbase.GetCurrentUser(c)
            if currentUser == "" {
                httpbase.UnauthorizedError(c, component.ErrUserNotFound)
                c.Abort()
                return
            }
            c.Set("currentUser", currentUser)
            c.Next()
        }
    }
    

• api/handler/mirror_source.go

  • Comments:
    • The error handling for ShouldBindJSON is not consistent with the rest of the error handling. It directly logs the error and sends a BadRequest response. It's better to return the error and handle it uniformly.
  • Suggestions:

    // Suggested to return error for uniform handling
    if err := ctx.ShouldBindJSON(&msReq); err != nil {
        return err
    }
    

• api/handler/mirror_source.go

  • Comments:
    • Direct assignment of currentUser to msReq.CurrentUser before checking if msReq is successfully bound from the request body could lead to incorrect behavior or panic if binding fails.
  • Suggestions:

    // Suggested to move the assignment inside the error check block after successful binding
    if err := ctx.ShouldBindJSON(&msReq); err != nil {
        slog.Error("Bad request format", "error", err)
        httpbase.BadRequest(ctx, err.Error())
        return
    }
    msReq.CurrentUser = currentUser
    

• component/discussion_test.go

  • Comments:
    • Missing import for 'types' package. The code references 'types' package structs but does not import it.
  • Suggestions:

    import (
      "opencsg.com/csghub-server/common/types"
    )
    

• component/discussion_test.go

  • Comments:
    • Incorrect struct name in test function. Should be 'types.CreateDiscussionRequest', not 'CreateRepoDiscussionRequest'.
  • Suggestions:

    req := types.CreateDiscussionRequest{
    

• component/discussion_test.go

  • Comments:
    • Incorrect struct name in test function. Should be 'types.UpdateDiscussionRequest', not 'UpdateDiscussionRequest'.

• component/discussion_test.go

  • Comments:
    • Incorrect struct name in test function. Should be 'types.CreateCommentRequest', not 'CreateCommentRequest'.

MR Evaluation:

This feature is still under test, evaluation are given by AI and might be inaccurate.

After evaluation, the code changes in the Merge Request get score: 100.

Tips

CodeReview Commands (invoked as MR or PR comments)

• @codegpt /review to trigger an code review.
• @codegpt /evaluate to trigger code evaluation process.
• @codegpt /describe to regenerate the summary of the MR.
• @codegpt /secscan to scan security vulnerabilities for the MR or the Repository.
• @codegpt /help to get help.

CodeReview Discussion Chat

There are 2 ways to chat with Starship CodeReview:

• Review comments: Directly reply to a review comment made by StarShip.
  Example:
  • @codegpt How to fix this bug?
• Files and specific lines of code (under the "Files changed" tab):
  Tag @codegpt in a new review comment at the desired location with your query.
  Examples:
  • @codegpt generate unit testing code for this code snippet.

Note: Be mindful of the bot's finite context window.
It's strongly recommended to break down tasks such as reading entire modules into smaller chunks.
For a focused discussion, use review comments to chat about specific files and their changes, instead of using the MR/PR comments.

CodeReview Documentation and Community

• Visit our Documentation
  for detailed information on how to use Starship CodeReview.

About Us:

Visit the OpenCSG StarShip website for the Dashboard and detailed information on CodeReview, CodeGen, and other StarShip modules.

[SeanHH86]

lgtm

[ganisback]

LGTM

[starship-github]

The StarShip CodeReviewer was triggered but terminated because it encountered an issue: The MR state is not opened.

Tips

CodeReview Commands (invoked as MR or PR comments)

• @codegpt /review to trigger an code review.
• @codegpt /evaluate to trigger code evaluation process.
• @codegpt /describe to regenerate the summary of the MR.
• @codegpt /secscan to scan security vulnerabilities for the MR or the Repository.
• @codegpt /help to get help.

CodeReview Discussion Chat

There are 2 ways to chat with Starship CodeReview:

• Review comments: Directly reply to a review comment made by StarShip.
  Example:
  • @codegpt How to fix this bug?
• Files and specific lines of code (under the "Files changed" tab):
  Tag @codegpt in a new review comment at the desired location with your query.
  Examples:
  • @codegpt generate unit testing code for this code snippet.

Note: Be mindful of the bot's finite context window.
It's strongly recommended to break down tasks such as reading entire modules into smaller chunks.
For a focused discussion, use review comments to chat about specific files and their changes, instead of using the MR/PR comments.

CodeReview Documentation and Community

• Visit our Documentation
  for detailed information on how to use Starship CodeReview.