Added documentation for containsSQLOutput

Signed-off-by: Lou Marvin Caraig <[email protected]>

Author: se7entyse7en

cmd/srcd/cmd/sql_test.go

@@ -204,6 +204,27 @@ func (s *SQLREPLTestSuite) waitMysqlCliContainerStopped(retries int, retryTimeou
 	return fmt.Errorf("maximum number of retries (%d) reached while waiting to stop container", retries)
 }
 
+// containsSQLOutput returns `true` if the given string is a SQL output table.
+// To detect whether the `out` is a SQL output table, this checks that there
+// are exactly 3 separators matching this regex ``\+-+\+`.
+// In fact an example of SQL output is the following:
+//
+//     +--------------+  <-- first separator
+//     | Table        |
+//     +--------------+  <-- second separator
+//     | blobs        |
+//     | commit_blobs |
+//     | commit_files |
+//     | commit_trees |
+//     | commits      |
+//     | files        |
+//     | ref_commits  |
+//     | refs         |
+//     | remotes      |
+//     | repositories |
+//     | tree_entries |
+//     +--------------+  <-- third separator
+//
 func (s *SQLREPLTestSuite) containsSQLOutput(out string) bool {
 	sep := regexp.MustCompile(`\+-+\+`)
 	matches := sep.FindAllStringIndex(out, -1)