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 config variable for build log path #8259

Merged
merged 7 commits into from
Mar 28, 2024

Conversation

laurenzfb
Copy link
Contributor

@laurenzfb laurenzfb commented Mar 26, 2024

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.

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

Build logs are not stored with a hardcoded path. This causes issues if we want to store them in different directories, e.g. in a shared file system.

Description

I introduced a config variable for the build log path. By default the path is /build-logs, for Docker deployments /opt/artemis/data/build-logs. In shared file systems, e.g. on production or staging, the path would be /mnt/storage/build-logs.

Steps for Testing

Test locally:
Prerequisites:

  • 1 Instructor
  1. Create a programming submission
  2. Check if you can download the build logs (Your participation > Submissions > You should see a "View build logs" link for your latest result

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

Summary by CodeRabbit

  • New Features
    • Enhanced build log management by introducing a configurable path for build log files, improving flexibility and customization options.
  • Tests
    • Updated test configurations to align with new version control, build logs path, and continuous integration settings adjustments.

@github-actions github-actions bot added server Pull requests that update Java code. (Added Automatically!) config-change Pull requests that change the config in a way that they require a deployment via Ansible. labels Mar 26, 2024
@laurenzfb laurenzfb changed the title Development Development: Add config variable for build log path Mar 26, 2024
@github-actions github-actions bot added the tests label Mar 26, 2024
@laurenzfb laurenzfb marked this pull request as ready for review March 26, 2024 15:09
@laurenzfb laurenzfb requested a review from a team as a code owner March 26, 2024 15:09
Copy link

coderabbitai bot commented Mar 26, 2024

Walkthrough

The recent update focuses on enhancing the management of build log files within a Java application. It introduces a new, configurable property named buildLogsPath that allows for more flexible and customizable handling of build log file operations. Additionally, the update modifies the test configuration to align with the changes in build logs management, version control, and continuous integration settings, ensuring that the test environment accurately reflects the new functionality.

Changes

File Path Change Summary
.../service/BuildLogEntryService.java Extended to include a configurable buildLogsPath property for managing build log files.
.../AbstractSpringIntegrationLocalCILocalVCTest.java Updated test configuration to reflect changes in build logs path, version control, and CI settings.

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-tests 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 tests 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 tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

mateusmm01
mateusmm01 previously approved these changes Mar 26, 2024
Copy link
Contributor

@mateusmm01 mateusmm01 left a comment

Choose a reason for hiding this comment

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

code lgtm

rstief
rstief previously approved these changes Mar 26, 2024
Copy link
Contributor

@rstief rstief 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, also demonstrated in testing session

milljoniaer
milljoniaer previously approved these changes Mar 27, 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.

Tested & code looks good 👍

@laurenzfb laurenzfb dismissed stale reviews from rstief, milljoniaer, and mateusmm01 via 6651ffd March 27, 2024 12:25
Copy link
Contributor

@mateusmm01 mateusmm01 left a comment

Choose a reason for hiding this comment

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

changes lgtm

Copy link
Contributor

@egekurt123 egekurt123 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 added this to the 6.9.5 milestone Mar 28, 2024
@krusche krusche merged commit 0ecf2ab into develop Mar 28, 2024
21 of 27 checks passed
@krusche krusche deleted the development/add-config-variable-for-build-log-path branch March 28, 2024 17:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
config-change Pull requests that change the config in a way that they require a deployment via Ansible. ready for review server Pull requests that update Java code. (Added Automatically!) small tests
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

7 participants