Move pods directory from .spice/pods to ./spicepods (#128)

.github/workflows/e2e_test.yml

@@ -210,7 +210,7 @@ jobs:
           export SPICE_DEEPRL_ALGORITHM="${{ matrix.algorithm }}"
           ./spice version --context ${{ matrix.context }}
           ./spice add test/Trader@0.2.0
-          ./spice train .spice/pods/trader.yaml --context ${{ matrix.context }}
+          ./spice train spicepods/trader.yaml --context ${{ matrix.context }}
 
   end-to-end:
     name: end-to-end test

.gitignore

@@ -11,6 +11,7 @@ cmd/spice/data
 cmd/spiced/spiced
 cmd/spiced/.spice
 cmd/spiced/data
+spicepods
 
 # Debug binaries
 __debug_bin

README.md

@@ -98,7 +98,7 @@ In the original terminal instance, add the LogPruner sample pod:
 spice add quickstarts/logpruner
 ```
 
-The Spice CLI will download the LogPruner sample pod manifest and add it to your project at `.spice/pods/logpruner.yaml`.
+The Spice CLI will download the LogPruner sample pod manifest and add it to your project at `spicepods/logpruner.yaml`.
 
 The Spice.ai runtime will then automatically detect the manifest and start your first training run!
 

pkg/cli/cli_test.go

@@ -66,10 +66,10 @@ func testInit(root *cobra.Command) func(*testing.T) {
 	return func(t *testing.T) {
 		_, err := executeCommand(root, "init", "foo")
 		assert.NoError(t, err)
-		_, err = os.Stat(".spice/pods/foo.yaml")
+		_, err = os.Stat("spicepods/foo.yaml")
 		assert.NoError(t, err)
 
-		_, err = pods.LoadPodFromManifest(".spice/pods/foo.yaml")
+		_, err = pods.LoadPodFromManifest("spicepods/foo.yaml")
 		assert.NoError(t, err)
 	}
 }
@@ -80,7 +80,7 @@ func testActionAddCmd(root *cobra.Command) func(*testing.T) {
 		_, err := executeCommand(root, "action", "add", "jump")
 		assert.NoError(t, err)
 
-		pod, err := pods.LoadPodFromManifest(".spice/pods/foo.yaml")
+		pod, err := pods.LoadPodFromManifest("spicepods/foo.yaml")
 		assert.NoError(t, err)
 
 		assert.Contains(t, pod.Actions(), "jump")
@@ -93,7 +93,7 @@ func testRewardsAddCmd(root *cobra.Command) func(*testing.T) {
 		_, err := executeCommand(root, "reward", "add")
 		assert.NoError(t, err)
 
-		pod, err := pods.LoadPodFromManifest(".spice/pods/foo.yaml")
+		pod, err := pods.LoadPodFromManifest("spicepods/foo.yaml")
 		assert.NoError(t, err)
 
 		assert.Contains(t, pod.Rewards(), "jump")

pkg/constants/constants.go

@@ -1,10 +1,11 @@
 package constants
 
 const (
-	DotSpice              = ".spice"
-	SpiceConfigBaseName   = "spice.config"
-	SpiceRuntimeFilename  = "spiced"
-	SpicePodFileExtension = ".spicepod"
-	PythonCmd             = "python3"
-	SpiceEnvVarPrefix     = "SPICE_"
+	DotSpice               = ".spice"
+	SpiceConfigBaseName    = "spice.config"
+	SpicePodsDirectoryName = "spicepods"
+	SpiceRuntimeFilename   = "spiced"
+	SpicePodFileExtension  = ".spicepod"
+	PythonCmd              = "python3"
+	SpiceEnvVarPrefix      = "SPICE_"
 )

pkg/context/docker/docker.go

@@ -31,7 +31,7 @@ const (
 
 func NewDockerContext() *DockerContext {
 	spiceBinDir := path.Join(dockerSpiceRuntimePath, "bin")
-	podsDir := path.Join(dockerAppPath, constants.DotSpice, "pods")
+	podsDir := path.Join(dockerAppPath, constants.SpicePodsDirectoryName)
 
 	return &DockerContext{
 		spiceBinDir: spiceBinDir,

pkg/context/metal/metal.go

@@ -66,7 +66,7 @@ func (c *MetalContext) Init() error {
 		return err
 	}
 	c.appDir = cwd
-	c.podsDir = filepath.Join(c.appDir, constants.DotSpice, "pods")
+	c.podsDir = filepath.Join(c.appDir, constants.SpicePodsDirectoryName)
 
 	return nil
 }

pkg/registry/local_file.go

@@ -1,11 +1,14 @@
 package registry
 
 import (
+	"errors"
 	"fmt"
 	"io/ioutil"
+	"os"
 	"path/filepath"
 
 	"github.com/spiceai/spiceai/pkg/context"
+	"github.com/spiceai/spiceai/pkg/util"
 )
 
 type LocalFileRegistry struct{}
@@ -16,6 +19,17 @@ func (r *LocalFileRegistry) GetPod(podPath string) (string, error) {
 		return "", fmt.Errorf("pod not found at %s: %w", podPath, err)
 	}
 
+	podsDir := context.CurrentContext().PodsDir()
+	if _, err = os.Stat(podsDir); err != nil {
+		if !errors.Is(err, os.ErrNotExist) {
+			return "", fmt.Errorf("error fetching pod %s: %w", podPath, err)
+		}
+		_, err = util.MkDirAllInheritPerm(podsDir)
+		if err != nil {
+			return "", fmt.Errorf("error fetching pod %s: %w", podPath, err)
+		}
+	}
+
 	podManifestFileName := filepath.Base(podPath)
 
 	podManifestPath := filepath.Join(context.CurrentContext().PodsDir(), podManifestFileName)

pkg/registry/registry_test.go

@@ -1,8 +1,10 @@
 package registry_test
 
 import (
+	"os"
 	"testing"
 
+	"github.com/spiceai/spiceai/pkg/constants"
 	"github.com/spiceai/spiceai/pkg/pods"
 	"github.com/spiceai/spiceai/pkg/registry"
 	"github.com/spiceai/spiceai/pkg/testutils"
@@ -21,8 +23,9 @@ func testGetPod() func(*testing.T) {
 		r := registry.GetRegistry(manifestPath)
 		_, err := r.GetPod(manifestPath)
 		assert.NoError(t, err)
+		defer os.RemoveAll(constants.SpicePodsDirectoryName)
 
-		pod, err := pods.LoadPodFromManifest(".spice/pods/trader.yaml")
+		pod, err := pods.LoadPodFromManifest("spicepods/trader.yaml")
 		if assert.NoError(t, err) {
 			assert.Contains(t, pod.Name, "trader")
 		}

pkg/runtime/runtime.go

@@ -147,7 +147,7 @@ func (r *SpiceRuntime) scanForPods() error {
 	podsManifestDir := context.CurrentContext().PodsDir()
 	_, err = os.Stat(podsManifestDir)
 	if err != nil {
-		// No .spice/pods means no pods
+		// No spicepods means no pods
 		return nil
 	}