Add running the unittests to the GitHub workflow #321

zmaalick · 2026-01-08T13:25:48Z

Closes #165 .

PR creation checklist for the developer

Has <issue_number> above ☝️ been replaced with the issue number?
Has main been selected as the base branch?
Does the feature branch name follow the format <issue_number>_<short_description_of_feature>?
Does the text of the PR title exactly match with the text (not including the issue number) of the issue title?
Have appropriate reviewers been added to the PR (once it is ready for review)?
Has the PR been assigned to the developer(s)?
Have the same labels as on the issue (except for the good first issue label) been added to the PR?
Has the Climate Model Evaluation Workflow (CMEW) project been added to the PR?
Has the appropriate milestone been added to the PR?

Definition of Done for the developer

Does the change in this PR address the above issue / have all acceptance criteria been met?
Does the change in this PR follow the requirements in the wiki: Developer Guide (including copyrights)?
Have new tests related to the change been added?
Do all the GitHub workflow checks pass?
Do all the tests run locally and pass? (Note: the tests are not run by the GitHub workflow, see wiki: Run the tests locally)
Has the API documentation (e.g. docstrings in Python modules) related to the change been updated appropriately?
Has the user documentation (i.e. everything in the doc directory) related to the change been updated appropriately, including the Quick Start section?
Do the HTML pages render correctly? (See wiki: Build the documentation locally)

PR creation checklist for the reviewer

Has <issue_number> above ☝️ been replaced with the issue number?
Has main been selected as the base branch?
Does the feature branch name follow the format <issue_number>_<short_description_of_feature>?
Does the text of the PR title exactly match with the text (not including the issue number) of the issue title?
Have appropriate reviewers been added to the PR (once it is ready for review)?
Has the PR been assigned to the developer(s)?
Have the same labels as on the issue (except for the good first issue label) been added to the PR?
Has the Climate Model Evaluation Workflow (CMEW) project been added to the PR?
Has the appropriate milestone been added to the PR?

Definition of Done for the reviewer

Does the change in this PR address the above issue / have all acceptance criteria been met?
Does the change in this PR follow the requirements in the wiki: Developer Guide (including copyrights)?
Have new tests related to the change been added? N/A
Do all the GitHub workflow checks pass?
Do all the tests run locally and pass? (Note: the tests are not run by the GitHub workflow, see wiki: Run the tests locally)
Has the API documentation (e.g. docstrings in Python modules) related to the change been updated appropriately? N/A
Has the user documentation (i.e. everything in the doc directory) related to the change been updated appropriately including the Quick Start section? N/A
Do the HTML pages render correctly? (See wiki: Build the documentation locally)

mo-nikosbaltas

Although the unit tests block is correct and works, my suggestion is:
Instead of:

eval "$(conda shell.bash hook)"
conda activate cmew
...

Use conda run:
conda run -n cmew cylc validate -O metoffice -O unittest .

This eliminates shell activation issues and is more reliable in Actions.
This also applies to other tests in this file.
As already said this is a suggestion.

     - name: Run Cylc unit tests
        run: |
          cd CMEW
          conda run -n cmew cylc vip -O metoffice -O unittest .

Although not applicable for this issue I would suggest to include some logging by adding at the end:

      - name: Upload cylc-run logs on failure
        if: failure()
        uses: actions/upload-artifact@v4
        with:
          name: cylc-run-logs
          path: ~/cylc-run

Otherwise it is all good for me.

mo-nikosbaltas · 2026-01-09T15:11:58Z

The unit tests should read:

     - name: Run Cylc unit tests
        run: |
          cd CMEW
          conda run -n cmew cylc vip -O metoffice -O unittest .

not
conda run -n cmew cylc validate -O metoffice -O unittest .

In my previous comment I was giving an example for 'cylc validate'. Sorry if I confused you. Also the checks failed when pushing. Can you correct?

zmaalick · 2026-01-09T16:13:50Z

Although the unit tests block is correct and works, my suggestion is: Instead of:
eval "$(conda shell.bash hook)"
conda activate cmew
...
Use conda run: conda run -n cmew cylc validate -O metoffice -O unittest .

This eliminates shell activation issues and is more reliable in Actions. This also applies to other tests in this file. As already said this is a suggestion.
     - name: Run Cylc unit tests
        run: |
          cd CMEW
          conda run -n cmew cylc vip -O metoffice -O unittest .
Although not applicable for this issue I would suggest to include some logging by adding at the end:
      - name: Upload cylc-run logs on failure
        if: failure()
        uses: actions/upload-artifact@v4
        with:
          name: cylc-run-logs
          path: ~/cylc-run
Otherwise it is all good for me.

Made the changes and also added the logging. Working fine.

mo-nikosbaltas

Modify PR title to : #321: Add running the unittests to the GitHub workflow. See https://github.com/MetOffice/CMEW/wiki/Detailed-Working-Practices#create-a-pull-request

zmaalick · 2026-01-12T12:23:16Z

Modify PR title to : #321: Add running the unittests to the GitHub workflow. See https://github.com/MetOffice/CMEW/wiki/Detailed-Working-Practices#create-a-pull-request

Done

mo-nikosbaltas · 2026-01-12T12:44:43Z

zmaalick · 2026-01-12T13:37:14Z

Also, @zmaalick can you change the copyright years (# (C) Crown Copyright 2022-2025, Met Office.) in the file to 2022-2026.

Done

mo-nikosbaltas

All looks good.

ehogan

Thanks @zmaalick 😊

The issue states "It may be worth configuring pytest so that it can be run from the GitHub workflow and via -O unittest without needing to change directories"; would it be possible for you to look into this, please? 👍

.github/workflows/cmew-env/cmew-env.lock

.github/workflows/default.yml

ehogan

Thanks @zmaalick! 🥳

.github/workflows/cmew-env/cmew-env.yml

.github/workflows/default.yml

ehogan

Thanks @zmaalick 🥳

The "end of new line" issue with one of the files in this branch suggests you have not set up the pre-commit hooks. Please set up the pre-commit hooks. Instructions are available at https://github.com/MetOffice/CMEW/wiki/First-time-developer-instructions#first-time-developer-instructions.

pytest.ini

ehogan

Thanks @zmaalick 😊

Now that the pytest configuration has been added, please remove the cd command to be removed from the unittest app.

CMEW/app/configure_recipe/bin/test_configure_recipe.py

ehogan · 2026-01-21T08:33:00Z

CMEW/app/configure_standardise/bin/test_create_request_file.py

 # (C) Crown Copyright 2024-2025, Met Office.
 # The LICENSE.md file contains full licensing details.
 import os
-


Please revert this change 😊

This change still needs reverting 😊

pyproject.toml

CMEW/site/metoffice.cylc

pyproject.toml

ehogan

Almost there! 🤪

ehogan · 2026-01-22T18:02:45Z

CMEW/app/configure_standardise/bin/test_create_request_file.py

 # (C) Crown Copyright 2024-2025, Met Office.
 # The LICENSE.md file contains full licensing details.
 import os
-


This change still needs reverting 😊

ehogan · 2026-01-22T18:03:18Z

CMEW/app/configure_recipe/bin/test_configure_recipe.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-# (C) Crown Copyright 2024-2025, Met Office.
+# (C) Crown Copyright 2024-2026, Met Office.


Please revert this change (there are now no changes in this file, so the copyright doesn't need updating) 👍

mo-nikosbaltas

Looks ok.

add unitests in github workflow

c6f04fe

zmaalick self-assigned this Jan 8, 2026

zmaalick added good first issue Good for newcomers quality assurance Anything related to Quality Assurance (QA) testing Anything related to testing labels Jan 8, 2026

zmaalick added this to the v0.2.0 (multiple model runs) milestone Jan 8, 2026

zmaalick requested review from alistairsellar and mo-nikosbaltas January 8, 2026 13:29

mo-nikosbaltas reviewed Jan 9, 2026

View reviewed changes

zmaalick added 2 commits January 9, 2026 15:01

update with changess suggested by nik #165

4d2c3be

remove logging block

53a6163

zmaalick added 5 commits January 9, 2026 15:13

change validate to vip

05b158e

revert back the changes

b3d7579

add logging block

81db099

end of file line

68cd5c9

unittest block changes

7e32edd

mo-nikosbaltas approved these changes Jan 9, 2026

View reviewed changes

mo-nikosbaltas self-requested a review January 12, 2026 12:06

mo-nikosbaltas requested changes Jan 12, 2026

View reviewed changes

zmaalick changed the title ~~add unitests in github workflow~~ Add running the unittests to the GitHub workflow Jan 12, 2026

Merge branch 'main' into 165_add_unittest_in_github_workflow

1edde1d

mo-nikosbaltas self-requested a review January 12, 2026 13:30

update copywrite year

d7a4213

mo-nikosbaltas previously approved these changes Jan 12, 2026

View reviewed changes

mo-nikosbaltas self-requested a review January 12, 2026 13:42

zmaalick added 4 commits January 12, 2026 14:54

fix pytest

4c8ed64

add pytest in yml

3a9d45a

add pluggy in lock

1b766ff

update lock

cc5ebb8

ehogan requested changes Jan 13, 2026

View reviewed changes

.github/workflows/cmew-env/cmew-env.lock Outdated Show resolved Hide resolved

.github/workflows/default.yml Outdated Show resolved Hide resolved

.github/workflows/default.yml Outdated Show resolved Hide resolved

.github/workflows/default.yml Outdated Show resolved Hide resolved

zmaalick added 3 commits January 13, 2026 10:12

add esmvalcore

8f0db29

fix linter issue and make consistancy in pytest call

d70e7de

remove logging section and update yml file

4e0b916

alistairsellar requested review from alistairsellar and removed request for alistairsellar January 13, 2026 16:35

ehogan requested changes Jan 15, 2026

View reviewed changes

.github/workflows/cmew-env/cmew-env.yml Outdated Show resolved Hide resolved

.github/workflows/default.yml Outdated Show resolved Hide resolved

.github/workflows/default.yml Outdated Show resolved Hide resolved

zmaalick added 2 commits January 15, 2026 10:13

reorder the env packages list alphabetically

96a62b6

update the copywrite

528024a

ehogan mentioned this pull request Jan 15, 2026

Update the GitHub Actions workflow #337

Open

zmaalick added 5 commits January 15, 2026 10:32

remove ignore in lint and update execution limit in metoffice.cylc

8836fda

add pytest conf file and update github actions

17dca6a

declaration correct in pytest conf

de8d97d

add pytest mark

6fda3d8

update with pytest mark

cecaec7

ehogan requested changes Jan 16, 2026

View reviewed changes

pytest.ini Outdated Show resolved Hide resolved

zmaalick added 2 commits January 16, 2026 11:22

remove marking for pytest

feb3d1e

move pytest conf in pyproj and update pytest command in actions

581af08

ehogan requested changes Jan 21, 2026

View reviewed changes

zmaalick added 2 commits January 21, 2026 11:30

updated the suggested changes

1bca788

pre-commit changes

c6114c3

ehogan requested changes Jan 22, 2026

View reviewed changes

mo-nikosbaltas mentioned this pull request Jan 22, 2026

Enable switching off CDDS extract #300

Open

34 tasks

zmaalick added 2 commits January 23, 2026 08:37

revert back the copywrite change

fe6953e

revert back the change

119b6dc

mo-nikosbaltas approved these changes Jan 23, 2026

View reviewed changes

Add running the unittests to the GitHub workflow #321

Are you sure you want to change the base?

Add running the unittests to the GitHub workflow #321

Uh oh!

Conversation

zmaalick commented Jan 8, 2026 • edited by mo-nikosbaltas Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR creation checklist for the developer

Definition of Done for the developer

PR creation checklist for the reviewer

Definition of Done for the reviewer

Uh oh!

mo-nikosbaltas left a comment

Choose a reason for hiding this comment

Uh oh!

mo-nikosbaltas commented Jan 9, 2026

Uh oh!

zmaalick commented Jan 9, 2026

Uh oh!

mo-nikosbaltas left a comment

Choose a reason for hiding this comment

Uh oh!

zmaalick commented Jan 12, 2026

Uh oh!

mo-nikosbaltas commented Jan 12, 2026

Uh oh!

zmaalick commented Jan 12, 2026

Uh oh!

mo-nikosbaltas left a comment

Choose a reason for hiding this comment

Uh oh!

ehogan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ehogan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ehogan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ehogan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ehogan Jan 21, 2026

Choose a reason for hiding this comment

Uh oh!

zmaalick Jan 21, 2026

Choose a reason for hiding this comment

Uh oh!

ehogan Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

zmaalick Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ehogan left a comment

Choose a reason for hiding this comment

Uh oh!

ehogan Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

ehogan Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

zmaalick Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

mo-nikosbaltas left a comment

zmaalick commented Jan 8, 2026 •

edited by mo-nikosbaltas

Loading