github/kubernetes
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Enable JSON-compatible base64 encoding of []byte for CBOR.

Browse Source 
The encoding/json package marshals []byte to a JSON string containing the base64 encoding of the
input slice's bytes, and unmarshals JSON strings to []byte by assuming the JSON string contains a
valid base64 text.

As a binary format, CBOR is capable of representing arbitrary byte sequences without converting them
to a text encoding, but it also needs to interoperate with the existing JSON serializer. It does
this using the "expected later encoding" tags defined in RFC 8949, which indicate a specific text
encoding to be used when interoperating with text-based protocols. The actual conversion to or from
a text encoding is deferred until necessary, so no conversion is performed during roundtrips of
[]byte to CBOR.
This commit is contained in:
Ben Luddy
2024-06-10 09:50:01 -04:00
parent 85ede67ac9
commit 38f87df0e3
7 changed files with 151 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
pkg/api/testing/unstructured_test.go
View File

@@ -150,30 +150,6 @@ func TestRoundtripToUnstructured(t *testing.T) {
// These are GVKs that whose CBOR roundtrippability is blocked by a known issue that must be
// resolved as a prerequisite for alpha.
knownFailureReasons := map[string][]schema.GroupVersionKind{
// Since JSON cannot directly represent arbitrary byte sequences, a byte slice
// encodes to a JSON string containing the base64 encoding of the slice
// contents. Decoding a JSON string into a byte slice assumes (and requires) that
// the JSON string contain base64-encoded data. The CBOR serializer must be
// compatible with this behavior.
"byte slices should be represented in unstructured as base64-encoded strings": {
{Version: "v1", Kind: "Secret"},
{Version: "v1", Kind: "SecretList"},
{Version: "v1", Kind: "RangeAllocation"},
{Version: "v1", Kind: "ConfigMap"},
{Version: "v1", Kind: "ConfigMapList"},
{Group: "admissionregistration.k8s.io", Version: "v1beta1", Kind: "MutatingWebhookConfiguration"},
{Group: "admissionregistration.k8s.io", Version: "v1beta1", Kind: "MutatingWebhookConfigurationList"},
{Group: "admissionregistration.k8s.io", Version: "v1beta1", Kind: "ValidatingWebhookConfiguration"},
{Group: "admissionregistration.k8s.io", Version: "v1beta1", Kind: "ValidatingWebhookConfigurationList"},
{Group: "admissionregistration.k8s.io", Version: "v1", Kind: "MutatingWebhookConfiguration"},
{Group: "admissionregistration.k8s.io", Version: "v1", Kind: "MutatingWebhookConfigurationList"},
{Group: "admissionregistration.k8s.io", Version: "v1", Kind: "ValidatingWebhookConfiguration"},
{Group: "admissionregistration.k8s.io", Version: "v1", Kind: "ValidatingWebhookConfigurationList"},
{Group: "certificates.k8s.io", Version: "v1beta1", Kind: "CertificateSigningRequest"},
{Group: "certificates.k8s.io", Version: "v1beta1", Kind: "CertificateSigningRequestList"},
{Group: "certificates.k8s.io", Version: "v1", Kind: "CertificateSigningRequest"},
{Group: "certificates.k8s.io", Version: "v1", Kind: "CertificateSigningRequestList"},
},
// If a RawExtension's bytes are invalid JSON, its containing object can't be encoded to JSON.
"rawextension needs to work in programs that assume json": {
{Version: "v1", Kind: "List"},