-
Notifications
You must be signed in to change notification settings - Fork 13
test(dashboard): use title attribute to find expand/collapse button #1342
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
base: main
Are you sure you want to change the base?
Conversation
Summary of ChangesHello @spliffone, 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 focuses on enhancing the reliability of the dashboard card component's expand and collapse tests. By transitioning from generic and order-dependent CSS selectors to precise attribute-based selectors, the changes ensure that test interactions accurately target the intended UI elements, thereby improving the maintainability and stability of the test suite. Highlights
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request improves the robustness of tests in si-dashboard-card.component.spec.ts by using the title attribute to select the expand/collapse buttons instead of relying on fragile CSS class names and element order. This is a great improvement. My review includes suggestions to make the tests even more explicit about element presence by avoiding optional chaining, which can sometimes hide issues during test runs.
| component.enableExpandInteraction = true; | ||
| fixture.detectChanges(); | ||
| (element.querySelector('si-content-action-bar .dropdown-item') as HTMLElement).click(); | ||
| element.querySelector<HTMLElement>('si-content-action-bar button[title="Expand"]')?.click(); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While using optional chaining (?.) prevents a null pointer exception if the element is not found, in a test it's generally better to fail explicitly. If the element isn't found, the click is silently skipped, and the test will fail on a later assertion, which can be misleading. Using a non-null assertion (!) will cause the test to fail immediately with a clearer error if the element is not found. This makes debugging easier.
| element.querySelector<HTMLElement>('si-content-action-bar button[title="Expand"]')?.click(); | |
| element.querySelector<HTMLElement>('si-content-action-bar button[title="Expand"]')!.click(); |
| fixture.detectChanges(); | ||
| expect(component.card().isExpanded()).toBeTrue(); | ||
| (element.querySelector('si-content-action-bar .dropdown-item') as HTMLElement).click(); | ||
| element.querySelector<HTMLElement>('si-content-action-bar button[title="Restore"]')?.click(); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For consistency and improved test clarity, please use the non-null assertion operator (!) here as well. This ensures the test fails explicitly if the element is not found.
| element.querySelector<HTMLElement>('si-content-action-bar button[title="Restore"]')?.click(); | |
| element.querySelector<HTMLElement>('si-content-action-bar button[title="Restore"]')!.click(); |
| fixture.detectChanges(); | ||
| // Second element in content action bar is our expand actions | ||
| (element.querySelectorAll('si-content-action-bar .dropdown-item')[1] as HTMLElement).click(); | ||
| element.querySelector<HTMLElement>('si-content-action-bar button[title="Expand"]')?.click(); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For consistency and improved test clarity, please use the non-null assertion operator (!) here as well. This ensures the test fails explicitly if the element is not found.
| element.querySelector<HTMLElement>('si-content-action-bar button[title="Expand"]')?.click(); | |
| element.querySelector<HTMLElement>('si-content-action-bar button[title="Expand"]')!.click(); |
| fixture.detectChanges(); | ||
| expect(component.card().isExpanded()).toBeTrue(); | ||
| (element.querySelectorAll('si-content-action-bar .dropdown-item')[1] as HTMLElement).click(); | ||
| element.querySelector<HTMLElement>('si-content-action-bar button[title="Restore"]')?.click(); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For consistency and improved test clarity, please use the non-null assertion operator (!) here as well. This ensures the test fails explicitly if the element is not found.
| element.querySelector<HTMLElement>('si-content-action-bar button[title="Restore"]')?.click(); | |
| element.querySelector<HTMLElement>('si-content-action-bar button[title="Restore"]')!.click(); |
| component.secondaryActions = [{ title: 'Action' }]; | ||
| fixture.detectChanges(); | ||
| (element.querySelector('si-content-action-bar .dropdown-item') as HTMLElement).click(); | ||
| element.querySelector<HTMLElement>('si-content-action-bar button[title="Expand"]')?.click(); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For consistency and improved test clarity, please use the non-null assertion operator (!) here as well. This ensures the test fails explicitly if the element is not found.
| element.querySelector<HTMLElement>('si-content-action-bar button[title="Expand"]')?.click(); | |
| element.querySelector<HTMLElement>('si-content-action-bar button[title="Expand"]')!.click(); |
| fixture.detectChanges(); | ||
| expect(component.card().isExpanded()).toBeTrue(); | ||
| (element.querySelector('si-content-action-bar .dropdown-item') as HTMLElement).click(); | ||
| element.querySelector<HTMLElement>('si-content-action-bar button[title="Restore"]')?.click(); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For consistency and improved test clarity, please use the non-null assertion operator (!) here as well. This ensures the test fails explicitly if the element is not found.
| element.querySelector<HTMLElement>('si-content-action-bar button[title="Restore"]')?.click(); | |
| element.querySelector<HTMLElement>('si-content-action-bar button[title="Restore"]')!.click(); |
|
Documentation. Coverage Reports: |
Uh oh!
There was an error while loading. Please reload this page.