Skip to content
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.

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

feat(extensions): add github release downloader #224

Merged
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
3 changes: 3 additions & 0 deletions cmd/cmd.go
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,9 @@ func initializedRootFromArgs(stdout, stderr io.Writer, args []string) (*cobra.Co
rootCmd.ParseFlags(args)

rootCmd.AddCommand(newExtCmd())
if err := addExtensions(rootCmd); err != nil {
uii.Verboseln("failed to register extensions: %s", err.Error())
}

if isInRepoContext() {
runCmd, err := newRun(uii, ctxProvider)
Expand Down
74 changes: 74 additions & 0 deletions cmd/ext.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ package cmd
import (
"errors"
"os"
"os/exec"

stdcontext "context"

"github.com/lunarway/shuttle/internal/extensions"
"github.com/lunarway/shuttle/internal/global"
Expand All @@ -25,6 +28,52 @@ func (c *extGlobalConfig) getRegistry() (string, bool) {
return "", false
}

func addExtensions(rootCmd *cobra.Command) error {
extManager := extensions.NewExtensionsManager(global.NewGlobalStore())

extensions, err := extManager.GetAll(stdcontext.Background())
if err != nil {
return err
}
grp := &cobra.Group{
ID: "extensions",
Title: "Extensions",
}
rootCmd.AddGroup(grp)
for _, extension := range extensions {
extension := extension

rootCmd.AddCommand(
&cobra.Command{
Use: extension.Name(),
Short: extension.Description(),
Version: extension.Version(),
GroupID: "extensions",
DisableFlagParsing: true,
RunE: func(cmd *cobra.Command, args []string) error {
extCmd := exec.CommandContext(cmd.Context(), extension.FullPath(), args...)

extCmd.Stdout = os.Stdout
extCmd.Stderr = os.Stderr
extCmd.Stdin = os.Stdin

if err := extCmd.Start(); err != nil {
return err
}

if err := extCmd.Wait(); err != nil {
return err
}

return nil
},
},
)
}

return nil
}

func newExtCmd() *cobra.Command {
globalConfig := &extGlobalConfig{}

Expand All @@ -37,6 +86,7 @@ func newExtCmd() *cobra.Command {
newExtInstallCmd(globalConfig),
newExtUpdateCmd(globalConfig),
newExtInitCmd(globalConfig),
newExtPublishCmd(globalConfig),
)

cmd.PersistentFlags().StringVar(&globalConfig.registry, "registry", "", "the given registry, if not set will default to SHUTTLE_EXTENSIONS_REGISTRY")
Expand Down Expand Up @@ -96,3 +146,27 @@ func newExtInitCmd(globalConfig *extGlobalConfig) *cobra.Command {

return cmd
}

func newExtPublishCmd(globalConfig *extGlobalConfig) *cobra.Command {
var version string

// Publish can either be called by a user to rollback an extension, or by CI to automatically publish an extension.
cmd := &cobra.Command{
Use: "publish",
Short: "Publishes the current extension to a registry",
RunE: func(cmd *cobra.Command, args []string) error {
extManager := extensions.NewExtensionsManager(global.NewGlobalStore())

if err := extManager.Publish(cmd.Context(), version); err != nil {
return err
}

return nil
},
}

cmd.Flags().StringVar(&version, "version", "", "the version to publish")
cmd.MarkFlagRequired("version")

return cmd
}
75 changes: 75 additions & 0 deletions internal/extensions/downloader.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
package extensions

import (
"context"
"fmt"
"io"
"log"
"net/http"
"os"
"time"
)

type Downloader interface {
kjuulh marked this conversation as resolved.
Show resolved Hide resolved
Download(ctx context.Context, dest string) error
}

func NewDownloader(downloadLink *registryExtensionDownloadLink) (Downloader, error) {
switch downloadLink.Provider {
case "github-release":
return newGitHubReleaseDownloader(downloadLink), nil
default:
return nil, fmt.Errorf("invalid provider type: %s", downloadLink.Provider)
}
}

type gitHubReleaseDownloader struct {
link *registryExtensionDownloadLink
}

func newGitHubReleaseDownloader(downloadLink *registryExtensionDownloadLink) Downloader {
return &gitHubReleaseDownloader{
link: downloadLink,
}
}

func (d *gitHubReleaseDownloader) Download(ctx context.Context, dest string) error {
client := http.DefaultClient
client.Timeout = time.Second * 60

req, err := http.NewRequestWithContext(ctx, http.MethodGet, d.link.Url, nil)
if err != nil {
return err
}

bearer, err := getGithubToken()
if err != nil {
return err
}

req.Header.Add("Authorization", fmt.Sprintf("token %s", bearer))
req.Header.Add("Accept", "application/octet-stream")

resp, err := client.Do(req)
if err != nil {
return err
}
defer resp.Body.Close()

if err := os.RemoveAll(dest); err != nil {
log.Printf("failed to remove extension before downloading new: %s, please try again", err.Error())
}

extensionBinary, err := os.Create(dest)
if err != nil {
return err
}
defer extensionBinary.Close()
extensionBinary.Chmod(0o755)

if _, err := io.Copy(extensionBinary, resp.Body); err != nil {
return err
}

return nil
}
30 changes: 27 additions & 3 deletions internal/extensions/extension.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,23 +35,47 @@ func (e *Extension) Ensure(ctx context.Context) error {

binaryPath := path.Join(extensionsCachePath, binaryName)
if exists(binaryPath) {
return nil
// TODO: do a checksum chck
//return nil
}

downloadLink := e.getRemoteBinaryDownloadLink()
if downloadLink == nil {
return fmt.Errorf("failed to find a valid extension matching your os and architecture")
}

//TODO: Initiate download
downloader, err := NewDownloader(downloadLink)
if err != nil {
return err
}

if err := downloader.Download(ctx, binaryPath); err != nil {
return err
}

panic("not implemented yet")
return nil
}

func (e *Extension) Name() string {
return e.remote.Name
}

func (e *Extension) Version() string {
return e.remote.Version
}

func (e *Extension) Description() string {
return e.remote.Description
}

func (e *Extension) getExtensionBinaryName() string {
return e.remote.Name
}

func (e *Extension) FullPath() string {
return path.Join(getExtensionsCachePath(e.globalStore), e.Name())
}

func (e *Extension) getRemoteBinaryDownloadLink() *registryExtensionDownloadLink {
for _, download := range e.remote.DownloadUrls {
if download.Os == e.os &&
Expand Down
44 changes: 44 additions & 0 deletions internal/extensions/extension_source.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
package extensions

import (
"context"
"fmt"
"os"

"gopkg.in/yaml.v2"
)

type shuttleExtensionsRegistry struct {
GitHub *string `json:"github" yaml:"github"`
}

type shuttleExtensionProviderGitHubRelease struct {
Owner string `json:"owner" yaml:"owner"`
Repo string `json:"repo" yaml:"repo"`
}

type shuttleExtensionsProvider struct {
GitHubRelease *shuttleExtensionProviderGitHubRelease `json:"github-release" yaml:"github-release"`
}

type shuttleExtensionsFile struct {
Name string `json:"name" yaml:"name"`
Description string `json:"description" yaml:"description"`

Provider shuttleExtensionsProvider `json:"provider" yaml:"provider"`
Registry shuttleExtensionsRegistry `json:"registry" yaml:"registry"`
}

func getExtensionsFile(_ context.Context) (*shuttleExtensionsFile, error) {
templateFileContent, err := os.ReadFile("shuttle.template.yaml")
if err != nil {
return nil, fmt.Errorf("failed to find shuttle.template.yaml: %w", err)
}

var templateFile shuttleExtensionsFile
if err := yaml.Unmarshal(templateFileContent, &templateFile); err != nil {
return nil, fmt.Errorf("failed to parse shuttle.template.yaml: %w", err)
}

return &templateFile, nil
}
45 changes: 43 additions & 2 deletions internal/extensions/extensions.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,30 @@ func (e *ExtensionsManager) Init(ctx context.Context) error {

// GetAll will return all known and installed extensions
func (e *ExtensionsManager) GetAll(ctx context.Context) ([]Extension, error) {
return nil, nil
registry := getRegistryPath(e.globalStore)

index := newRegistryIndex(registry)

registryExtensions, err := index.getExtensions(ctx)
if err != nil {
return nil, fmt.Errorf("failed to install extensions, could not get extensions from index: %w", err)
}

extensions := make([]Extension, 0)
for _, registryExtension := range registryExtensions {
registryExtension := registryExtension

extension, err := newExtensionFromRegistry(e.globalStore, &registryExtension)
if err != nil {
return nil, err
}

if extension != nil {
extensions = append(extensions, *extension)
}
}

return extensions, nil
}

// Install will ensure that all known extensions are installed and ready for use
Expand Down Expand Up @@ -53,7 +76,7 @@ func (e *ExtensionsManager) Install(ctx context.Context) error {

// Update will fetch the latest extensions from a registry and install them afterwards so that they're ready for use
func (e *ExtensionsManager) Update(ctx context.Context, registry string) error {
reg, err := NewRegistry(registry, e.globalStore)
reg, err := NewRegistryFromCombined(registry, e.globalStore)
if err != nil {
return fmt.Errorf("failed to update extensions: %w", err)
}
Expand All @@ -68,3 +91,21 @@ func (e *ExtensionsManager) Update(ctx context.Context, registry string) error {

return nil
}

func (e *ExtensionsManager) Publish(ctx context.Context, version string) error {
extensionsFile, err := getExtensionsFile(ctx)
if err != nil {
return err
}

registry, err := newGitHubRegistry()
if err != nil {
return err
}

if err := registry.Publish(ctx, extensionsFile, version); err != nil {
return err
}

return nil
}
5 changes: 5 additions & 0 deletions internal/extensions/git_registry.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@ type gitRegistry struct {
globalStore *global.GlobalStore
}

// Publish isn't implemented yet for gitRegistry
func (*gitRegistry) Publish(ctx context.Context, extFile *shuttleExtensionsFile, version string) error {
panic("unimplemented")
}

func (*gitRegistry) Get(ctx context.Context) error {
panic("unimplemented")
}
Expand Down
Loading
Loading