Update d/rules and d/p/retain-setuptools.patch to leverage DEB_VERSION settings #6733

blackboxsw · 2026-02-07T22:32:16Z

Resolve PEP440 version warnings about@MISSING_MESON_BUILD_ARTIFACT@ python3 setup.py clean, build or install stages by providing debian/rules $(DEB_VERSION) to the patched setup_utils.py. This allows us to avoid either python3-setuptools-scm dependencies or complex override_dh_auto_(clean|build|install) stages to attempt to create meson_versions.py.

This branch represents 4 actions:

new_upsream_snapshot.py
Update debian/rules to export PACKAGED_VERSION=$(DEB_VERSION)
Simplify d/p/retain-setuptools by dropping tools.read-version and simplify setup_utils.py get_version to read os.environ("PACKAGED_VERSION")
update changelog

Proposed Commit Message

See individual commits

Additional Context

Test Steps

One can test the build environment behavior with the following:

$ quilt push -a
$ python3 setup.py --version
# expected error because we are missing MISSING_ENVVAR_DEB_VERSION env var
...
packaging.version.InvalidVersion: Invalid version: 'MISSING_ENVVAR_DEB_VERSION'


$ PACKAGED_VERSION=25.3-0ubuntu1~22.04.2 python3 setup.py --version
25.3
quilt pop -a

Merge type

Squash merge using "Proposed Commit Message"
Rebase and merge unique commits. Requires commit messages per-commit each referencing the pull request number (#<PR_NUM>)

-made sure test case classes don't inherit from TestCase -used pytest fixtures instead of unittest setUp method -converted all self.assert to plain assert. Related canonicalGH-6427

disable-sshd-keygen-if-cloud-init-active.conf seems to have been added twice. Fix it. Also replace '/usr/lib/systemd/system' by the macro %{_unitdir} to make the spec file more portable across distros. Signed-off-by: Ani Sinha <anisinha@redhat.com>

This is true since FreeBSD 14.0-RELEASE https://www.freebsd.org/releases/14.0R/relnotes/ https://cgit.freebsd.org/src/commit/?id=bbb2d2ce4220

…6646)

Add test_ds_identify functionality to provide environment variables to tests using PATH_DI_ENV.

) When ephemeral networking is brought up in Azure, the selected interface (`iface`) is `None` under certain conditions. This change introduces a helper function `find_primary_nic()` which uses `net.find_candidate_nics()` to determine and select the system's primary network interface if one is not explicitly set. Additional improvements: - Log the MAC address and driver of the selected NIC for easier debugging. - Ensure the DHCP retry loop updates `iface` to the current primary NIC before retrying to obtain a lease. Fixes canonical#6558

The "has_gnu_date" function checks "date --help" output, but some versions of "date" don't include a "--help" flag.

`time.strftime()` has platform-specific behavior when dealing with a `gmtime()` struct.

It was removed in canonical#6356, but is still needed in some tests that interact with `/tmp`.

Many socket attributes are OS-specific, so ensure we have attributes that work for the tests that need them. Also, mock socket calls where needed.

'echo -n' isn't universal

Note that this test wasn't always Linux-specific, but when the pid stuff moved under Distro, the test was changed to test the base class (i.e., Linux) functionality only.

Implementation differences cause different results.

In DataSourceCloudStack.py, get_newest_lease() is currently being passed a Distro object, causing a Python type error. This PR changes the Distro object to the interface string to fix this error.

Add VM ID to the KVP (Key-Value Pair) event key format to improve telemetry tracking and debugging capabilities for Azure/Hyper-V deployments.

The EC2 datasource checks all NICs one by one to see which can reach the metadata server. This can lead to slow boot if the primary NIC is not checked first. We use the fact that typically the primary NIC on an EC2 instance will be the lowest numbered Elastic interface (either ENA or EFA) and order these first. Only then checking other network devices that may be present. Fixes canonicalGH-6618 Signed-off-by: Zachary Raines <zachary.raines@canonical.com>

…resolute (canonical#6701)

…mal places (canonical#6709)

cloud-init project now requires full SHA commits instead of tags for all workflows to utilize a more secure policy for CI runners. Any Github actions lacking full SHA pins in workflows/actions will error due to repo prevention policy. Additionally update SHA pins to latest known workflow releases.

…cal#6707) Fixes DNS queries for IP addresses that cause 2+ minute boot delays with systemd 259+. Moves IP detection earlier in is_resolvable() and removes legacy DNS-dependent metadata URL. Fixes canonicalGH-6641

Various pages in the table of contents documented things that are not useful without some other context. Remove these from the table of contents and link to them from pages that have that context. Introduce new "advanced" pages under the reference and explanation categories to link to pages which are not suitable for the average user. Other pages contained implementation details. Remove the implementation details or move the page to be under the new "advanced" pages. Introduce a new "project status" page to gather project-related info. Delete content and pages containing duplicate information. Don't make security policy recommendations to users. Remove page documenting the performance analysis subcommand, since there are more accurate ways of analyzing performance. File deletions -------------- about-cloud-config.rst performance_analysis.rst File renames ------------ faq.rst -> from reference to explanation user_files.rst -> from reference to explanation module_run_frequency -> from how-to to reference test_unreleased_packages -> from howto to reference foramt.rst -> format/index.rst (and sub-pages)

blackboxsw

I wanted to avoid introducing extra package dependencies in debian/control for jammy or noble on python3-setuptools-scm. Instead we can "set" the right python package version (and egg info) by providing a PACKAGED_VERSION environment variable which is sourced by setup_tools.get_version

blackboxsw · 2026-02-07T22:38:56Z

debian/patches/retain-setuptools.patch


 # This one is currently used only by the CloudSigma and SmartOS datasources.
--- /dev/null
-+++ b/tools/read-version


Drop tools/read-version because we have simplified setup_utils.py to only look at os.environ("PACKAGED_VERSION") which is now provided by our debian/rules file

blackboxsw · 2026-02-07T22:40:55Z

debian/patches/retain-setuptools.patch

-+    cmd = [sys.executable, "tools/read-version"]
-+    ver = subprocess.check_output(cmd)  # B603
-+    version = ver.decode("utf-8").strip()
+    ver = os.environ.get("PACKAGED_VERSION", "MISSING_ENVVAR_PACKAGE_VERSION")


Avoid shelling out to a script we no longer need. This get_version is called by setup.py during clean, build and install stages and we don't want to have to override the value returned when those stages don't yet have a modified cloudinit/version.py file.

This version retuerned is validated by setuptools and gets a warning in jammy when it doesn't adhere to PEP440. In noble, it's a hard error for the same non-PEP440 compliance.

blackboxsw · 2026-02-07T22:59:33Z

debian/patches/retain-setuptools.patch

-+    # that should give us a valid version.
-+    return version.replace("-", "+", 1)
+    # which is invalid under PEP 440. Redact it to only major.minor.patch
+    return version.strip("_").split("-")[0]


This function is only used by setuptools during python3 setup clean, build, install etc. And generates a PEP440 warning in jammy and error in noble if we don't present simple MAJOR.MINOR.PATCH version strings. This version is exposed in the egg-info included in packaging which historically adheres to the format cloud_init-25.2.egg-info. We don't expose the downstream ubuntu version suffixes.

holmanb · 2026-02-10T16:17:29Z

This branch has conflicts that need to be resolved.

holmanb · 2026-02-10T16:06:27Z

debian/changelog

+  * d/rules: update replace DOWNSTREAM_VERSION string to DEB_VERSION value and
+    export PACKAGED_VERSION environment variable


This comment is a bit confusing and probably adds more detail than necessary. Can we rewrite it in a way that explains what / why we made the change rather than what the change is?

MoeSalah1999 and others added 30 commits December 19, 2025 08:35

tests: convert test_cc_rsyslog.py to pytest (canonical#6622)

3067c25

-made sure test case classes don't inherit from TestCase -used pytest fixtures instead of unittest setUp method -converted all self.assert to plain assert. Related canonicalGH-6427

chore: add scheduled job for py3-fast (canonical#6634)

07922ae

fix(distros/freebsd): set home_dir to /home (canonical#6637)

9813bb8

This is true since FreeBSD 14.0-RELEASE https://www.freebsd.org/releases/14.0R/relnotes/ https://cgit.freebsd.org/src/commit/?id=bbb2d2ce4220

chore: use curl instead of wget (canonical#6610)

85c4638

chore: enable type checking cloudinit/distros/__init__.py (canonical#…

fad68ab

…6646)

chore: drop dscheck maas (canonical#6638)

a19f958

Add test_ds_identify functionality to provide environment variables to tests using PATH_DI_ENV.

fix: don't traceback when using BSD date

70b8771

The "has_gnu_date" function checks "date --help" output, but some versions of "date" don't include a "--help" flag.

test: ensure TMPDIR parents exist

1ae2027

fix: ensure timestamp timezone encoded correctly in status.py

3d7b545

`time.strftime()` has platform-specific behavior when dealing with a `gmtime()` struct.

test: ensure we don't actually rename ntp.conf in test

c3bf207

test: bring back fake tmpdir creation

2024036

It was removed in canonical#6356, but is still needed in some tests that interact with `/tmp`.

test: mock chown to account for distro grp differences

45c7555

test: hardcode passlib usage in Azure test

ec10d36

test: add a socket fixtures and mocks

528a712

Many socket attributes are OS-specific, so ensure we have attributes that work for the tests that need them. Also, mock socket calls where needed.

test: ensure symlinks are resolved in certain tests

d8d5a47

test: Replace 'echo -n' with 'printf'

818a261

'echo -n' isn't universal

fix: ensure mount type is used if passed

4e45baa

test: use realpath for tmp directories

e346b51

test: skip Linux-specific test on non-Linux

3139e94

Note that this test wasn't always Linux-specific, but when the pid stuff moved under Distro, the test was changed to test the base class (i.e., Linux) functionality only.

test: Skip Azure openssl tests on non-Linux

b5080b9

Implementation differences cause different results.

fix: Pass interface string to get_newest_lease() (canonical#6648)

e02b739

In DataSourceCloudStack.py, get_newest_lease() is currently being passed a Distro object, causing a Python type error. This PR changes the Distro object to the interface string to fix this error.

ci: add Python 3.15

78da9db

ci: reword action and workflow names for clarity

6880d34

chore: rename workflow files for organization

7cc31f5

ci: exercise TMPDIR now that it works (canonical#6652)

4810cc6

feat(azure): add vm_id to KVP telemetry event keys (canonical#6551)

974646e

Add VM ID to the KVP (Key-Value Pair) event key format to improve telemetry tracking and debugging capabilities for Azure/Hyper-V deployments.

chore: type cloudinit/sources/__init__.py (canonical#6647)

4495525

blackboxsw and others added 6 commits February 2, 2026 08:46

ci: install missing distro-info-data dependency to test devel series …

567cfe8

…resolute (canonical#6701)

fix(azure): round duration field in FinishReportingEvent to four deci…

580b21b

…mal places (canonical#6709)

fix: do not write meson version twice in version.py (canonical#6729)

090026a

blackboxsw requested a review from holmanb February 7, 2026 22:32

github-actions bot added the packaging Supplemental package review requested label Feb 7, 2026

blackboxsw force-pushed the ubuntu/jammy branch 2 times, most recently from 858ac97 to a9b4ffd Compare February 7, 2026 22:37

blackboxsw assigned holmanb Feb 7, 2026

blackboxsw commented Feb 7, 2026

View reviewed changes

blackboxsw force-pushed the ubuntu/jammy branch 3 times, most recently from 049e5b3 to 8a66d27 Compare February 7, 2026 22:57

blackboxsw commented Feb 7, 2026

View reviewed changes

blackboxsw mentioned this pull request Feb 7, 2026

Ubuntu/noble: fix daily recipe avoid PEP440 errors during python3 setup.py clean stage. #6734

Closed

2 tasks

This was referenced Feb 10, 2026

Ubuntu/noble: fix PEP440 setuptools --version issues plus new_upstream_snapshot #6739

Closed

ubuntu/noble: fix PEP440 setuptools --version warnings, perform new_upstream_snapshot #6740

Open

blackboxsw added 4 commits February 10, 2026 14:33

merge from 090026a at 25.3-133-g090026a3

4ccd83c

update changelog (new upstream snapshot)

23378be

d/rules: export DEB_VERSION and PACKAGED_VERSION

da7840e

d/p/retain-setuptools: drop read-version use PACKAGED_VERSION env var

f8b4593

blackboxsw force-pushed the ubuntu/jammy branch from 8a66d27 to 58a85de Compare February 10, 2026 21:39

holmanb reviewed Feb 11, 2026

View reviewed changes

blackboxsw force-pushed the ubuntu/jammy branch from 58a85de to 4a06f9f Compare February 11, 2026 15:26

update changelog

9cc84c6

blackboxsw force-pushed the ubuntu/jammy branch from 4a06f9f to 9cc84c6 Compare February 11, 2026 15:27

blackboxsw requested a review from holmanb February 11, 2026 22:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update d/rules and d/p/retain-setuptools.patch to leverage DEB_VERSION settings #6733

Update d/rules and d/p/retain-setuptools.patch to leverage DEB_VERSION settings #6733

Uh oh!

blackboxsw commented Feb 7, 2026 •

edited

Loading

Uh oh!

blackboxsw left a comment

Uh oh!

blackboxsw Feb 7, 2026

Uh oh!

blackboxsw Feb 7, 2026

Uh oh!

blackboxsw Feb 7, 2026

Uh oh!

holmanb commented Feb 10, 2026

Uh oh!

holmanb Feb 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

16 participants

		* d/rules: update replace DOWNSTREAM_VERSION string to DEB_VERSION value and
		export PACKAGED_VERSION environment variable

Update d/rules and d/p/retain-setuptools.patch to leverage DEB_VERSION settings #6733

Are you sure you want to change the base?

Update d/rules and d/p/retain-setuptools.patch to leverage DEB_VERSION settings #6733

Uh oh!

Conversation

blackboxsw commented Feb 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed Commit Message

Additional Context

Test Steps

Merge type

Uh oh!

blackboxsw left a comment

Choose a reason for hiding this comment

Uh oh!

blackboxsw Feb 7, 2026

Choose a reason for hiding this comment

Uh oh!

blackboxsw Feb 7, 2026

Choose a reason for hiding this comment

Uh oh!

blackboxsw Feb 7, 2026

Choose a reason for hiding this comment

Uh oh!

holmanb commented Feb 10, 2026

Uh oh!

holmanb Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

16 participants

blackboxsw commented Feb 7, 2026 •

edited

Loading