Merge pull request #22 from teamhava/bug/dev-1753/fix-derefernce-segf…

…ault Added a safe derefence method for printing values to screen
teamhava · Oct 23, 2023 · ed9f214 · ed9f214
2 parents a9fc197 + 34725cc
commit ed9f214
Show file tree

Hide file tree

Showing 8 changed files with 85 additions and 11 deletions.
diff --git a/.gitignore b/.gitignore
@@ -27,3 +27,6 @@ go.work
 hava
 hava-ui-cli
 dist/
+
+# system files
+.DS_Store
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -0,0 +1,16 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Launch Package",
+      "type": "go",
+      "request": "launch",
+      "mode": "auto",
+      "program": "${workspaceFolder}",
+      "args": ["source", "list"]
+    }
+  ]
+}
diff --git a/cmd/source.go b/cmd/source.go
@@ -43,7 +43,13 @@ func showSourceId(api *havaclient.APIClient, sourceId string) {
 	}
 
 	o.AddTableHeaders("DisplayName", "Id", "Info", "Name", "State", "Type")
-	o.AddTableRows(*source.DisplayName, *source.Id, *source.Info, *source.Name, *source.State, *source.Type)
+	o.AddTableRows(
+		SafeDeref(source.DisplayName), 
+		SafeDeref(source.Id),
+		SafeDeref(source.Info), 
+		SafeDeref(source.Name), 
+		SafeDeref(source.State), 
+		SafeDeref(source.Type))
 
 }
 
@@ -66,13 +72,20 @@ func showSources(api *havaclient.APIClient) {
 
 	//Length of Results
 
-	if len(source.Results) > 0 {
+	numResults := len(source.Results)
+
+	if numResults > 0 {
 
 		o.AddTableHeaders("DisplayName", "Id", "Info", "Name", "State", "Type")
 		// Loop through results
-		for i := 0; i < len(source.Results); i++ {
-
-			o.AddTableRows(*source.Results[i].DisplayName, *source.Results[i].Id, *source.Results[i].Info, *source.Results[i].Name, *source.Results[i].State, *source.Results[i].Type)
+		for i := 0; i < numResults; i++ {
+			o.AddTableRows(
+				SafeDeref(source.Results[i].DisplayName), 
+				SafeDeref(source.Results[i].Id), 
+				SafeDeref(source.Results[i].Info), 
+				SafeDeref(source.Results[i].Name), 
+				SafeDeref(source.Results[i].State), 
+				SafeDeref(source.Results[i].Type))
 		}
 
 	} else {

diff --git a/cmd/source_create_aws.go b/cmd/source_create_aws.go
@@ -87,8 +87,13 @@ func sourceCreateAwsKey(api *havaclient.APIClient, sourceName string, awsType st
 
 	o.AddInfoMessage("Created AWS Source for the following source:\n")
 	o.AddTableHeaders("DisplayName", "Id", "Info", "Name", "State", "Type")
-	o.AddTableRows(*source.DisplayName, *source.Id, *source.Info, *source.Name, *source.State, *source.Type)
-
+	o.AddTableRows(
+		SafeDeref(source.DisplayName), 
+		SafeDeref(source.Id), 
+		SafeDeref(source.Info), 
+		SafeDeref(source.Name), 
+		SafeDeref(source.State), 
+		SafeDeref(source.Type))
 }
 
 func sourceCreateAwsCar(api *havaclient.APIClient, sourceName string, awsType string, roleArn string, externalID string) {
@@ -121,6 +126,12 @@ func sourceCreateAwsCar(api *havaclient.APIClient, sourceName string, awsType st
 
 	o.AddInfoMessage("Created AWS Source for the following source:\n")
 	o.AddTableHeaders("DisplayName", "Id", "Info", "Name", "State", "Type")
-	o.AddTableRows(*source.DisplayName, *source.Id, *source.Info, *source.Name, *source.State, *source.Type)
+	o.AddTableRows(
+		SafeDeref(source.DisplayName), 
+		SafeDeref(source.Id), 
+		SafeDeref(source.Info), 
+		SafeDeref(source.Name), 
+		SafeDeref(source.State), 
+		SafeDeref(source.Type))
 
 }
diff --git a/cmd/source_create_azure.go b/cmd/source_create_azure.go
@@ -88,6 +88,12 @@ func sourceCreateAzure(api *havaclient.APIClient, sourceName string, sourceType
 
 	o.AddInfoMessage("Created Azure Source for the following source:\n")
 	o.AddTableHeaders("DisplayName", "Id", "Info", "Name", "State", "Type")
-	o.AddTableRows(*source.DisplayName, *source.Id, *source.Info, *source.Name, *source.State, *source.Type)
+	o.AddTableRows(
+		SafeDeref(source.DisplayName), 
+		SafeDeref(source.Id), 
+		SafeDeref(source.Info), 
+		SafeDeref(source.Name), 
+		SafeDeref(source.State), 
+		SafeDeref(source.Type))
 
 }
diff --git a/cmd/source_create_gcp.go b/cmd/source_create_gcp.go
@@ -76,6 +76,12 @@ func sourceCreateGcp(api *havaclient.APIClient, sourceName string, sourceType st
 
 	o.AddInfoMessage("Created GCP Source for the following source:\n")
 	o.AddTableHeaders("DisplayName", "Id", "Info", "Name", "State", "Type")
-	o.AddTableRows(*source.DisplayName, *source.Id, *source.Info, *source.Name, *source.State, *source.Type)
+	o.AddTableRows(
+		SafeDeref(source.DisplayName), 
+		SafeDeref(source.Id), 
+		SafeDeref(source.Info), 
+		SafeDeref(source.Name), 
+		SafeDeref(source.State), 
+		SafeDeref(source.Type))
 
 }
diff --git a/cmd/source_sync.go b/cmd/source_sync.go
@@ -79,6 +79,12 @@ func syncSourceID(api *havaclient.APIClient, sourceId string) {
 
 	o.AddInfoMessage("Sync scheduled for the following source:")
 	o.AddTableHeaders("DisplayName", "Id", "Info", "Name", "State", "Type")
-	o.AddTableRows(*source.DisplayName, *source.Id, *source.Info, *source.Name, *source.State, *source.Type)
+	o.AddTableRows(
+		SafeDeref(source.DisplayName), 
+		SafeDeref(source.Id), 
+		SafeDeref(source.Info), 
+		SafeDeref(source.Name), 
+		SafeDeref(source.State), 
+		SafeDeref(source.Type))
 
 }
diff --git a/cmd/utils.go b/cmd/utils.go
@@ -0,0 +1,13 @@
+package cmd
+
+// SafeDeref is used to safely derefence a pointer where it might point to null
+// In the case where it points to null it will return the default value for the type
+// rather than a runtime error / segfault
+func SafeDeref[T any](pointer *T) T {
+	if pointer == nil {
+		var defaultValue T
+		return defaultValue
+	}
+
+	return *pointer
+}