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: adds github remote registry index #226

Merged
merged 6 commits into from
Jun 13, 2024
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
2 changes: 1 addition & 1 deletion cmd/cmd.go
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ func initializedRootFromArgs(stdout, stderr io.Writer, args []string) (*cobra.Co

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

if isInRepoContext() {
Expand Down
25 changes: 25 additions & 0 deletions cmd/ext.go
Original file line number Diff line number Diff line change
Expand Up @@ -86,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 @@ -145,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{
kjuulh marked this conversation as resolved.
Show resolved Hide resolved
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
}
21 changes: 11 additions & 10 deletions internal/extensions/downloader.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ package extensions

import (
"context"
"errors"
"fmt"
"io"
"log"
"net/http"
"os"
"time"
Expand Down Expand Up @@ -42,29 +42,30 @@ func (d *gitHubReleaseDownloader) Download(ctx context.Context, dest string) err
return err
}

var bearer string
if accessToken := os.Getenv("SHUTTLE_EXTENSIONS_GITHUB_ACCESS_TOKEN"); accessToken != "" {
bearer = accessToken
} else if accessToken := os.Getenv("GITHUB_ACCESS_TOKEN"); accessToken != "" {
bearer = accessToken
bearer, err := getGithubToken()
if err != nil {
return err
}

if bearer == "" {
return errors.New("failed to find a valid authorization token for github. Please make sure you're logged into github-cli (gh), or have followed the setup documentation")
}
req.Header.Add("Authorization", fmt.Sprintf("token %s", bearer))
req.Header.Add("Accept", "application/octet-stream")

req.Header.Add("Authorization", fmt.Sprintf("Bearer %s", bearer))
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
Expand Down
3 changes: 2 additions & 1 deletion internal/extensions/extension.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ 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()
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
}
22 changes: 21 additions & 1 deletion internal/extensions/extensions.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ func (e *ExtensionsManager) GetAll(ctx context.Context) ([]Extension, error) {

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

extension, err := newExtensionFromRegistry(e.globalStore, &registryExtension)
if err != nil {
return nil, err
Expand Down Expand Up @@ -74,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 @@ -89,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