feature: support filtering by workspace provider when listing environments

Faris Huskovic · Faris Huskovic · commit e9874ea9c921 · 2021-03-11T15:50:46.000Z
diff --git a/ci/integration/envs_test.go b/ci/integration/envs_test.go
@@ -144,6 +144,20 @@ func TestEnvsCLI(t *testing.T) {
 			tcli.StdoutMatches(regexp.QuoteMeta(name)),
 		)
 
+		// filter by provider that does not exist should fail
+		doesntExist := randString(10)
+		c.Run(ctx, fmt.Sprintf("coder envs ls --provider %s", doesntExist)).Assert(t,
+			tcli.Error(),
+			tcli.StderrMatches(regexp.QuoteMeta(fmt.Sprintf("fatal: no environments found for workspace provider %q", doesntExist))),
+		)
+
+		// filter by provider that does exist should succeed
+		var envs []coder.Environment
+		c.Run(ctx, "coder envs ls --provider built-in").Assert(t,
+			tcli.Success(),
+			tcli.StdoutJSONUnmarshal(&envs),
+		)
+
 		var env coder.Environment
 		c.Run(ctx, fmt.Sprintf(`coder envs ls -o json | jq '.[] | select(.name == "%s")'`, name)).Assert(t,
 			tcli.Success(),
diff --git a/coder-sdk/env.go b/coder-sdk/env.go
@@ -338,3 +338,11 @@ func (c *DefaultClient) EnvironmentByID(ctx context.Context, id string) (*Enviro
 	}
 	return &env, nil
 }
+
+func (c *DefaultClient) EnvironmentsByWorkspaceProvider(ctx context.Context, wpID string) ([]Environment, error) {
+	var envs []Environment
+	if err := c.requestBody(ctx, http.MethodGet, "/api/private/resource-pools/"+wpID+"/environments/", nil, &envs); err != nil {
+		return nil, err
+	}
+	return envs, nil
+}
diff --git a/coder-sdk/interface.go b/coder-sdk/interface.go
@@ -130,6 +130,9 @@ type Client interface {
 	// EnvironmentByID get the details of an environment by its id.
 	EnvironmentByID(ctx context.Context, id string) (*Environment, error)
 
+	// EnvironmentsByWorkspaceProvider returns environments that belong to a particular workspace provider.
+	EnvironmentsByWorkspaceProvider(ctx context.Context, wpID string) ([]Environment, error)
+
 	// ImportImage creates a new image and optionally a new registry.
 	ImportImage(ctx context.Context, req ImportImageReq) (*Image, error)
 
diff --git a/internal/cmd/ceapi.go b/internal/cmd/ceapi.go
@@ -202,3 +202,30 @@ func getUserOrgs(ctx context.Context, client coder.Client, email string) ([]code
 	}
 	return lookupUserOrgs(u, orgs), nil
 }
+
+func getProviderByName(ctx context.Context, client coder.Client, wpName string) (*coder.KubernetesProvider, error) {
+	providers, err := client.WorkspaceProviders(ctx)
+	if err != nil {
+		return nil, err
+	}
+
+	for _, provider := range providers.Kubernetes {
+		if provider.Name == wpName {
+			return &provider, nil
+		}
+	}
+	return nil, xerrors.Errorf("workspace provider %q not found", wpName)
+}
+
+func getEnvsByProvider(ctx context.Context, client coder.Client, wpName string) ([]coder.Environment, error) {
+	wp, err := getProviderByName(ctx, client, wpName)
+	if err != nil {
+		return nil, err
+	}
+
+	envs, err := client.EnvironmentsByWorkspaceProvider(ctx, wp.ID)
+	if err != nil {
+		return nil, err
+	}
+	return envs, nil
+}
diff --git a/internal/cmd/envs.go b/internal/cmd/envs.go
@@ -51,6 +51,7 @@ func lsEnvsCommand() *cobra.Command {
 	var (
 		outputFmt string
 		user      string
+		provider  string
 	)
 
 	cmd := &cobra.Command{
@@ -67,6 +68,12 @@ func lsEnvsCommand() *cobra.Command {
 			if err != nil {
 				return err
 			}
+			if provider != "" {
+				envs, err = getEnvsByProvider(ctx, client, provider)
+				if err != nil {
+					return err
+				}
+			}
 			if len(envs) < 1 {
 				clog.LogInfo("no environments found")
 				envs = []coder.Environment{} // ensures that json output still marshals
@@ -94,6 +101,7 @@ func lsEnvsCommand() *cobra.Command {
 
 	cmd.Flags().StringVar(&user, "user", coder.Me, "Specify the user whose resources to target")
 	cmd.Flags().StringVarP(&outputFmt, "output", "o", humanOutput, "human | json")
+	cmd.Flags().StringVarP(&provider, "provider", "p", "", "Filter environments by a particular workspace provider name.")
 
 	return cmd
 }

Original file line number	Diff line number	Diff line change
`@@ -338,3 +338,11 @@ func (c DefaultClient) EnvironmentByID(ctx context.Context, id string) (Enviro`
`338`	`338`	`}`
`339`	`339`	`return &env, nil`
`340`	`340`	`}`
	`341`	`+`
	`342`	`+func (c *DefaultClient) EnvironmentsByWorkspaceProvider(ctx context.Context, wpID string) ([]Environment, error) {`
	`343`	`+ var envs []Environment`
	`344`	`+ if err := c.requestBody(ctx, http.MethodGet, "/api/private/resource-pools/"+wpID+"/environments/", nil, &envs); err != nil {`
	`345`	`+ return nil, err`
	`346`	`+ }`
	`347`	`+ return envs, nil`
	`348`	`+}`