kobotoolbox / kpi / 22778573038

81%

master: 76%

push

github

feat(metadata): add `ExtraProjectMetadataField` model DEV-1523 (#6789)

### 🗒️ Checklist

1. [X] run linter locally
2. [X] update developer docs (API, README, inline, etc.), if any
3. [X] for user-facing doc changes create a Zulip thread at `#Support
Docs Updates`, if any
4. [X] draft PR with a title `<type>(<scope>)<!>: <title> DEV-1234`
5. [X] assign yourself, tag PR: at least `Front end` and/or `Back end`
or `workflow`
6. [X] fill in the template below and delete template comments
7. [X] review thyself: read the diff and repro the preview as written
8. [X] open PR & confirm that CI passes & request reviewers, if needed
9. [ ] delete this section before merging

### 📣 Summary
Add the `ExtraProjectMetadataField` model to support customizable
project metadata on private servers.

### 👀 Preview steps
There are no changes visible in the UI, validate these changes through
creating a model in the shell.

2. ℹ️ Run migrations: `python manage.py migrate kpi`
3. Open the Django shell
5. 🟢 [on PR] Test a successful creation of the model:
```
from kpi.models import ExtraProjectMetadataField
field = ExtraProjectMetadataField(
    name="donor_id", 
    type="text", 
    label={"default": "Donor ID"}
)
field.full_clean()
field.save()
print(f"Created: {field.name}")
```
7. Test validation failure:
```
try:
    bad_field = ExtraProjectMetadataField(name="sector", type="single_select")
    bad_field.full_clean() # This triggers the clean() method
except Exception as e:
    print(f"Caught expected error: {e}")
```
8. 🟢 Should output this error: `{'options': ['Options are required for
select fields.']}`

7536 of 11616 branches covered (64.88%)

27 of 28 new or added lines in 2 files covered. (96.43%)

28926 of 35218 relevant lines covered (82.13%)

1.62 hits per line