i/statemachine: add manifest-v2 to align with livecd-rootfs format by fhost · Pull Request #288 · canonical/ubuntu-image

fhost · 2026-02-13T22:36:38Z

Add a new artifact manifest-v2 for classic image with the same format as the one from livecd-rootfs.
Difference with the current manifest:

Use tab instead of space in the manifest
Add snaps to the manifest

codecov · 2026-02-16T14:46:33Z

Codecov Report

❌ Patch coverage is 90.27778% with 7 lines in your changes missing coverage. Please review.
✅ Project coverage is 93.47%. Comparing base (3533000) to head (654bf4b).
⚠️ Report is 15 commits behind head on main.

Files with missing lines	Patch %	Lines
internal/statemachine/helper.go	88.67%	3 Missing and 3 partials ⚠️
internal/helper/helper.go	83.33%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #288      +/-   ##
==========================================
- Coverage   93.49%   93.47%   -0.03%     
==========================================
  Files          19       19              
  Lines        3552     3602      +50     
==========================================
+ Hits         3321     3367      +46     
- Misses        151      153       +2     
- Partials       80       82       +2

Flag	Coverage Δ
unittests	`93.47% <90.27%> (-0.03%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

fhost · 2026-02-16T14:53:44Z

(I'll do the coverage if you do accept the modification)

mwhudson · 2026-02-18T00:56:26Z

 }

+// GenerateClassicManifest generate the classic manifest file for the given rootfs
+func GenerateClassicManifest(rootfs string, outputPath string, debug bool) error {


does this need to be exported?

Yes, it is used in classic_state.go.

that's in the same package though? my Go is a bit rusty but I'm not that out of it yet!

My Go is a bit too new, so I did not know it works like this :)

mwhudson

i do want you to unexport GenerateClassicManifest please

mwhudson · 2026-02-19T03:37:46Z

 }

+// GenerateClassicManifest generate the classic manifest file for the given rootfs
+func GenerateClassicManifest(rootfs string, outputPath string, debug bool) error {


that's in the same package though? my Go is a bit rusty but I'm not that out of it yet!

upils

The manifest currently produced is very likely consumed by some tools by some people. So this change would be a breaking change due to the 2 changes you mention in the description. I would like to avoid that if possible.

I am more inclined to post-process the output than change it. We have unfortunately no way to express the format version so this will be a surprising change for users.

I assume the space->tab issue could be solved with a call to sed. Is that so or is that more complex?
Also, in the README, it is clearly stated that the manifest lists packages, the current proposition would change this definition.

I agree the snaps list is currently missing and that would be nice to extract it. What do you think of generating another separate "snaps.manifest" file, listing snaps (and maybe using the tab separator?)? A bit a thinking is needed to define how that would be expressed in the image definition file but we can discuss it.
With that, the post-process would also be trivial before calling sbom-generate.

fhost · 2026-02-25T12:27:22Z

The manifest currently produced is very likely consumed by some tools by some people. So this change would be a breaking change due to the 2 changes you mention in the description. I would like to avoid that if possible.

It is what I'm afraid of.

I am more inclined to post-process the output than change it. We have unfortunately no way to express the format version so this will be a surprising change for users.

I assume the space->tab issue could be solved with a call to sed. Is that so or is that more complex? Also, in the README, it is clearly stated that the manifest lists packages, the current proposition would change this definition.

I guess the tab/space issue could be also solved on sbom side (i.e. accepting both). But we do need the snap list.

I agree the snaps list is currently missing and that would be nice to extract it. What do you think of generating another separate "snaps.manifest" file, listing snaps (and maybe using the tab separator?)? A bit a thinking is needed to define how that would be expressed in the image definition file but we can discuss it. With that, the post-process would also be trivial before calling sbom-generate.

Could we add another artifact entry and generates that manifest (tab + snap) if specified? Not sure about a name tho, as it is also a manifest ^^´

artifacts:
  img:
    - name: ubuntu-24.04-preinstalled-server-arm64+dragonwing.img
  manifest:
    name: ubuntu-24.04-preinstalled-server-arm64+dragonwing.manifest
  full-manifest:
    name: buntu-24.04-preinstalled-server-arm64+dragonwing-with-snap-and-tabs.manifest

upils · 2026-02-25T14:39:46Z

Could we add another artifact entry and generates that manifest (tab + snap) if specified?

This is another possibility but as you pointed out it might be tricky to find a good name (because the concept might be hard to express, which might indicate something is fishy). Side note: this is unlikely, but if we ever add another kind of object, the "full-manifest" name might be misleading or might see its definition change.

Another approach would be to add a new "manifest-v2" (name TBD here too) that would accept a list of "kinds" (package,snap, etc.). So users could express precisely what they want in the manifest. Drawbacks:

This might be giving too much freedom to users
There is no good default

fhost · 2026-02-26T08:44:21Z

This is another possibility but as you pointed out it might be tricky to find a good name (because the concept might be hard to express, which might indicate something is fishy). Side note: this is unlikely, but if we ever add another kind of object, the "full-manifest" name might be misleading or might see its definition change.

The fishy part is that we have different tools that output different manfiests and we're trying to align them ^^´
And yes, "full-manifest" is not a good name. Maybe the "manifest-v2" is a good name. It's just another "format" for the manifest. And you're using "manifest" to get the legacy manifest or "manifest-v2" to get the "new" one.

Another approach would be to add a new "manifest-v2" (name TBD here too) that would accept a list of "kinds" (package,snap, etc.). So users could express precisely what they want in the manifest. Drawbacks:
* This might be giving too much freedom to users

* There is no good default

Yeah, the point is to have the same manifest format everywhere, so I don't think it is a good idea to give user customization.

fhost · 2026-05-28T16:38:46Z

Added manifest-v2 (we can change the name later). This way it doesn't break anything.

And I don't understand what is failing from the tests, there is no FAIL: :(

Copilot

Pull request overview

This PR updates classic image manifest generation to optionally produce a “v2” manifest that matches the livecd-rootfs format (tab-separated package entries and inclusion of snap seed entries).

Changes:

Add manifest-v2 as a new classic artifact and implement generateClassicManifestV2 to append snap seed info from seed.yaml.
Refactor classic manifest generation to use helper functions instead of inline chroot dpkg-query calls.
Extend tests/mocks to cover the v2 manifest output format.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
internal/statemachine/helper.go	Adds classic manifest generator helpers, including v2 logic and snap seed parsing.
internal/statemachine/classic_states.go	Updates `generatePackageManifest()` to generate v1 and/or v2 manifests based on artifacts.
internal/statemachine/classic.go	Adds manifest-v2 artifact support when assembling classic artifact states.
internal/statemachine/classic_test.go	Converts manifest testing into table-driven cases and adds v2 expectations (including snaps).
internal/statemachine/state_machine_test.go	Extends the exec helper process to return tab-separated dpkg output for the v2 test case.
internal/imagedefinition/image_definition.go	Adds `ManifestV2` to the artifact schema (`manifest-v2`).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Copilot

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.

fhost · 2026-05-29T15:30:26Z

Fixed Copilot reviews, I still don't understand why short tests are failing?

upils

Overall it LGTM, thanks @fhost!

See my comments for some suggestions. Can you also:

fix the linter errors
add a changelog entry
update the snapcraft.yaml conf

I was unable to reproduce the test failure locally. Let's see after pushing your fixes if this is still breaking.

upils · 2026-06-01T09:39:52Z

+			File    string `yaml:"file"`
+			Name    string `yaml:"name"`
+			Channel string `yaml:"channel"`


suggestion: did you consider using https://github.com/canonical/snapd/blob/master/seed/seed.go#L50 instead of defining a new type here? This might make it easier to maintain over time.

No I did not, I'll take a look.

So my modification to use the Seed class is working, but that break the test as just having the seed file is probably not enough now.

I don't know how to test >.< I don't know what is required, but I guess at least the snaps in the seed file in the snaps/ directory. I'll test with snapd, but I don't think adding snapd into the repository for testing is a good idea... If the file is enough, maybe I should make an empty example snap?

Okay, I've just mocked the Seed directly!

I did not expect such a big change when I suggested that, I thought unmarshaling into the Seed type from the snapd lib was going to be enough. It looks fine though and I guess that was the cleaner way to do it.

It was enough for running, not for testing ^^´

Copilot

Pull request overview

Copilot reviewed 11 out of 11 changed files in this pull request and generated 2 comments.

upils

LGTM. I am waiting for the base on main and the rerun of the CI to see if unit tests pass.

Make the classic image manifest follow the same format as the one from livecd-rootfs. Changes: * Use tab instead of space in the manifest * Add snaps to the manifest

fhost requested review from mwhudson and upils February 13, 2026 22:36

fhost force-pushed the fhost/manifest branch 3 times, most recently from 2031a11 to b3228f7 Compare February 16, 2026 14:43

mwhudson reviewed Feb 18, 2026

View reviewed changes

fhost requested a review from mwhudson February 18, 2026 09:39

mwhudson requested changes Feb 19, 2026

View reviewed changes

fhost force-pushed the fhost/manifest branch from b3228f7 to 7d550e6 Compare February 19, 2026 09:39

fhost requested a review from mwhudson February 19, 2026 09:39

upils requested changes Feb 25, 2026

View reviewed changes

Comment thread internal/statemachine/helper.go Outdated

fhost force-pushed the fhost/manifest branch 2 times, most recently from c726e9b to b937ee8 Compare May 28, 2026 16:32

fhost requested a review from upils May 28, 2026 16:39

upils requested a review from Copilot May 29, 2026 13:59

Copilot started reviewing on behalf of upils May 29, 2026 13:59 View session

Copilot AI reviewed May 29, 2026

View reviewed changes

fhost force-pushed the fhost/manifest branch from dcbe8fa to dd584e7 Compare May 29, 2026 14:55

fhost requested a review from Copilot May 29, 2026 14:55

Copilot started reviewing on behalf of fhost May 29, 2026 14:56 View session

Copilot AI reviewed May 29, 2026

View reviewed changes

Comment thread internal/statemachine/helper.go Outdated

Comment thread internal/imagedefinition/image_definition.go

fhost force-pushed the fhost/manifest branch from 7b2c39d to c305ed1 Compare May 29, 2026 15:13

fhost requested a review from Copilot May 29, 2026 15:14

Copilot started reviewing on behalf of fhost May 29, 2026 15:14 View session

Copilot AI reviewed May 29, 2026

View reviewed changes

Comment thread internal/statemachine/helper.go

Comment thread internal/imagedefinition/README.rst

Comment thread internal/statemachine/classic_states.go

fhost changed the title ~~i/statemachine: fix manifest generation for classic image~~ i/statemachine: add manifest-v2 to align with livecd-rootfs format May 29, 2026

fhost force-pushed the fhost/manifest branch from 8dd99c7 to d56847f Compare May 29, 2026 15:24

upils requested changes Jun 1, 2026

View reviewed changes

fhost force-pushed the fhost/manifest branch 2 times, most recently from 03fa94b to 7b88ce4 Compare June 1, 2026 23:17

fhost force-pushed the fhost/manifest branch from 37f05cc to 9df65c1 Compare June 12, 2026 14:11

fhost requested a review from Copilot June 12, 2026 15:32

Copilot started reviewing on behalf of fhost June 12, 2026 15:33 View session

Copilot AI reviewed Jun 12, 2026

View reviewed changes

Comment thread debian/changelog Outdated

Comment thread internal/statemachine/helper.go

fhost force-pushed the fhost/manifest branch from c86e3a8 to 8cfbb6c Compare June 12, 2026 15:42

fhost requested a review from upils June 12, 2026 15:42

upils previously approved these changes Jun 25, 2026

View reviewed changes

fhost added 2 commits June 25, 2026 10:37

i/statemachine: fix manifest generation for classic image

76fe0f6

Make the classic image manifest follow the same format as the one from livecd-rootfs. Changes: * Use tab instead of space in the manifest * Add snaps to the manifest

i/statemachine: add manifest-v2 instead of replacing manifest

3fc1848

fhost force-pushed the fhost/manifest branch from 8cfbb6c to 901b161 Compare June 25, 2026 08:37

fhost dismissed upils’s stale review via 538720e June 25, 2026 17:00

fhost added 3 commits June 25, 2026 19:09

i/statemachine: use existing seed class to parse seed

9c1c4e7

internal/helper: Fix linter errors

a6e44c5

snapcraft, debian: bump version to 3.10.9

654bf4b

fhost force-pushed the fhost/manifest branch from 538720e to 654bf4b Compare June 25, 2026 17:09

upils merged commit 27aa535 into main Jun 26, 2026
8 of 20 checks passed

upils deleted the fhost/manifest branch June 26, 2026 06:59

Uh oh!

Conversation

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

Uh oh!

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

fhost commented Feb 16, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mwhudson left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

upils left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

fhost commented Feb 25, 2026

Uh oh!

upils commented Feb 25, 2026

Uh oh!

fhost commented Feb 26, 2026

Uh oh!

fhost commented May 28, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fhost commented May 29, 2026

Uh oh!

upils left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

fhost commented Feb 13, 2026 •

edited

Loading

codecov Bot commented Feb 16, 2026 •

edited

Loading

upils Jun 24, 2026 •

edited

Loading