project-chip/connectedhomeip

[Cirque] use virtualenv

Open

#33,950 opened on Jun 17, 2024

View on GitHub
 (2 comments) (0 reactions) (0 assignees)C++ (6,410 stars) (1,659 forks)batch import
CI/CD improvementsgood first issue

Description

After upgrading to 24.04 it becomes very obvious that cirque should use a virtualenv instead of dirtying the system python packages.

We should instead create a virtualenv for every pip package install and python usage. We also seem to have significant copy&paste throughout the tests for pip install, those should be consolidated.

Contributor guide

Tech stack
python
Domain
testingtooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Pythonvirtualenvpipbasic testing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
The issue asks to replace direct Python package installation with a virtualenv based approach in the Cirque testing setup. A contributor should first locate the test scripts that currently use pip install (likely in the test/ or scripts/ directory) and refactor them to create a virtualenv, install dependencies there, and consolidate repeated pip install commands into a single script or helper function. The maintainers have not yet specified whether to use a single virtualenv for all tests or per test virtualenvs, so that may need clarification.