Integrated code lifecycle: Improve SSH handling

[SimonEntholzer]

Checklist

General

• I tested all changes and their related features with all corresponding user types locally.
• This is a small issue that I tested locally and was confirmed by another developer 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 pre-authorization annotations according to the guidelines and checked the course groups for all new REST Calls (security).
• 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.
• I added multiple integration tests (Jest) related to the features (with a high test coverage), while following the test guidelines.
• I added authorities to all new routes and checked the course groups for displaying navigation elements (links, buttons).
• 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.

Motivation and Context

Users should use SSH to clone from localVC for programming exercise repositories.

Description

• Added settings subpage to add, edit and remove the users SSH key
• Added link in the copy clone link UI to the SSH key settings
• Added documentation about SSH for new users

Link to SSH settings in the clone dialogue:

SSH settings page: - creating a new key

save the key:

edit or delete the key:

Steps for Testing

Prerequisites:

1. Log in to Artemis as a student, go to Settings
2. Test if you can add, edit and remove your SSH key, in the SSH Settings tab.
3. Go to a programming exercise, copy the clone link, and check if you can clone the exercise with the key you set in the settings.

Testserver States

Note

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

Review Progress

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Test Coverage

Screenshots

Summary by CodeRabbit

• New Features

  • Added functionality to manage SSH public keys within user settings, including viewing, editing, and deleting keys.
  • Introduced new constants and configuration for GitLab version control support.

• Bug Fixes

  • Updated conditions in the clone repository button component to correctly display warnings related to SSH key usage.

• Documentation

  • Added new links for SSH setup in both English and German documentation.

• Tests

  • Introduced tests for the SSH User Settings component, ensuring proper initialization, key saving, and edit mode toggling.

[coderabbitai]

Walkthrough

Recent modifications enhance the application by introducing SSH key management features, such as adding, viewing, editing, and deleting SSH keys. Key additions include new methods in backend services, updates to the Angular frontend components, and relevant localization entries. These changes improve user management and security in repository interactions, especially for users utilizing GitLab version control.

Changes

Files	Change Summary
UserResource.java	Added a deleteSshPublicKey method to manage SSH keys for users.
app.constants.ts	Introduced a new constant PROFILE_GITLAB.
account.service.ts	Introduced a method deleteSshPublicKey to manage user SSH keys.
clone-repo-button.component.html, clone-repo-button.component.ts	Updated conditions for SSH key usage warnings and set setupSshKeysUrl based on specific conditions.
documentation-button.component.ts	Added SshSetup link in DocumentationLinks object.
ssh-user-settings.component.html, ssh-user-settings.component.ts	Provided UI and component for managing SSH keys, including viewing, editing, saving, and deleting.
user-settings.module.ts	Included SshUserSettingsComponent and necessary imports into UserSettingsModule.
de/documentationLinks.json, de/userSettings.json, en/documentationLinks.json, en/userSettings.json	Added SSH setup documentation links and SSH settings content in both English and German.
ssh-user-settings.component.spec.ts	Introduced tests for SshUserSettingsComponent, covering initialization and SSH key management functionalities.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UserResource
    participant AccountService
    participant AngularComponent

    User->>AngularComponent: Interact with SSH Key Management UI
    AngularComponent->>AccountService: deleteSshPublicKey()
    AccountService->>UserResource: DELETE /api/users/sshpublickey
    UserResource->>AccountService: Confirm Deletion
    AccountService->>AngularComponent: Update UI
    AngularComponent->>User: Display updated SSH Key status

Loading

In this sequence diagram, a user interacts with the Angular component for SSH key management. The component calls the deleteSshPublicKey method in AccountService, which then performs a DELETE request to UserResource. Upon confirmation, the service updates the UI to reflect the changes, and the user can see the updated SSH key status.

---

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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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: 9

[coderabbitai]

Actionable comments posted: 7

Outside diff range comments (1)

src/test/javascript/spec/component/account/account-information.component.spec.ts (1)

Line range hint 48-51: Disallow duplicate setup and teardown hooks.

The beforeEach block is duplicated inside the describe function. Consider combining them into a single beforeEach block to avoid redundancy and potential confusion during test execution.

[BBesrour]

Tested on TS2:

• Can edit and delete ssh key
• warning is visible and link redirects me to the settings

Should the warning still be visible even if the user has set an ssh key?
And I am not sure if this is related to your PR but I get a 500 error when I access any course

[Strohgelaender]

Should the warning still be visible even if the user has set an ssh key?

Imo it would be better if the warning would disapear now, see also #6650. Before we were not able to know if the user has a ssh key setup, now we can test for that and should hide the message.

[SimonEntholzer]

Should the warning still be visible even if the user has set an ssh key?

Imo it would be better if the warning would disapear now, see also #6650. Before we were not able to know if the user has a ssh key setup, now we can test for that and should hide the message.

Good point, I changed it so that the warning goes away when there is a SSH key available. 👍

[kaancayli]

Reapprove

[EneaGore]

re-approve

[BBesrour]

re-approve

[DominikRemo]

Reapprove

[Strohgelaender]

code