✨ [#4788] ConfigurationStep for Objects API registration config #4822

stevenbal · 2024-11-12T14:37:54Z

Closes #4787

Changes

ConfigurationStep for Objects API registration config
Add identifier to ObjectsAPIGroupConfig

Checklist

Check off the items that are completed or not relevant.

Impact on features
- Checked copying a form
- Checked import/export of a form
- Config checks in the configuration overview admin page
- Problem detection in the admin email digest is handled
Release management
- I have labelled the PR as "needs-backport" accordingly
I have updated the translations assets (you do NOT need to provide translations)
- Ran ./bin/makemessages_js.sh
- Ran ./bin/compilemessages_js.sh
Commit hygiene
- Commit messages refer to the relevant Github issue
- Commit messages explain the "why" of change, not the how

codecov · 2024-11-12T14:45:28Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.60%. Comparing base (26615d1) to head (07c23a6).
Report is 23 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #4822   +/-   ##
=======================================
  Coverage   96.60%   96.60%           
=======================================
  Files         752      754    +2     
  Lines       25809    25853   +44     
  Branches     3411     3415    +4     
=======================================
+ Hits        24932    24976   +44     
  Misses        613      613           
  Partials      264      264

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

src/openforms/config/setup_configuration/models.py

stevenbal · 2024-11-15T15:24:15Z

@sergei-maertens this PR of course depends on the changes in django-setup-configuration and zgw-consumers, but I figured it would be good if you could take a look at the implementation before I start working on #4789

stevenbal · 2024-12-03T14:13:18Z

I've created a separate issue for the documentation (for all config steps) #4882

Dockerfile

bin/docker_start.sh

bin/setup_configuration.sh

bin/wait_for_db.sh

docs/installation/config.rst

src/openforms/contrib/objects_api/setup_configuration/tests/test_objects_api_config.py

src/openforms/contrib/objects_api/tests/factories.py

src/openforms/contrib/objects_api/tests/test_migrations.py

this is needed to load the Services required to setup configuration such as ObjectsAPIGroupConfig, etc.

add a web-init container and the required scripts for setup_configuration. Example data has been added to docker/setup_configuration

this step relies on the previously added ServiceConfigurationStep and can be used to set up the necessary configuration for the Objects API registration backend

to avoid having to bring up the Open Zaak and Objects/Objecttypes docker compose stacks for the CI tests to simulate upgrading Open Forms

to make sure there is a unique field that can be used to refer to the groups and identify them when they are loaded using setup-configuration

* Make Documenten and Catalogi API optional in config model * Add identifier * Use lowercase namespaces * Remove is_configured and validate_result * add tests for required fields, all fields and idempotency * Rename service_slug to service_identifier

identifiers were added instead of slugs, and the selftest functionality has been removed

since this is all tightly coupled with the objects API models, the steps and models should be defined there as well

* setup_configuration now only takes one yaml file as a source * remove legacy `is_configured` and `validate_result` hooks * change testing utils

currently django_model_refs are not recognized as attributes on the model, an upstream issue has been created for this

sergei-maertens

Last polishing items, after that it's good to merge!

bin/docker_start.sh

sergei-maertens · 2024-12-06T15:16:41Z

bin/setup_configuration.sh

+
+if [[ "${RUN_SETUP_CONFIG,,}" =~ ^(true|1|yes)$ ]]; then
+    # wait for required services
+    /wait_for_db.sh


Suggested change

/wait_for_db.sh

./wait_for_db.sh

these scripts need to be debugged outside of docker context too, so you can't assume that they're available in the root of the system.

* add type: ignore to specific lines in steps.py instead of ignoring entire file with pyright * several docs improvements * remove unused SCRIPTPATH variable in wait_for_db.sh and setup_configuration.sh * move tests to objects_api.tests directory

stevenbal marked this pull request as draft November 12, 2024 14:37

stevenbal force-pushed the feature/setup-configuration branch from dfdfd01 to c52c208 Compare November 12, 2024 15:27

stevenbal changed the title ~~📌 [#4788] Pin zgw-consumers to branch~~ ✨ [#4788] ConfigurationStep for Objects API registration config Nov 12, 2024

stevenbal force-pushed the feature/setup-configuration branch 6 times, most recently from 1fe35d5 to a4fde34 Compare November 15, 2024 15:05

stevenbal commented Nov 15, 2024

View reviewed changes

src/openforms/config/setup_configuration/models.py Outdated Show resolved Hide resolved

stevenbal requested a review from sergei-maertens November 15, 2024 15:23

stevenbal force-pushed the feature/setup-configuration branch 2 times, most recently from b49b89b to e70f68a Compare November 19, 2024 14:18

stevenbal marked this pull request as ready for review November 19, 2024 14:18

stevenbal marked this pull request as draft November 19, 2024 14:20

stevenbal force-pushed the feature/setup-configuration branch 5 times, most recently from 0c8a7cb to 3821f26 Compare November 25, 2024 15:48

stevenbal force-pushed the feature/setup-configuration branch 3 times, most recently from ecfece5 to 67390e6 Compare December 2, 2024 10:19

stevenbal mentioned this pull request Dec 2, 2024

✨ [#4789] ConfigurationStep for ZGW API registration config #4876

Merged

9 tasks

stevenbal force-pushed the feature/setup-configuration branch 4 times, most recently from 5cb5618 to 4f92c5b Compare December 3, 2024 13:54

stevenbal force-pushed the feature/setup-configuration branch from 4f92c5b to 0d16714 Compare December 3, 2024 14:01

stevenbal marked this pull request as ready for review December 3, 2024 14:18

SonnyBA reviewed Dec 4, 2024

View reviewed changes

Dockerfile Show resolved Hide resolved

sergei-maertens requested changes Dec 5, 2024

View reviewed changes

stevenbal added 15 commits December 6, 2024 12:45

⬆️ [#4787] Upgrade zgw-consumers to 0.36.0

0333c63

👽 [#4787] Add missing Service.slug to fix service fetch tests

0850a24

✨ [#4787] Add ServiceConfigurationStep to steps

48230fa

this is needed to load the Services required to setup configuration such as ObjectsAPIGroupConfig, etc.

🐳 [#4787] Docker compose setup for setup-configuration

83c2bc7

add a web-init container and the required scripts for setup_configuration. Example data has been added to docker/setup_configuration

✨ [#4787] ConfigurationStep for Objects API registration config

5d65975

this step relies on the previously added ServiceConfigurationStep and can be used to set up the necessary configuration for the Objects API registration backend

✅ [#4787] Add tests for Objects API config step

2220c61

🐳 [#4787] Disable setup_config command in upgrade tests

4b72ee4

to avoid having to bring up the Open Zaak and Objects/Objecttypes docker compose stacks for the CI tests to simulate upgrading Open Forms

📝 [#4787] Documentation for setup_configuration

66942ce

✨ [#4787] Add identifier field to ObjectsAPIGroupConfig

556bf61

to make sure there is a unique field that can be used to refer to the groups and identify them when they are loaded using setup-configuration

🐳 [#4787] Update setup_configuration docker setup

fe5ad02

identifiers were added instead of slugs, and the selftest functionality has been removed

🚚 [#4787] Move setup config code to objects_api contrib directory

9409374

since this is all tightly coupled with the objects API models, the steps and models should be defined there as well

👽 [#4787] Changes according to setup-configuration lib changes

d710652

* setup_configuration now only takes one yaml file as a source * remove legacy `is_configured` and `validate_result` hooks * change testing utils

💚 [#4787] Ignore ConfigurationStep with pyright in CI

47f7a02

currently django_model_refs are not recognized as attributes on the model, an upstream issue has been created for this

🚚 [#4787] Rename several fields on Objects API config model

c16c4fe

stevenbal force-pushed the feature/setup-configuration branch from 0d16714 to edd2b72 Compare December 6, 2024 14:21

stevenbal requested a review from sergei-maertens December 6, 2024 14:31

sergei-maertens approved these changes Dec 6, 2024

View reviewed changes

👌 [#4787] Process PR feedback

07c23a6

* add type: ignore to specific lines in steps.py instead of ignoring entire file with pyright * several docs improvements * remove unused SCRIPTPATH variable in wait_for_db.sh and setup_configuration.sh * move tests to objects_api.tests directory

stevenbal force-pushed the feature/setup-configuration branch from edd2b72 to 07c23a6 Compare December 6, 2024 15:26

sergei-maertens merged commit ae74347 into master Dec 6, 2024
17 of 18 checks passed

sergei-maertens deleted the feature/setup-configuration branch December 6, 2024 15:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ [#4788] ConfigurationStep for Objects API registration config #4822

✨ [#4788] ConfigurationStep for Objects API registration config #4822

stevenbal commented Nov 12, 2024 •

edited

Loading

codecov bot commented Nov 12, 2024 •

edited

Loading

stevenbal commented Nov 15, 2024 •

edited

Loading

stevenbal commented Dec 3, 2024

sergei-maertens left a comment

sergei-maertens Dec 6, 2024

✨ [#4788] ConfigurationStep for Objects API registration config #4822

✨ [#4788] ConfigurationStep for Objects API registration config #4822

Conversation

stevenbal commented Nov 12, 2024 • edited Loading

codecov bot commented Nov 12, 2024 • edited Loading

Codecov Report

stevenbal commented Nov 15, 2024 • edited Loading

stevenbal commented Dec 3, 2024

sergei-maertens left a comment

Choose a reason for hiding this comment

sergei-maertens Dec 6, 2024

Choose a reason for hiding this comment

stevenbal commented Nov 12, 2024 •

edited

Loading

codecov bot commented Nov 12, 2024 •

edited

Loading

stevenbal commented Nov 15, 2024 •

edited

Loading