Merge pull request #40 from atlanhq/DVX-525

DVX-525: Fixed missing "description" in the `SearchAttributes` struct
atlanhq · Jun 19, 2024 · 68a4383 · 68a4383
2 parents f54645b + badda1f
commit 68a4383
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 4 deletions.
diff --git a/atlan/assets/fluent_search_test.go b/atlan/assets/fluent_search_test.go
@@ -2,12 +2,16 @@ package assets
 
 import (
 	"fmt"
-	"github.com/atlanhq/atlan-go/atlan"
-	"github.com/stretchr/testify/assert"
 	"testing"
 	"time"
+
+	"github.com/atlanhq/atlan-go/atlan"
+	"github.com/atlanhq/atlan-go/atlan/model/structs"
+	"github.com/stretchr/testify/assert"
 )
 
+const GlossaryDescription = "Automated testing of GO SDK."
+
 func TestIntegrationFluentSearch(t *testing.T) {
 	if testing.Short() {
 		t.Skip("skipping integration test")
@@ -17,6 +21,7 @@ func TestIntegrationFluentSearch(t *testing.T) {
 	// Create a glossary
 	g := &AtlasGlossary{}
 	g.Creator(GlossaryName, atlan.AtlanIconAirplaneInFlight)
+	g.Description = structs.StringPtr(GlossaryDescription)
 	response, err := Save(g)
 	if err != nil {
 		t.Errorf("Error: %v", err)
@@ -29,7 +34,7 @@ func TestIntegrationFluentSearch(t *testing.T) {
 		PageSizes(10).
 		ActiveAssets().
 		Where(ctx.Glossary.NAME.Eq(GlossaryName)).
-		//IncludeOnResults("guid").
+		IncludeOnResults("description").
 		Execute()
 
 	if err != nil {
@@ -40,6 +45,7 @@ func TestIntegrationFluentSearch(t *testing.T) {
 	assert.NotNil(t, searchResult, "search result should not be nil")
 	assert.Equal(t, 1, len(searchResult), "number of glossaries should be 1")
 	assert.Equal(t, GlossaryName, *searchResult[0].Entities[0].DisplayName, "glossary name should match")
+	assert.Equal(t, GlossaryDescription, *searchResult[0].Entities[0].Description, "glossary description should exist")
 
 	// Search for glossaries starts with letter G and sort them in ascending order by name
 	searchResult, err = NewFluentSearch().
@@ -49,6 +55,11 @@ func TestIntegrationFluentSearch(t *testing.T) {
 		Sort(NAME, atlan.SortOrderAscending).
 		Execute()
 
+	if err != nil {
+		fmt.Printf("Error executing search: %v\n", err)
+		return
+	}
+
 	assert.Equal(t, 1, len(searchResult), "number of glossaries should be 1")
 	assert.Equal(t, "g", string((*searchResult[0].Entities[0].DisplayName)[0]), "glossary name should start with G")
 

diff --git a/atlan/assets/glossary_client.go b/atlan/assets/glossary_client.go
@@ -3,9 +3,10 @@ package assets
 import (
 	"encoding/json"
 	"errors"
+	"time"
+
 	"github.com/atlanhq/atlan-go/atlan"
 	"github.com/atlanhq/atlan-go/atlan/model/structs"
-	"time"
 )
 
 const (
@@ -126,6 +127,9 @@ func (g *AtlasGlossary) MarshalJSON() ([]byte, error) {
 	if g.DisplayName != nil && *g.DisplayName != "" {
 		customJSON["attributes"].(map[string]interface{})["displayName"] = *g.DisplayName
 	}
+	if g.Description != nil && *g.Description != "" {
+		customJSON["attributes"].(map[string]interface{})["description"] = *g.Description
+	}
 
 	// Marshal the custom JSON
 	return json.MarshalIndent(customJSON, "", "  ")

diff --git a/atlan/model/search.go b/atlan/model/search.go
@@ -4,6 +4,7 @@ package model
 
 import (
 	"encoding/json"
+
 	"github.com/atlanhq/atlan-go/atlan"
 	"github.com/atlanhq/atlan-go/atlan/model/structs"
 )
@@ -485,6 +486,7 @@ type SearchAttributes struct {
 	QualifiedName     *string                    `json:"qualifiedName,omitempty"`
 	Name              *string                    `json:"name,omitempty"`
 	UserDescription   *string                    `json:"userDescription,omitempty"`
+	Description       *string                    `json:"description,omitempty"`
 	DataType          *string                    `json:"dataType,omitempty"`
 	IsPrimary         *bool                      `json:"isPrimary,omitempty"`
 	IsNullable        *bool                      `json:"isNullable,omitempty"`
@@ -534,6 +536,7 @@ func (sa *SearchAssets) UnmarshalJSON(data []byte) error {
 		sa.Name = aux.SearchAttributes.Name
 		sa.QualifiedName = aux.SearchAttributes.QualifiedName
 		sa.DataType = aux.SearchAttributes.DataType
+		sa.Description = aux.SearchAttributes.Description
 		sa.UserDescription = aux.SearchAttributes.UserDescription
 		sa.IsPrimary = aux.SearchAttributes.IsPrimary
 		sa.IsNullable = aux.SearchAttributes.IsNullable