feat: add system metadata assertion #270
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @strantalis, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request introduces a new feature to automatically embed system metadata as an assertion within the TDF manifest. This enhancement improves traceability and debugging by capturing details about the environment where a TDF file was created, such as the operating system, Java version, and hostname, directly within the TDF's metadata.
Highlights
- New System Metadata Assertion: A new static method
getSystemMetadataAssertionConfighas been added toAssertionConfig. This method generates an assertion containing system-specific details such as the operating system, Java version, architecture, hostname, creation date, SDK version, and TDF specification version. This information is formatted as a JSON string and included as the assertion's value. - Configurable System Metadata Assertion: A
systemMetadataAssertionboolean flag has been introduced inConfig.TDFConfig, along with a convenientwithSystemMetadataAssertion()builder method. This allows users to easily enable or disable the automatic inclusion of system metadata as an assertion during TDF creation. - Integration into TDF Creation Workflow: The
createTDFmethod inTDF.javahas been updated to conditionally add the generated system metadata assertion to the TDF manifest. This occurs only if thesystemMetadataAssertionflag is enabled in the provided configuration, ensuring that the metadata is embedded directly into the TDF file. - Comprehensive Test Coverage: A new unit test,
testSystemMetadataAssertion, has been added toTDFTest.java. This test thoroughly validates that when thesystemMetadataAssertionflag is enabled, the system metadata assertion is correctly generated, included in the TDF manifest, and that its JSON content accurately reflects the expected system properties.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
sdk/src/main/resources/io/opentdf/platform/sdk/version.properties
Outdated
Show resolved
Hide resolved
|
No description provided.