Skip to content
Merged
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
93 changes: 10 additions & 83 deletions cmd/feature/publish.go
Original file line number Diff line number Diff line change
@@ -1,27 +1,16 @@
package feature

import (
"bytes"
"encoding/json"
"fmt"
"io"
"os"
"path/filepath"

"github.com/devsy-org/devsy/cmd/flags"
"github.com/devsy-org/devsy/pkg/devcontainer/config"
"github.com/devsy-org/devsy/pkg/extract"
cliflags "github.com/devsy-org/devsy/pkg/flags"
"github.com/devsy-org/devsy/pkg/flags/names"
"github.com/devsy-org/devsy/pkg/image"
"github.com/devsy-org/devsy/pkg/log"
"github.com/google/go-containerregistry/pkg/authn"
"github.com/google/go-containerregistry/pkg/name"
v1 "github.com/google/go-containerregistry/pkg/v1"
"github.com/google/go-containerregistry/pkg/v1/empty"
"github.com/google/go-containerregistry/pkg/v1/mutate"
"github.com/google/go-containerregistry/pkg/v1/remote"
"github.com/google/go-containerregistry/pkg/v1/stream"
"github.com/google/go-containerregistry/pkg/v1/types"
"github.com/spf13/cobra"
)

Expand Down Expand Up @@ -80,46 +69,29 @@ func runPublish(f *PublishFlags) error {
return err
}

version := featureCfg.Version
if version == "" {
version = "latest"
}
version := image.ResolvePublishVersion(featureCfg.Version)

ref, err := parsePublishRef(f.Registry, f.Namespace, featureCfg.ID, version)
ref, err := image.ParsePublishReference(f.Registry, f.Namespace, featureCfg.ID, version)
if err != nil {
return err
}

log.Infof("publishing feature %q to %s", featureCfg.ID, ref.String())

img, err := buildFeatureImage(target)
img, err := image.BuildPublishImage("feature", target)
if err != nil {
return err
}

if err := remote.Write(
ref, img, remote.WithAuthFromKeychain(authn.DefaultKeychain),
); err != nil {
return fmt.Errorf("push feature to registry: %w", err)
if err := image.PushPublishImage("feature", ref, img); err != nil {
return err
}

log.Infof("feature published successfully: %s", ref.String())

metadata := publishedFeatureMetadata{
return image.WritePublishedMetadata(os.Stdout, publishedFeatureMetadata{
ID: featureCfg.ID,
Version: version,
Ref: ref.String(),
}

metadataJSON, err := json.MarshalIndent(metadata, "", " ")
if err != nil {
return fmt.Errorf("marshal published metadata: %w", err)
}

_, _ = os.Stdout.Write(metadataJSON)
_, _ = os.Stdout.WriteString("\n")

return nil
})
}

type publishedFeatureMetadata struct {
Expand All @@ -129,13 +101,8 @@ type publishedFeatureMetadata struct {
}

func validatePublishTarget(target string) (*config.FeatureConfig, error) {
stat, err := os.Stat(target)
if err != nil {
return nil, fmt.Errorf("stat target: %w", err)
}

if !stat.IsDir() {
return nil, fmt.Errorf("target must be a directory: %s", target)
if err := image.ValidatePublishDir(target); err != nil {
return nil, err
}

featureCfg, err := config.ParseDevContainerFeature(target)
Expand All @@ -145,43 +112,3 @@ func validatePublishTarget(target string) (*config.FeatureConfig, error) {

return featureCfg, nil
}

func parsePublishRef(
registry, namespace, id, version string,
) (name.Reference, error) {
refStr := buildPublishReference(registry, namespace, id, version)

ref, err := name.ParseReference(refStr)
if err != nil {
return nil, fmt.Errorf("parse publish reference %q: %w", refStr, err)
}

return ref, nil
}

func buildPublishReference(registry, namespace, id, version string) string {
if namespace != "" {
return fmt.Sprintf("%s/%s/%s:%s", registry, namespace, id, version)
}

return fmt.Sprintf("%s/%s:%s", registry, id, version)
}

func buildFeatureImage(sourceDir string) (v1.Image, error) {
var buf bytes.Buffer
if err := extract.WriteTar(&buf, sourceDir, true); err != nil {
return nil, fmt.Errorf("create feature archive: %w", err)
}

layer := stream.NewLayer(
io.NopCloser(bytes.NewReader(buf.Bytes())),
stream.WithMediaType(types.OCILayer),
)

img, err := mutate.AppendLayers(empty.Image, layer)
if err != nil {
return nil, fmt.Errorf("build feature image: %w", err)
}

return img, nil
}
90 changes: 2 additions & 88 deletions cmd/feature/publish_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,8 @@ import (
)

const (
testRegistry = "ghcr.io"
testVersion = "1.0.0"
testFeatureNode = "node"
testRegistry = "ghcr.io"
testVersion = "1.0.0"
)

func TestPublishCmd_FlagDefaults(t *testing.T) {
Expand Down Expand Up @@ -49,56 +48,6 @@ func TestPublishCmd_TargetRequired(t *testing.T) {
require.Contains(t, annotations, "cobra_annotation_bash_completion_one_required_flag")
}

func TestBuildPublishReference(t *testing.T) {
tests := []struct {
name string
registry string
namespace string
id string
version string
want string
}{
{
name: "with namespace",
registry: testRegistry,
namespace: "devcontainers/features",
id: "go",
version: testVersion,
want: testRegistry + "/devcontainers/features/go:" + testVersion,
},
{
name: "without namespace",
registry: testRegistry,
id: "go",
version: testVersion,
want: testRegistry + "/go:" + testVersion,
},
{
name: "custom registry",
registry: "registry.example.com",
namespace: "my-org/features",
id: testFeatureNode,
version: "2.0.0",
want: "registry.example.com/my-org/features/" + testFeatureNode + ":2.0.0",
},
{
name: "latest version",
registry: testRegistry,
namespace: "test",
id: "python",
version: "latest",
want: testRegistry + "/test/python:latest",
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got := buildPublishReference(tt.registry, tt.namespace, tt.id, tt.version)
assert.Equal(t, tt.want, got)
})
}
}

func TestValidatePublishTarget_NotADirectory(t *testing.T) {
tmpFile := filepath.Join(t.TempDir(), "not-a-dir.txt")
require.NoError(t, os.WriteFile(tmpFile, []byte("hello"), 0o600))
Expand Down Expand Up @@ -148,38 +97,3 @@ func TestValidatePublishTarget_NonexistentPath(t *testing.T) {
require.Error(t, err)
assert.Contains(t, err.Error(), "stat target")
}

func TestBuildFeatureImage(t *testing.T) {
tmpDir := t.TempDir()
require.NoError(t, os.WriteFile(
filepath.Join(tmpDir, "devcontainer-feature.json"),
[]byte(`{"id": "go", "version": "1.0.0"}`),
0o600,
))
// #nosec G306 -- test install script must be executable
require.NoError(t, os.WriteFile(
filepath.Join(tmpDir, "install.sh"),
[]byte("#!/bin/bash\necho hello\n"),
0o750,
))

img, err := buildFeatureImage(tmpDir)
require.NoError(t, err)
require.NotNil(t, img)

layers, err := img.Layers()
require.NoError(t, err)
assert.Len(t, layers, 1)
}

func TestParsePublishRef_Valid(t *testing.T) {
ref, err := parsePublishRef(testRegistry, "devcontainers/features", "go", testVersion)
require.NoError(t, err)
assert.Contains(t, ref.String(), testRegistry+"/devcontainers/features/go:"+testVersion)
}

func TestParsePublishRef_Invalid(t *testing.T) {
_, err := parsePublishRef("", "", "INVALID REF!!!", "")
require.Error(t, err)
assert.Contains(t, err.Error(), "parse publish reference")
}
89 changes: 9 additions & 80 deletions cmd/template/publish.go
Original file line number Diff line number Diff line change
@@ -1,26 +1,15 @@
package template

import (
"bytes"
"encoding/json"
"fmt"
"io"
"os"
"path/filepath"

"github.com/devsy-org/devsy/cmd/flags"
"github.com/devsy-org/devsy/pkg/extract"
cliflags "github.com/devsy-org/devsy/pkg/flags"
"github.com/devsy-org/devsy/pkg/flags/names"
"github.com/devsy-org/devsy/pkg/image"
"github.com/devsy-org/devsy/pkg/log"
"github.com/google/go-containerregistry/pkg/authn"
"github.com/google/go-containerregistry/pkg/name"
v1 "github.com/google/go-containerregistry/pkg/v1"
"github.com/google/go-containerregistry/pkg/v1/empty"
"github.com/google/go-containerregistry/pkg/v1/mutate"
"github.com/google/go-containerregistry/pkg/v1/remote"
"github.com/google/go-containerregistry/pkg/v1/stream"
"github.com/google/go-containerregistry/pkg/v1/types"
"github.com/spf13/cobra"
)

Expand Down Expand Up @@ -72,50 +61,30 @@ func runPublish(f *PublishFlags) error {
return err
}

version := metadata.Version
if version == "" {
version = "latest"
}
version := image.ResolvePublishVersion(metadata.Version)

ref, err := parsePublishRef(f.Registry, f.Namespace, metadata.ID, version)
ref, err := image.ParsePublishReference(f.Registry, f.Namespace, metadata.ID, version)
if err != nil {
return err
}

log.Infof("publishing template %q to %s", metadata.ID, ref.String())

img, err := buildTemplateImage(target)
img, err := image.BuildPublishImage("template", target)
if err != nil {
return err
}

if err := remote.Write(
ref, img, remote.WithAuthFromKeychain(authn.DefaultKeychain),
); err != nil {
return fmt.Errorf("push template to registry: %w", err)
}

log.Infof("template published successfully: %s", ref.String())

metadataJSON, err := json.MarshalIndent(metadata, "", " ")
if err != nil {
return fmt.Errorf("marshal published metadata: %w", err)
if err := image.PushPublishImage("template", ref, img); err != nil {
return err
}

_, _ = os.Stdout.Write(metadataJSON)
_, _ = os.Stdout.WriteString("\n")

return nil
return image.WritePublishedMetadata(os.Stdout, metadata)
}

func validatePublishTarget(target string) (*TemplateMetadata, error) {
stat, err := os.Stat(target)
if err != nil {
return nil, fmt.Errorf("stat target: %w", err)
}

if !stat.IsDir() {
return nil, fmt.Errorf("target must be a directory: %s", target)
if err := image.ValidatePublishDir(target); err != nil {
return nil, err
}

metadata, err := readTemplateMetadata(target)
Expand All @@ -129,43 +98,3 @@ func validatePublishTarget(target string) (*TemplateMetadata, error) {

return metadata, nil
}

func parsePublishRef(
registry, namespace, id, version string,
) (name.Reference, error) {
refStr := buildPublishReference(registry, namespace, id, version)

ref, err := name.ParseReference(refStr)
if err != nil {
return nil, fmt.Errorf("parse publish reference %q: %w", refStr, err)
}

return ref, nil
}

func buildPublishReference(registry, namespace, id, version string) string {
if namespace != "" {
return fmt.Sprintf("%s/%s/%s:%s", registry, namespace, id, version)
}

return fmt.Sprintf("%s/%s:%s", registry, id, version)
}

func buildTemplateImage(sourceDir string) (v1.Image, error) {
var buf bytes.Buffer
if err := extract.WriteTar(&buf, sourceDir, true); err != nil {
return nil, fmt.Errorf("create template archive: %w", err)
}

layer := stream.NewLayer(
io.NopCloser(bytes.NewReader(buf.Bytes())),
stream.WithMediaType(types.OCILayer),
)

img, err := mutate.AppendLayers(empty.Image, layer)
if err != nil {
return nil, fmt.Errorf("build template image: %w", err)
}

return img, nil
}
Loading
Loading