Skip to content

Commit

Permalink
Fix saved query update test (elastic#173576)
Browse files Browse the repository at this point in the history
## Summary

Fixes elastic#173094.

Relying on the text from the toast notification was problematic because
sometimes the toast would already have disappeared by the time the check
was happening. Instead, this updates the test to refresh and check the
saved query list for the updated saved query.

Flaky test runner:
https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/4750

### 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
lukasolson authored Jan 4, 2024
1 parent 1182ce6 commit 9cb830f
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions x-pack/test/functional/apps/discover/saved_queries.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,13 @@
* 2.0.
*/

import expect from '@kbn/expect';
import { FtrProviderContext } from '../../ftr_provider_context';

export default function ({ getService, getPageObjects }: FtrProviderContext) {
const browser = getService('browser');
const esArchiver = getService('esArchiver');
const kibanaServer = getService('kibanaServer');
const spaces = getService('spaces');
const toasts = getService('toasts');
const PageObjects = getPageObjects([
'common',
'discover',
Expand All @@ -26,8 +24,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
const savedQueryName = 'shared-saved-query';
const destinationSpaceId = 'nondefaultspace';

// Failing: See https://github.com/elastic/kibana/issues/173094
describe.skip('Discover Saved Queries', () => {
describe('Discover Saved Queries', () => {
before('initialize tests', async () => {
await esArchiver.loadIfNeeded('x-pack/test/functional/es_archives/logstash_functional');
await kibanaServer.importExport.load(
Expand All @@ -53,6 +50,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
// Navigate to Discover & create a saved query
await PageObjects.common.navigateToApp('discover');
await queryBar.setQuery('response:200');
await queryBar.submitQuery();
await savedQueryManagementComponent.saveNewQuery(savedQueryName, '', true, false);
await savedQueryManagementComponent.savedQueryExistOrFail(savedQueryName);
await savedQueryManagementComponent.closeSavedQueryManagementComponent();
Expand All @@ -76,24 +74,26 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
});

it('updates a saved query', async () => {
const name = `${savedQueryName}-update`;

// Navigate to Discover & create a saved query
await PageObjects.common.navigateToApp('discover');
await queryBar.setQuery('response:200');
await savedQueryManagementComponent.saveNewQuery(savedQueryName, '', true, false);
await savedQueryManagementComponent.savedQueryExistOrFail(savedQueryName);
await queryBar.submitQuery();
await savedQueryManagementComponent.saveNewQuery(name, '', true, false);
await savedQueryManagementComponent.savedQueryExistOrFail(name);
await savedQueryManagementComponent.closeSavedQueryManagementComponent();

// Navigate to Discover & create a saved query
// Update the saved query
await queryBar.setQuery('response:404');
await queryBar.submitQuery();
await savedQueryManagementComponent.updateCurrentlyLoadedQuery('', true, false);

// Expect to see a success toast
const successToast = await toasts.getToastElement(1);
const successText = await successToast.getVisibleText();
expect(successText).to.equal(`Your query "${savedQueryName}" was saved`);

// Navigate to Discover ensure updated query exists
await PageObjects.common.navigateToApp('discover');
await savedQueryManagementComponent.deleteSavedQuery(savedQueryName);
await savedQueryManagementComponent.savedQueryExistOrFail(name);
await savedQueryManagementComponent.closeSavedQueryManagementComponent();
await savedQueryManagementComponent.deleteSavedQuery(name);
});
});
});
Expand Down

0 comments on commit 9cb830f

Please sign in to comment.