Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,15 @@ Optional.
The type of artifact being injected. This field helps users identify which signing
process to apply to each artifact.

For supported values, see [`output.artifacts.items`](./outputArtifacts.md#items-string).
Supported values:

- `ukis` – UKI PE images.
- `uki-addons` – UKI addon files (`vmlinuz-<version>.addon.efi`). These are
automatically generated when `ukis` is specified in
[`output.artifacts.items`](./outputArtifacts.md#items-string) and the base image
contains UKI addon files.
- `shim` – Bootloader shim executable.
- `bootloader` – Bootloader executable (grub or systemd-boot).
- `verity-hash` – Verity hash files.

Added in v1.1.
1 change: 1 addition & 0 deletions run-tests.sh
2 changes: 1 addition & 1 deletion toolkit/tools/imagecustomizerapi/artifacts.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ func (a *Artifacts) IsValid() error {
}

for _, item := range a.Items {
if err := item.IsValid(); err != nil {
if err := item.IsValidOutputItem(); err != nil {
return err
}
}
Expand Down
14 changes: 14 additions & 0 deletions toolkit/tools/imagecustomizerapi/outputartifactsitemtype.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,17 @@ func (i OutputArtifactsItemType) IsValid() error {
return fmt.Errorf("invalid item value (%v)", i)
}
}

// IsValidOutputItem validates that the item is a user-selectable output artifact type.
// The uki-addons type is excluded because addon files are automatically included
// when ukis is specified. The uki-addons type is only valid as an inject-files
// metadata type.
func (i OutputArtifactsItemType) IsValidOutputItem() error {
switch i {
case OutputArtifactsItemUkis, OutputArtifactsItemShim, OutputArtifactsItemBootloader, OutputArtifactsItemVerityHash,
OutputArtifactsItemDefault:
return nil
default:
return fmt.Errorf("invalid item value (%v)", i)
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@ import (
"github.com/stretchr/testify/assert"
)

func TestItemIsValid_ValidItems(t *testing.T) {
func TestOutputArtifactsItemTypeIsValid_ValidItems_Pass(t *testing.T) {
validItems := []OutputArtifactsItemType{
OutputArtifactsItemUkis,
OutputArtifactsItemUkiAddons,
OutputArtifactsItemShim,
OutputArtifactsItemBootloader,
OutputArtifactsItemVerityHash,
Expand All @@ -24,9 +25,37 @@ func TestItemIsValid_ValidItems(t *testing.T) {
}
}

func TestItemIsValid_InvalidItem(t *testing.T) {
func TestOutputArtifactsItemTypeIsValid_InvalidItem_Fail(t *testing.T) {
invalidItem := OutputArtifactsItemType("invalidItem")
err := invalidItem.IsValid()
assert.Error(t, err)
assert.ErrorContains(t, err, "invalid item value")
}

func TestOutputArtifactsItemTypeIsValidOutputItem_ValidItems_Pass(t *testing.T) {
validItems := []OutputArtifactsItemType{
OutputArtifactsItemUkis,
OutputArtifactsItemShim,
OutputArtifactsItemBootloader,
OutputArtifactsItemVerityHash,
OutputArtifactsItemDefault,
}

for _, item := range validItems {
err := item.IsValidOutputItem()
assert.NoError(t, err, "valid output item should not return an error: %s", item)
}
}

func TestOutputArtifactsItemTypeIsValidOutputItem_UkiAddons_Fail(t *testing.T) {
err := OutputArtifactsItemUkiAddons.IsValidOutputItem()
assert.Error(t, err)
assert.ErrorContains(t, err, "uki-addons are automatically included with ukis")
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I am not seeing the uki-addons are automatically included with ukis error in the IsValidOutputItem function.

}

func TestOutputArtifactsItemTypeIsValidOutputItem_InvalidItem_Fail(t *testing.T) {
invalidItem := OutputArtifactsItemType("invalidItem")
err := invalidItem.IsValidOutputItem()
assert.Error(t, err)
assert.ErrorContains(t, err, "invalid item value")
}
Loading