NCAS-CMS / NCAS-CMS/cf-python

Actions workflow for profiling unit test runs

Open
#127 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

GitHub Actions
Dominant language
Python
Stars
150
Forks
23
Avg merge
1d 11h
Merged PRs (30d)
2

Description

It would be useful to have a CI workflow that runs cProfile on the unit test run (or perhaps some custom script that is more useful to profile) for the jobs with their differing matrix variables (currently OS & Python version), that we can run ad-hoc.

It would allow us to pinpoint identify performance differences across platforms and Python versions. In particular I raise this since I have noticed the MacOS jobs all consistently run significantly slower than the Ubuntu jobs over the current test suite. With profiling stats we could investigate that with detailed outputs and without having to rummage through the job logs for timings. Otherwise it is hard to check up on potential Mac-specific bottlenecks, not having a Mac at hand.

Ideally we can have a workflow that grabs the profiling stats for unit test runs with each matrix variable and then runs a final step with some logic to determine any major differences in outputs, to inform us of any significant platform or version-specific differences. Or runs a vis tool like snakeviz or gprof2dot to eyeball for noticeable differences.

Contributor guide

Open the contributing guide

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

No file or test path is named. Start by reviewing the existing GitHub Actions unit-test matrix and its OS and Python-version jobs, then determine how profiling outputs would be collected and compared on demand. Done means an ad-hoc workflow produces per-matrix profiling results and highlights meaningful platform or version differences.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, python
Domain
ci-cd, performance
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.