NETOBSERV-2187: adapt regex to new query language in flp (netobserv#285)

* NETOBSERV-2187: adapt regex to new query language in flp

See netobserv/flowlogs-pipeline#930

* New --query options

Refactoring was needed to avoid loosing options string quotes when it's
read and passed to functions: it's now a global array, so quoting &
escaping is preserved everywhere.

For consistency I also changed "command" and "manifest" to globals.

* fix linter and regen doc

Author: jotak

commands/netobserv

@@ -85,7 +85,7 @@ case "$1" in
     ;;
   *)
     shift # remove first argument
-    options="$*"
+    options=( "$@" )
     # run flows command
     command="flows"
     ;;
@@ -99,7 +99,7 @@ case "$1" in
     ;;
   *)
     shift # remove first argument
-    options="$*"
+    options=( "$@" )
     # run packets command
     command="packets"
     ;;
@@ -113,7 +113,7 @@ case "$1" in
     ;;
   *)
     shift # remove first argument
-    options="$*"
+    options=( "$@" )
     # run metrics command
     command="metrics"
     ;;
@@ -179,7 +179,7 @@ esac
 
 trap cleanup EXIT
 
-setup $command $options
+setup
 
 if [[ "$command" == "flows" || "$command" == "packets" ]]; then
   # convert options to string

docs/netobserv_cli.adoc

@@ -61,7 +61,7 @@ $ oc netobserv flows [<feature_option>] [<command_options>]
 |--enable_pkt_translation|    enable packet translation                  | false
 |--enable_pkt_drop|           enable packet drop                         | false
 |--enable_rtt|                enable RTT tracking                        | false
-|--enable_udn_mapping|        enable User Defined Network mapping | false
+|--enable_udn_mapping|        enable User Defined Network mapping        | false
 |--get-subnets|               get subnets information                    | false
 |--background|                run in background                          | false
 |--copy|                      copy the output files locally              | prompt
@@ -84,7 +84,7 @@ $ oc netobserv flows [<feature_option>] [<command_options>]
 |--port|                      filter port                                | -
 |--ports|                     filter on either of two ports              | -
 |--protocol|                  filter protocol                            | -
-|--regexes|                   filter flows using regular expression      | -
+|--query|                     filter flows using a custom query          | -
 |--sport_range|               filter source port range                   | -
 |--sport|                     filter source port                         | -
 |--sports|                    filter on either of two source ports       | -
@@ -131,7 +131,7 @@ $ oc netobserv packets [<option>]
 |--port|                      filter port                                | -
 |--ports|                     filter on either of two ports              | -
 |--protocol|                  filter protocol                            | -
-|--regexes|                   filter flows using regular expression      | -
+|--query|                     filter flows using a custom query          | -
 |--sport_range|               filter source port range                   | -
 |--sport|                     filter source port                         | -
 |--sports|                    filter on either of two source ports       | -
@@ -161,7 +161,7 @@ $ oc netobserv metrics [<option>]
 |--enable_pkt_translation|    enable packet translation                  | false
 |--enable_pkt_drop|           enable packet drop                         | false
 |--enable_rtt|                enable RTT tracking                        | false
-|--enable_udn_mapping|        enable User Defined Network mapping | false
+|--enable_udn_mapping|        enable User Defined Network mapping        | false
 |--get-subnets|               get subnets information                    | false
 |--action|                    filter action                              | Accept
 |--cidr|                      filter CIDR                                | 0.0.0.0/0
@@ -179,7 +179,7 @@ $ oc netobserv metrics [<option>]
 |--port|                      filter port                                | -
 |--ports|                     filter on either of two ports              | -
 |--protocol|                  filter protocol                            | -
-|--regexes|                   filter flows using regular expression      | -
+|--query|                     filter flows using a custom query          | -
 |--sport_range|               filter source port range                   | -
 |--sport|                     filter source port                         | -
 |--sports|                    filter on either of two source ports       | -

e2e/integration-tests/integration_test.go

@@ -43,7 +43,7 @@ var _ = g.Describe("NetObserv CLI e2e integration test suite", g.Serial, func()
 	g.It("Verify regexes filters are applied", func() {
 		// capture upto 500KB
 		nsfilter := "openshift-monitoring"
-		cliArgs := []string{"flows", "--regexes=SrcK8S_Namespace~" + nsfilter, "--copy=true", "--max-bytes=500000"}
+		cliArgs := []string{"flows", "--query=\"SrcK8S_Namespace=~" + nsfilter + "\"", "--copy=true", "--max-bytes=500000"}
 		cmd := exec.Command(ocNetObservBinPath, cliArgs...)
 		err := cmd.Run()
 		o.Expect(err).NotTo(o.HaveOccurred())
@@ -70,7 +70,7 @@ var _ = g.Describe("NetObserv CLI e2e integration test suite", g.Serial, func()
 			err := decoder.Decode(&flow)
 			o.Expect(err).NotTo(o.HaveOccurred())
 			if flow.SrcK8sNamespace != nsfilter {
-				o.Expect(true).To(o.BeFalse(), fmt.Sprintf("Flow %v does not meet regexes condition SrcK8S_Namespace~%s", flow, nsfilter))
+				o.Expect(true).To(o.BeFalse(), fmt.Sprintf("Flow %v does not meet regexes condition SrcK8S_Namespace=~%s", flow, nsfilter))
 			}
 		}
 	})

e2e/script_test.go

@@ -44,7 +44,7 @@ func TestHelpCommand(t *testing.T) {
 		// ensure help to display examples
 		assert.Contains(t, str, "basic examples:")
 		assert.Contains(t, str, "netobserv flows --drops                              # Capture dropped flows on all nodes")
-		assert.Contains(t, str, "netobserv flows --regexes=SrcK8S_Namespace~app-.*    # Capture flows from any namespace starting by app-")
+		assert.Contains(t, str, "netobserv flows --query=\"SrcK8S_Namespace=~app-.*\" # Capture flows from any namespace starting by app-")
 		assert.Contains(t, str, "netobserv packets --port=8080                        # Capture packets on port 8080")
 		assert.Contains(t, str, "netobserv metrics --enable_all                       # Capture all cluster metrics including packet drop, dns, rtt, network events packet translation and UDN mapping features informations")
 		assert.Contains(t, str, "advanced examples:")