Add -filter to CLI listing and website docs (#967)

* Add -filter to CLI listing.

This doesn't include docs/Changelog yet, that will come shortly.

* Add changelog

* Add website docs and fix a curl output bug

CHANGELOG.md

@@ -24,6 +24,13 @@ All of these changes are from [PR
 
 ### New and Improved
 
+* list filtering: Listing now supports filtering results before being returned
+  to the user. The filtering takes place server side and uses boolean
+  expressions against the JSON representation of returned items. See [the
+  documentation](https://www.boundaryproject.io/docs/concepts/filtering/resource-listing)
+  for more details. ([PR](https://github.com/hashicorp/boundary/pull/952))
+  ([PR](https://github.com/hashicorp/boundary/pull/957))
+  ([PR](https://github.com/hashicorp/boundary/pull/967))
 * server: Officially support reloading TLS parameters on `SIGHUP`. (This likely
   worked before but wasn't fully tested.)
   ([PR](https://github.com/hashicorp/boundary/pull/959))

api/output_string.go

@@ -57,18 +57,19 @@ func (d *OutputStringError) parseRequest() {
 					h = fmt.Sprintf("Bearer $(boundary config get-token -keyring-type %s -token-name %s)", keyringType, tokenName)
 				}
 			}
-			d.parsedCurlString = fmt.Sprintf("%s-H \"%s: %s\" ", d.parsedCurlString, k, h)
+			d.parsedCurlString = fmt.Sprintf("%s-H \"%s: %s\"", d.parsedCurlString, k, h)
 		}
 	}
 
 	if len(body) > 0 {
 		// We need to escape single quotes since that's what we're using to
 		// quote the body
 		escapedBody := strings.Replace(string(body), "'", "'\"'\"'", -1)
-		d.parsedCurlString = fmt.Sprintf("%s-d '%s' ", d.parsedCurlString, escapedBody)
+		d.parsedCurlString = fmt.Sprintf(" %s-d '%s'", d.parsedCurlString, escapedBody)
 	}
 
-	d.parsedCurlString = fmt.Sprintf("%s%s", d.parsedCurlString, d.Request.URL.String())
+	// Filters can have shell characters so we use single quotes to surround the URL
+	d.parsedCurlString = fmt.Sprintf("%s '%s'", d.parsedCurlString, d.Request.URL.String())
 }
 
 func (d *OutputStringError) CurlString() string {

internal/cmd/base/base.go

@@ -77,6 +77,7 @@ type Command struct {
 	FlagHostCatalogId string
 	FlagVersion       int
 	FlagRecursive     bool
+	FlagFilter        string
 
 	client *api.Client
 }

internal/cmd/commands/server/listener_reload_test.go

@@ -104,10 +104,10 @@ func TestServer_ReloadListener(t *testing.T) {
 	// Setup initial certs
 	inBytes, err := ioutil.ReadFile(wd + "bundle1.pem")
 	require.NoError(err)
-	require.NoError(ioutil.WriteFile(td+"/bundle.pem", inBytes, 0777))
+	require.NoError(ioutil.WriteFile(td+"/bundle.pem", inBytes, 0o777))
 
 	relHcl := fmt.Sprintf(reloadConfig, cmd.DatabaseUrl, controllerKey, workerAuthKey, recoveryKey, td, td)
-	require.NoError(ioutil.WriteFile(td+"/reload.hcl", []byte(relHcl), 0777))
+	require.NoError(ioutil.WriteFile(td+"/reload.hcl", []byte(relHcl), 0o777))
 
 	// Populate CA pool
 	inBytes, _ = ioutil.ReadFile(td + "/bundle.pem")
@@ -146,7 +146,7 @@ func TestServer_ReloadListener(t *testing.T) {
 
 	inBytes, err = ioutil.ReadFile(wd + "bundle2.pem")
 	require.NoError(err)
-	require.NoError(ioutil.WriteFile(td+"/bundle.pem", inBytes, 0777))
+	require.NoError(ioutil.WriteFile(td+"/bundle.pem", inBytes, 0o777))
 
 	cmd.SighupCh <- struct{}{}
 	select {

internal/cmd/common/flags.go

@@ -71,6 +71,12 @@ func PopulateCommonFlags(c *base.Command, f *base.FlagSet, resourceType string,
 				Target: &c.FlagRecursive,
 				Usage:  "If set, the list operation will be applied recursively into child scopes, if supported by the type.",
 			})
+		case "filter":
+			f.StringVar(&base.StringVar{
+				Name:   "filter",
+				Target: &c.FlagFilter,
+				Usage:  "If set, the list operation will be filtered before being returned. The filter operates against each item in the list. Using single quotes is recommended as filters contain double quotes. See https://www.boundaryproject.io/docs/concepts/filtering/resource-listing for details.",
+			})
 		}
 	}
 }