Add custom fields and creating/updating test cases with custom fields

[ramilamparo]

https://github.com/Hypersequent/tms-issues/issues/2061

[gemini-code-assist]

Summary of Changes

Hello @ramilamparo, 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 introduces a significant enhancement by integrating custom field management into the system. It provides a new API tool to fetch project-specific custom fields and extends the existing test case management to allow for the creation and updating of test cases with these custom field values. This change aims to provide greater flexibility and extensibility for test case metadata, enabling users to tailor test case information to their unique requirements.

Highlights

• New Tool: List Custom Fields: A new tool, list_custom_fields, has been added to retrieve all custom fields available for a given project. This tool interacts with the QASPHERE API and includes robust error handling for various API responses.
• Custom Fields for Test Cases: The functionality for creating and updating test cases has been extended to support custom fields. Test cases can now include a customFields property, allowing users to define additional metadata specific to their organization's needs.
• Schema and Type Definitions: New Zod schemas (tcaseCustomFieldParamSchema) and TypeScript interfaces (CustomFieldOption, CustomField, CustomFieldsResponse) have been introduced and updated to properly define the structure and validation for custom field data, both for API requests and responses.

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 introduces functionality for handling custom fields. A new tool list_custom_fields is added to fetch custom fields for a project. The create_test_case and update_test_case tools are updated to support setting custom field values. The changes are well-structured. I've provided a few suggestions to improve error handling, API usability, and schema robustness.

[hi-rai]

Question - how does AI infer that the key should be the system name ?

[satvik007]

In zod schema, there is information about it

  .describe(
    'Custom field values. Use the systemName property from custom fields as the key. Only enabled fields should be used. Use list_custom_fields tool to get the custom fields.'
  )

but I am not sure if this information reaches the AI agent.