NCAR / NCAR/ccpp-framework

Add xmllint-ing of SDFs to offline_check_fortran_vs_metadata.py

Open
#607 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
25
Forks
67
Avg merge
3d 8h
Merged PRs (30d)
2

Description

Description

It would be nice if the offline fortran vs metadata checker also linted the XML SDFs to validate those.

Solution

We should be able to use this function (in scripts/parse_tools/xml_tools.py) to validate any SDFs on the path:

def validate_xml_file(filename, schema_root, version, logger,
                      schema_path=None, error_on_noxmllint=False):

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in scripts/offline_check_fortran_vs_metadata.py and inspect how SDF paths are discovered and checked. Read validate_xml_file in scripts/parse_tools/xml_tools.py, then use it for each SDF and confirm that XML validation is performed alongside the existing checks. Done means the checker validates every SDF on its path and reports validation failures appropriately.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.