cli: add support for health_check metadata object in sources

PR-URL: hasura/graphql-engine-mono#5287 GitOrigin-RevId: be7e1d19b9875cf05a52a9894cf2bda58b209733
hasura · Aug 3, 2022 · 48a0a34 · 48a0a34
1 parent a1fc55e
commit 48a0a34
Show file tree

Hide file tree

Showing 6 changed files with 282 additions and 4 deletions.
diff --git a/cli/internal/metadataobject/sources/sources.go b/cli/internal/metadataobject/sources/sources.go
@@ -28,6 +28,7 @@ type SourceWithNormalFields struct {
 	Configuration yaml.Node `yaml:"configuration"`
 	QueryTags     yaml.Node `yaml:"query_tags,omitempty"`
 	Customization yaml.Node `yaml:"customization,omitempty"`
+	HealthCheck	  yaml.Node `yaml:"health_check,omitempty"`
 }
 type Source struct {
 	SourceWithNormalFields `yaml:",inline"`

diff --git a/cli/internal/metadataobject/sources/sources_test.go b/cli/internal/metadataobject/sources/sources_test.go
@@ -1,6 +1,8 @@
 package sources
 
 import (
+	"bytes"
+	"encoding/json"
 	"io/ioutil"
 	"testing"
 
@@ -51,13 +53,15 @@ func TestSourceConfig_Build(t *testing.T) {
 				assert.NoError(t, err)
 				jsonbs, err := goyaml.YAMLToJSON(gotbs)
 				assert.NoError(t, err)
-
+				var pretty_jsonbs bytes.Buffer
+				err = json.Indent(&pretty_jsonbs, jsonbs, "", " ")
+				assert.NoError(t, err)
 				// uncomment following lines to update golden file
-				// assert.NoError(t, ioutil.WriteFile(tt.wantGolden, jsonbs, os.ModePerm))
+				// assert.NoError(t, ioutil.WriteFile(tt.wantGolden, pretty_jsonbs.Bytes(), os.ModePerm))
 
 				wantbs, err := ioutil.ReadFile(tt.wantGolden)
 				assert.NoError(t, err)
-				assert.Equal(t, string(wantbs), string(jsonbs))
+				assert.Equal(t, string(wantbs), pretty_jsonbs.String())
 			}
 		})
 	}

diff --git a/cli/internal/metadataobject/sources/testdata/build_test/t1/metadata/databases/databases.yaml b/cli/internal/metadataobject/sources/testdata/build_test/t1/metadata/databases/databases.yaml
@@ -19,6 +19,12 @@
       suffix: null
       prefix: null
       namespace: mynamespace
+  health_check:
+    interval: 10
+    retries: 3
+    test:
+      sql: SELECT 1
+    timeout: 5  
   tables: !include "s1/tables/tables.yaml"
   functions: !include "s1/functions/functions.yaml"
 - name: s2

diff --git a/cli/internal/metadataobject/sources/testdata/build_test/t1/want.golden.json b/cli/internal/metadataobject/sources/testdata/build_test/t1/want.golden.json
@@ -1 +1,254 @@
-{"sources": [{"name": "s1", "kind": "postgres", "configuration": {"connection_info": {"database_url": {"from_env": "HASURA_GRAPHQL_DATABASE_URL"}, "isolation_level": "read-committed", "pool_settings": {"idle_timeout": 180, "max_connections": 50, "retries": 1}, "use_prepared_statements": true}}, "query_tags": {"disabled": false, "format": "standard"}, "customization": {"type_names": null, "root_fields": {"suffix": null, "prefix": null, "namespace": "mynamespace"}}, "tables": [{"table": {"name": "t1", "schema": "public"}}, {"table": {"name": "t2", "schema": "public"}}], "functions": [{"function": {"name": "get_t1", "schema": "public"}}, {"function": {"name": "get_t2", "schema": "public"}}]}, {"name": "s2", "kind": "postgres", "configuration": {"connection_info": {"database_url": {"from_env": "HASURA_GRAPHQL_DATABASE_URL"}, "isolation_level": "read-committed", "pool_settings": {"idle_timeout": 180, "max_connections": 50, "retries": 1}, "use_prepared_statements": true}}, "tables": [{"table": {"name": "t1", "schema": "public"}}, {"table": {"name": "t2", "schema": "public"}}], "functions": [{"function": {"name": "get_t1", "schema": "public"}}, {"function": {"name": "get_t2", "schema": "public"}}]}, {"name": "s 3", "kind": "postgres", "configuration": {"connection_info": {"database_url": {"from_env": "HASURA_GRAPHQL_DATABASE_URL"}, "isolation_level": "read-committed", "pool_settings": {"idle_timeout": 180, "max_connections": 50, "retries": 1}, "use_prepared_statements": true}}, "tables": [{"table": {"name": "t1", "schema": "public"}}, {"table": {"name": "t2", "schema": "public"}}], "functions": [{"function": {"name": "get_t1", "schema": "public"}}, {"function": {"name": "get_t2", "schema": "public"}}]}, {"name": "s 4", "kind": "postgres", "configuration": {"connection_info": {"database_url": {"from_env": "HASURA_GRAPHQL_DATABASE_URL"}, "isolation_level": "read-committed", "pool_settings": {"idle_timeout": 180, "max_connections": 50, "retries": 1}, "use_prepared_statements": true}}, "tables": [{"table": {"name": "t1", "schema": "public"}}, {"table": {"name": "t2", "schema": "public"}}], "functions": [{"function": {"name": "get_t1", "schema": "public"}}, {"function": {"name": "get_t2", "schema": "public"}}]}, {"name": "s 5", "kind": "postgres", "configuration": {"connection_info": {"database_url": {"from_env": "HASURA_GRAPHQL_DATABASE_URL"}, "isolation_level": "read-committed", "pool_settings": {"idle_timeout": 180, "max_connections": 50, "retries": 1}, "use_prepared_statements": true}}, "tables": [{"table": {"name": "t1", "schema": "public"}}, {"table": {"name": "t2", "schema": "public"}}], "functions": [{"function": {"name": "get_t1", "schema": "public"}}, {"function": {"name": "get_t2", "schema": "public"}}]}]}
+{
+ "sources": [
+  {
+   "name": "s1",
+   "kind": "postgres",
+   "configuration": {
+    "connection_info": {
+     "database_url": {
+      "from_env": "HASURA_GRAPHQL_DATABASE_URL"
+     },
+     "isolation_level": "read-committed",
+     "pool_settings": {
+      "idle_timeout": 180,
+      "max_connections": 50,
+      "retries": 1
+     },
+     "use_prepared_statements": true
+    }
+   },
+   "query_tags": {
+    "disabled": false,
+    "format": "standard"
+   },
+   "customization": {
+    "type_names": null,
+    "root_fields": {
+     "suffix": null,
+     "prefix": null,
+     "namespace": "mynamespace"
+    }
+   },
+   "health_check": {
+    "interval": 10,
+    "retries": 3,
+    "test": {
+     "sql": "SELECT 1"
+    },
+    "timeout": 5
+   },
+   "tables": [
+    {
+     "table": {
+      "name": "t1",
+      "schema": "public"
+     }
+    },
+    {
+     "table": {
+      "name": "t2",
+      "schema": "public"
+     }
+    }
+   ],
+   "functions": [
+    {
+     "function": {
+      "name": "get_t1",
+      "schema": "public"
+     }
+    },
+    {
+     "function": {
+      "name": "get_t2",
+      "schema": "public"
+     }
+    }
+   ]
+  },
+  {
+   "name": "s2",
+   "kind": "postgres",
+   "configuration": {
+    "connection_info": {
+     "database_url": {
+      "from_env": "HASURA_GRAPHQL_DATABASE_URL"
+     },
+     "isolation_level": "read-committed",
+     "pool_settings": {
+      "idle_timeout": 180,
+      "max_connections": 50,
+      "retries": 1
+     },
+     "use_prepared_statements": true
+    }
+   },
+   "tables": [
+    {
+     "table": {
+      "name": "t1",
+      "schema": "public"
+     }
+    },
+    {
+     "table": {
+      "name": "t2",
+      "schema": "public"
+     }
+    }
+   ],
+   "functions": [
+    {
+     "function": {
+      "name": "get_t1",
+      "schema": "public"
+     }
+    },
+    {
+     "function": {
+      "name": "get_t2",
+      "schema": "public"
+     }
+    }
+   ]
+  },
+  {
+   "name": "s 3",
+   "kind": "postgres",
+   "configuration": {
+    "connection_info": {
+     "database_url": {
+      "from_env": "HASURA_GRAPHQL_DATABASE_URL"
+     },
+     "isolation_level": "read-committed",
+     "pool_settings": {
+      "idle_timeout": 180,
+      "max_connections": 50,
+      "retries": 1
+     },
+     "use_prepared_statements": true
+    }
+   },
+   "tables": [
+    {
+     "table": {
+      "name": "t1",
+      "schema": "public"
+     }
+    },
+    {
+     "table": {
+      "name": "t2",
+      "schema": "public"
+     }
+    }
+   ],
+   "functions": [
+    {
+     "function": {
+      "name": "get_t1",
+      "schema": "public"
+     }
+    },
+    {
+     "function": {
+      "name": "get_t2",
+      "schema": "public"
+     }
+    }
+   ]
+  },
+  {
+   "name": "s 4",
+   "kind": "postgres",
+   "configuration": {
+    "connection_info": {
+     "database_url": {
+      "from_env": "HASURA_GRAPHQL_DATABASE_URL"
+     },
+     "isolation_level": "read-committed",
+     "pool_settings": {
+      "idle_timeout": 180,
+      "max_connections": 50,
+      "retries": 1
+     },
+     "use_prepared_statements": true
+    }
+   },
+   "tables": [
+    {
+     "table": {
+      "name": "t1",
+      "schema": "public"
+     }
+    },
+    {
+     "table": {
+      "name": "t2",
+      "schema": "public"
+     }
+    }
+   ],
+   "functions": [
+    {
+     "function": {
+      "name": "get_t1",
+      "schema": "public"
+     }
+    },
+    {
+     "function": {
+      "name": "get_t2",
+      "schema": "public"
+     }
+    }
+   ]
+  },
+  {
+   "name": "s 5",
+   "kind": "postgres",
+   "configuration": {
+    "connection_info": {
+     "database_url": {
+      "from_env": "HASURA_GRAPHQL_DATABASE_URL"
+     },
+     "isolation_level": "read-committed",
+     "pool_settings": {
+      "idle_timeout": 180,
+      "max_connections": 50,
+      "retries": 1
+     },
+     "use_prepared_statements": true
+    }
+   },
+   "tables": [
+    {
+     "table": {
+      "name": "t1",
+      "schema": "public"
+     }
+    },
+    {
+     "table": {
+      "name": "t2",
+      "schema": "public"
+     }
+    }
+   ],
+   "functions": [
+    {
+     "function": {
+      "name": "get_t1",
+      "schema": "public"
+     }
+    },
+    {
+     "function": {
+      "name": "get_t2",
+      "schema": "public"
+     }
+    }
+   ]
+  }
+ ]
+}
diff --git a/cli/internal/metadataobject/sources/testdata/export_test/t1/metadata.json b/cli/internal/metadataobject/sources/testdata/export_test/t1/metadata.json
@@ -106,6 +106,14 @@
           "prefix": null,
           "namespace": "mynamespace"
         }
+      },
+      "health_check": {
+        "interval": 10,
+        "retries": 3,
+        "test": {
+          "sql": "SELECT 1"
+        },        
+        "timeout": 5
       }
     },
     {

diff --git a/cli/internal/metadataobject/sources/testdata/export_test/t1/want/databases/databases.yaml b/cli/internal/metadataobject/sources/testdata/export_test/t1/want/databases/databases.yaml
@@ -19,6 +19,12 @@
       suffix: null
       prefix: null
       namespace: mynamespace
+  health_check:
+    interval: 10
+    retries: 3
+    test:
+      sql: SELECT 1
+    timeout: 5
   tables: "!include default/tables/tables.yaml"
   functions: "!include default/functions/functions.yaml"
 - name: bg