Add JSON extension support for duckdb backends. Closes #467 (#472)

turbot · Aug 22, 2024 · 3c647f5 · 3c647f5
1 parent 1ee31ba
commit 3c647f5
Show file tree

Hide file tree

Showing 9 changed files with 46 additions and 3 deletions.
diff --git a/.github/workflows/01-powerpipe-pre-release.yaml b/.github/workflows/01-powerpipe-pre-release.yaml
@@ -100,6 +100,7 @@ jobs:
           - "check"
           - "resource_show_outputs"
           - "dashboard"
+          - "backend"
           - "mod"
           - "mod_install"
           - "sp_files"

diff --git a/.github/workflows/02-powerpipe-release.yaml b/.github/workflows/02-powerpipe-release.yaml
@@ -120,6 +120,7 @@ jobs:
           - "check"
           - "resource_show_outputs"
           - "dashboard"
+          - "backend"
           - "mod"
           - "mod_install"
           - "sp_files"

diff --git a/.github/workflows/11-test-acceptance.yaml b/.github/workflows/11-test-acceptance.yaml
@@ -76,6 +76,7 @@ jobs:
           - "check"
           - "resource_show_outputs"
           - "dashboard"
+          - "backend"
           - "mod"
           - "mod_install"
           - "sp_files"

diff --git a/go.mod b/go.mod
@@ -23,7 +23,7 @@ require (
 	github.com/spf13/viper v1.19.0
 	github.com/stevenle/topsort v0.2.0 // indirect
 	github.com/turbot/go-kit v0.10.0-rc.0
-	github.com/turbot/pipe-fittings v1.5.1
+	github.com/turbot/pipe-fittings v1.5.4
 	github.com/turbot/steampipe-plugin-sdk/v5 v5.10.3
 	github.com/turbot/terraform-components v0.0.0-20231108031935-358f803c1a8b // indirect
 	github.com/xlab/treeprint v1.2.0 // indirect

diff --git a/go.sum b/go.sum
@@ -818,8 +818,8 @@ github.com/tkrajina/go-reflector v0.5.6 h1:hKQ0gyocG7vgMD2M3dRlYN6WBBOmdoOzJ6njQ
 github.com/tkrajina/go-reflector v0.5.6/go.mod h1:ECbqLgccecY5kPmPmXg1MrHW585yMcDkVl6IvJe64T4=
 github.com/turbot/go-kit v0.10.0-rc.0 h1:kd+jp2ibbIV33Hc8SsMAN410Dl9Pz6SJ40axbKUlSoA=
 github.com/turbot/go-kit v0.10.0-rc.0/go.mod h1:fFQqR59I5z5JeeBLfK1PjSifn4Oprs3NiQx0CxeSJxs=
-github.com/turbot/pipe-fittings v1.5.1 h1:ekUvULaoVqpcyEgtpghKEk4q1I5om/nmKyubPdCqcMw=
-github.com/turbot/pipe-fittings v1.5.1/go.mod h1:IgGxXEXfG3UTJCIkDOjjErVzU1ClsK6NmxlyaapZaNc=
+github.com/turbot/pipe-fittings v1.5.4 h1:I686yzC9F5W3ZCWzdMHVE99VbWKWP0WdjcGh44tIDxA=
+github.com/turbot/pipe-fittings v1.5.4/go.mod h1:IgGxXEXfG3UTJCIkDOjjErVzU1ClsK6NmxlyaapZaNc=
 github.com/turbot/pipes-sdk-go v0.9.1 h1:2yRojY2wymvJn6NQyE6A0EDFV267MNe+yDLxPVvsBwM=
 github.com/turbot/pipes-sdk-go v0.9.1/go.mod h1:Mb+KhvqqEdRbz/6TSZc2QWDrMa5BN3E4Xw+gPt2TRkc=
 github.com/turbot/steampipe-plugin-code v0.7.0 h1:SROYIo/TI/Q/YNfXK+sAIS71umypUFm1Uz851TmoJkM=

diff --git a/tests/acceptance/test_data/mods/duckdb_mod/query.pp b/tests/acceptance/test_data/mods/duckdb_mod/query.pp
@@ -4,6 +4,18 @@
   EOQ
 }
 
+query "json_casting" {
+  sql = <<-EOQ
+    SELECT preferences::JSON FROM employee;
+  EOQ
+}
+
+query "extensions" {
+  sql = <<-EOQ
+    select extension_name, installed from duckdb_extensions();
+  EOQ
+}
+
 query "params_only" {
   sql = <<-EOQ
     SELECT CONCAT($1::text, ' ', $2::text, ' ', $3::text) as "Params" FROM employee;

diff --git a/tests/acceptance/test_data/templates/expected_duckdb_backend_json_casting.csv b/tests/acceptance/test_data/templates/expected_duckdb_backend_json_casting.csv
@@ -0,0 +1,4 @@
+"CAST(preferences AS ""JSON"")"
+"{""theme"": ""dark"", ""notifications"": true}"
+"{""theme"": ""light"", ""notifications"": true}"
+"{""theme"": ""dark"", ""notifications"": true}"
diff --git a/tests/acceptance/test_data/templates/expected_duckdb_backend_total_employee.csv b/tests/acceptance/test_data/templates/expected_duckdb_backend_total_employee.csv
@@ -0,0 +1,2 @@
+Total Employees
+3
diff --git a/tests/acceptance/test_files/backend.bats b/tests/acceptance/test_files/backend.bats
@@ -0,0 +1,22 @@
+load "$LIB_BATS_ASSERT/load.bash"
+load "$LIB_BATS_SUPPORT/load.bash"
+
+@test "connecting to a duckdb backend" {
+  cd $MODS_DIR/duckdb_mod
+
+  # run a powerpipe query connecting to a local duckdb database
+  run powerpipe query run query.total_employee --database duckdb:///$MODS_DIR/duckdb_mod/employee.duckdb --output csv
+  echo $output
+  # check output
+  assert_equal "$output" "$(cat $TEST_DATA_DIR/expected_duckdb_backend_total_employee.csv)"
+}
+
+@test "using json extension(casting) with duckdb backend" {
+  cd $MODS_DIR/duckdb_mod
+
+  # run a powerpipe query(which performs a JSON casting operation) connecting to a local duckdb database
+  run powerpipe query run query.json_casting --database duckdb:///$MODS_DIR/duckdb_mod/employee.duckdb --output csv
+  echo $output
+  # check output
+  assert_equal "$output" "$(cat $TEST_DATA_DIR/expected_duckdb_backend_json_casting.csv)"
+}