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
Devurl crud ops#60
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
5 commits Select commitHold shift + click to select a range
9294633 Improve rsync trouble error messages
eefa329 Improve ssync error msgs
29dde34 Merge pull request #58 from cdr/rsync-error-msgs
6450687 Merge remote-tracking branch 'origin/master' into devurl-CRUD-ops
4f09af1 Add subcommands 'create' and 'del' to manage devurls
File 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
10 changes: 2 additions & 8 deletionscmd/coder/sync.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 |
|---|---|---|
| @@ -1,7 +1,6 @@ | ||
| package main | ||
| import ( | ||
| "os" | ||
| "path/filepath" | ||
| "strings" | ||
| @@ -30,9 +29,6 @@ func (cmd *syncCmd) RegisterFlags(fl *pflag.FlagSet) { | ||
| fl.BoolVarP(&cmd.init, "init", "i", false, "do initial transfer and exit") | ||
| } | ||
| func (cmd *syncCmd) Run(fl *pflag.FlagSet) { | ||
| var ( | ||
| local = fl.Arg(0) | ||
| @@ -79,9 +75,7 @@ func (cmd *syncCmd) Run(fl *pflag.FlagSet) { | ||
| err = s.Run() | ||
| } | ||
| if err != nil { | ||
Russtopia marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| flog.Fatal("%v", err) | ||
| } | ||
| } | ||
165 changes: 156 additions & 9 deletionscmd/coder/urls.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 |
|---|---|---|
| @@ -5,6 +5,8 @@ import ( | ||
| "fmt" | ||
| "net/http" | ||
| "os" | ||
| "strconv" | ||
| "strings" | ||
| "text/tabwriter" | ||
| "github.com/spf13/pflag" | ||
| @@ -15,35 +17,164 @@ import ( | ||
| type urlsCmd struct{} | ||
| // DevURL is the parsed json response record for a devURL from cemanager | ||
| type DevURL struct { | ||
| ID string `json:"id"` | ||
| URL string `json:"url"` | ||
| Port string `json:"port"` | ||
| Access string `json:"access"` | ||
| } | ||
| var urlAccessLevel = map[string]string{ | ||
| //Remote API endpoint requires these in uppercase | ||
| "PRIVATE": "Only you can access", | ||
| "ORG": "All members of your organization can access", | ||
| "AUTHED": "Authenticated users can access", | ||
| "PUBLIC": "Anyone on the internet can access this link", | ||
Russtopia marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| } | ||
| func portIsValid(port string) bool { | ||
| p, err := strconv.ParseUint(port, 10, 16) | ||
| if p < 1 { | ||
| // port 0 means 'any free port', which we don't support | ||
| err = strconv.ErrRange | ||
| } | ||
| if err != nil { | ||
| fmt.Println("Invalid port") | ||
| } | ||
| return err == nil | ||
| } | ||
| func accessLevelIsValid(level string) bool { | ||
| _, ok := urlAccessLevel[level] | ||
| if !ok { | ||
| fmt.Println("Invalid access level") | ||
| } | ||
| return ok | ||
| } | ||
| type createSubCmd struct { | ||
| access string | ||
| } | ||
| func (sub *createSubCmd) RegisterFlags(fl *pflag.FlagSet) { | ||
| fl.StringVarP(&sub.access, "access", "a", "private", "[private | org | authed | public] set devurl access") | ||
| } | ||
| func (sub createSubCmd) Spec() cli.CommandSpec { | ||
| return cli.CommandSpec{ | ||
| Name: "create", | ||
| Usage: "<env name> <port> [--access <level>]", | ||
| Desc: "create/update a devurl for external access", | ||
| } | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. I made it just --a, do you want it fully-spelled out ie., --access ? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. I'd prefer | ||
| } | ||
| // Run creates or updates a devURL, specified by env ID and port | ||
| // (fl.Arg(0) and fl.Arg(1)), with access level (fl.Arg(2)) on | ||
| // the cemanager. | ||
| func (sub createSubCmd) Run(fl *pflag.FlagSet) { | ||
| envName := fl.Arg(0) | ||
| port := fl.Arg(1) | ||
| access := fl.Arg(2) | ||
| if envName == "" { | ||
| exitUsage(fl) | ||
| } | ||
| if !portIsValid(port) { | ||
| exitUsage(fl) | ||
| } | ||
| access = strings.ToUpper(sub.access) | ||
| if !accessLevelIsValid(access) { | ||
| exitUsage(fl) | ||
| } | ||
| entClient := requireAuth() | ||
| env := findEnv(entClient, envName) | ||
| _, found := devURLID(port, urlList(envName)) | ||
| if found { | ||
| fmt.Printf("Updating devurl for port %v\n", port) | ||
| } else { | ||
| fmt.Printf("Adding devurl for port %v\n", port) | ||
| } | ||
| err := entClient.UpsertDevURL(env.ID, port, access) | ||
| if err != nil { | ||
| flog.Error("upsert devurl: %s", err.Error()) | ||
| } | ||
| } | ||
| type delSubCmd struct{} | ||
| func (sub delSubCmd) Spec() cli.CommandSpec { | ||
| return cli.CommandSpec{ | ||
| Name: "del", | ||
| Usage: "<env name> <port>", | ||
| Desc: "delete a devurl", | ||
| } | ||
| } | ||
| // devURLID returns the ID of a devURL, given the env name and port. | ||
| // ("", false) is returned if no match is found. | ||
| func devURLID(port string, urls []DevURL) (string, bool) { | ||
| for _, url := range urls { | ||
| if url.Port == port { | ||
| return url.ID, true | ||
| } | ||
| } | ||
| return "", false | ||
| } | ||
| // Run deletes a devURL, specified by env ID and port, from the cemanager. | ||
| func (sub delSubCmd) Run(fl *pflag.FlagSet) { | ||
| envName := fl.Arg(0) | ||
| port := fl.Arg(1) | ||
| if envName == "" { | ||
| exitUsage(fl) | ||
| } | ||
| if !portIsValid(port) { | ||
| exitUsage(fl) | ||
| } | ||
| entClient := requireAuth() | ||
| env := findEnv(entClient, envName) | ||
| urlID, found := devURLID(port, urlList(envName)) | ||
| if found { | ||
| fmt.Printf("Deleting devurl for port %v\n", port) | ||
| } else { | ||
| flog.Fatal("No devurl found for port %v", port) | ||
| } | ||
| err := entClient.DelDevURL(env.ID, urlID) | ||
| if err != nil { | ||
| flog.Error("delete devurl: %s", err.Error()) | ||
| } | ||
| } | ||
| func (cmd urlsCmd) Spec() cli.CommandSpec { | ||
| return cli.CommandSpec{ | ||
| Name: "urls", | ||
| Usage: "<env name>", | ||
| Desc: "get all development urls for external access", | ||
| } | ||
| } | ||
| // urlList returns the list of active devURLs from the cemanager. | ||
| func urlList(envName string) []DevURL { | ||
| entClient := requireAuth() | ||
| env := findEnv(entClient, envName) | ||
| reqString := "%s/api/environments/%s/devurls?session_token=%s" | ||
| reqURL := fmt.Sprintf(reqString, entClient.BaseURL, env.ID, entClient.Token) | ||
| resp, err := http.Get(reqURL) | ||
| if err != nil { | ||
| flog.Fatal("%v", err) | ||
| } | ||
| @@ -55,7 +186,7 @@ func (cmd urlsCmd) Run(fl *pflag.FlagSet) { | ||
| dec := json.NewDecoder(resp.Body) | ||
| devURLs:= make([]DevURL, 0) | ||
| err = dec.Decode(&devURLs) | ||
| if err != nil { | ||
| flog.Fatal("%v", err) | ||
| @@ -65,9 +196,25 @@ func (cmd urlsCmd) Run(fl *pflag.FlagSet) { | ||
| fmt.Printf("no dev urls were found for environment: %s\n", envName) | ||
| } | ||
| return devURLs | ||
| } | ||
| // Run gets the list of active devURLs from the cemanager for the | ||
| // specified environment and outputs info to stdout. | ||
| func (cmd urlsCmd) Run(fl *pflag.FlagSet) { | ||
| envName := fl.Arg(0) | ||
| devURLs := urlList(envName) | ||
Russtopia marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| w := tabwriter.NewWriter(os.Stdout, 0, 0, 1, ' ', tabwriter.TabIndent) | ||
| for _, devURL := range devURLs { | ||
| fmt.Fprintf(w, "%s\t%s\t%s\n", devURL.URL, devURL.Port, devURL.Access) | ||
| } | ||
| w.Flush() | ||
| } | ||
| func (cmd *urlsCmd) Subcommands() []cli.Command { | ||
| return []cli.Command{ | ||
| &createSubCmd{}, | ||
| &delSubCmd{}, | ||
| } | ||
| } | ||
4 changes: 3 additions & 1 deletioninternal/entclient/activity.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
45 changes: 45 additions & 0 deletionsinternal/entclient/devurl.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,45 @@ | ||
| package entclient | ||
| import ( | ||
| "fmt" | ||
| "net/http" | ||
| ) | ||
| func (cClient)DelDevURL(envID,urlIDstring)error { | ||
| reqString:="/api/environments/%s/devurls/%s" | ||
| reqUrl:=fmt.Sprintf(reqString,envID,urlID) | ||
| res,err:=c.request("DELETE",reqUrl,map[string]string{ | ||
| "environment_id":envID, | ||
| "url_id":urlID, | ||
| }) | ||
| iferr!=nil { | ||
| returnerr | ||
| } | ||
| ifres.StatusCode!=http.StatusOK { | ||
| returnbodyError(res) | ||
| } | ||
| returnnil | ||
| } | ||
| func (cClient)UpsertDevURL(envID,port,accessstring)error { | ||
| reqString:="/api/environments/%s/devurls" | ||
| reqUrl:=fmt.Sprintf(reqString,envID) | ||
| res,err:=c.request("POST",reqUrl,map[string]string{ | ||
| "environment_id":envID, | ||
| "port":port, | ||
| "access":access, | ||
| }) | ||
| iferr!=nil { | ||
| returnerr | ||
| } | ||
| ifres.StatusCode!=http.StatusOK { | ||
| returnbodyError(res) | ||
| } | ||
| returnnil | ||
| } |
15 changes: 15 additions & 0 deletionsinternal/sync/sync.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 |
|---|---|---|
| @@ -41,6 +41,12 @@ type Sync struct { | ||
| Client *entclient.Client | ||
| } | ||
| // See https://lxadm.com/Rsync_exit_codes#List_of_standard_rsync_exit_codes. | ||
| const ( | ||
| rsyncExitCodeIncompat = 2 | ||
| rsyncExitCodeDataStream = 12 | ||
| ) | ||
| func (s Sync) syncPaths(delete bool, local, remote string) error { | ||
| self := os.Args[0] | ||
| @@ -66,6 +72,15 @@ func (s Sync) syncPaths(delete bool, local, remote string) error { | ||
| cmd.Stdin = os.Stdin | ||
| err := cmd.Run() | ||
| if err != nil { | ||
| if exitError, ok := err.(*exec.ExitError); ok { | ||
| if exitError.ExitCode() == rsyncExitCodeIncompat { | ||
| return xerrors.Errorf("no compatible rsync on remote machine: rsync: %w", err) | ||
| } else if exitError.ExitCode() == rsyncExitCodeDataStream { | ||
| return xerrors.Errorf("protocol datastream error or no remote rsync found: %w", err) | ||
| } else { | ||
| return xerrors.Errorf("rsync: %w", err) | ||
| } | ||
| } | ||
Russtopia marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| return xerrors.Errorf("rsync: %w", err) | ||
| } | ||
| return nil | ||
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.