-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Add Helpers For Marshalling And Unmarshalling AnyValue #13837
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
9e5efad
Add Helpers For Marshalling And Unmarshalling AnyValue
mahadzaryab1 e0dc418
Move To pcommon
mahadzaryab1 c0b826d
Fix
mahadzaryab1 8b89b7a
Add Fuzz Tests
mahadzaryab1 77fb07b
Merge branch 'main' into any-value
mahadzaryab1 d079200
Add License
mahadzaryab1 690431d
Fix Test Name
mahadzaryab1 c4939f9
Add Changelog
mahadzaryab1 58245e3
Update Changelog
mahadzaryab1 24df39f
make goporto
mahadzaryab1 339d3a9
Address Feedback
mahadzaryab1 043d862
Update Changelog
mahadzaryab1 6f8a531
Merge branch 'main' into any-value
mahadzaryab1 ecf526c
Add Unit Tests
mahadzaryab1 f950d8d
Add Test For Unmarshalling Unknown AnyValue
mahadzaryab1 6c7de3b
Add License
mahadzaryab1 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # Use this changelog template to create an entry for release notes. | ||
|
|
||
| # One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' | ||
| change_type: enhancement | ||
|
|
||
| # The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver) | ||
| component: xpdata | ||
|
|
||
| # A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
| note: Add Serialization and Deserialization of AnyValue | ||
|
|
||
| # One or more tracking issues or pull requests related to the change | ||
| issues: [12826] | ||
|
|
||
| # (Optional) One or more lines of additional information to render under the primary note. | ||
| # These lines will be padded with 2 spaces and then inserted directly into the document. | ||
| # Use pipe (|) for multiline entries. | ||
| subtext: | ||
|
|
||
| # Optional: The change log or logs in which this entry should be included. | ||
| # e.g. '[user]' or '[user, api]' | ||
| # Include 'user' if the change is relevant to end users. | ||
| # Include 'api' if there is a change to a library API. | ||
| # Default: '[user]' | ||
| change_logs: [] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package xpdata | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| var unexpectedBytes = "expected the same bytes from unmarshaling and marshaling." | ||
|
|
||
| func FuzzUnmarshalJSONAnyValue(f *testing.F) { | ||
| f.Fuzz(func(t *testing.T, data []byte) { | ||
| u1 := &JSONUnmarshaler{} | ||
| ld1, err := u1.UnmarshalAnyValue(data) | ||
| if err != nil { | ||
| return | ||
| } | ||
| m1 := &JSONMarshaler{} | ||
| b1, err := m1.MarshalAnyValue(ld1) | ||
| require.NoError(t, err, "failed to marshal valid struct") | ||
|
|
||
| u2 := &JSONUnmarshaler{} | ||
| ld2, err := u2.UnmarshalAnyValue(b1) | ||
| require.NoError(t, err, "failed to unmarshal valid bytes") | ||
| m2 := &JSONMarshaler{} | ||
| b2, err := m2.MarshalAnyValue(ld2) | ||
| require.NoError(t, err, "failed to marshal valid struct") | ||
|
|
||
| require.True(t, bytes.Equal(b1, b2), "%s. \nexpected %d but got %d\n", unexpectedBytes, b1, b2) | ||
| }) | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package xpdata // import "go.opentelemetry.io/collector/pdata/xpdata" | ||
|
|
||
| import ( | ||
| "slices" | ||
|
|
||
| "go.opentelemetry.io/collector/pdata/internal" | ||
| otlpcommon "go.opentelemetry.io/collector/pdata/internal/data/protogen/common/v1" | ||
| "go.opentelemetry.io/collector/pdata/internal/json" | ||
| ) | ||
|
|
||
| type JSONMarshaler struct{} | ||
|
|
||
| func (*JSONMarshaler) MarshalAnyValue(value *otlpcommon.AnyValue) ([]byte, error) { | ||
| dest := json.BorrowStream(nil) | ||
| defer json.ReturnStream(dest) | ||
| internal.MarshalJSONOrigAnyValue(value, dest) | ||
| if dest.Error() != nil { | ||
| return nil, dest.Error() | ||
| } | ||
| return slices.Clone(dest.Buffer()), nil | ||
| } | ||
|
|
||
| type JSONUnmarshaler struct{} | ||
|
|
||
| func (*JSONUnmarshaler) UnmarshalAnyValue(buf []byte) (*otlpcommon.AnyValue, error) { | ||
| iter := json.BorrowIterator(buf) | ||
| defer json.ReturnIterator(iter) | ||
| value := &otlpcommon.AnyValue{} | ||
| internal.UnmarshalJSONOrigAnyValue(value, iter) | ||
| if iter.Error() != nil { | ||
| return nil, iter.Error() | ||
| } | ||
| return value, nil | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package xpdata | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
|
|
||
| "go.opentelemetry.io/collector/pdata/internal" | ||
| otlpcommon "go.opentelemetry.io/collector/pdata/internal/data/protogen/common/v1" | ||
| ) | ||
|
|
||
| func TestMarshalAndUnmarshalAnyValue(t *testing.T) { | ||
| for name, src := range genTestEncodingValuesAnyValue() { | ||
| t.Run(name, func(t *testing.T) { | ||
| m := &JSONMarshaler{} | ||
| b, err := m.MarshalAnyValue(src) | ||
| require.NoError(t, err) | ||
|
|
||
| u := &JSONUnmarshaler{} | ||
| dest, err := u.UnmarshalAnyValue(b) | ||
| require.NoError(t, err) | ||
|
|
||
| require.Equal(t, src, dest) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestUnmarshalAnyValueUnknown(t *testing.T) { | ||
| m := &JSONUnmarshaler{} | ||
|
|
||
| b, err := m.UnmarshalAnyValue([]byte(`{"unknown": "string"}`)) | ||
| require.NoError(t, err) | ||
| assert.Equal(t, internal.NewOrigAnyValue(), b) | ||
| } | ||
|
|
||
| func genTestEncodingValuesAnyValue() map[string]*otlpcommon.AnyValue { | ||
| return map[string]*otlpcommon.AnyValue{ | ||
| "empty": internal.NewOrigAnyValue(), | ||
| "StringValue/default": {Value: &otlpcommon.AnyValue_StringValue{StringValue: ""}}, | ||
| "StringValue/test": {Value: &otlpcommon.AnyValue_StringValue{StringValue: "test_stringvalue"}}, | ||
| "BoolValue/default": {Value: &otlpcommon.AnyValue_BoolValue{BoolValue: false}}, | ||
| "BoolValue/test": {Value: &otlpcommon.AnyValue_BoolValue{BoolValue: true}}, | ||
| "IntValue/default": {Value: &otlpcommon.AnyValue_IntValue{IntValue: int64(0)}}, | ||
| "IntValue/test": {Value: &otlpcommon.AnyValue_IntValue{IntValue: int64(13)}}, | ||
| "DoubleValue/default": {Value: &otlpcommon.AnyValue_DoubleValue{DoubleValue: float64(0)}}, | ||
| "DoubleValue/test": {Value: &otlpcommon.AnyValue_DoubleValue{DoubleValue: float64(3.1415926)}}, | ||
| "ArrayValue/default": {Value: &otlpcommon.AnyValue_ArrayValue{ArrayValue: &otlpcommon.ArrayValue{}}}, | ||
| "ArrayValue/test": {Value: &otlpcommon.AnyValue_ArrayValue{ArrayValue: internal.GenTestOrigArrayValue()}}, | ||
| "KvlistValue/default": {Value: &otlpcommon.AnyValue_KvlistValue{KvlistValue: &otlpcommon.KeyValueList{}}}, | ||
| "KvlistValue/test": {Value: &otlpcommon.AnyValue_KvlistValue{KvlistValue: internal.GenTestOrigKeyValueList()}}, | ||
| "BytesValue/default": {Value: &otlpcommon.AnyValue_BytesValue{BytesValue: nil}}, | ||
| "BytesValue/test": {Value: &otlpcommon.AnyValue_BytesValue{BytesValue: []byte{1, 2, 3}}}, | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.