dabla opened a new pull request, #70007:
URL: https://github.com/apache/airflow/pull/70007
<!-- SPDX-License-Identifier: Apache-2.0
https://www.apache.org/licenses/LICENSE-2.0 -->
<!--
Thank you for contributing!
Please provide above a brief description of the changes made in this pull
request.
Write a good git commit message following this guide:
http://chris.beams.io/posts/git-commit/
Please make sure that your code changes are covered with tests.
And in case of new features or big changes remember to adjust the
documentation.
For user-facing UI changes, please attach before/after screenshots (or a
short
screen recording) so reviewers can assess the visual impact.
Feel free to ping (in general) for the review if you do not see reaction for
a few days
(72 Hours is the minimum reaction time you can expect from volunteers) - we
sometimes miss notifications.
In case of an existing issue, reference it using one of the following:
* closes: #ISSUE
* related: #ISSUE
-->
Currently, the `check-provider-yaml-valid` prek hook only fires when a
`provider.yaml` file is modified. When a developer adds a new field to
`get_connection_form_widgets()` in a hook Python file — as in PR #64643
which added `auth_protocol` to `SambaHook` — the static check is never
triggered, so the mismatch between the hook and `provider.yaml` goes
undetected.
There was also a second gap: even when the check _did_ run, a
`connection-type` entry with **no `conn-fields` section at all** was
silently skipped, regardless of how many form widgets the hook declared.
This PR closes both gaps:
**1. Trigger on hook file changes**
`check-provider-yaml-valid` in `providers/.pre-commit-config.yaml` now
also fires when any file matching
`src/airflow/providers/**/hooks/*.py` is staged.
`check_provider_yaml_files.py` maps each changed hook file to the
`provider.yaml` at the root of the same provider package and passes
that to the in-container validator, so the full conn-fields check runs
even when only the hook changes.
**2. Flag absent `conn-fields` when the hook declares widgets**
`check_conn_fields_for_entry()` previously returned early with no error
when `conn-fields` was absent from `provider.yaml`. It now treats an
absent `conn-fields` section as an empty dict, so every field returned
by `get_connection_form_widgets()` is reported as missing — exactly the
same error the existing bidirectional check already produces for a
present-but-incomplete `conn-fields` section.
**Changes**
| File | What changed |
|---|---|
| `scripts/ci/prek/check_provider_conn_fields.py` | Treat absent
`conn-fields` as `{}` instead of short-circuiting |
| `scripts/ci/prek/check_provider_yaml_files.py` | Map hook Python files →
provider.yaml before delegating to Breeze |
| `providers/.pre-commit-config.yaml` | Expand trigger to include
`hooks/*.py` files |
| `scripts/tests/ci/prek/test_check_conn_fields_match_form_widgets.py` |
Replace the "no-conn-fields-with-hook-widgets-is-ok" passing case with a
failing case; add `absent-conn-fields-with-hook-widgets` error test |
**Reproduction**
Without this fix, the following scenario produces no CI error:
```yaml
# provider.yaml — no conn-fields section at all
connection-types:
- hook-class-name: airflow.providers.samba.hooks.samba.SambaHook
connection-type: samba
```
```python
# samba.py
@classmethod
def get_connection_form_widgets(cls):
return {"auth_protocol": SelectField(...)} # invisible in React UI!
```
With this fix, the static check reports:
```
Mismatch between conn-fields in providers/samba/provider.yaml and
SambaHook.get_connection_form_widgets() for connection-type 'samba':
Fields in get_connection_form_widgets() but NOT in provider.yaml
conn-fields: auth_protocol
How to fix it: Add the missing key(s) to conn-fields in provider.yaml.
```
---
##### Was generative AI tooling used to co-author this PR?
<!--
If generative AI tooling has been used in the process of authoring this PR,
please
change below checkbox to `[X]` followed by the name of the tool, uncomment
the "Generated-by".
-->
- [ x ] Yes (please specify the tool below)
Claude Sonnet 4.6
<!--
Generated-by: [Tool Name] following [the
guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#gen-ai-assisted-contributions)
-->
---
* Read the **[Pull Request
Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)**
for more information. Note: commit author/co-author name and email in commits
become permanently public when merged.
* For fundamental code changes, an Airflow Improvement Proposal
([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals))
is needed.
* When adding dependency, check compliance with the [ASF 3rd Party License
Policy](https://www.apache.org/legal/resolved.html#category-x).
* For significant user-facing changes create newsfragment:
`{pr_number}.significant.rst`, in
[airflow-core/newsfragments](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments).
You can add this file in a follow-up commit after the PR is created so you
know the PR number.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
