URBBDC-3312 Add group for housing editor and reader

[jimbiscuit]

Summary by CodeRabbit

• New Features
  • Added dedicated housing editor and reader access groups.
  • Housing editors can access housing editing tools and receive contributor permissions for housing licences.
  • Housing readers and editors receive appropriate access to housing-related tools, applications, and contacts.
  • Housing licences now use tailored workflow roles and permissions.
• Bug Fixes
  • Housing editors can now access the housing editor interface and related content as intended.
• Chores
  • Added an upgrade step to apply the new housing permissions automatically.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 6f15f051-0ef3-42ee-86dc-0bae9d185252

📥 Commits

Reviewing files that changed from the base of the PR and between cfe46fa and 5fcbbe9.

📒 Files selected for processing (9)

• news/URBBDC-3312.feature
• src/Products/urban/browser/portlets.py
• src/Products/urban/migration/update_290.py
• src/Products/urban/migration/upgrades_290.zcml
• src/Products/urban/profiles/default/metadata.xml
• src/Products/urban/setuphandlers.py
• src/Products/urban/workflows/adapter.py
• src/Products/urban/workflows/opinionsrequest_workflow.py
• src/Products/urban/workflows/urbanevent_workflow.py

---

📝 Walkthrough

Walkthrough

The PR adds housing editor and reader groups, assigns local permissions, enables the configuration portlet for housing editors, and maps housing licences to housing-specific workflow roles.

Changes

Housing access control

Layer / File(s)	Summary
Group creation and permission migration news/URBBDC-3312.feature, src/Products/urban/setuphandlers.py, src/Products/urban/migration/update_290.py, src/Products/urban/migration/upgrades_290.zcml, src/Products/urban/profiles/default/metadata.xml, src/Products/urban/browser/portlets.py	The PR creates housing editor and reader groups, assigns local permissions, updates the profile version, adds the 2919→2920 upgrade step, reindexes security metadata, refreshes workflow permissions, and enables the configuration portlet for housing editors.
Housing workflow role mapping src/Products/urban/workflows/adapter.py, src/Products/urban/workflows/opinionsrequest_workflow.py, src/Products/urban/workflows/urbanevent_workflow.py	Housing licences resolve to the housing group category. Workflow mappings assign housing and urban editor or reader groups, and opinion workflows grant housing editors the corresponding roles.

Estimated code review effort: 3 (Moderate) | ~25 minutes

Sequence Diagram(s)

sequenceDiagram
  participant HousingLicence
  participant WorkflowAdapter
  participant HousingGroups
  participant OpinionWorkflow
  HousingLicence->>WorkflowAdapter: provide IHousing
  WorkflowAdapter->>HousingGroups: resolve housing editors and readers
  HousingGroups->>OpinionWorkflow: assign housing editor roles

Loading

Possibly related PRs

• IMIO/Products.urban#540: Modifies related housing security, local-role, migration, and workflow mapping code.

Suggested reviewers: mpeeters

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly identifies the main change: adding housing editor and reader groups.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches 💡 1

📝 Generate docstrings 💡

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch URBBDC-3312-Add-group-for-housing-editor-and-reader

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}