Add artifactory stub

Author: code-asher

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Added
+
+- Artifactory integration.
+
 ## [1.1.0](https://github.com/coder/code-marketplace/releases/tag/v1.1.0) - 2022-10-03
 
 ### Added

README.md

@@ -29,16 +29,35 @@ wget https://github.com/coder/code-marketplace/releases/latest/download/code-mar
 chmod +x ./code-marketplace
 ```
 
-### Running the binary
+### Running the server
 
 The marketplace server can be ran using the `server` sub-command.
 
 ```console
-./code-marketplace server --extensions-dir ./extensions
+./code-marketplace server [flags]
 ```
 
 Run `./code-marketplace --help` for a full list of options.
 
+### Local storage
+
+To use a local directory for extension storage use the `--extensions-dir` flag.
+
+```console
+
+./code-marketplace [command] --extensions-dir ./extensions
+```
+
+### Artifactory storage
+
+It is possible use Artifactory as a file store instead of local storage. For
+this to work the `ARTIFACTORY_TOKEN` environment variable must be set.
+
+```console
+export ARTIFACTORY_TOKEN="my-token"
+./code-marketplace [command] --artifactory http://artifactory.server/artifactory --repo extensions
+```
+
 ### Exposing the marketplace
 
 The marketplace must be put behind TLS otherwise code-server will reject
@@ -71,8 +90,8 @@ Extensions can be added to the marketplace by file or URL. The extensions
 directory does not need to be created beforehand.
 
 ```console
-./code-marketplace add extension.vsix --extensions-dir ./extensions
-./code-marketplace add https://domain.tld/extension.vsix --extensions-dir ./extensions
+./code-marketplace add extension.vsix [flags]
+./code-marketplace add https://domain.tld/extension.vsix [flags]
 ```
 
 If the extension has dependencies or is in an extension pack those details will
@@ -88,13 +107,14 @@ If an extension is open source you can get it from one of three locations:
 For example to add the Python extension from Open VSX:
 
 ```console
-./code-marketplace add https://open-vsx.org/api/ms-python/python/2022.14.0/file/ms-python.python-2022.14.0.vsix --extensions-dir ./extensions
+./code-marketplace add https://open-vsx.org/api/ms-python/python/2022.14.0/file/ms-python.python-2022.14.0.vsix [flags]
 ```
 
 Or the Vim extension from GitHub:
 
 ```console
-./code-marketplace add https://github.com/VSCodeVim/Vim/releases/download/v1.24.1/vim-1.24.1.vsix --extensions-dir ./extensions
+./code-marketplace add
+https://github.com/VSCodeVim/Vim/releases/download/v1.24.1/vim-1.24.1.vsix [flags]
 ```
 
 ## Removing extensions
@@ -103,8 +123,8 @@ Extensions can be removed from the marketplace by ID and version (or use `--all`
 to remove all versions).
 
 ```console
-./code-marketplace remove ms-python.python-2022.14.0 --extensions-dir ./extensions
-./code-marketplace remove ms-python.python --all --extensions-dir ./extensions
+./code-marketplace remove ms-python.python-2022.14.0 [flags]
+./code-marketplace remove ms-python.python --all [flags]
 ```
 
 ## Usage in code-server
@@ -121,8 +141,8 @@ marketplace is running behind an https URL.
 
 ```console
 make test
-mkdir -p extensions
-go run ./cmd/marketplace/main.go server --extensions-dir ./extensions
+mkdir extensions
+go run ./cmd/marketplace/main.go server [flags]
 ```
 
 When testing with code-server you may run into issues with content security
@@ -148,4 +168,6 @@ update the changelog as part of your PR.
 
 ## Planned work
 
-- jFrog integration for file storage.
+- Bulk add.
+- Bulk add from one Artifactory repository to another (or to itself).
+- Progress indicators when adding/removing extensions.

cli/add.go

@@ -3,7 +3,6 @@ package cli
 import (
 	"context"
 	"fmt"
-	"path/filepath"
 	"strings"
 
 	"github.com/spf13/cobra"
@@ -17,15 +16,17 @@ import (
 
 func add() *cobra.Command {
 	var (
-		extdir string
+		artifactory string
+		extdir      string
+		repo        string
 	)
 
 	cmd := &cobra.Command{
 		Use:   "add <source>",
 		Short: "Add an extension to the marketplace",
 		Example: strings.Join([]string{
 			"  marketplace add https://domain.tld/extension.vsix --extensions-dir ./extensions",
-			"  marketplace add extension.vsix --extensions-dir ./extensions",
+			"  marketplace add extension.vsix --artifactory http://artifactory.server/artifactory --repo extensions",
 		}, "\n"),
 		Args: cobra.ExactArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
@@ -41,7 +42,12 @@ func add() *cobra.Command {
 				logger = logger.Leveled(slog.LevelDebug)
 			}
 
-			extdir, err = filepath.Abs(extdir)
+			store, err := storage.NewStorage(&storage.Options{
+				Artifactory: artifactory,
+				ExtDir:      extdir,
+				Logger:      logger,
+				Repo:        repo,
+			})
 			if err != nil {
 				return err
 			}
@@ -59,8 +65,6 @@ func add() *cobra.Command {
 				return err
 			}
 
-			// Always local storage for now.
-			store := storage.NewLocalStorage(extdir, logger)
 			location, err := store.AddExtension(ctx, manifest, vsix)
 			if err != nil {
 				return err
@@ -109,7 +113,8 @@ func add() *cobra.Command {
 	}
 
 	cmd.Flags().StringVar(&extdir, "extensions-dir", "", "The path to extensions.")
-	_ = cmd.MarkFlagRequired("extensions-dir")
+	cmd.Flags().StringVar(&artifactory, "artifactory", "", "Artifactory server URL.")
+	cmd.Flags().StringVar(&repo, "repo", "", "Artifactory repository.")
 
 	return cmd
 }

cli/remove.go

@@ -5,7 +5,6 @@ import (
 	"errors"
 	"fmt"
 	"os"
-	"path/filepath"
 	"strings"
 
 	"github.com/spf13/cobra"
@@ -20,16 +19,18 @@ import (
 
 func remove() *cobra.Command {
 	var (
-		extdir string
-		all    bool
+		all         bool
+		artifactory string
+		extdir      string
+		repo        string
 	)
 
 	cmd := &cobra.Command{
 		Use:   "remove <id>",
 		Short: "Remove an extension from the marketplace",
 		Example: strings.Join([]string{
 			"  marketplace remove publisher.extension-1.0.0 --extensions-dir ./extensions",
-			"  marketplace remove publisher.extension --all --extensions-dir ./extensions",
+			"  marketplace remove publisher.extension --all --artifactory http://artifactory.server/artifactory --repo extensions",
 		}, "\n"),
 		Args: cobra.ExactArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
@@ -45,7 +46,12 @@ func remove() *cobra.Command {
 				logger = logger.Leveled(slog.LevelDebug)
 			}
 
-			extdir, err = filepath.Abs(extdir)
+			store, err := storage.NewStorage(&storage.Options{
+				Artifactory: artifactory,
+				ExtDir:      extdir,
+				Logger:      logger,
+				Repo:        repo,
+			})
 			if err != nil {
 				return err
 			}
@@ -60,9 +66,6 @@ func remove() *cobra.Command {
 				return xerrors.Errorf("cannot specify both --all and version %s", version)
 			}
 
-			// Always local storage for now.
-			store := storage.NewLocalStorage(extdir, logger)
-
 			allVersions, err := store.Versions(ctx, publisher, name)
 			if err != nil && !errors.Is(err, os.ErrNotExist) {
 				return err
@@ -104,7 +107,8 @@ func remove() *cobra.Command {
 
 	cmd.Flags().BoolVar(&all, "all", false, "Whether to delete all versions of the extension.")
 	cmd.Flags().StringVar(&extdir, "extensions-dir", "", "The path to extensions.")
-	_ = cmd.MarkFlagRequired("extensions-dir")
+	cmd.Flags().StringVar(&artifactory, "artifactory", "", "Artifactory server URL.")
+	cmd.Flags().StringVar(&repo, "repo", "", "Artifactory repository.")
 
 	return cmd
 }

cli/server.go

@@ -6,7 +6,6 @@ import (
 	"net"
 	"net/http"
 	"os/signal"
-	"path/filepath"
 	"strings"
 	"time"
 
@@ -24,15 +23,18 @@ import (
 
 func server() *cobra.Command {
 	var (
-		extdir  string
-		address string
+		address     string
+		artifactory string
+		extdir      string
+		repo        string
 	)
 
 	cmd := &cobra.Command{
 		Use:   "server",
 		Short: "Start the Code extension marketplace",
 		Example: strings.Join([]string{
 			"  marketplace server --extensions-dir ./extensions",
+			"  marketplace server --artifactory http://artifactory.server/artifactory --repo extensions",
 		}, "\n"),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx, cancel := context.WithCancel(cmd.Context())
@@ -50,6 +52,16 @@ func server() *cobra.Command {
 				logger = logger.Leveled(slog.LevelDebug)
 			}
 
+			store, err := storage.NewStorage(&storage.Options{
+				Artifactory: artifactory,
+				ExtDir:      extdir,
+				Logger:      logger,
+				Repo:        repo,
+			})
+			if err != nil {
+				return err
+			}
+
 			// A separate listener is required to get the resulting address (as
 			// opposed to using http.ListenAndServe()).
 			listener, err := net.Listen("tcp", address)
@@ -63,14 +75,6 @@ func server() *cobra.Command {
 			}
 			logger.Info(ctx, "Starting API server", slog.F("address", tcpAddr))
 
-			extdir, err = filepath.Abs(extdir)
-			if err != nil {
-				return err
-			}
-
-			// Always local storage for now.
-			store := storage.NewLocalStorage(extdir, logger)
-
 			// Always no database for now.
 			database := &database.NoDB{
 				Storage: store,
@@ -130,7 +134,8 @@ func server() *cobra.Command {
 	}
 
 	cmd.Flags().StringVar(&extdir, "extensions-dir", "", "The path to extensions.")
-	_ = cmd.MarkFlagRequired("extensions-dir")
+	cmd.Flags().StringVar(&artifactory, "artifactory", "", "Artifactory server URL.")
+	cmd.Flags().StringVar(&repo, "repo", "", "Artifactory repository.")
 	cmd.Flags().StringVar(&address, "address", "127.0.0.1:3001", "The address on which to serve the marketplace API.")
 
 	return cmd

storage/artifactory.go

@@ -0,0 +1,69 @@
+package storage
+
+import (
+	"context"
+	"errors"
+	"net/http"
+	"os"
+
+	"golang.org/x/xerrors"
+
+	"cdr.dev/slog"
+)
+
+const ArtifactoryTokenEnvKey = "ARTIFACTORY_TOKEN"
+
+// Artifactory implements Storage.  It stores extensions remotely through
+// Artifactory by both copying the VSIX and extracting said VSIX to a tree
+// structure in the form of publisher/extension/version to easily serve
+// individual assets via HTTP.
+type Artifactory struct {
+	logger slog.Logger
+	repo   string
+	token  string
+	uri    string
+}
+
+func NewArtifactoryStorage(uri, repo string, logger slog.Logger) (*Artifactory, error) {
+	token := os.Getenv(ArtifactoryTokenEnvKey)
+	if token == "" {
+		return nil, xerrors.Errorf("the %s environment variable must be set", ArtifactoryTokenEnvKey)
+	}
+
+	if !strings.HasSuffix(uri, "/") {
+		uri = uri + "/"
+	}
+
+	return &Artifactory{
+		logger: logger,
+		repo:   repo,
+		token:  token,
+		uri:    uri,
+	}, nil
+}
+
+func (s *Artifactory) AddExtension(ctx context.Context, manifest *VSIXManifest, vsix []byte) (string, error) {
+	return "", errors.New("not implemented")
+}
+
+func (s *Artifactory) FileServer() http.Handler {
+	return http.HandlerFunc(func(rw http.ResponseWriter, r *http.Request) {
+		http.Error(rw, "not found", http.StatusNotFound)
+	})
+}
+
+func (s *Artifactory) Manifest(ctx context.Context, publisher, name, version string) (*VSIXManifest, error) {
+	return nil, errors.New("not implemented")
+}
+
+func (s *Artifactory) RemoveExtension(ctx context.Context, publisher, name, version string) error {
+	return errors.New("not implemented")
+}
+
+func (s *Artifactory) WalkExtensions(ctx context.Context, fn func(manifest *VSIXManifest, versions []string) error) error {
+	return errors.New("not implemented")
+}
+
+func (s *Artifactory) Versions(ctx context.Context, publisher, name string) ([]string, error) {
+	return nil, errors.New("not implemented")
+}

storage/local.go

@@ -22,11 +22,15 @@ type Local struct {
 	logger slog.Logger
 }
 
-func NewLocalStorage(extdir string, logger slog.Logger) *Local {
+func NewLocalStorage(extdir string, logger slog.Logger) (*Local, error) {
+	extdir, err := filepath.Abs(extdir)
+	if err != nil {
+		return nil, err
+	}
 	return &Local{
 		extdir: extdir,
 		logger: logger,
-	}
+	}, nil
 }
 
 func (s *Local) AddExtension(ctx context.Context, manifest *VSIXManifest, vsix []byte) (string, error) {