Skip to content
Draft
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
add roundtrip tests for all frame implementers
  • Loading branch information
gvaradarajan authored and nicksanford committed Aug 6, 2025
commit b495875eef98bfb600f3daa9ff223aad1e8d89ec
11 changes: 11 additions & 0 deletions referenceframe/frame.go
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,17 @@ func (sf *tailGeometryStaticFrame) Geometries(input []Input) (*GeometriesInFrame
return NewGeometriesInFrame(sf.name, []spatial.Geometry{newGeom}), nil
}

func (sf *tailGeometryStaticFrame) UnmarshalJSON(data []byte) error {
var inner staticFrame

err := json.Unmarshal(data, &inner)
if err != nil {
return err
}
sf.staticFrame = &inner
return nil
}

// namedFrame is used to change the name of a frame.
type namedFrame struct {
Frame
Expand Down
4 changes: 2 additions & 2 deletions referenceframe/frame_json.go
Original file line number Diff line number Diff line change
Expand Up @@ -208,10 +208,10 @@ func jsonToFrame(data json.RawMessage) (Frame, error) {
return nil, fmt.Errorf("%s is not a registered Frame implementation", frameType)
}
frameZeroStruct := reflect.New(implementer).Elem()
if err := json.Unmarshal(sF["frame"], frameZeroStruct.Addr().Interface()); err != nil {
frame := frameZeroStruct.Addr().Interface()
if err := json.Unmarshal(sF["frame"], frame); err != nil {
return nil, err
}
frame := frameZeroStruct.Addr().Interface()

return utils.AssertType[Frame](frame)
}
65 changes: 65 additions & 0 deletions referenceframe/frame_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import (
"github.com/golang/geo/r3"
"github.com/pkg/errors"
pb "go.viam.com/api/component/arm/v1"
rdkutils "go.viam.com/rdk/utils"
"go.viam.com/test"
"go.viam.com/utils"

Expand Down Expand Up @@ -280,3 +281,67 @@ func TestFrame(t *testing.T) {
test.That(t, err, test.ShouldBeNil)
test.That(t, sFrame, test.ShouldResemble, expStaticFrame)
}

func TestFrameToJSONAndBack(t *testing.T) {
// static frame
static, err := NewStaticFrame("foo", spatial.NewPose(r3.Vector{X: 1, Y: 2, Z: 3}, &spatial.R4AA{Theta: math.Pi / 2, RX: 4, RY: 5, RZ: 6}))
test.That(t, err, test.ShouldBeNil)

jsonData, err := frameToJSON(static)
test.That(t, err, test.ShouldBeNil)

static2, err := jsonToFrame(json.RawMessage(jsonData))
test.That(t, err, test.ShouldBeNil)

test.That(t, static, test.ShouldResemble, static2)

staticFrame, ok := static.(*staticFrame)
test.That(t, ok, test.ShouldBeTrue)
tailGeoFrame := tailGeometryStaticFrame{staticFrame: staticFrame}

jsonData, err = frameToJSON(&tailGeoFrame)
test.That(t, err, test.ShouldBeNil)

tailGeoFrame2, err := jsonToFrame(json.RawMessage(jsonData))
test.That(t, err, test.ShouldBeNil)

test.That(t, &tailGeoFrame, test.ShouldResemble, tailGeoFrame2)

// translational frame
tF, err := NewTranslationalFrame("foo", r3.Vector{X: 1, Y: 0, Z: 0}, Limit{1, 2})
test.That(t, err, test.ShouldBeNil)

jsonData, err = frameToJSON(tF)
test.That(t, err, test.ShouldBeNil)

tF2, err := jsonToFrame(json.RawMessage(jsonData))
test.That(t, err, test.ShouldBeNil)

test.That(t, tF, test.ShouldResemble, tF2)

// rotational frame
rot, err := NewRotationalFrame("foo", spatial.R4AA{Theta: 3.7, RX: 2.1, RY: 3.1, RZ: 4.1}, Limit{5, 6})
test.That(t, err, test.ShouldBeNil)

jsonData, err = frameToJSON(rot)
test.That(t, err, test.ShouldBeNil)

rot2, err := jsonToFrame(json.RawMessage(jsonData))
test.That(t, err, test.ShouldBeNil)

test.That(t, rot, test.ShouldResemble, rot2)

// SimpleModel
simpleModel, err := ParseModelJSONFile(rdkutils.ResolveFile("components/arm/example_kinematics/xarm6_kinematics_test.json"), "")
test.That(t, err, test.ShouldBeNil)
// simpleModel, ok := m.(*SimpleModel)
// test.That(t, ok, test.ShouldBeTrue)

jsonData, err = frameToJSON(simpleModel)
test.That(t, err, test.ShouldBeNil)

simpleModel2, err := jsonToFrame(json.RawMessage(jsonData))
test.That(t, err, test.ShouldBeNil)

test.That(t, simpleModel, test.ShouldResemble, simpleModel2)
}