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

add delete_project and bulk_delete_project #95

Merged
merged 2 commits into from
Aug 4, 2024

Conversation

sp3c73r2038
Copy link

@sp3c73r2038 sp3c73r2038 commented Mar 12, 2024

Summary by CodeRabbit

  • New Features
    • Introduced new API endpoints for project deletion, allowing users to delete projects both individually and in bulk based on specific filters.
    • Maintained existing endpoints for showing components and searching projects.

Copy link

coderabbitai bot commented Mar 12, 2024

Walkthrough

The recent modifications enhance project management capabilities in SonarQube by introducing new methods for both individual and bulk project deletion. Users can now manage project deletions more effectively through dedicated API endpoints. Additionally, the configuration file has been updated to reflect these new functionalities while retaining the existing operations for project display and search.

Changes

File Path Change Summary
.../rest/projects.py Added methods for single and bulk project deletion, enhancing API functionality for project management.
.../utils/config.py Introduced new API endpoint constants for individual and bulk project deletion while keeping existing endpoints intact.

🐰✨
In the land of code so bright,
A rabbit hopped with sheer delight.
"Delete in bulk, or one by one,
With new endpoints, the task is done!"
🌟📂🚮
"Rejoice, for clean-up's now a breeze,
With these updates, we code with ease."
🎉🐾


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

@sp3c73r2038 sp3c73r2038 changed the title add delete_project and batch_delete_project add delete_project and bulk_delete_project Mar 12, 2024
Copy link

sonarcloud bot commented Mar 12, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 248b0d5 and c9dcf5d.
Files selected for processing (2)
  • sonarqube/rest/projects.py (2 hunks)
  • sonarqube/utils/config.py (1 hunks)
Files skipped from review due to trivial changes (1)
  • sonarqube/utils/config.py
Additional comments: 3
sonarqube/rest/projects.py (3)
  • 6-7: The addition of API_PROJECTS_BULK_DELETE_ENDPOINT and API_PROJECTS_DELETE_ENDPOINT aligns well with the existing naming conventions and is necessary for the new functionalities introduced in this PR. Good job on maintaining consistency.
  • 72-81: The delete_project function is well-implemented with clear documentation and appropriate use of the @POST decorator. It's great to see the SonarQube version mentioned, which helps in understanding the API's evolution.
  • 82-102: The bulk_delete_project function is well-documented and uses the @POST decorator appropriately. The parameters provide the necessary flexibility for bulk deletion operations. Ensure that the default values and types for parameters like analyzedBefore, onProvisionedOnly, and qualifiers align with the SonarQube API's expectations.

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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 248b0d5 and d864e0d.
Files selected for processing (2)
  • sonarqube/rest/projects.py (2 hunks)
  • sonarqube/utils/config.py (1 hunks)
Files skipped from review as they are similar to previous changes (2)
  • sonarqube/rest/projects.py
  • sonarqube/utils/config.py

chrislovecnm added a commit to chrislovecnm/python-sonarqube-api that referenced this pull request Mar 16, 2024
This commit uses the code from two different PRs to add
support for creating and deleting projects.

Two new endpoints are added to projects.py

See:

shijl0925#95
shijl0925#97
Copy link

sonarcloud bot commented Aug 4, 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: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d864e0d and f148237.

Files selected for processing (2)
  • sonarqube/rest/projects.py (3 hunks)
  • sonarqube/utils/config.py (1 hunks)
Additional context used
Ruff
sonarqube/rest/projects.py

88-88: Undefined name POST

(F821)


98-98: Undefined name POST

(F821)

Additional comments not posted (2)
sonarqube/utils/config.py (1)

3-4: LGTM!

The new endpoint constants are correctly defined and follow the existing pattern.

sonarqube/rest/projects.py (1)

98-98: Fix the undefined name POST.

The POST decorator is undefined. Ensure it is imported or defined.

Tools
Ruff

98-98: Undefined name POST

(F821)

"""

@POST(API_PROJECTS_DELETE_ENDPOINT)
Copy link

Choose a reason for hiding this comment

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

Fix the undefined name POST.

The POST decorator is undefined. Ensure it is imported or defined.

+ from sonarqube.utils.common import POST
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
@POST(API_PROJECTS_DELETE_ENDPOINT)
+ from sonarqube.utils.common import POST
@POST(API_PROJECTS_DELETE_ENDPOINT)
Tools
Ruff

88-88: Undefined name POST

(F821)

@shijl0925 shijl0925 merged commit 0bc434e into shijl0925:master Aug 4, 2024
2 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants