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

Add FieldNameMatching decode option. #433

Merged

Conversation

benluddy
Copy link
Contributor

@benluddy benluddy commented Nov 3, 2023

Description

When decoding a CBOR map into a Go struct, FieldNameMatching controls how string
keys are matched to struct fields in the destination struct and allows users to
require case-sensitive matches. The default value of this option preserves the
existing behavior, which prefers case-sensitive matches but will fall back to a
case-insensitive match.

PR Was Proposed and Welcomed in Currently Open Issue

Checklist (for code PR only, ignore for docs PR)

  • Include unit tests that cover the new code
  • Pass all unit tests
  • Pass all 18 ci linters (golint, gosec, staticcheck, etc.)
  • Sign each commit with your real name and email.
    Last line of each commit message should be in this format:
    Signed-off-by: Firstname Lastname firstname.lastname@example.com
  • Certify the Developer's Certificate of Origin 1.1
    (see next section).

Certify the Developer's Certificate of Origin 1.1

  • By marking this item as completed, I certify
    the Developer Certificate of Origin 1.1.
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
660 York Street, Suite 102,
San Francisco, CA 94110 USA

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

When decoding a CBOR map into a Go struct, FieldNameMatching controls how string
keys are matched to struct fields in the destination struct and allows users to
require case-sensitive matches. The default value of this option preserves the
existing behavior, which prefers case-sensitive matches but will fall back to a
case-insensitive match.

Signed-off-by: Ben Luddy <bluddy@redhat.com>
@fxamacker fxamacker added the enhancement New feature or request label Nov 3, 2023
@fxamacker fxamacker added this to the v2.6.0 milestone Nov 3, 2023
Copy link
Owner

@fxamacker fxamacker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! 👍 Thanks again for opening this PR!

Fuzzer is running with checks enabled for default and non-default settings. I'll let it run overnight.

fuzz: elapsed: 45m39s, execs: 61050856 (22464/sec), new interesting: 83 (total: 3492)
fuzz: elapsed: 45m42s, execs: 61133672 (27651/sec), new interesting: 83 (total: 3492)

@fxamacker fxamacker merged commit 4687659 into fxamacker:master Nov 4, 2023
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants