Skip to content

Conversation

@fsbraun
Copy link
Member

@fsbraun fsbraun commented Jun 17, 2025

Description

Add Django CMS 5 tests

Related resources

  • #...
  • #...

Checklist

  • I have opened this pull request against master
  • I have added or modified the tests when changing logic
  • I have followed the conventional commits guidelines to add meaningful information into the changelog
  • I have read the contribution guidelines and I have joined #workgroup-pr-review on
    Slack to find a “pr review buddy” who is going to review my pull request.

Summary by Sourcery

Add compatibility and testing updates for django CMS 5.0 by expanding the CI matrix, including package data in the build, updating admin comments, and adjusting tests to use the new admin content API.

Enhancements:

  • Update admin code comment to reflect django CMS 5.0 compatibility

Build:

  • Add package data to pyproject.toml for static files, templates, locale, LICENSE, and README

CI:

  • Expand GitHub Actions test matrix to include Django 3.2 with CMS 5.1 and 5.0 and switch to ubuntu-latest runner

Tests:

  • Adapt endpoint and field tests for Django CMS 5.0 by using get_admin_content("en").title and str(self.page) in assertions

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jun 17, 2025

Reviewer's Guide

Adds support for django CMS 5.0+ in testing by updating CI workflows, packaging metadata, admin comments, and adapting existing tests.

Class diagram for updated admin compatibility comment

classDiagram
    class PageContent {
        +admin_manager
        +filter(language)
        # Updated: Admin comment now indicates compatibility with django CMS 5.0+
    }
Loading

File-Level Changes

Change Details Files
Updated CI configuration to test against django CMS 5.0 and 5.1
  • Added dj52_cms51.txt and dj52_cms50.txt to the requirements matrix
  • Switched runner image from ubuntu-20.04 to ubuntu-latest
.github/workflows/test.yml
Included static assets and documentation in the package distribution
  • Added setuptools.package-data entries for static/, templates/, locale/, LICENSE, README
pyproject.toml
Bumped admin compatibility comment to django CMS 5.0+
  • Changed version note in admin.py from “django CMS 4.2+” to “django CMS 5.0+”
djangocms_link/admin.py
Adapted tests for django CMS 5.0 page title retrieval and widget rendering
  • Assert API endpoint uses get_admin_content('en').title for page text
  • Use dynamic page string in widget rendering test
tests/test_endpoint.py
tests/test_fields.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@codecov
Copy link

codecov bot commented Jun 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.01%. Comparing base (9f19709) to head (3cca956).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #244      +/-   ##
==========================================
+ Coverage   95.72%   96.01%   +0.29%     
==========================================
  Files          28       28              
  Lines         678      678              
  Branches       88       88              
==========================================
+ Hits          649      651       +2     
+ Misses         13       11       -2     
  Partials       16       16              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @fsbraun - I've reviewed your changes and they look great!

Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments

### Comment 1
<location> `pyproject.toml:58` </location>
<code_context>
 [tool.setuptools.dynamic]
 version = { attr = "djangocms_link.__version__" }

+[tool.setuptools.package-data]
+djangocms_link = [ "static/", "templates/", "locale/", "LICENSE", "README.rst" ]
+
</code_context>

<issue_to_address>
Use recursive globs for nested resource files

Use recursive globs (e.g., "static/**/*", "templates/**/*", "locale/**/*") to ensure all files in subdirectories are included.
</issue_to_address>

<suggested_fix>
<<<<<<< SEARCH
[tool.setuptools.package-data]
djangocms_link = [ "static/", "templates/", "locale/", "LICENSE", "README.rst" ]
=======
[tool.setuptools.package-data]
djangocms_link = [ "static/**/*", "templates/**/*", "locale/**/*", "LICENSE", "README.rst" ]
>>>>>>> REPLACE

</suggested_fix>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

fsbraun and others added 2 commits June 17, 2025 11:21
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@fsbraun fsbraun merged commit 412f02a into master Jun 17, 2025
53 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