Skip to content

Always include layers field, even if there are no layers in ModelKit #1291

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
amisevsk wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Always include layers field, even if there are no layers in ModelKit #1291

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions pkg/lib/filesystem/local-storage.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,8 @@ func saveConfig(ctx context.Context, target oras.Target, kitfile *artifact.KitFi
}

func saveKitfileLayers(ctx context.Context, target oras.Target, kitfile *artifact.KitFile, ignore ignore.Paths, opts *SaveModelOptions) (layers []ocispec.Descriptor, diffIDs []digest.Digest, err error) {
layers = []ocispec.Descriptor{}
diffIDs = []digest.Digest{}
toVerifyRemote := map[string]s3api.S3ObjectReference{}
if kitfile.Model != nil {
if kitfile.Model.Path != "" && !artifact.IsModelKitReference(kitfile.Model.Path) {
Expand Down Expand Up @@ -266,6 +268,11 @@ func saveKitfileLayers(ctx context.Context, target oras.Target, kitfile *artifac
}
}

// If ModelKit is actually empty (i.e. no remote datasets or Model references), warn the user
if len(layers) == 0 && len(kitfile.DataSets) == 0 && (kitfile.Model == nil || !artifact.IsModelKitReference(kitfile.Model.Path)) {
output.Logf(output.LogLevelWarn, "ModelKit contains no layers")
}

return layers, diffIDs, nil
}

Expand Down
30 changes: 30 additions & 0 deletions pkg/lib/filesystem/local-storage_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ package filesystem

import (
"context"
"encoding/json"
"os"
"path/filepath"
"testing"
Expand All @@ -27,7 +28,9 @@ import (
"github.com/kitops-ml/kitops/pkg/lib/filesystem/cache"
"github.com/kitops-ml/kitops/pkg/lib/filesystem/ignore"

ocispec "github.com/opencontainers/image-spec/specs-go/v1"
"github.com/stretchr/testify/require"
"oras.land/oras-go/v2/content"
"oras.land/oras-go/v2/content/memory"
)

Expand Down Expand Up @@ -65,3 +68,30 @@ func TestSaveModelToNonLocalTarget(t *testing.T) {
require.NoError(t, err)
require.True(t, exists, "manifest should be pushed directly to the target")
}

func TestSaveModelWithNoLayers(t *testing.T) {
tmpDir := t.TempDir()
cache.SetCacheHome(t.TempDir())
t.Cleanup(func() { cache.SetCacheHome(os.TempDir()) })
t.Chdir(tmpDir)

kitfile := &artifact.KitFile{ManifestVersion: "1.0.0"}
ignorePaths, err := ignore.NewFromContext(tmpDir, kitfile)
require.NoError(t, err)

target := memory.New()
ctx := context.Background()
manifestDesc, err := SaveModel(ctx, target, kitfile, ignorePaths, &SaveModelOptions{
ModelFormat: mediatype.KitFormat,
Compression: mediatype.NoneCompression,
LayerFormat: mediatype.TarFormat,
})
require.NoError(t, err)

manifestBytes, err := content.FetchAll(ctx, target, *manifestDesc)
require.NoError(t, err)
var manifest ocispec.Manifest
require.NoError(t, json.Unmarshal(manifestBytes, &manifest))
require.NotNil(t, manifest.Layers)
require.Empty(t, manifest.Layers)
}
Loading