Skip to content

Commit

Permalink
[Console Monaco migration] Fix flaky documentation tests (#186641)
Browse files Browse the repository at this point in the history
## Summary

Related to #188977

This PR fixes a flaky test by closing any additionally opened tabs after
each test.


### Checklist

Delete any items that are not applicable to this PR.

- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [ ] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed
- [ ] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [ ] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)


### Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to
identify risks that should be tested prior to the change/feature
release.

When forming the risk matrix, consider some of the following examples
and how they may potentially impact the change:

| Risk | Probability | Severity | Mitigation/Notes |

|---------------------------|-------------|----------|-------------------------|
| Multiple Spaces—unexpected behavior in non-default Kibana Space.
| Low | High | Integration tests will verify that all features are still
supported in non-default Kibana Space and when user switches between
spaces. |
| Multiple nodes—Elasticsearch polling might have race conditions
when multiple Kibana nodes are polling for the same tasks. | High | Low
| Tasks are idempotent, so executing them multiple times will not result
in logical error, but will degrade performance. To test for this case we
add plenty of unit tests around this logic and document manual testing
procedure. |
| Code should gracefully handle cases when feature X or plugin Y are
disabled. | Medium | High | Unit tests will verify that any feature flag
or plugin combination still results in our service operational. |
| [See more potential risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |


### For maintainers

- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
  • Loading branch information
yuliacech authored Aug 1, 2024
1 parent 4e0910a commit 5c9853d
Showing 1 changed file with 22 additions and 18 deletions.
40 changes: 22 additions & 18 deletions test/functional/apps/console/monaco/_misc_console_behavior.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
});

describe('keyboard shortcuts', () => {
let tabCount = 1;

after(async () => {
if (tabCount > 1) {
let tabOpened = false;
afterEach(async () => {
if (tabOpened) {
await browser.closeCurrentWindow();
tabOpened = false;
await browser.switchTab(0);
}
});
Expand Down Expand Up @@ -91,20 +91,24 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
expect(await PageObjects.console.monaco.getCurrentLineNumber()).to.be(4);
});

// flaky
it.skip('should open documentation when Ctrl+/ is pressed', async () => {
await PageObjects.console.monaco.enterText('GET _search');
await PageObjects.console.monaco.pressEscape();
await PageObjects.console.monaco.pressCtrlSlash();
await retry.tryForTime(10000, async () => {
await browser.switchTab(1);
tabCount++;
});

// Retry until the documentation is loaded
await retry.try(async () => {
const url = await browser.getCurrentUrl();
expect(url).to.contain('search-search.html');
describe('open documentation', () => {
const requests = ['GET _search', 'GET test_index/_search', 'GET /_search'];
requests.forEach((request) => {
it('should open documentation when Ctrl+/ is pressed', async () => {
await PageObjects.console.monaco.enterText(request);
await PageObjects.console.monaco.pressEscape();
await PageObjects.console.monaco.pressCtrlSlash();
await retry.tryForTime(10000, async () => {
await browser.switchTab(1);
tabOpened = true;
});

// Retry until the documentation is loaded
await retry.try(async () => {
const url = await browser.getCurrentUrl();
expect(url).to.contain('search-search.html');
});
});
});
});
});
Expand Down

0 comments on commit 5c9853d

Please sign in to comment.