Merge pull request #439 from jfontan/improvement/upgrade-bblfshd-client

Improvement/upgrade bblfshd client

Author: ajnavarro

Gopkg.lock

@@ -50,7 +50,7 @@
 
 [[constraint]]
   name = "gopkg.in/bblfsh/client-go.v2"
-  version = "2.8.0"
+  version = "2.8.4"
 
 [[constraint]]
   name = "gopkg.in/bblfsh/sdk.v1"

Gopkg.toml

@@ -4,13 +4,14 @@
 
 To make some common tasks easier for the user, there are some functions to interact with the aforementioned tables:
 
-|     Name     |                                               Description                                           |
-|:-------------|:----------------------------------------------------------------------------------------------------|
-|is_remote(reference_name)bool| check if the given reference name is from a remote one                               |
-|is_tag(reference_name)bool| check if the given reference name is a tag                                              |
-|language(path, [blob])text| gets the language of a file given its path and the optional content of the file         |
-|uast(blob, [lang, [xpath]])json_blob| returns an array of UAST nodes as blobs                                       |
-|uast_xpath(json_blob, xpath)| performs an XPath query over the given UAST nodes                                     |
+|     Name     |                                               Description                                                                      |
+|:-------------|:-------------------------------------------------------------------------------------------------------------------------------|
+|is_remote(reference_name)bool| check if the given reference name is from a remote one                                                          |
+|is_tag(reference_name)bool| check if the given reference name is a tag                                                                         |
+|language(path, [blob])text| gets the language of a file given its path and the optional content of the file                                    |
+|uast(blob, [lang, [xpath]])json_blob| returns an array of UAST nodes as blobs in semantic mode                                                 |
+|uast_mode(mode, blob, lang)json_blob| returns an array of UAST nodes as blobs specifying its language and mode (semantic, annotated or native) |
+|uast_xpath(json_blob, xpath)| performs an XPath query over the given UAST nodes                                                                |
 
 ## Standard functions
 

docs/using-gitbase/functions.md

@@ -4,7 +4,7 @@
 
 `gitbase` has two optional dependencies that should be running on your system if you're planning on using certain functionality.
 
-- [bblfsh](https://github.com/bblfsh/bblfshd) >= 2.5.0 (only if you're planning to use the `UAST` functionality provided in gitbase)
+- [bblfsh](https://github.com/bblfsh/bblfshd) >= 2.6.1 (only if you're planning to use the `UAST` functionality provided in gitbase)
 - [pilosa](https://github.com/pilosa/pilosa) 0.9.0 (only if you're planning on using indexes)
 
 ## Installing gitbase

docs/using-gitbase/getting-started.md

@@ -261,26 +261,56 @@ func TestIntegration(t *testing.T) {
 }
 
 func TestUastQueries(t *testing.T) {
-	require := require.New(t)
-
 	engine, pool, cleanup := setup(t)
 	defer cleanup()
 
-	session := gitbase.NewSession(pool)
-	ctx := sql.NewContext(context.TODO(), sql.WithSession(session))
-	_, iter, err := engine.Query(ctx, `
-		SELECT uast_xpath(uast(blob_content, language(tree_entry_name, blob_content)), '//*[@roleIdentifier]') as uast,
+	testCases := []struct {
+		query string
+		rows  int
+	}{
+		{`SELECT uast_xpath(uast(blob_content, language(tree_entry_name, blob_content)), '//Identifier') as uast,
 			tree_entry_name
 		FROM tree_entries te
 		INNER JOIN blobs b
 		ON b.blob_hash = te.blob_hash
-		WHERE te.tree_entry_name = 'crappy.php'`,
-	)
-	require.NoError(err)
+		WHERE te.tree_entry_name = 'example.go'`, 1},
+		{`SELECT uast_xpath(uast_mode('semantic', blob_content, language(tree_entry_name, blob_content)), '//Identifier') as uast,
+			tree_entry_name
+		FROM tree_entries te
+		INNER JOIN blobs b
+		ON b.blob_hash = te.blob_hash
+		WHERE te.tree_entry_name = 'example.go'`, 1},
+		{`SELECT uast_xpath(uast_mode('annotated', blob_content, language(tree_entry_name, blob_content)), '//*[@roleIdentifier]') as uast,
+			tree_entry_name
+		FROM tree_entries te
+		INNER JOIN blobs b
+		ON b.blob_hash = te.blob_hash
+		WHERE te.tree_entry_name = 'example.go'`, 1},
+		{`SELECT uast_xpath(uast_mode('native', blob_content, language(tree_entry_name, blob_content)), '//*[@ast_type=\'FunctionDef\']') as uast,
+			tree_entry_name
+		FROM tree_entries te
+		INNER JOIN blobs b
+		ON b.blob_hash = te.blob_hash
+		WHERE te.tree_entry_name = 'example.go'`, 1},
+	}
 
-	rows, err := sql.RowIterToRows(iter)
-	require.NoError(err)
-	require.Len(rows, 1)
+	_ = testCases
+
+	for _, c := range testCases {
+		t.Run(c.query, func(t *testing.T) {
+			require := require.New(t)
+
+			session := gitbase.NewSession(pool)
+			ctx := sql.NewContext(context.TODO(), sql.WithSession(session))
+
+			_, iter, err := engine.Query(ctx, c.query)
+			require.NoError(err)
+
+			rows, err := sql.RowIterToRows(iter)
+			require.NoError(err)
+			require.Len(rows, c.rows)
+		})
+	}
 }
 
 func TestSquashCorrectness(t *testing.T) {

integration_test.go

@@ -8,5 +8,6 @@ var Functions = sql.Functions{
 	"is_remote":  sql.Function1(NewIsRemote),
 	"language":   sql.FunctionN(NewLanguage),
 	"uast":       sql.FunctionN(NewUAST),
+	"uast_mode":  sql.Function3(NewUASTMode),
 	"uast_xpath": sql.Function2(NewUASTXPath),
 }