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

[#123] Introduce hash value #128

Merged

Conversation

elfenpiff
Copy link
Contributor

@elfenpiff elfenpiff commented Feb 20, 2024

Notes for Reviewer

According to this: https://csrc.nist.gov/glossary/term/hash_value the result of a hash function is a HashValue or HashOutput. I decided to use HashValue.
It is based on the newly introduced Base64Url semantic string so that the hash result can always be used for file names.

Pre-Review Checklist for the PR Author

  1. Add sensible notes for the reviewer
  2. PR title is short, expressive and meaningful
  3. Relevant issues are linked
  4. Every source code file has a copyright header with SPDX-License-Identifier: Apache-2.0 OR MIT
  5. Branch follows the naming format (iox2-123-introduce-posix-ipc-example)
  6. Commits messages are according to this guideline
  7. Tests follow the best practice for testing
  8. Changelog updated in the unreleased section including API breaking changes
  9. Assign PR to reviewer
  10. All checks have passed (except task-list-completed)

Checklist for the PR Reviewer

  • Commits are properly organized and messages are according to the guideline
  • Unit tests have been written for new behavior
  • Public API is documented
  • PR title describes the changes

Post-review Checklist for the PR Author

  1. All open points are addressed and tracked via issues

References

Use either 'Closes #123' or 'Relates to #123' to reference the corresponding issue.

Closes #123

@elfenpiff elfenpiff self-assigned this Feb 20, 2024
Copy link

codecov bot commented Feb 20, 2024

Codecov Report

Attention: 7 lines in your changes are missing coverage. Please review.

Comparison is base (80db0c4) 77.38% compared to head (e7e006e) 77.41%.
Report is 19 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #128      +/-   ##
==========================================
+ Coverage   77.38%   77.41%   +0.02%     
==========================================
  Files         181      179       -2     
  Lines       19599    19682      +83     
==========================================
+ Hits        15166    15236      +70     
- Misses       4433     4446      +13     
Files Coverage Δ
iceoryx2-bb/container/src/semantic_string.rs 78.20% <100.00%> (+0.97%) ⬆️
iceoryx2-cal/src/hash/sha1.rs 100.00% <100.00%> (ø)
iceoryx2/src/service/static_config/mod.rs 85.52% <100.00%> (+0.80%) ⬆️
iceoryx2-bb/system-types/src/base64url.rs 83.33% <83.33%> (ø)
iceoryx2-cal/src/hash/mod.rs 71.42% <71.42%> (ø)

... and 15 files with indirect coverage changes

Copy link
Member

@elBoberido elBoberido left a comment

Choose a reason for hiding this comment

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

Look good. One additional test for a failed insertion would be nice.

@elfenpiff elfenpiff merged commit 8ccb385 into eclipse-iceoryx:main Feb 21, 2024
20 of 23 checks passed
@elfenpiff elfenpiff deleted the iox2-123-introduce-uuid-type branch February 21, 2024 23:24
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.

iceoryx2-cal::hash Introduce uuid type and make it convertable to FileName
2 participants