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

updated tests for full coverage #957

Merged
merged 1 commit into from
Oct 14, 2024

Conversation

ajhollid
Copy link
Collaborator

This PR updates some authController tests to provide full test coverage

@ajhollid ajhollid marked this pull request as ready for review October 14, 2024 07:24
@ajhollid ajhollid merged commit 3c400d3 into develop Oct 14, 2024
1 of 2 checks passed
@ajhollid ajhollid deleted the fix/be/auth-controller-test-coverage branch October 14, 2024 07:24
Copy link

coderabbitai bot commented Oct 14, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request focus on enhancing the authController.js and its corresponding test suite. A new method, issueToken, has been added to the controller, improving token management. Error handling has been strengthened across several existing methods, including user registration and recovery processes, with improved logging for both success and error scenarios. The test suite has been expanded to include comprehensive tests for the new and modified functionalities, ensuring robust error handling and validation across various user-related operations.

Changes

File Change Summary
Server/controllers/authController.js Added issueToken method; enhanced error handling in registerUser, requestRecovery, and others; improved logging.
Server/tests/controllers/authController.test.js Added tests for issueToken; expanded tests for registerUser, loginUser, editUser, checkSuperadminExists, requestRecovery, validateRecovery, resetPassword, and deleteUser with enhanced error handling and validation checks.

Possibly related PRs

  • Feat/server auth controller tests #922: This PR enhances the test suite for the authController, which includes tests for the registerUser and loginUser functions, directly related to the changes made in the main PR that also focuses on the authController functionalities.
  • Feat/be/controller-utils-tests, #924 #930: This PR introduces tests for the handleValidationError and handleError functions, which are relevant to the error handling improvements made in the main PR's authController.js.
  • Feat/be/invite-controller-tests, #924 #932: Although primarily focused on the inviteController, this PR's testing enhancements reflect a similar approach to improving error handling and functionality testing, which aligns with the objectives of the main PR.

Suggested reviewers

  • marcelluscaio
  • jennifer-gan

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

const error = new Error("jwt.sign error");
stub = sinon.stub(jwt, "sign").throws(error);
const payload = { id: "123" };
const appSettings = { jwtSecret: "my_secret" };

Check failure

Code scanning / CodeQL

Hard-coded credentials Critical test

The hard-coded value "my_secret" is used as
jwt key
.

it("should return a token if jwt.sign is successful and appSettings.jtwTTL is not defined", () => {
const payload = { id: "123" };
const appSettings = { jwtSecret: "my_secret" };

Check failure

Code scanning / CodeQL

Hard-coded credentials Critical test

The hard-coded value "my_secret" is used as
jwt key
.

it("should return a token if jwt.sign is successful and appSettings.jwtTTL is defined", () => {
const payload = { id: "123" };
const appSettings = { jwtSecret: "my_secret", jwtTTL: "1s" };

Check failure

Code scanning / CodeQL

Hard-coded credentials Critical test

The hard-coded value "my_secret" is used as
jwt key
.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant