Skip to content

Add _field_types attribute to GroupedRecord#171

Merged
yunzheng merged 3 commits intofox-it:mainfrom
B0TAxy:fix/grouped_record_field_type
Jun 19, 2025
Merged

Add _field_types attribute to GroupedRecord#171
yunzheng merged 3 commits intofox-it:mainfrom
B0TAxy:fix/grouped_record_field_type

Conversation

@B0TAxy
Copy link
Contributor

@B0TAxy B0TAxy commented Jun 18, 2025

When using --hash, --resolve, or both, there's a script called record_modifier.py that tries to find the fields and then performs the requested action, adding a new field afterward. However, since the GroupedRecord class doesn’t have the self._field_types attribute, it just crashes every time a GroupedRecord is involved. This code fixes that issue.

Fixes #168

@yunzheng
Copy link
Member

Thanks! Could you also add a regression test that tests the old broken situation?

@DissectBot
Copy link

@B0TAxy thank you for your contribution! As this is your first code contribution, please read the following Contributor License Agreement (CLA). If you agree with the CLA, please reply with the following information:

@DissectBot agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement ("Agreement") governs your Contribution(s) (as defined below) and conveys certain license rights to Fox-IT B.V. ("Fox-IT") for your Contribution(s) to Fox-IT"s open source Dissect project. This Agreement covers any and all Contributions that you ("You" or "Your"), now or in the future, Submit (as defined below) to this project. This Agreement is between Fox-IT B.V. and You and takes effect when you click an “I Accept” button, check box presented with these terms, otherwise accept these terms or, if earlier, when You Submit a Contribution.

  1. Definitions.
    "Contribution" means any original work of authorship, including any modifications or additions to an existing work, that is intentionally submitted by You to Fox-IT for inclusion in, or documentation of, any of the software products owned or managed by, or on behalf of, Fox-IT as part of the Project (the "Work").
    "Project" means any of the projects owned or managed by Fox-IT and offered under a license approved by the Open Source Initiative (www.opensource.org).
    "Submit" means any form of electronic, verbal, or written communication sent to Fox-IT or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, Fox-IT for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution."

  2. Grant of Copyright License. Subject to the terms and conditions of this Agreement, You hereby grant to Fox-IT and to recipients of software distributed by Fox-IT a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works.

  3. Grant of Patent License. Subject to the terms and conditions of this Agreement, You hereby grant to Fox-IT and to recipients of software distributed by Fox-IT a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, maintain, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your Contribution, or the Work to which you have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed.

  4. Representations. You represent that:

    • You are legally entitled to grant the above license.
    • each of Your Contributions is Your original creation (see section 8 for submissions on behalf of others).
    • Your Contribution submissions include complete details of any third-party license or other restriction (including, but not limited to, related patents and trademarks) of which you are personally aware and which are associated with any part of Your Contributions.
  5. Employer. If Your Contribution is made in the course of Your work for an employer or Your employer has intellectual property rights in Your Submission by contract or applicable law, You must secure permission from Your employer to make the Contribution before signing this Agreement. In that case, the term "You" in this Agreement will refer to You and the employer collectively. If You change employers in the future and desire to Submit additional Contribution for the new employer, then You agree to sign a new Agreement and secure permission from the new employer before Submitting those Contributions.

  6. Support. You are not expected to provide support for Your Contribution, unless You choose to do so. Any such support provided to the Project is provided free of charge.

  7. Warranty. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE.

  8. Third party material. Should You wish to submit work that is not Your original creation, You may only submit it to Fox-IT separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which You are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [named here]".

  9. Notify. You agree to notify Fox-IT of any facts or circumstances of which You become aware that would make the above representations inaccurate in any respect.

  10. Governing law / competent court. This Agreement is governed by the laws of the Netherlands. Any disputes that may arise are resolved by arbitration in accordance with the Arbitration Regulations of the Foundation for the Settlement of Automation Disputes (Stichting Geschillenoplossing Automatisering – SGOA – (www.sgoa.eu), this without prejudice to either party"s right to request preliminary relief in preliminary relief proceedings or arbitral preliminary relief proceedings. Arbitration proceedings take place in Amsterdam, or in any other place designated in the Arbitration Regulations. Arbitration shall take place in English.

@B0TAxy
Copy link
Contributor Author

B0TAxy commented Jun 18, 2025

@DissectBot agree

@B0TAxy
Copy link
Contributor Author

B0TAxy commented Jun 18, 2025

Thanks! Could you also add a regression test that tests the old broken situation?

Hi,
Thanks for the review. I've added a regression test — please let me know if it's sufficient.

@yunzheng yunzheng requested a review from Copilot June 19, 2025 08:29
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR fixes a bug in record_modifier.py where a GroupedRecord instance would crash due to the missing _field_types attribute. The changes include adding an expected field type mapping in the tests and initializing _field_types in the base GroupedRecord constructor.

  • Updated tests in tests/test_record.py to verify the _field_types attribute.
  • Modified flow/record/base.py to initialize the _field_types attribute based on the RecordDescriptor.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
tests/test_record.py Added new assertions to check the _field_types attribute and expected field mappings; minor spelling errors in variable/comments need correction.
flow/record/base.py Initializes _field_types to maintain compatibility with RecordDescriptor.

@yunzheng yunzheng changed the title Fixed bug were record_modifier.py could not find self._field_types Add _field_types attribute to GroupedRecord Jun 19, 2025
Copy link
Member

@yunzheng yunzheng left a comment

Choose a reason for hiding this comment

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

Looks good, thanks for the pointer where it goes wrong. It seems that dissect.target is using a private attribute to get the fields.

Can you apply the above suggestions by copilot? PR looks good otherwise for merge.

@B0TAxy B0TAxy requested a review from yunzheng June 19, 2025 09:17
@B0TAxy
Copy link
Contributor Author

B0TAxy commented Jun 19, 2025

Looks good, thanks for the pointer where it goes wrong. It seems that dissect.target is using a private attribute to get the fields.

Can you apply the above suggestions by copilot? PR looks good otherwise for merge.

I've addressed the suggestions provided by Copilot.

@codecov
Copy link

codecov bot commented Jun 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.84%. Comparing base (f4eba70) to head (b217d67).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #171   +/-   ##
=======================================
  Coverage   82.84%   82.84%           
=======================================
  Files          34       34           
  Lines        3573     3574    +1     
=======================================
+ Hits         2960     2961    +1     
  Misses        613      613           
Flag Coverage Δ
unittests 82.84% <100.00%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@yunzheng yunzheng merged commit 18b5920 into fox-it:main Jun 19, 2025
24 checks passed
@B0TAxy B0TAxy deleted the fix/grouped_record_field_type branch December 24, 2025 19:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Grouped Record missing record type

4 participants