FCP-INDI / C-PAC

Configurable Pipeline for the Analysis of Connectomes
https://fcp-indi.github.io/
GNU Lesser General Public License v3.0
64 stars 40 forks source link

♻️ Move mutual-exclusivity check to schema validation #2009

Closed shnizzedy closed 11 months ago

shnizzedy commented 11 months ago

Fixes

Follow-up to 676705c by @e-kenneally Fixes af72ff8 by @sgiavasis Fixes #1952 by @e-kenneally

Description

Smoke tests are failing in current develop after merging #1952 because, for example,

bool({'run': False,
      'Regressors': {'Name': 'default', 'Columns': ['global_signal']}
     }) == True

and https://github.com/FCP-INDI/C-PAC/blob/2fb9d13c997c9509a04ce9938f0492409bd63403/CPAC/pipeline/cpac_pipeline.py#L1315-L1320 is checking cfg.nuisance_corrections['2-nuisance_regression']['ingress_regressors'] which includes dictionary values like that.

This PR:

  1. Adds 'run' to https://github.com/FCP-INDI/C-PAC/blob/3a2a06ae90332c8685812d2e8e7e9946db76b8f4/CPAC/pipeline/schema.py#L1160-L1161
  2. Moves the check from pipeline building to schema validation (so the check happens sooner)
  3. Changes the exception type from generic Exception to the more specific ExclusiveInvalid https://github.com/FCP-INDI/C-PAC/blob/2fb9d13c997c9509a04ce9938f0492409bd63403/CPAC/pipeline/cpac_pipeline.py#L1318-L1320https://github.com/FCP-INDI/C-PAC/blob/3a2a06ae90332c8685812d2e8e7e9946db76b8f4/CPAC/pipeline/schema.py#L1164-L1166

Tests

The smoke tests should start passing again once this is merged to develop

Checklist

Developer Certificate of Origin

Developer Certificate of Origin ``` Developer Certificate of Origin Version 1.1 Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 1 Letterman Drive Suite D4700 San Francisco, CA, 94129 Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Developer's Certificate of Origin 1.1 By making a contribution to this project, I certify that: (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it. (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved. ```
e-kenneally commented 11 months ago

🙌