Integrated code lifecycle: Let users generate personal access tokens

[SimonEntholzer]

Checklist

General

• I tested all changes and their related features with all corresponding user types on a test server.
• Language: I followed the guidelines for inclusive, diversity-sensitive, and appreciative language.
• I chose a title conforming to the naming conventions for pull requests.

Server

• Important: I implemented the changes with a very good performance and prevented too many (unnecessary) database calls.
• I strictly followed the server coding and design guidelines.
• I added multiple integration tests (Spring) related to the features (with a high test coverage).
• I documented the Java code using JavaDoc style.

Client

• Important: I implemented the changes with a very good performance, prevented too many (unnecessary) REST calls and made sure the UI is responsive, even with large data.
• I strictly followed the client coding and design guidelines.
• Following the theming guidelines, I specified colors only in the theming variable files and checked that the changes look consistent in both the light and the dark theme.
• I added multiple integration tests (Jest) related to the features (with a high test coverage), while following the test guidelines.
• I documented the TypeScript code using JSDoc style.
• I added multiple screenshots/screencasts of my UI changes.
• I translated all newly inserted strings into English and German.

Changes affecting Programming Exercises

• High priority: I tested all changes and their related features with all corresponding user types on a test server configured with the integrated lifecycle setup (LocalVC and LocalCI).

Motivation and Context

Users should be able to use a personal access token to interact with the LocalVC. Especially for instructors this is handy, as they can use the token (similar as in the gitlab setup), to also clone the student's repositories.

Description

This PR:

• Adds VCS access tokens user settings page
• Enables users to add/remove their personal access token with user defined expiry date, being able to copy it, and view the expiration date

Steps for Testing

0. Use TS3 or TS4, on the other test servers token are not yet enabled.
1. As an instructor go to the settings -> VCS tokens settings -> add a new token
2. Go to course management and open a programming exercise, which does have student participations
3. Go to participations
4. Use the code button to clone the students participation's repository

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked
Click on the badges to get to the test servers.

Review Progress

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Test Coverage

Screenshots

Summary by CodeRabbit

Summary by CodeRabbit

• New Features

  • Users can now create and delete Version Control System (VCS) access tokens directly from their settings.
  • A new settings page for managing VCS access tokens has been introduced, featuring a user-friendly interface.
  • Users can view and manage the expiry dates of their VCS access tokens.
  • Added functionality for users to manage SSH public keys, including addition and deletion options.
  • Enhanced logging and error handling for token and SSH key operations.
  • New tooltips and messages in German and English to guide users on VCS access token requirements.

• Bug Fixes

  • Improved handling of user authentication states when managing tokens.

• Style

  • Updated user settings interface for clarity and functionality regarding VCS management.

• Tests

  • Introduced unit tests for the new VCS access tokens settings component.
  • Updated tests to reflect changes in API endpoints for SSH public key management.
  • Expanded test coverage for user account functionalities related to VCS access.

[coderabbitai]

Walkthrough

The recent changes enhance user account management by introducing new RESTful endpoints for handling SSH public keys and Version Control System (VCS) access tokens. An Angular component has been added for better user interaction with these tokens. Additionally, improvements in logging, error handling, and testing have been implemented to strengthen the overall functionality of the authentication management system.

Changes

File(s)	Change Summary
src/main/java/de/tum/in/www1/artemis/web/rest/AccountResource.java	Introduced endpoints for managing SSH public keys and VCS access tokens, enhancing user account management functionalities.
src/main/webapp/app/shared/user-settings/vcs-access-tokens-settings/vcs-access-tokens-settings.component.ts	Added VcsAccessTokensSettingsComponent for managing VCS access tokens, including methods for adding, deleting, and validating tokens.
src/test/java/de/tum/in/www1/artemis/user/UserTestService.java	Updated endpoint URLs for SSH public key management and added test methods for VCS access token lifecycle and retrieval.
src/test/javascript/spec/component/shared/code-button.component.spec.ts	Updated tests to reflect renamed properties and added scenarios for the new wasCopied functionality, ensuring robust coverage for VCS token management.
src/main/webapp/i18n/de/exercise-actions.json	Added German localization entries for VCS token management tips, enhancing user guidance.
src/main/webapp/i18n/en/exercise-actions.json	Added English localization entries for VCS token management tips, providing clear instructions for users.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant VcsAccessTokensSettingsComponent
    participant AccountService
    participant AccountResource

    User->>VcsAccessTokensSettingsComponent: View VCS Token Settings
    VcsAccessTokensSettingsComponent->>AccountService: Fetch current tokens
    AccountService->>AccountResource: Request tokens
    AccountResource-->>AccountService: Return tokens
    AccountService-->>VcsAccessTokensSettingsComponent: Return tokens
    VcsAccessTokensSettingsComponent-->>User: Display tokens

    User->>VcsAccessTokensSettingsComponent: Add new token
    VcsAccessTokensSettingsComponent->>AccountService: Add token request
    AccountService->>AccountResource: Create new token
    AccountResource-->>AccountService: Token created
    AccountService-->>VcsAccessTokensSettingsComponent: Token added
    VcsAccessTokensSettingsComponent-->>User: Confirm token added

Loading

sequenceDiagram
    participant User
    participant VcsAccessTokensSettingsComponent
    participant AccountService
    participant AccountResource

    User->>VcsAccessTokensSettingsComponent: Delete token
    VcsAccessTokensSettingsComponent->>AccountService: Delete token request
    AccountService->>AccountResource: Delete token
    AccountResource-->>AccountService: Token deleted
    AccountService-->>VcsAccessTokensSettingsComponent: Confirm deletion
    VcsAccessTokensSettingsComponent-->>User: Confirm token deletion

Loading

Possibly related issues

• Implement Parsing out REST Calls on the Client #8515: The changes in this PR enhance the handling of REST calls and token management, aligning with the objective of implementing automated parsing for client-side REST calls, improving efficiency in the code review process.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 or @coderabbitai title 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.

[coderabbitai]

Actionable comments posted: 5

[JohannesStoehr]

Can you also add 1-2 server tests?

[coderabbitai]

Actionable comments posted: 8

[florian-glombik]

Re-approve (test)

[pzdr7]

Reapprove tested on TS3. Max 1 year works 👍

[dfuchss]

Code

[janthoXO]

Re-approve