Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

318: update tests/data for MTD 3d cluster #334

Merged
merged 6 commits into from
Sep 17, 2024

Conversation

John-Sharples
Copy link

  • adds some more test coverage for MTD data

Pull Request Testing

  • Describe testing already performed for these changes:

    Tests run locally

  • Recommend testing for the reviewer(s) to perform, including the location of input datasets, and any additional instructions:

    None

  • [x Do these changes include sufficient documentation updates, ensuring that no errors or warnings exist in the build of the documentation? [Yes or No]

  • Do these changes include sufficient testing updates? [Yes or No]
    yes

  • Will this PR result in changes to the test suite? [Yes or No]

    yes, increase to 83% coverage

  • Do these changes introduce new SonarQube findings? [Yes or No]

    If yes, please describe:

  • Please complete this pull request review by [Fill in date].

Pull Request Checklist

See the METplus Workflow for details.

  • Add any new Python packages to the METplus Components Python Requirements table.
  • Review the source issue metadata (required labels, projects, and milestone).
  • Complete the PR definition above.
  • Ensure the PR title matches the feature or bugfix branch name.
  • Define the PR metadata, as permissions allow.
    Select: Reviewer(s) and Development issue
    Select: Milestone as the version that will include these changes
    Select: Coordinated METplus-X.Y Support project for bugfix releases or METdataio-X.Y.Z Development project for official releases
  • After submitting the PR, select the ⚙️ icon in the Development section of the right hand sidebar. Search for the issue that this PR will close and select it, if it is not already selected.
  • After the PR is approved, merge your changes. If permissions do not allow this, request that the reviewer do the merge.
  • Close the linked issue and delete your feature or bugfix branch from GitHub.

Copy link
Contributor

@georgemccabe georgemccabe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These changes look good.

I noticed many of the GitHub Actions checks failed, so I reran them and they succeeded.

I checked the SonarQube report and it looks like it is reporting only 40.7% code coverage. The code coverage run in GHA shows 68% coverage. I thought you were closer to 80%? Could you check on this and see what is going on? Perhaps some files are being excluded/included in the report when they should not be? The list of files to ignore in SonarQube can be found in the sonar-project.properties file.

@John-Sharples
Copy link
Author

@georgemccabe I've added some coverage and pytest config in a new pyproject.toml file, this allows us to run a single pytest from the top dir. After some trial and error I realise sonarQube has a separate coverage configuration! I've made these consistent and both are now reporting 81%

Please let me know if you're happy with the exclusions, in particular METdbLoad/sql. It contains some helper scripts, which are not currently covered by tests, but nor is it application code.

Copy link
Contributor

@georgemccabe georgemccabe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for making those edits. I see that both the GHA code coverage report and SonarQube both show 81% coverage.

Regarding the exclusion of METdbLoad/sql, I am not familiar enough with METdbLoad to know if these scripts should be ignored or not. @bikegeek or @mollybsmith-noaa, do either of you know if these scripts are used elsewhere, e.g. by METviewer or METexpress? If so, we may want to include them in the tests.

@bikegeek
Copy link
Collaborator

bikegeek commented Sep 17, 2024 via email

@mollybsmith-noaa
Copy link
Contributor

mollybsmith-noaa commented Sep 17, 2024 via email

@John-Sharples John-Sharples merged commit 2aaedd0 into develop Sep 17, 2024
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: 🏁 Done
Development

Successfully merging this pull request may close these issues.

Create additional tests to METdataio to increase code coverage
4 participants