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

Development: Add domain objects for standardized competencies #8129

Conversation

rstief
Copy link
Contributor

@rstief rstief commented Mar 3, 2024

🚨 DO NOT DEPLOY TO TS1/TS2! (conflicting changelogs) 🚨

Checklist

General

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

Motivation and Context

Adds the domain objects for #8001

Description

  • Adds the tables, domain objects, repositories, services and resources for standardized competencies.
  • Adds a BaseCompetency object from which all competencies inherit.

Steps for Testing

Run locally and see that the migration works and Artemis starts up.
Test the following endpoints with Postman:

  • POST api/admin/standardized-competencies/knowledge-areas (create a knowledge area)
  • POST api/admin/standardized-competencies (create a standardized competency)
  • GET api/standardized-competencies/:id (get a standardized competency)
  • GET api/standardized-competencies/knowledge-areas/:id (get a knowledge area)

Testserver States

Note

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







Review Progress

Performance Review

  • I (as a reviewer) confirm that the server changes (in particular related to database calls) are implemented with a very good performance

Code Review

  • Code Review 1
  • Code Review 2

Manual Tests

  • Test 1
  • Test 2

Test Coverage

Server

Class/File Line Coverage Confirmation (assert/expect)
BaseCompetency.java 100% βœ…
Competency.java 79% βœ…
KnowledgeArea.java 100% βœ…
Source.java 92% βœ…
StandardizedCompetency.java 89% βœ…
SourceRepository.java 100% βœ…
KnowledgeAreaRepository.java 100% βœ…
StandardizedCompetencyRepository.java 100% βœ…
KnowledgeAreaService.java 100% βœ…
StandardizedCompetencyService.java 100% βœ…
AdminStandardizedCompetencyResource.java 100% βœ…
StandardizedCompetencyResource.java 100% βœ…

Summary by CodeRabbit

  • New Features
    • Introduced a service for efficiently managing knowledge areas, including creation and validation processes.
  • Tests
    • Added comprehensive integration tests for standardized competencies and knowledge areas, ensuring robust authorization and error handling mechanisms.

@artemis-bot artemis-bot added this to In progress in Artemis Development Mar 3, 2024
@github-actions github-actions bot added the server Pull requests that update Java code. (Added Automatically!) label Mar 3, 2024
@github-actions github-actions bot added the database Pull requests that update the database. (Added Automatically!). Require a CRITICAL deployment. label Mar 10, 2024
@rstief rstief marked this pull request as ready for review March 10, 2024 22:58
@rstief rstief requested a review from a team as a code owner March 10, 2024 22:58
Copy link

coderabbitai bot commented Mar 10, 2024

Walkthrough

This update introduces a service and integration tests for managing and testing KnowledgeArea entities and standardized competencies within Artemis. The service facilitates creating new knowledge areas by ensuring their validity before saving them to the database. Meanwhile, the integration tests cover scenarios for creating, retrieving, and validating standardized competencies and knowledge areas, including authorization checks and error handling.

Changes

Files Change Summary
.../service/competency/KnowledgeAreaService.java
.../domain/competency/KnowledgeArea.java
Implements service for managing KnowledgeArea entities with basic attributes and relationships.
.../competency/StandardizedCompetencyIntegrationTest.java Adds integration tests for standardized competencies and knowledge areas.

Possibly related issues

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:

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

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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/coderabbit-overrides.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.

@artemis-bot artemis-bot moved this from In progress to Ready for review in Artemis Development Mar 10, 2024
Artemis Development automation moved this from Ready for review to Review in progress Mar 10, 2024
rstief and others added 4 commits March 11, 2024 00:22
…ry.java

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
…dgeAreaService.java

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@rstief rstief added the blocked label Apr 2, 2024
milljoniaer
milljoniaer previously approved these changes Apr 2, 2024
Copy link
Contributor

@milljoniaer milljoniaer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code looks good πŸ‘

reschandreas
reschandreas previously approved these changes Apr 2, 2024
JohannesWt
JohannesWt previously approved these changes Apr 2, 2024
Copy link
Contributor

@JohannesWt JohannesWt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested in virtual test session on test server 2 with @rstief . Everything works πŸ‘

@MaximilianAnzinger MaximilianAnzinger dismissed coderabbitai’s stale review April 2, 2024 17:53

A rabbit, silly, under the sun, Chased his tail, thought the moon was fun. In his blunders, a lesson clear: Find joy in laughter, ever near.

Copy link
Contributor

@MaximilianAnzinger MaximilianAnzinger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@krusche krusche merged commit 88b3f0f into develop Apr 3, 2024
27 of 34 checks passed
@krusche krusche deleted the feature/adaptive-learning/add-standardized-competency-domain-objects branch April 3, 2024 20:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:AdaptiveLearning database Pull requests that update the database. (Added Automatically!). Require a CRITICAL deployment. ready to merge server Pull requests that update Java code. (Added Automatically!) tests too-long-open !!! This is an antipattern, we should aim for small PRs that are only open for a short time !!!
Projects
Archived in project
Artemis Development
  
Review in progress
Development

Successfully merging this pull request may close these issues.

None yet

8 participants