Files
genai-toolbox/internal/util/orderedmap/orderedmap_test.go
Bala Narasimhan c5962bd96f chore: introduce orderedmap to preserve column order in SQL results during marshal (#1852)
This commit introduces a new `orderedmap` package to preserve the column
order of SQL query results when they are marshaled to JSON.

The default Go `json.Marshal` function sorts map keys, which was causing
the column order to be lost in the output of the database tools.

This commit updates the following tools to use the new `orderedmap`
package:
- `mysqlexecutesql`
- `mssqlexecutesql`
- `postgresexecutesql`
- `spannerexecutesql`
- `sqliteexecutesql`
- `bigqueryexecutesql`

A new test has been added to the `mysqlexecutesql` tool to verify that
the column order is preserved.

## Description

> Should include a concise description of the changes (bug or feature),
it's
> impact, along with a summary of the solution

## PR Checklist

> Thank you for opening a Pull Request! Before submitting your PR, there
are a
> few things you can do to make sure it goes smoothly:

- [ ] Make sure you reviewed

[CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md)
- [ ] Make sure to open an issue as a

[bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose)
  before writing your code! That way we can discuss the change, evaluate
  designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
- [ ] Make sure to add `!` if this involve a breaking change

🛠️ Fixes #1492

---------

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
Co-authored-by: Yuan Teoh <yuanteoh@google.com>
Co-authored-by: Yuan Teoh <45984206+Yuan325@users.noreply.github.com>
2025-11-05 18:43:33 +00:00

84 lines
1.8 KiB
Go

// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package orderedmap
import (
"encoding/json"
"testing"
)
func TestRowMarshalJSON(t *testing.T) {
tests := []struct {
name string
row Row
want string
wantErr bool
}{
{
name: "Simple row",
row: Row{
Columns: []Column{
{Name: "A", Value: 1},
{Name: "B", Value: "two"},
{Name: "C", Value: true},
},
},
want: `{"A":1,"B":"two","C":true}`,
wantErr: false,
},
{
name: "Row with different order",
row: Row{
Columns: []Column{
{Name: "C", Value: true},
{Name: "A", Value: 1},
{Name: "B", Value: "two"},
},
},
want: `{"C":true,"A":1,"B":"two"}`,
wantErr: false,
},
{
name: "Empty row",
row: Row{},
want: `{}`,
wantErr: false,
},
{
name: "Row with nil value",
row: Row{
Columns: []Column{
{Name: "A", Value: 1},
{Name: "B", Value: nil},
},
},
want: `{"A":1,"B":null}`,
wantErr: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := json.Marshal(tt.row)
if (err != nil) != tt.wantErr {
t.Errorf("Row.MarshalJSON() error = %v, wantErr %v", err, tt.wantErr)
return
}
if string(got) != tt.want {
t.Errorf("Row.MarshalJSON() = %s, want %s", string(got), tt.want)
}
})
}
}