kibana/x-pack/test/functional/apps/canvas/expression.ts
Catherine Liu aea6cebb1b
[Canvas] Adds a functional test for expression editor autocomplete (#146943)
## Summary
Fixes https://github.com/elastic/kibana/issues/147887

I added a functional test to check that autocomplete suggestions appear
as you type in the expression editor in Canvas.

[Flaky test runner x
100](https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/1658)

### 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
- [ ] 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)
2022-12-21 12:39:06 -07:00

106 lines
3.9 KiB
TypeScript

/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/
import expect from '@kbn/expect';
import { FtrProviderContext } from '../../ftr_provider_context';
export default function canvasExpressionTest({ getService, getPageObjects }: FtrProviderContext) {
const archive = 'x-pack/test/functional/fixtures/kbn_archiver/canvas/default';
const browser = getService('browser');
const find = getService('find');
const kibanaServer = getService('kibanaServer');
const monacoEditor = getService('monacoEditor');
const PageObjects = getPageObjects(['canvas', 'common']);
const retry = getService('retry');
const testSubjects = getService('testSubjects');
describe('expression editor', function () {
// there is an issue with FF not properly clicking on workpad elements
this.tags('skipFirefox');
before(async () => {
await kibanaServer.importExport.load(archive);
// load test workpad
await PageObjects.common.navigateToApp('canvas', {
hash: '/workpad/workpad-1705f884-6224-47de-ba49-ca224fe6ec31/page/1',
});
});
after(async () => {
await kibanaServer.importExport.unload(archive);
});
it('updates when element is changed via side bar', async () => {
// wait for all our elements to load up
await retry.try(async () => {
const elements = await testSubjects.findAll(
'canvasWorkpadPage > canvasWorkpadPageElementContent'
);
expect(elements).to.have.length(4);
});
const codeEditorSubj = 'canvasCodeEditorField';
// find the first workpad element (a markdown element) and click it to select it
await testSubjects.click('canvasWorkpadPage > canvasWorkpadPageElementContent', 20000);
await monacoEditor.waitCodeEditorReady(codeEditorSubj);
// open the expression editor
await PageObjects.canvas.openExpressionEditor();
await monacoEditor.waitCodeEditorReady('canvasExpressionInput');
// select markdown content and clear it
const oldMd = await monacoEditor.getCodeEditorValue(0);
await monacoEditor.setCodeEditorValue('', 0);
// type the new text
const newMd = `${oldMd} and this is a test`;
await monacoEditor.setCodeEditorValue(newMd, 0);
// make sure the open expression editor also has the changes
await retry.try(async () => {
const editorText = await monacoEditor.getCodeEditorValue(1);
expect(editorText).to.contain('Orange: Timelion, Server function and this is a test');
});
// reset the markdown
await monacoEditor.setCodeEditorValue(oldMd, 0);
});
it('does not show autocomplete before typing', async () => {
await retry.try(async () => {
const elements = await find.allByCssSelector('.monaco-list-rows > .monaco-list-row');
expect(elements.length).to.be(0);
});
});
it('shows autocomplete when typing', async () => {
const originalExpression = await monacoEditor.getCodeEditorValue(1);
await monacoEditor.setCodeEditorValue(' ', 1);
// checks that no suggestions are rendered
await retry.try(async () => {
const elements = await find.allByCssSelector('.monaco-list-rows > .monaco-list-row');
expect(elements.length).to.be(0);
});
await testSubjects.click('canvasExpressionInput');
await browser.pressKeys(browser.keys.SPACE);
// checks that suggestions are rendered after typing
await retry.try(async () => {
const elements = await find.allByCssSelector('.monaco-list-rows > .monaco-list-row');
expect(elements.length).to.be.above(0);
});
// reset expression
await monacoEditor.setCodeEditorValue(originalExpression, 1);
});
});
}