This repository was archived by the owner on Aug 30, 2024. It is now read-only.
- Notifications
You must be signed in to change notification settings - Fork18
feat: Add update command to coder-cli#417
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes from1 commit
Commits
Show all changes
26 commits Select commitHold shift + click to select a range
d256581 feat: Add update command to coder-cli
johnstcn972847e internal/cmd/update_test.go: refactor unit tests
johnstcn597afe1 fixup! internal/cmd/update_test.go: refactor unit tests
johnstcn1373e79 internal/cmd/update_test.go: more tests
johnstcn513282a internal/cmd/update_test.go: create dirs in memfs
johnstcn5bf7f56 internal/cmd/update_test.go: test for windows
johnstcndabd178 fixup! internal/cmd/update_test.go: test for windows
johnstcndcfeec1 internal/cmd/update.go: replace semver library
johnstcn0801cfc internal/cmd/update.go: use /api/private/version instead of sniffing …
johnstcnf6ce76f gendocs
johnstcn6371084 internal/cmd/update.go: use os.Executable() instead of os.Args[0]
johnstcnbdb998e internal/cmd/update.go: check path prefixes
johnstcn306686c lint
johnstcn60a75a1 internal/cmd/update_test.go: assertCLIError helper function for clog.…
johnstcn26984a2 internal/cmd/update.go: allow explicitly specifying version
johnstcnbcaac7b internal/cmd/update.go: validate we can exec new binary
johnstcn2002876 fixup! internal/cmd/update.go: validate we can exec new binary
johnstcn3ba1bed internal/cmd/update.go: query github releases api for assets
johnstcn6238053 internal/cmd/update.go: handle copy error from archive
johnstcn24df4f7 internal/cmd/update.go: handle windows-specific behaviours
johnstcn21dd836 fixup! internal/cmd/update.go: handle windows-specific behaviours
johnstcne064c47 fixup! internal/cmd/update.go: handle windows-specific behaviours
johnstcneefa2f3 gofmt
johnstcn0e63d2f internal/cmd/users_test.go: assert CICD user instead of admin
johnstcn60944f0 Revert "internal/cmd/users_test.go: assert CICD user instead of admin"
johnstcnc8943ed Merge branch 'master' into cianjohnston/autoupdate
johnstcnFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
2 changes: 2 additions & 0 deletionsgo.mod
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -5,6 +5,7 @@ go 1.14 | ||
| require ( | ||
| cdr.dev/slog v1.4.1 | ||
| cdr.dev/wsep v0.0.0-20200728013649-82316a09813f | ||
| github.com/blang/semver/v4 v4.0.0 | ||
johnstcn marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| github.com/briandowns/spinner v1.16.0 | ||
| github.com/cli/safeexec v1.0.0 | ||
| github.com/fatih/color v1.12.0 | ||
| @@ -23,6 +24,7 @@ require ( | ||
| github.com/pion/webrtc/v3 v3.0.32 | ||
| github.com/pkg/browser v0.0.0-20180916011732-0a3d74bf9ce4 | ||
| github.com/rjeczalik/notify v0.9.2 | ||
| github.com/spf13/afero v1.6.0 | ||
johnstcn marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| github.com/spf13/cobra v1.2.1 | ||
| github.com/stretchr/testify v1.7.0 | ||
| golang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97 | ||
3 changes: 3 additions & 0 deletionsgo.sum
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
1 change: 1 addition & 0 deletionsinternal/cmd/cmd.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
309 changes: 309 additions & 0 deletionsinternal/cmd/update.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,309 @@ | ||
| package cmd | ||
| import ( | ||
| "archive/tar" | ||
| "archive/zip" | ||
| "bufio" | ||
| "bytes" | ||
| "compress/gzip" | ||
| "context" | ||
| "fmt" | ||
| "io" | ||
| "net/http" | ||
| "net/url" | ||
| "os" | ||
| "path" | ||
| "runtime" | ||
| "strings" | ||
| "time" | ||
| "cdr.dev/coder-cli/internal/config" | ||
| "cdr.dev/coder-cli/internal/version" | ||
| "cdr.dev/coder-cli/pkg/clog" | ||
| "golang.org/x/xerrors" | ||
| "github.com/blang/semver/v4" | ||
| "github.com/manifoldco/promptui" | ||
| "github.com/spf13/afero" | ||
| "github.com/spf13/cobra" | ||
| ) | ||
| // updater updates coder-cli. | ||
| type updater struct { | ||
| confirmF func(label string) (string, error) | ||
| executablePath string | ||
| fs afero.Fs | ||
| httpClient getter | ||
| versionF func() string | ||
| } | ||
| func updateCmd() *cobra.Command { | ||
| var ( | ||
| force bool | ||
| coderURL string | ||
| ) | ||
| cmd := &cobra.Command{ | ||
| Use: "update", | ||
| Short: "Update coder binary", | ||
| Long: "Update coder to the version matching a given coder instance.", | ||
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| ctx := cmd.Context() | ||
| httpClient := &http.Client{ | ||
| Timeout: 10 * time.Second, | ||
| } | ||
| updater := &updater{ | ||
| httpClient: httpClient, | ||
| fs: afero.NewOsFs(), | ||
| confirmF: defaultConfirm, | ||
| versionF: func() string { return version.Version }, | ||
| executablePath: os.Args[0], | ||
johnstcn marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| } | ||
| return updater.Run(ctx, force, coderURL) | ||
| }, | ||
| } | ||
| cmd.Flags().BoolVar(&force, "force", false, "do not prompt for confirmation") | ||
| cmd.Flags().StringVar(&coderURL, "coder", "", "coder instance against which to match version") | ||
| return cmd | ||
| } | ||
| type getter interface { | ||
| Get(url string) (*http.Response, error) | ||
| } | ||
| func (u *updater) Run(ctx context.Context, force bool, coderURLString string) error { | ||
| // TODO: check under following directories and warn if coder binary is under them: | ||
| // * homebrew prefix | ||
johnstcn marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| // * coder assets root (env CODER_ASSETS_ROOT) | ||
johnstcn marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| currentBinaryStat, err := u.fs.Stat(u.executablePath) | ||
| if err != nil { | ||
| return clog.Fatal("preflight: cannot stat current binary", clog.Causef("%s", err)) | ||
| } | ||
johnstcn marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| if currentBinaryStat.Mode().Perm()&0222 == 0 { | ||
| return clog.Fatal("preflight: missing write permission on current binary") | ||
| } | ||
| var coderURL *url.URL | ||
| if coderURLString == "" { | ||
| coderURL, err = getCoderConfigURL() | ||
| if err != nil { | ||
| return clog.Fatal( | ||
| "Unable to automatically determine coder URL", | ||
| clog.Causef(err.Error()), | ||
| clog.BlankLine, | ||
| clog.Tipf("use --coder <url> to specify coder URL"), | ||
| ) | ||
| } | ||
| } else { | ||
| coderURL, err = url.Parse(coderURLString) | ||
| if err != nil { | ||
| return clog.Fatal("invalid coder URL", err.Error()) | ||
| } | ||
| } | ||
| desiredVersion, err := getAPIVersionUnauthed(u.httpClient, *coderURL) | ||
| if err != nil { | ||
| return clog.Fatal("fetch api version", clog.Causef(err.Error())) | ||
| } | ||
| clog.LogInfo(fmt.Sprintf("Coder instance at %q reports version %s", coderURL.String(), desiredVersion.String())) | ||
| clog.LogInfo(fmt.Sprintf("Current version of coder-cli is %s", version.Version)) | ||
| if currentVersion, err := semver.Make(u.versionF()); err == nil { | ||
| if desiredVersion.Compare(currentVersion) == 0 { | ||
johnstcn marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| clog.LogInfo("Up to date!") | ||
| return nil | ||
| } | ||
| } | ||
| if !force { | ||
| label := fmt.Sprintf("Update coder-cli to version %s", desiredVersion.FinalizeVersion()) | ||
| if _, err := u.confirmF(label); err != nil { | ||
| return clog.Fatal("failed to confirm update", clog.Tipf(`use "--force" to update without confirmation`)) | ||
johnstcn marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| } | ||
| } | ||
| downloadURL := makeDownloadURL(desiredVersion.FinalizeVersion(), runtime.GOOS, runtime.GOARCH) | ||
| var downloadBuf bytes.Buffer | ||
| memWriter := bufio.NewWriter(&downloadBuf) | ||
| clog.LogInfo("fetching coder-cli from GitHub releases", downloadURL) | ||
| resp, err := u.httpClient.Get(downloadURL) | ||
| if err != nil { | ||
| return clog.Fatal(fmt.Sprintf("failed to fetch URL %s", downloadURL), clog.Causef(err.Error())) | ||
| } | ||
| if resp.StatusCode != http.StatusOK { | ||
| return clog.Fatal("failed to fetch release", clog.Causef("URL %s returned status code %d", downloadURL, resp.StatusCode)) | ||
| } | ||
| if _, err := io.Copy(memWriter, resp.Body); err != nil { | ||
| return clog.Fatal(fmt.Sprintf("failed to download %s", downloadURL), clog.Causef(err.Error())) | ||
| } | ||
| _ = resp.Body.Close() | ||
| if err := memWriter.Flush(); err != nil { | ||
| return clog.Fatal(fmt.Sprintf("failed to save %s", downloadURL), clog.Causef(err.Error())) | ||
| } | ||
| // TODO: validate the checksum of the downloaded file. GitHub does not currently provide this information | ||
| // and we do not generate them yet. | ||
| updatedBinary, err := extractFromArchive("coder", downloadBuf.Bytes()) | ||
johnstcn marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| if err != nil { | ||
| return clog.Fatal("failed to extract coder binary from archive", clog.Causef(err.Error())) | ||
| } | ||
| // We assume the binary is named coder and write it to coder.new | ||
| updatedCoderBinaryPath := u.executablePath + ".new" | ||
deansheather marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| updatedBin, err := u.fs.OpenFile(updatedCoderBinaryPath, os.O_RDWR|os.O_CREATE|os.O_TRUNC, currentBinaryStat.Mode().Perm()) | ||
| if err != nil { | ||
| return clog.Fatal("failed to create file for updated coder binary", clog.Causef(err.Error())) | ||
| } | ||
| fsWriter := bufio.NewWriter(updatedBin) | ||
| if _, err := io.Copy(fsWriter, bytes.NewReader(updatedBinary)); err != nil { | ||
| return clog.Fatal("failed to write updated coder binary to disk", clog.Causef(err.Error())) | ||
| } | ||
| if err := fsWriter.Flush(); err != nil { | ||
| return clog.Fatal("failed to persist updated coder binary to disk", clog.Causef(err.Error())) | ||
| } | ||
| if err = u.fs.Rename(updatedCoderBinaryPath, u.executablePath); err != nil { | ||
| return clog.Fatal("failed to update coder binary in-place", clog.Causef(err.Error())) | ||
| } | ||
johnstcn marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| clog.LogSuccess("Updated coder CLI to version " + desiredVersion.FinalizeVersion()) | ||
| return nil | ||
| } | ||
| func defaultConfirm(label string) (string, error) { | ||
| p := promptui.Prompt{IsConfirm: true, Label: label} | ||
| return p.Run() | ||
| } | ||
| func makeDownloadURL(version, ostype, archetype string) string { | ||
| const template = "https://github.com/cdr/coder-cli/releases/download/v%s/coder-cli-%s-%s.%s" | ||
| var ext string | ||
| switch ostype { | ||
| case "linux": | ||
| ext = "tar.gz" | ||
| default: | ||
| ext = ".zip" | ||
| } | ||
| return fmt.Sprintf(template, version, ostype, archetype, ext) | ||
| } | ||
| func extractFromArchive(path string, archive []byte) ([]byte, error) { | ||
| contentType := http.DetectContentType(archive) | ||
| switch contentType { | ||
| case "application/zip": | ||
| return extractFromZip(path, archive) | ||
| case "application/x-gzip": | ||
| return extractFromTgz(path, archive) | ||
| default: | ||
| return nil, xerrors.Errorf("unknown archive type: %s", contentType) | ||
| } | ||
| } | ||
| func extractFromZip(path string, archive []byte) ([]byte, error) { | ||
| zipReader, err := zip.NewReader(bytes.NewReader(archive), int64(len(archive))) | ||
| if err != nil { | ||
| return nil, xerrors.Errorf("failed to open zip archive") | ||
| } | ||
| var zf *zip.File | ||
| for _, f := range zipReader.File { | ||
| if f.Name == path { | ||
| zf = f | ||
| break | ||
| } | ||
| } | ||
| if zf == nil { | ||
| return nil, xerrors.Errorf("could not find path %q in zip archive", path) | ||
| } | ||
| rc, err := zf.Open() | ||
| if err != nil { | ||
| return nil, xerrors.Errorf("failed to extract path %q from archive", path) | ||
| } | ||
| defer rc.Close() | ||
| var b bytes.Buffer | ||
| bw := bufio.NewWriter(&b) | ||
| if _, err := io.Copy(bw, rc); err != nil { | ||
| return nil, xerrors.Errorf("failed to copy path %q to from archive", path) | ||
| } | ||
| return b.Bytes(), nil | ||
| } | ||
| func extractFromTgz(path string, archive []byte) ([]byte, error) { | ||
| zr, err := gzip.NewReader(bytes.NewReader(archive)) | ||
| if err != nil { | ||
| return nil, xerrors.Errorf("failed to gunzip archive") | ||
| } | ||
| tr := tar.NewReader(zr) | ||
| var b bytes.Buffer | ||
| bw := bufio.NewWriter(&b) | ||
| for { | ||
| hdr, err := tr.Next() | ||
| if err == io.EOF { | ||
| break | ||
| } | ||
| if err != nil { | ||
| return nil, xerrors.Errorf("failed to read tar archive: %w", err) | ||
| } | ||
| fi := hdr.FileInfo() | ||
| if fi.Name() == path && fi.Mode().IsRegular() { | ||
| _, _ = io.Copy(bw, tr) | ||
johnstcn marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| break | ||
| } | ||
| } | ||
| return b.Bytes(), nil | ||
| } | ||
| // getCoderConfigURL reads the currently configured coder URL, returning an empty string if not configured. | ||
| func getCoderConfigURL() (*url.URL, error) { | ||
| urlString, err := config.URL.Read() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| configuredURL, err := url.Parse(strings.TrimSpace(urlString)) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return configuredURL, nil | ||
| } | ||
| // XXX: coder.Client requires an API key, but we may not be logged into the coder instance for which we | ||
johnstcn marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| // want to determine the version. We don't need an API key to sniff the version header. | ||
| func getAPIVersionUnauthed(client getter, baseURL url.URL) (semver.Version, error) { | ||
| baseURL.Path = path.Join(baseURL.Path, "/api") | ||
johnstcn marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| resp, err := client.Get(baseURL.String()) | ||
| if err != nil { | ||
| return semver.Version{}, xerrors.Errorf("get %s: %w", baseURL.String(), err) | ||
| } | ||
| defer resp.Body.Close() | ||
| versionHdr := resp.Header.Get("coder-version") | ||
| if versionHdr == "" { | ||
| return semver.Version{}, xerrors.Errorf("URL %s response missing coder-version header", baseURL.String()) | ||
| } | ||
| version, err := semver.Parse(versionHdr) | ||
| if err != nil { | ||
| return semver.Version{}, xerrors.Errorf("parsing coder-version header: %w", err) | ||
| } | ||
| return version, nil | ||
| } | ||
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.