aodn/python-aodncore

Specify additional check params separately for each check suite

Opened this issue · 1 comments

Currently we're only using the check_params config element to specify which check suites (cf / imos) to apply. However, the checker accepts other parameters (see ComplianceChecker.run_checker) that control its behaviour. Some of these (in particular skip_checks and/or criteria) could be used to circumvent some troublesome checks in specific cases (see https://github.com/aodn/internal-discussions/issues/410). However, these parameters may need to be different for CF and IMOS checks.

The current config only allows one set of parameters, e.g.

  "check_params": {
    "checks": [ "cf", "imos:1.4" ],
    "skip_checks": [ "check_dimension_order", "check_convention_globals" ]
  }

Instead, we could have

  "check_params": {
    "cf": {
      "criteria": "normal"
      "skip_checks": [ "check_dimension_order", "check_convention_globals" ]
    },
    "imos:1.4": {
      "criteria": "strict"
    }
  }

I just realised the skip_checks option expects a list, so I've updated the examples above.