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

Update legacy manifest file test #605

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

Ceredron
Copy link
Collaborator

@Ceredron Ceredron commented Dec 2, 2024

Description

Change test to generate a .zip file in-memory that is at least 10kb big to cover the Read() -> ReadExactly() bug (that only appears with >3kb files).

Related Issue(s)

Verification

  • Your code builds clean without any errors or warnings
  • Manual testing done (required)
  • Relevant automated test added (if you find this hard, leave it and we'll help out)
  • All tests run green

Documentation

  • User documentation is updated with a separate linked PR in altinn-studio-docs. (if applicable)

Summary by CodeRabbit

  • New Features

    • Enhanced file upload testing by generating zip files dynamically in memory.
    • Introduced a method to create dummy files for varied input data in tests.
  • Bug Fixes

    • Improved flexibility in handling zip file uploads within the test suite.

…ig to cover the Read() -> ReadExactly() bug (that only appears with >3kb files).
@Ceredron Ceredron added the kind/bug Something isn't working label Dec 2, 2024
Copy link

coderabbitai bot commented Dec 2, 2024

📝 Walkthrough

Walkthrough

The pull request modifies the LegacyFileControllerTests class in the tests/Altinn.Broker.Tests/LegacyFileControllerTests.cs file. Key changes include replacing the System.IO directive with System.IO.Compression, updating the UploadZipFile method to generate a zip file in memory instead of reading from disk, and adding a new method, GenerateDummyFile, to create random byte arrays for testing. These adjustments enhance the flexibility and dynamism of the file handling in the test suite.

Changes

File Path Change Summary
tests/Altinn.Broker.Tests/LegacyFileControllerTests.cs - Replaced using System.IO with using System.IO.Compression.
- Updated UploadZipFile method to create a zip file in memory.
- Added GenerateDummyFile method to generate random byte arrays.

Possibly related PRs

  • Bugfix/brokerlegacy route #593: Changes in LegacyFileControllerTests regarding API endpoint paths are related to modifications in the LegacyFileController class, which also involves routing adjustments.
  • Legacy file uploads also need content length #598: Updates in LegacyFileControllerTests to assert file size after upload are relevant to changes in LegacyFileController, which now includes validation for the Content-Length header during file uploads.

Suggested reviewers

  • RagnarFatland-Avanade

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>, please review it.
    • 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 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.

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

@Ceredron Ceredron added kind/chore Routine task or minor maintenance work that doesn't introduce new features or functionality product/formidling Issues related til Altinn Broker and removed kind/bug Something isn't working labels Dec 2, 2024
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
tests/Altinn.Broker.Tests/LegacyFileControllerTests.cs (2)

562-581: Optimize memory usage in zip file upload.

The implementation correctly creates an in-memory zip file, but there's a redundant memory allocation at line 574 where zipStream.ToArray() is called twice.

Consider this optimization:

-        using (var content = new ByteArrayContent(zipStream.ToArray()))
+        var zipBytes = zipStream.ToArray();
+        using (var content = new ByteArrayContent(zipBytes))

583-587: Enhance GenerateDummyFile with input validation and better randomization.

While the implementation works, it could be improved in terms of robustness and security.

Consider these improvements:

     private async Task<byte[]> GenerateDummyFile(long bytes)
     {
+        if (bytes <= 0)
+            throw new ArgumentException("Bytes must be positive", nameof(bytes));
         var fileBuffer = new byte[bytes];
-        new Random().NextBytes(fileBuffer);
+        Random.Shared.NextBytes(fileBuffer);
         return fileBuffer;
     }

This change:

  1. Adds input validation
  2. Uses Random.Shared which is both thread-safe and more efficient than creating new Random instances
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 6c44c97 and 567b8ab.

📒 Files selected for processing (1)
  • tests/Altinn.Broker.Tests/LegacyFileControllerTests.cs (2 hunks)
🔇 Additional comments (1)
tests/Altinn.Broker.Tests/LegacyFileControllerTests.cs (1)

562-587: Implementation successfully meets PR objectives.

The changes effectively address the PR requirements by:

  1. Generating a zip file in-memory
  2. Ensuring the file size is at least 10kb (10240 bytes)
  3. Supporting testing of the Read() -> ReadExactly() functionality with files larger than 3kb

The implementation is clean and well-structured.

Copy link
Collaborator

@RagnarFatland-Avanade RagnarFatland-Avanade left a comment

Choose a reason for hiding this comment

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

Looks good

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/chore Routine task or minor maintenance work that doesn't introduce new features or functionality product/formidling Issues related til Altinn Broker
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants