Move results into subdir

[rfbgo]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @rfbgo, I'm Gemini Code Assist¹! 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 refactors the workspace's file management by introducing a dedicated subdirectory for storing all generated result files. This change aims to improve the clarity and organization of the workspace structure, making it easier to manage and locate output data. It also ensures that existing workflows remain functional through the use of symlinks for the latest results, while internal logic and tests are updated to utilize the new structured path.

Highlights

• Centralized Result Storage: All generated result files (e.g., results.json, results.txt, results.yaml) are now stored in a dedicated results subdirectory within the workspace, improving organization.
• New Workspace Property: A new results_dir property has been added to the Workspace class, providing a standardized way to access the path to the results directory.
• Backward Compatibility: To ensure backward compatibility, a symlink to the latest result file is still created in the top-level workspace directory, pointing to the file within the new results subdirectory.
• Test Updates: Existing tests have been updated to reflect the new file structure, verifying that result files are correctly located and accessed from the results_dir.

Changelog

• lib/ramble/ramble/pipeline.py
  • Updated the pattern for archiving result files to correctly reference the new WORKSPACE_RESULTS_PATH.
• lib/ramble/ramble/test/cmd/workspace.py
  • Modified assertions in check_results to verify the existence of result files within the ws.results_dir.
• lib/ramble/ramble/test/end_to_end/analyze_fom_output.py
  • Adjusted paths in end-to-end tests to retrieve results.latest.txt from the ws.results_dir.
• lib/ramble/ramble/test/end_to_end/setup_analyze.py
  • Updated the path for actual_analyze to point to the results.latest.txt file within the ws.results_dir.
• lib/ramble/ramble/workspace/init.py
  • Imported WORKSPACE_RESULTS_PATH and added it to the module's __all__ export list.
• lib/ramble/ramble/workspace/workspace.py
  • Defined WORKSPACE_RESULTS_PATH constant as 'results'.
  • Modified write_json_results to create the results directory and save JSON results within it.
  • Updated dump_results to create the results directory and save text, JSON, and YAML results within it.
  • Added logic to dump_results to create a symlink for the latest result file in the root directory for backward compatibility.
  • Introduced a new @property results_dir to return the path to the workspace's results directory.
  • Added workspace_results to the dictionary returned by get_workspace_paths.

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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

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

1. 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. ↩

[gemini-code-assist]

Code Review

This pull request refactors the result file handling to store them in a dedicated results subdirectory within the workspace. The changes are consistent across the codebase, including updates to tests and configuration. I've identified a couple of areas for improvement in lib/ramble/ramble/workspace/workspace.py: one regarding code duplication and another about a potential inconsistency in backward compatibility for different result formats. My detailed comments are below.

[rfbgo]

/gemini review

[gemini-code-assist]

Code Review

This pull request refactors the result file handling to store results in a dedicated subdirectory. The changes are consistent across the codebase, including updates to tests and core workspace logic. The addition of a symlink for backwards compatibility is a good consideration. I've left one comment regarding code duplication that could be addressed to improve maintainability.