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.

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

Bring python yaml test parser of octet string inline with what javascript codegen is doing #23670

Merged
merged 4 commits into from
Nov 21, 2022
Merged
Show file tree
Hide file tree
Changes from 3 commits
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
3 changes: 2 additions & 1 deletion src/app/tests/suites/TestCluster.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -749,7 +749,8 @@ tests:
command: "readAttribute"
attribute: "octet_string"
response:
value: "\r\n\xff\"\xa0"
# This is the properly 'hex:...' version of "\r\n\xff\"\xa0"
value: "hex:0d0aff22a0"

- label: "Write attribute OCTET_STRING"
command: "writeAttribute"
Expand Down
23 changes: 19 additions & 4 deletions src/controller/python/chip/yaml/format_converter.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,26 @@
from chip.tlv import uint, float32
import enum
from chip.yaml.errors import ValidationError
import binascii


_HEX_PREFIX = 'hex:'
def convert_yaml_octet_string_to_bytes(s: str) -> bytes:
"""Convert YAML octet string body to bytes, handling any c-style hex escapes (e.g. \x5a) and hex: prefix"""
# Step 1: handle explicit "hex:" prefix
if s.startswith('hex:'):
return binascii.unhexlify(s[4:])

# Step 2: convert non-hex-prefixed to bytes
# TODO(#23669): This does not properly support utf8 octet strings. We mimic
# javascript codegen behavior. Behavior or javascript is:
tehampson marked this conversation as resolved.
Show resolved Hide resolved
# * Octet string character >= u+0200 errors out.
tehampson marked this conversation as resolved.
Show resolved Hide resolved
# * Any character greater than 0xFF has the upper bytes chopped off.
as_bytes = [ord(c) for c in s]
tehampson marked this conversation as resolved.
Show resolved Hide resolved

if any([value > 0x200 for value in as_bytes]):
raise ValueError('Unsupported char in octet string %r' % as_bytes)
accumulated_hex = ''.join([f"{(v & 0xFF):02x}" for v in as_bytes])
return binascii.unhexlify(accumulated_hex)


def convert_name_value_pair_to_dict(arg_values):
Expand Down Expand Up @@ -118,9 +135,7 @@ def convert_yaml_type(field_value, field_type, use_from_dict=False):
return field_type(field_value)
# YAML treats bytes as strings. Convert to a byte string.
elif (field_type == bytes and type(field_value) != bytes):
if isinstance(field_value, str) and field_value.startswith(_HEX_PREFIX):
return bytes.fromhex(field_value[len(_HEX_PREFIX):])
return str.encode(field_value)
return convert_yaml_octet_string_to_bytes(field_value)
# By default, just return the field_value casted to field_type.
else:
return field_type(field_value)
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
#
# Copyright (c) 2022 Project CHIP Authors
# All rights reserved.
#
# 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.
#

from chip.yaml.format_converter import convert_yaml_octet_string_to_bytes
from binascii import unhexlify
import unittest


class TestOctetStringYamlDecode(unittest.TestCase):
def test_common_cases(self):
self.assertEqual(convert_yaml_octet_string_to_bytes("hex:aa55"), unhexlify("aa55"))
self.assertEqual(convert_yaml_octet_string_to_bytes("hex:"), unhexlify(""))
self.assertEqual(convert_yaml_octet_string_to_bytes("hex:AA55"), unhexlify("aa55"))

self.assertEqual(convert_yaml_octet_string_to_bytes("0\xaa\x55"), unhexlify("30aa55"))
self.assertEqual(convert_yaml_octet_string_to_bytes("0\xAA\x55"), unhexlify("30aa55"))
self.assertEqual(convert_yaml_octet_string_to_bytes("0\xAa\x55"), unhexlify("30aa55"))

self.assertEqual(convert_yaml_octet_string_to_bytes("0hex:"), b"0hex:")
self.assertEqual(convert_yaml_octet_string_to_bytes("0hex:A"), b"0hex:A")
self.assertEqual(convert_yaml_octet_string_to_bytes("0hex:AA55"), b"0hex:AA55")

self.assertEqual(convert_yaml_octet_string_to_bytes("AA55"), b"AA55")
self.assertEqual(convert_yaml_octet_string_to_bytes("AA\n\r\t55"), unhexlify("41410a0d093535"))
# TODO(#23669): After utf8 is properly supported expected result is unhexlify("c3a9c3a90a0a")
self.assertEqual(convert_yaml_octet_string_to_bytes("\xC3\xA9é\n\n"), unhexlify("c3a9e90a0a"))
tehampson marked this conversation as resolved.
Show resolved Hide resolved

# Partial hex nibble
with self.assertRaises(ValueError):
convert_yaml_octet_string_to_bytes("hex:aa5")


def main():
unittest.main()


if __name__ == "__main__":
main()
2 changes: 1 addition & 1 deletion zzz_generated/chip-tool/zap-generated/test/Commands.h

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.