Add running the unittests to the GitHub workflow

[zmaalick]

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]

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]

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]

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]

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

[zmaalick]

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 "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.

[ehogan]

Thanks @zmaalick 😊

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

[ehogan]

Almost there! 🤪

[mo-nikosbaltas]

Looks ok.

[ehogan]

Thanks @zmaalick, just one more outstanding change (and I will add to the working practices that the developer should check the changes in the "Files changed" tab and perform a self-review before requesting a review).

[ehogan]

Thanks @zmaalick 🥳

pytest on the command line, cylc vip -O metoffice -O test and cylc vip -O metoffice -O unittest all return the same output 🎉