Skip to content

Add running the unittests to the GitHub workflow #321

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.

Sign up for GitHub

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

Open
Zubair Maalick (zmaalick) wants to merge 41 commits into
base: main
Choose a base branch
from
Open

Add running the unittests to the GitHub workflow #321

Show file tree
Hide file tree
Changes from 38 commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
c6f04fe
add unitests in github workflow
zmaalick Jan 8, 2026
4d2c3be
update with changess suggested by nik #165
zmaalick Jan 9, 2026
53a6163
remove logging block
zmaalick Jan 9, 2026
05b158e
change validate to vip
zmaalick Jan 9, 2026
b3d7579
revert back the changes
zmaalick Jan 9, 2026
81db099
add logging block
zmaalick Jan 9, 2026
68cd5c9
end of file line
zmaalick Jan 9, 2026
7e32edd
unittest block changes
zmaalick Jan 9, 2026
1edde1d
Merge branch 'main' into 165_add_unittest_in_github_workflow
alistairsellar Jan 12, 2026
d7a4213
update copywrite year
zmaalick Jan 12, 2026
06ae314
update unittest with pytest
zmaalick Jan 12, 2026
9853ca9
add pytest in env
zmaalick Jan 12, 2026
4c8ed64
fix pytest
zmaalick Jan 12, 2026
3a9d45a
add pytest in yml
zmaalick Jan 12, 2026
1b766ff
add pluggy in lock
zmaalick Jan 12, 2026
cc5ebb8
update lock
zmaalick Jan 13, 2026
8f0db29
add esmvalcore
zmaalick Jan 13, 2026
d70e7de
fix linter issue and make consistancy in pytest call
zmaalick Jan 13, 2026
4e0b916
remove logging section and update yml file
zmaalick Jan 13, 2026
96a62b6
reorder the env packages list alphabetically
zmaalick Jan 15, 2026
528024a
update the copywrite
zmaalick Jan 15, 2026
8836fda
remove ignore in lint and update execution limit in metoffice.cylc
zmaalick Jan 15, 2026
17dca6a
add pytest conf file and update github actions
zmaalick Jan 15, 2026
de8d97d
declaration correct in pytest conf
zmaalick Jan 15, 2026
6fda3d8
add pytest mark
zmaalick Jan 15, 2026
cecaec7
update with pytest mark
zmaalick Jan 15, 2026
feb3d1e
remove marking for pytest
zmaalick Jan 16, 2026
581af08
move pytest conf in pyproj and update pytest command in actions
zmaalick Jan 20, 2026
1bca788
updated the suggested changes
zmaalick Jan 21, 2026
c6114c3
pre-commit changes
zmaalick Jan 21, 2026
fe6953e
revert back the copywrite change
zmaalick Jan 23, 2026
119b6dc
revert back the change
zmaalick Jan 23, 2026
3fc8305
revert the copywrite change
zmaalick Jan 27, 2026
1859b12
add pytest.ini
zmaalick Feb 3, 2026
59e3a6c
add unittest solution
zmaalick Feb 3, 2026
1b49c65
hook changes
zmaalick Feb 3, 2026
e422473
update copywrites
zmaalick Feb 3, 2026
2fc7f4d
fix rose-dump error
zmaalick Feb 3, 2026
6a17f12
update unittest rose conf
zmaalick Feb 9, 2026
ced2bb3
fix type
zmaalick Feb 9, 2026
6e0e98e
rename pytest.ini
zmaalick Mar 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
556 changes: 381 additions & 175 deletions .github/workflows/cmew-env/cmew-env.lock
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 4 additions & 2 deletions .github/workflows/cmew-env/cmew-env.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# (C) Crown Copyright 2024-2025, Met Office.
# (C) Crown Copyright 2024-2026, Met Office.
# The LICENSE.md file contains full licensing details.
name: cmew

Expand All @@ -8,7 +8,9 @@ channels:
dependencies:
- cylc-flow
- cylc-rose
- esmvalcore
- metomi-rose
- pre-commit
- pytest
- sphinx
- sphinx_rtd_theme
- pre-commit
8 changes: 7 additions & 1 deletion .github/workflows/default.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# (C) Crown Copyright 2022-2025, Met Office.
# (C) Crown Copyright 2022-2026, Met Office.
# The LICENSE.md file contains full licensing details.
# This workflow creates the required Conda environment, performs various
# validation steps for Cylc and Rose, and builds and checks the documentation.
Expand Down Expand Up @@ -67,6 +67,12 @@ jobs:
cd CMEW
rose metadata-check -C meta/

- name: Run Python unit tests
run: |
eval "$(conda shell.bash hook)"
conda activate cmew
pytest -v

- name: Build documentation
run: |
eval "$(conda shell.bash hook)"
Expand Down
10 changes: 8 additions & 2 deletions CMEW/app/unittest/rose-app.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# (C) Crown Copyright 2024-2025, Met Office.
# (C) Crown Copyright 2024-2026, Met Office.
# The LICENSE.md file contains full licensing details.
# CMEW/app/unittest/rose-app.conf
Comment thread
ehogan marked this conversation as resolved.
Outdated

file-install-root=${CYLC_WORKFLOW_RUN_DIR}

[command]
default=cd ${CYLC_WORKFLOW_RUN_DIR}/app
= cmew-esmvaltool-env pytest
=cmew-esmvaltool-env pytest

[file:pytest.ini]

@ehogan Emma Hogan (ehogan) Feb 6, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I feel it would be clearer if the full path was specified here, rather than specifying file-install-root at the top of this file. Also, would it be possible to use .pytest.ini rather than pytest.ini, please?

Suggested change
[file:pytest.ini]
[file:${CYLC_WORKFLOW_RUN_DIR/.pytest.ini]

@zmaalick Zubair Maalick (zmaalick) Feb 9, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

6a17f12

@ehogan Emma Hogan (ehogan) Mar 6, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Also, would it be possible to use .pytest.ini rather than pytest.ini, please?

Please also update the name of the file in the repository from pytest.ini to .pytest.ini.

@zmaalick Zubair Maalick (zmaalick) Mar 6, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

6e0e98e

@ehogan Emma Hogan (ehogan) Mar 6, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

As mentioned at #321 (comment) and in a previous retro where we agreed to update the PR checklist with the point "Remember to re-check the Definition of Done after making changes in response to a review.", please re-check the Definition of Done after making this change (particularly the testing).

@zmaalick Zubair Maalick (zmaalick) Mar 16, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Hi Emma Hogan (@ehogan)

in `app/unittest' we are doing:

[file:$CYLC_WORKFLOW_RUN_DIR/.pytest.ini]
source=git:https://github.com/MetOffice/CMEW.git::pytest.ini::165_add_unittest_in_github_workflow

cylc does not read hidden files. Making pytest.ini to .pytest.ini will not work in cylc. (that is why unitest are failing in cylc)

we need to convert it back to pytest.ini to make it work.

source=git:https://github.com/MetOffice/CMEW.git::pytest.ini::165_add_unittest_in_github_workflow
4 changes: 2 additions & 2 deletions CMEW/site/metoffice.cylc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!jinja2
# (C) Crown Copyright 2022-2025, Met Office.
# (C) Crown Copyright 2022-2026, Met Office.
# The LICENSE.md file contains full licensing details.
# metoffice.cylc
[runtime]
Expand All @@ -14,6 +14,6 @@
--ntasks = {{ MAX_PARALLEL_TASKS }}

[[run_recipe<recipe=radiation_budget>]]
execution time limit = PT2H
[[[directives]]]
--time = 2
Comment thread
ehogan marked this conversation as resolved.
--mem = 3G
13 changes: 1 addition & 12 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# (C) Crown Copyright 2024-2025, Met Office.
# (C) Crown Copyright 2024-2026, Met Office.
# The LICENSE.md file contains full licensing details.
# Configure black.
[tool.black]
Expand All @@ -15,14 +15,3 @@ exclude = '''
)/
)
'''

# Configure pytest.
[tool.pytest.ini_options]
filterwarnings = [
# Ignore deprecation warnings from webob, esmpy and pkg_resources:
"ignore:'cgi' is deprecated and slated for removal in Python 3.13:DeprecationWarning",
"ignore:Implicit None on return values is deprecated:DeprecationWarning",
"ignore:Deprecated call to `pkg_resources.declare_namespace:DeprecationWarning",
# Ignore user warnings from pybtex:
"ignore:pkg_resources is deprecated as an API:UserWarning",
]
12 changes: 12 additions & 0 deletions pytest.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# (C) Crown Copyright 2026, Met Office.
# The LICENSE.md file contains full licensing details.
[pytest]
testpaths = CMEW
Comment thread
ehogan marked this conversation as resolved.

Comment thread
ehogan marked this conversation as resolved.
Outdated
filterwarnings =
# Ignore deprecation warnings from webob, esmpy and pkg_resources:
ignore:'cgi' is deprecated and slated for removal in Python 3.13:DeprecationWarning
ignore:Implicit None on return values is deprecated:DeprecationWarning
ignore:Deprecated call to `pkg_resources.declare_namespace:DeprecationWarning
# Ignore user warnings from pybtex:
ignore:pkg_resources is deprecated as an API:UserWarning