Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make Go example tests robust to metadata order #3652

Merged
merged 2 commits into from
Apr 3, 2023
Merged

Make Go example tests robust to metadata order #3652

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fdee5d5
Made metadata print in a consistent order so that tests are determini…
chipkent Apr 3, 2023
49852eb
minor rename.
chipkent Apr 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions go/internal/test_tools/test_tools.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"fmt"
"math/rand"
"os"
"sort"
"testing"

"github.com/apache/arrow/go/v8/arrow"
Expand Down Expand Up @@ -110,3 +111,37 @@ func GetAuthToken() string {
return auth
}
}

type sortableMetadata arrow.Metadata

func (m sortableMetadata) Len() int { md := arrow.Metadata(m); return md.Len() }
func (m sortableMetadata) Less(i, j int) bool {
md := arrow.Metadata(m)
return md.Keys()[i] < md.Keys()[j]
}
func (m sortableMetadata) Swap(i, j int) {
md := arrow.Metadata(m)
k := md.Keys()
v := md.Values()
k[i], k[j] = k[j], k[i]
v[i], v[j] = v[j], v[i]
}

// RecordString returns a string representation of a record in a deterministic way that is safe to use for diffs.
func RecordString(r arrow.Record) string {

if s := r.Schema(); s != nil {
sort.Sort(sortableMetadata(s.Metadata()))

for _, f := range s.Fields() {
sort.Sort(sortableMetadata(f.Metadata))
}
}

return fmt.Sprintf("%v", r)
}

// RecordPrint prints a record in a deterministic way that is safe to use for diffs.
func RecordPrint(r arrow.Record) {
fmt.Println(RecordString(r))
}
12 changes: 6 additions & 6 deletions go/pkg/client/example_import_table_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ func Example_importTable() {
defer sampleRecord.Release()

fmt.Println("Data Before:")
fmt.Println(sampleRecord)
test_tools.RecordPrint(sampleRecord)

// Now we upload the record so that we can manipulate its data using the server.
// We get back a TableHandle, which is a reference to a table on the server.
Expand Down Expand Up @@ -68,7 +68,7 @@ func Example_importTable() {
defer filteredRecord.Release()

fmt.Println("Data After:")
fmt.Println(filteredRecord)
test_tools.RecordPrint(filteredRecord)

// Output:
// Data Before:
Expand All @@ -88,12 +88,12 @@ func Example_importTable() {
// schema:
// fields: 3
// - Ticker: type=utf8, nullable
// metadata: ["deephaven:isRowStyle": "false", "deephaven:isNumberFormat": "false", "deephaven:isStyle": "false", "deephaven:type": "java.lang.String", "deephaven:isDateFormat": "false"]
// metadata: ["deephaven:isDateFormat": "false", "deephaven:isNumberFormat": "false", "deephaven:isRowStyle": "false", "deephaven:isStyle": "false", "deephaven:type": "java.lang.String"]
// - Close: type=float32, nullable
// metadata: ["deephaven:isRowStyle": "false", "deephaven:isNumberFormat": "false", "deephaven:isStyle": "false", "deephaven:type": "float", "deephaven:isDateFormat": "false"]
// metadata: ["deephaven:isDateFormat": "false", "deephaven:isNumberFormat": "false", "deephaven:isRowStyle": "false", "deephaven:isStyle": "false", "deephaven:type": "float"]
// - Volume: type=int32, nullable
// metadata: ["deephaven:isRowStyle": "false", "deephaven:isNumberFormat": "false", "deephaven:isStyle": "false", "deephaven:type": "int", "deephaven:isDateFormat": "false"]
// metadata: ["deephaven:attribute.SortedColumns": "Close=Ascending", "deephaven:attribute_type.SortedColumns": "java.lang.String", "deephaven:attribute_type.AddOnly": "java.lang.Boolean", "deephaven:attribute.AddOnly": "true", "deephaven:attribute_type.AppendOnly": "java.lang.Boolean", "deephaven:attribute.AppendOnly": "true"]
// metadata: ["deephaven:isDateFormat": "false", "deephaven:isNumberFormat": "false", "deephaven:isRowStyle": "false", "deephaven:isStyle": "false", "deephaven:type": "int"]
// metadata: ["deephaven:attribute.AddOnly": "true", "deephaven:attribute.AppendOnly": "true", "deephaven:attribute.SortedColumns": "Close=Ascending", "deephaven:attribute_type.AddOnly": "java.lang.Boolean", "deephaven:attribute_type.AppendOnly": "java.lang.Boolean", "deephaven:attribute_type.SortedColumns": "java.lang.String"]
// rows: 5
// col[0][Ticker]: ["IBM" "XRX" "XYZZY" "GME" "ZNGA"]
// col[1][Close]: [38.7 53.8 88.5 453 544.9]
Expand Down
8 changes: 4 additions & 4 deletions go/pkg/client/example_input_table_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ func Example_inputTable() {
}

fmt.Println("Got the output table!")
fmt.Println(outputRec)
test_tools.RecordPrint(outputRec)
outputRec.Release()
break
}
Expand All @@ -124,11 +124,11 @@ func Example_inputTable() {
// schema:
// fields: 3
// - Ticker: type=utf8, nullable
// metadata: ["deephaven:isRowStyle": "false", "deephaven:type": "java.lang.String", "deephaven:isNumberFormat": "false", "deephaven:isStyle": "false", "deephaven:inputtable.isKey": "true", "deephaven:isDateFormat": "false"]
// metadata: ["deephaven:inputtable.isKey": "true", "deephaven:isDateFormat": "false", "deephaven:isNumberFormat": "false", "deephaven:isRowStyle": "false", "deephaven:isStyle": "false", "deephaven:type": "java.lang.String"]
// - Close: type=float32, nullable
// metadata: ["deephaven:isRowStyle": "false", "deephaven:type": "float", "deephaven:isNumberFormat": "false", "deephaven:isStyle": "false", "deephaven:inputtable.isKey": "false", "deephaven:isDateFormat": "false"]
// metadata: ["deephaven:inputtable.isKey": "false", "deephaven:isDateFormat": "false", "deephaven:isNumberFormat": "false", "deephaven:isRowStyle": "false", "deephaven:isStyle": "false", "deephaven:type": "float"]
// - Volume: type=int32, nullable
// metadata: ["deephaven:isRowStyle": "false", "deephaven:type": "int", "deephaven:isNumberFormat": "false", "deephaven:isStyle": "false", "deephaven:inputtable.isKey": "false", "deephaven:isDateFormat": "false"]
// metadata: ["deephaven:inputtable.isKey": "false", "deephaven:isDateFormat": "false", "deephaven:isNumberFormat": "false", "deephaven:isRowStyle": "false", "deephaven:isStyle": "false", "deephaven:type": "int"]
// metadata: ["deephaven:unsent.attribute.InputTable": ""]
// rows: 4
// col[0][Ticker]: ["XRX" "XYZZY" "GME" "ZNGA"]
Expand Down
21 changes: 11 additions & 10 deletions go/pkg/client/example_table_ops_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ func Example_tableOps() {

fmt.Println(queryResult)

// Output:
// Data Before:
// record:
// schema:
Expand All @@ -51,12 +52,12 @@ func Example_tableOps() {
// schema:
// fields: 3
// - Ticker: type=utf8, nullable
// metadata: ["deephaven:isRowStyle": "false", "deephaven:isNumberFormat": "false", "deephaven:isStyle": "false", "deephaven:type": "java.lang.String", "deephaven:isDateFormat": "false"]
// metadata: ["deephaven:isDateFormat": "false", "deephaven:isNumberFormat": "false", "deephaven:isRowStyle": "false", "deephaven:isStyle": "false", "deephaven:type": "java.lang.String"]
// - Close: type=float32, nullable
// metadata: ["deephaven:isRowStyle": "false", "deephaven:isNumberFormat": "false", "deephaven:isStyle": "false", "deephaven:type": "float", "deephaven:isDateFormat": "false"]
// metadata: ["deephaven:isDateFormat": "false", "deephaven:isNumberFormat": "false", "deephaven:isRowStyle": "false", "deephaven:isStyle": "false", "deephaven:type": "float"]
// - Volume: type=int32, nullable
// metadata: ["deephaven:isRowStyle": "false", "deephaven:isNumberFormat": "false", "deephaven:isStyle": "false", "deephaven:type": "int", "deephaven:isDateFormat": "false"]
// metadata: ["deephaven:attribute_type.AppendOnly": "java.lang.Boolean", "deephaven:attribute.AppendOnly": "true", "deephaven:attribute_type.AddOnly": "java.lang.Boolean", "deephaven:attribute.AddOnly": "true"]
// metadata: ["deephaven:isDateFormat": "false", "deephaven:isNumberFormat": "false", "deephaven:isRowStyle": "false", "deephaven:isStyle": "false", "deephaven:type": "int"]
// metadata: ["deephaven:attribute.AddOnly": "true", "deephaven:attribute.AppendOnly": "true", "deephaven:attribute_type.AddOnly": "java.lang.Boolean", "deephaven:attribute_type.AppendOnly": "java.lang.Boolean"]
// rows: 5
// col[0][Ticker]: ["XRX" "IBM" "GME" "AAPL" "ZNGA"]
// col[1][Close]: [53.8 38.7 453 26.7 544.9]
Expand All @@ -66,13 +67,13 @@ func Example_tableOps() {
// schema:
// fields: 4
// - Ticker: type=utf8, nullable
// metadata: ["deephaven:isRowStyle": "false", "deephaven:isNumberFormat": "false", "deephaven:isStyle": "false", "deephaven:type": "java.lang.String", "deephaven:isDateFormat": "false"]
// metadata: ["deephaven:isDateFormat": "false", "deephaven:isNumberFormat": "false", "deephaven:isRowStyle": "false", "deephaven:isStyle": "false", "deephaven:type": "java.lang.String"]
// - Close: type=float32, nullable
// metadata: ["deephaven:isRowStyle": "false", "deephaven:isNumberFormat": "false", "deephaven:isStyle": "false", "deephaven:type": "float", "deephaven:isDateFormat": "false"]
// metadata: ["deephaven:isDateFormat": "false", "deephaven:isNumberFormat": "false", "deephaven:isRowStyle": "false", "deephaven:isStyle": "false", "deephaven:type": "float"]
// - Volume: type=int32, nullable
// metadata: ["deephaven:isRowStyle": "false", "deephaven:isNumberFormat": "false", "deephaven:isStyle": "false", "deephaven:type": "int", "deephaven:isDateFormat": "false"]
// metadata: ["deephaven:isDateFormat": "false", "deephaven:isNumberFormat": "false", "deephaven:isRowStyle": "false", "deephaven:isStyle": "false", "deephaven:type": "int"]
// - Magnitude: type=int32, nullable
// metadata: ["deephaven:isRowStyle": "false", "deephaven:isNumberFormat": "false", "deephaven:isStyle": "false", "deephaven:type": "int", "deephaven:isDateFormat": "false"]
// metadata: ["deephaven:isDateFormat": "false", "deephaven:isNumberFormat": "false", "deephaven:isRowStyle": "false", "deephaven:isStyle": "false", "deephaven:type": "int"]
// rows: 5
// col[0][Ticker]: ["XRX" "IBM" "GME" "AAPL" "ZNGA"]
// col[1][Close]: [53.8 38.7 453 26.7 544.9]
Expand Down Expand Up @@ -159,7 +160,7 @@ func doImmediateOps() (string, error) {
}
defer magRecord.Release()

return fmt.Sprintf("Data Before:\n%s\nNew data:\n%s\n%s", sampleRecord, midRecord, magRecord), nil
return fmt.Sprintf("Data Before:\n%s\nNew data:\n%s\n%s", test_tools.RecordString(sampleRecord), test_tools.RecordString(midRecord), test_tools.RecordString(magRecord)), nil
}

// This function demonstrates how to use query-graph table operations.
Expand Down Expand Up @@ -239,5 +240,5 @@ func doQueryOps() (string, error) {
}
defer magRecord.Release()

return fmt.Sprintf("Data Before:\n%s\nNew data:\n%s\n%s", sampleRecord, midRecord, magRecord), nil
return fmt.Sprintf("Data Before:\n%s\nNew data:\n%s\n%s", test_tools.RecordString(sampleRecord), test_tools.RecordString(midRecord), test_tools.RecordString(magRecord)), nil
}