Jm/ex - Extension support added (local).

MAINTAINERS.md

@@ -1,2 +1,3 @@
 - Shivansh Vij <shivanshvij@loopholelabs.io> @shivanshvij
 - Dan Phillips <dan@loopholelabs.io> @dphilla
+- Jimmy Moore <jamesmoore@loopholelabs.io> @jimmyaxod

cmd/cmd.go

@@ -20,6 +20,7 @@ import (
 	"github.com/loopholelabs/cmdutils/pkg/command"
 	"github.com/loopholelabs/scale-cli/cmd/access"
 	"github.com/loopholelabs/scale-cli/cmd/auth"
+	"github.com/loopholelabs/scale-cli/cmd/extension"
 	"github.com/loopholelabs/scale-cli/cmd/function"
 	"github.com/loopholelabs/scale-cli/cmd/registry"
 	"github.com/loopholelabs/scale-cli/cmd/signature"
@@ -35,5 +36,5 @@ var Cmd = command.New[*config.Config](
 	true,
 	version.V,
 	config.New,
-	[]command.SetupCommand[*config.Config]{access.Cmd(), auth.Cmd(), registry.Cmd(), function.Cmd(), signature.Cmd(), update.Cmd()},
+	[]command.SetupCommand[*config.Config]{access.Cmd(), auth.Cmd(), registry.Cmd(), function.Cmd(), signature.Cmd(), extension.Cmd(), update.Cmd()},
 )

cmd/extension/extension.go

@@ -0,0 +1,54 @@
+/*
+	Copyright 2023 Loophole Labs
+
+	Licensed under the Apache License, Version 2.0 (the "License");
+	you may not use this file except in compliance with the License.
+	You may obtain a copy of the License at
+
+		   http://www.apache.org/licenses/LICENSE-2.0
+
+	Unless required by applicable law or agreed to in writing, software
+	distributed under the License is distributed on an "AS IS" BASIS,
+	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+	See the License for the specific language governing permissions and
+	limitations under the License.
+*/
+
+package extension
+
+import (
+	"github.com/loopholelabs/cmdutils"
+	"github.com/loopholelabs/cmdutils/pkg/command"
+	"github.com/loopholelabs/scale-cli/internal/config"
+	"github.com/spf13/cobra"
+)
+
+type extensionModel struct {
+	Name    string `header:"name" json:"name"`
+	Tag     string `header:"tag" json:"tag"`
+	Org     string `header:"org" json:"org"`
+	Hash    string `header:"hash" json:"hash"`
+	Version string `header:"version" json:"version"`
+}
+
+// Cmd encapsulates the commands for extensions.
+func Cmd() command.SetupCommand[*config.Config] {
+	return func(cmd *cobra.Command, ch *cmdutils.Helper[*config.Config]) {
+		extensionCmd := &cobra.Command{
+			Use:     "extension <command>",
+			Aliases: []string{"ext"},
+			Short:   "Create, list, and manage Scale Extensions",
+		}
+
+		newSetup := NewCmd(false)
+		newSetup(extensionCmd, ch)
+
+		generateSetup := GenerateCmd(false)
+		generateSetup(extensionCmd, ch)
+
+		listSetup := ListCmd(false)
+		listSetup(extensionCmd, ch)
+
+		cmd.AddCommand(extensionCmd)
+	}
+}

cmd/extension/generate.go

@@ -0,0 +1,130 @@
+/*
+	Copyright 2023 Loophole Labs
+
+	Licensed under the Apache License, Version 2.0 (the "License");
+	you may not use this file except in compliance with the License.
+	You may obtain a copy of the License at
+
+		   http://www.apache.org/licenses/LICENSE-2.0
+
+	Unless required by applicable law or agreed to in writing, software
+	distributed under the License is distributed on an "AS IS" BASIS,
+	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+	See the License for the specific language governing permissions and
+	limitations under the License.
+*/
+
+package extension
+
+import (
+	"fmt"
+	"os"
+	"path"
+	"strings"
+
+	"github.com/loopholelabs/cmdutils"
+	"github.com/loopholelabs/cmdutils/pkg/command"
+	"github.com/loopholelabs/cmdutils/pkg/printer"
+	"github.com/loopholelabs/scale-cli/internal/config"
+	"github.com/loopholelabs/scale-cli/utils"
+	"github.com/loopholelabs/scale/extension"
+	"github.com/loopholelabs/scale/scalefunc"
+	"github.com/loopholelabs/scale/storage"
+	"github.com/spf13/cobra"
+)
+
+// GenerateCmd encapsulates the commands for generating an Extension from an Extension File
+func GenerateCmd(hidden bool) command.SetupCommand[*config.Config] {
+	var directory string
+
+	return func(cmd *cobra.Command, ch *cmdutils.Helper[*config.Config]) {
+		generateCmd := &cobra.Command{
+			Use:      "generate <name>:<tag> [flags]",
+			Args:     cobra.ExactArgs(1),
+			Short:    "generate a scale extension from an extension file",
+			Hidden:   hidden,
+			PreRunE:  utils.PreRunUpdateCheck(ch),
+			PostRunE: utils.PostRunAnalytics(ch),
+			RunE: func(cmd *cobra.Command, args []string) error {
+				sourceDir := directory
+				if !path.IsAbs(sourceDir) {
+					wd, err := os.Getwd()
+					if err != nil {
+						return fmt.Errorf("failed to get working directory: %w", err)
+					}
+					sourceDir = path.Join(wd, sourceDir)
+				}
+
+				extensionPath := path.Join(sourceDir, "scale.extension")
+				extensionFile, err := extension.ReadSchema(extensionPath)
+				if err != nil {
+					return fmt.Errorf("failed to read extension file at %s: %w", extensionPath, err)
+				}
+
+				nametag := strings.Split(args[0], ":")
+				if len(nametag) != 2 {
+					return fmt.Errorf("invalid name or tag %s", args[0])
+				}
+				name := nametag[0]
+				tag := nametag[1]
+
+				if name == "" || !scalefunc.ValidString(name) {
+					return utils.InvalidStringError("name", name)
+				}
+
+				if tag == "" || !scalefunc.ValidString(tag) {
+					return utils.InvalidStringError("tag", tag)
+				}
+
+				end := ch.Printer.PrintProgress(fmt.Sprintf("Generating scale extension local/%s:%s...", name, tag))
+
+				st := storage.DefaultExtension
+				if ch.Config.StorageDirectory != "" {
+					st, err = storage.NewExtension(ch.Config.StorageDirectory)
+					if err != nil {
+						end()
+						return fmt.Errorf("failed to instantiate function storage for %s: %w", ch.Config.StorageDirectory, err)
+					}
+				}
+
+				oldEntry, err := st.Get(name, tag, "local", "")
+				if err != nil {
+					end()
+					return fmt.Errorf("failed to check if scale extension already exists: %w", err)
+				}
+
+				if oldEntry != nil {
+					err = st.Delete(name, tag, oldEntry.Organization, oldEntry.Hash)
+					if err != nil {
+						end()
+						return fmt.Errorf("failed to delete existing scale extension %s:%s: %w", name, tag, err)
+					}
+				}
+
+				err = st.Put(name, tag, "local", extensionFile)
+				if err != nil {
+					end()
+					return fmt.Errorf("failed to store scale extension: %w", err)
+				}
+
+				end()
+
+				if ch.Printer.Format() == printer.Human {
+					ch.Printer.Printf("Successfully generated scale extension %s\n", printer.BoldGreen(fmt.Sprintf("local/%s:%s", name, tag)))
+					return nil
+				}
+
+				return ch.Printer.PrintResource(map[string]string{
+					"name":      name,
+					"tag":       tag,
+					"org":       "local",
+					"directory": directory,
+				})
+			},
+		}
+
+		generateCmd.Flags().StringVarP(&directory, "directory", "d", ".", "the directory containing the extension file")
+
+		cmd.AddCommand(generateCmd)
+	}
+}

cmd/extension/list.go

@@ -0,0 +1,80 @@
+/*
+	Copyright 2023 Loophole Labs
+
+	Licensed under the Apache License, Version 2.0 (the "License");
+	you may not use this file except in compliance with the License.
+	You may obtain a copy of the License at
+
+		   http://www.apache.org/licenses/LICENSE-2.0
+
+	Unless required by applicable law or agreed to in writing, software
+	distributed under the License is distributed on an "AS IS" BASIS,
+	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+	See the License for the specific language governing permissions and
+	limitations under the License.
+*/
+
+package extension
+
+import (
+	"fmt"
+
+	"github.com/loopholelabs/cmdutils"
+	"github.com/loopholelabs/cmdutils/pkg/command"
+	"github.com/loopholelabs/cmdutils/pkg/printer"
+	"github.com/loopholelabs/scale-cli/analytics"
+	"github.com/loopholelabs/scale-cli/internal/config"
+	"github.com/loopholelabs/scale-cli/utils"
+	"github.com/loopholelabs/scale/storage"
+	"github.com/spf13/cobra"
+)
+
+// ListCmd encapsulates the commands for listing the available Extensions
+func ListCmd(hidden bool) command.SetupCommand[*config.Config] {
+	return func(cmd *cobra.Command, ch *cmdutils.Helper[*config.Config]) {
+		listCmd := &cobra.Command{
+			Use:      "list",
+			Short:    "list locally available scale extensions",
+			Args:     cobra.NoArgs,
+			PreRunE:  utils.PreRunUpdateCheck(ch),
+			PostRunE: utils.PostRunAnalytics(ch),
+			RunE: func(cmd *cobra.Command, args []string) error {
+				st := storage.DefaultExtension
+				if ch.Config.StorageDirectory != "" {
+					var err error
+					st, err = storage.NewExtension(ch.Config.StorageDirectory)
+					if err != nil {
+						return fmt.Errorf("failed to instantiate extension storage for %s: %w", ch.Config.StorageDirectory, err)
+					}
+				}
+
+				analytics.Event("list-extension")
+
+				extensionEntries, err := st.List()
+				if err != nil {
+					return fmt.Errorf("failed to list scale extensions: %w", err)
+				}
+
+				if len(extensionEntries) == 0 && ch.Printer.Format() == printer.Human {
+					ch.Printer.Println("No Scale Extensions available yet.")
+					return nil
+				}
+
+				exts := make([]extensionModel, len(extensionEntries))
+				for i, entry := range extensionEntries {
+					exts[i] = extensionModel{
+						Name:    entry.Name,
+						Tag:     entry.Tag,
+						Org:     entry.Organization,
+						Hash:    entry.Hash,
+						Version: entry.Schema.Version,
+					}
+				}
+
+				return ch.Printer.PrintResource(exts)
+			},
+		}
+
+		cmd.AddCommand(listCmd)
+	}
+}

cmd/extension/new.go

@@ -0,0 +1,75 @@
+/*
+	Copyright 2023 Loophole Labs
+
+	Licensed under the Apache License, Version 2.0 (the "License");
+	you may not use this file except in compliance with the License.
+	You may obtain a copy of the License at
+
+		   http://www.apache.org/licenses/LICENSE-2.0
+
+	Unless required by applicable law or agreed to in writing, software
+	distributed under the License is distributed on an "AS IS" BASIS,
+	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+	See the License for the specific language governing permissions and
+	limitations under the License.
+*/
+
+package extension
+
+import (
+	"fmt"
+	"os"
+	"path"
+
+	"github.com/loopholelabs/cmdutils"
+	"github.com/loopholelabs/cmdutils/pkg/command"
+	"github.com/loopholelabs/cmdutils/pkg/printer"
+	"github.com/loopholelabs/scale-cli/analytics"
+	"github.com/loopholelabs/scale-cli/internal/config"
+	"github.com/loopholelabs/scale-cli/template"
+	"github.com/loopholelabs/scale-cli/utils"
+	"github.com/spf13/cobra"
+)
+
+// NewCmd encapsulates the commands for creating new Extensions
+func NewCmd(hidden bool) command.SetupCommand[*config.Config] {
+	var directory string
+	return func(cmd *cobra.Command, ch *cmdutils.Helper[*config.Config]) {
+		newCmd := &cobra.Command{
+			Use:      "new [flags]",
+			Args:     cobra.ExactArgs(0),
+			Short:    "create a new scale extension",
+			Hidden:   hidden,
+			PreRunE:  utils.PreRunUpdateCheck(ch),
+			PostRunE: utils.PostRunAnalytics(ch),
+			RunE: func(cmd *cobra.Command, args []string) error {
+				analytics.Event("new-extension")
+				sourceDir := directory
+				if !path.IsAbs(sourceDir) {
+					wd, err := os.Getwd()
+					if err != nil {
+						return fmt.Errorf("failed to get working directory: %w", err)
+					}
+					sourceDir = path.Join(wd, sourceDir)
+				}
+				err := os.WriteFile(path.Join(sourceDir, fmt.Sprintf("scale.extension")), []byte(template.ExtensionFile), 0644)
+				if err != nil {
+					return fmt.Errorf("error writing extension: %w", err)
+				}
+
+				if ch.Printer.Format() == printer.Human {
+					ch.Printer.Printf("Successfully created new scale extension\n")
+					return nil
+				}
+
+				return ch.Printer.PrintResource(map[string]string{
+					"path": path.Join(directory, fmt.Sprintf("scale.extension")),
+				})
+			},
+		}
+
+		newCmd.Flags().StringVarP(&directory, "directory", "d", ".", "the directory to create the new scale extension in")
+
+		cmd.AddCommand(newCmd)
+	}
+}