Skip to content

Commit

Permalink
[8.17] [API keys] Improve functional tests for API keys management pa…
Browse files Browse the repository at this point in the history
…ge (#200110) (#201206)

# Backport

This will backport the following commits from `main` to `8.17`:
- [[API keys] Improve functional tests for API keys management page
(#200110)](#200110)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT
[{"author":{"name":"Sid","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-11-21T14:15:13Z","message":"[API
keys] Improve functional tests for API keys management page
(#200110)\n\nCloses
https://github.com/elastic/kibana/issues/200756\r\n\r\n##
Summary\r\n\r\nEnhance existing functional tests for API Keys querying
to test filters\r\nand toggles while querying API keys.\r\n\r\n###
Notes\r\n\r\nThe following tests were added:\r\n\r\n- Toggling the
following filters displays the correct keys\r\n - Personal, Managed,
Cross cluster types\r\n - Active or expired keys\r\n- Filtering by
username by clicking the dropdown list\r\n- Added test for querying
using the search bar **but it is skipped** for\r\nnow as we'd like to
fix the behavior. Tracked
by\r\nhttps://github.com//issues/195795\r\n\r\n###
Checklist\r\n\r\nCheck the PR satisfies following conditions.
\r\n\r\nReviewers should verify this PR satisfies this list as
well.\r\n\r\n- [x] [Unit or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios=\r\n- [ ] The PR
description includes the appropriate Release Notes section,\r\nand the
correct `release_node:*` label is applied per
the\r\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n---------\r\n\r\nCo-authored-by:
Elastic Machine
<[email protected]>","sha":"889ce000eb18bf60d3dc65ec0b39dbf705c7184b","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["test","Team:Security","Feature:Users/Roles/API
Keys","release_note:skip","v9.0.0","backport:prev-major"],"title":"[API
keys] Improve functional tests for API keys management
page","number":200110,"url":"https://github.com/elastic/kibana/pull/200110","mergeCommit":{"message":"[API
keys] Improve functional tests for API keys management page
(#200110)\n\nCloses
https://github.com/elastic/kibana/issues/200756\r\n\r\n##
Summary\r\n\r\nEnhance existing functional tests for API Keys querying
to test filters\r\nand toggles while querying API keys.\r\n\r\n###
Notes\r\n\r\nThe following tests were added:\r\n\r\n- Toggling the
following filters displays the correct keys\r\n - Personal, Managed,
Cross cluster types\r\n - Active or expired keys\r\n- Filtering by
username by clicking the dropdown list\r\n- Added test for querying
using the search bar **but it is skipped** for\r\nnow as we'd like to
fix the behavior. Tracked
by\r\nhttps://github.com//issues/195795\r\n\r\n###
Checklist\r\n\r\nCheck the PR satisfies following conditions.
\r\n\r\nReviewers should verify this PR satisfies this list as
well.\r\n\r\n- [x] [Unit or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios=\r\n- [ ] The PR
description includes the appropriate Release Notes section,\r\nand the
correct `release_node:*` label is applied per
the\r\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n---------\r\n\r\nCo-authored-by:
Elastic Machine
<[email protected]>","sha":"889ce000eb18bf60d3dc65ec0b39dbf705c7184b"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/200110","number":200110,"mergeCommit":{"message":"[API
keys] Improve functional tests for API keys management page
(#200110)\n\nCloses
https://github.com/elastic/kibana/issues/200756\r\n\r\n##
Summary\r\n\r\nEnhance existing functional tests for API Keys querying
to test filters\r\nand toggles while querying API keys.\r\n\r\n###
Notes\r\n\r\nThe following tests were added:\r\n\r\n- Toggling the
following filters displays the correct keys\r\n - Personal, Managed,
Cross cluster types\r\n - Active or expired keys\r\n- Filtering by
username by clicking the dropdown list\r\n- Added test for querying
using the search bar **but it is skipped** for\r\nnow as we'd like to
fix the behavior. Tracked
by\r\nhttps://github.com//issues/195795\r\n\r\n###
Checklist\r\n\r\nCheck the PR satisfies following conditions.
\r\n\r\nReviewers should verify this PR satisfies this list as
well.\r\n\r\n- [x] [Unit or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios=\r\n- [ ] The PR
description includes the appropriate Release Notes section,\r\nand the
correct `release_node:*` label is applied per
the\r\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n---------\r\n\r\nCo-authored-by:
Elastic Machine
<[email protected]>","sha":"889ce000eb18bf60d3dc65ec0b39dbf705c7184b"}}]}]
BACKPORT-->

Co-authored-by: Sid <[email protected]>
Co-authored-by: Elastic Machine <[email protected]>
  • Loading branch information
3 people authored Nov 25, 2024
1 parent c0fb5ca commit b7ddad9
Show file tree
Hide file tree
Showing 3 changed files with 165 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,7 @@ export const ApiKeysTable: FunctionComponent<ApiKeysTableProps> = ({
<EuiSearchBar
query={query}
box={{
'data-test-subj': 'apiKeysSearchBar',
incremental: true,
schema: {
strict: true,
Expand Down Expand Up @@ -393,6 +394,7 @@ export const TypesFilterButton: FunctionComponent<CustomComponentProps> = ({ que
onFilterChange({ ...filters, type: filters.type === 'rest' ? undefined : 'rest' });
}}
withNext={types.includes('cross_cluster') || types.includes('managed')}
data-test-subj="personalFilterButton"
>
<FormattedMessage
id="xpack.security.accountManagement.apiKeyBadge.restTitle"
Expand All @@ -412,6 +414,7 @@ export const TypesFilterButton: FunctionComponent<CustomComponentProps> = ({ que
});
}}
withNext={types.includes('managed')}
data-test-subj="crossClusterFilterButton"
>
<FormattedMessage
id="xpack.security.accountManagement.apiKeyBadge.crossClusterLabel"
Expand All @@ -430,6 +433,7 @@ export const TypesFilterButton: FunctionComponent<CustomComponentProps> = ({ que
type: filters.type === 'managed' ? undefined : 'managed',
});
}}
data-test-subj="managedFilterButton"
>
<FormattedMessage
id="xpack.security.accountManagement.apiKeyBadge.managedTitle"
Expand Down Expand Up @@ -463,6 +467,7 @@ export const ExpiredFilterButton: FunctionComponent<CustomComponentProps> = ({
}
}}
withNext={true}
data-test-subj="activeFilterButton"
>
<FormattedMessage
id="xpack.security.management.apiKeys.table.activeFilter"
Expand All @@ -478,6 +483,7 @@ export const ExpiredFilterButton: FunctionComponent<CustomComponentProps> = ({
onFilterChange({ ...filters, expired: true });
}
}}
data-test-subj="expiredFilterButton"
>
<FormattedMessage
id="xpack.security.management.apiKeys.table.expiredFilter"
Expand Down Expand Up @@ -520,6 +526,7 @@ export const UsersFilterButton: FunctionComponent<CustomComponentProps> = ({ que
numFilters={usernames.length}
hasActiveFilters={numActiveFilters ? true : false}
numActiveFilters={numActiveFilters}
data-test-subj="ownerFilterButton"
>
<FormattedMessage
id="xpack.security.management.apiKeys.table.ownerFilter"
Expand Down
129 changes: 129 additions & 0 deletions x-pack/test/functional/apps/api_keys/home_page.ts
Original file line number Diff line number Diff line change
Expand Up @@ -419,5 +419,134 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => {
);
});
});

describe('querying API keys', function () {
before(async () => {
await clearAllApiKeys(es, log);
await security.testUser.setRoles(['kibana_admin', 'test_api_keys']);

await es.transport.request({
method: 'POST',
path: '/_security/cross_cluster/api_key',
body: {
name: 'test_cross_cluster',
expiration: '1d',
access: {
search: [
{
names: ['*'],
},
],
replication: [
{
names: ['*'],
},
],
},
},
});

await es.security.createApiKey({
name: 'my api key',
expiration: '1d',
role_descriptors: {
role_1: {},
},
metadata: {
managed: true,
},
});

await es.security.createApiKey({
name: 'Alerting: Managed',
expiration: '1d',
role_descriptors: {
role_1: {},
},
});

await es.security.createApiKey({
name: 'test_api_key',
expiration: '1s',
role_descriptors: {
role_1: {},
},
});

await es.security.grantApiKey({
api_key: {
name: 'test_user_api_key',
expiration: '1d',
},
grant_type: 'password',
run_as: 'test_user',
username: 'elastic',
password: 'changeme',
});

await pageObjects.common.navigateToApp('apiKeys');
});

after(async () => {
await security.testUser.restoreDefaults();
await clearAllApiKeys(es, log);
});

it('active/expired filter buttons work as expected', async () => {
await pageObjects.apiKeys.clickExpiryFilters('active');
await ensureApiKeysExist(['my api key', 'Alerting: Managed', 'test_cross_cluster']);
expect(await pageObjects.apiKeys.doesApiKeyExist('test_api_key')).to.be(false);

await pageObjects.apiKeys.clickExpiryFilters('expired');
await ensureApiKeysExist(['test_api_key']);
expect(await pageObjects.apiKeys.doesApiKeyExist('my api key')).to.be(false);

// reset filter buttons
await pageObjects.apiKeys.clickExpiryFilters('expired');
});

it('api key type filter buttons work as expected', async () => {
await pageObjects.apiKeys.clickTypeFilters('personal');

await ensureApiKeysExist(['test_api_key']);

await pageObjects.apiKeys.clickTypeFilters('cross_cluster');

await ensureApiKeysExist(['test_cross_cluster']);

await pageObjects.apiKeys.clickTypeFilters('managed');

await ensureApiKeysExist(['my api key', 'Alerting: Managed']);

// reset filters by simulate clicking the managed filter button again
await pageObjects.apiKeys.clickTypeFilters('managed');
});

it('username filter buttons work as expected', async () => {
await pageObjects.apiKeys.clickUserNameDropdown();
expect(
await testSubjects.exists('userProfileSelectableOption-system_indices_superuser')
).to.be(true);
expect(await testSubjects.exists('userProfileSelectableOption-test_user')).to.be(true);

await testSubjects.click('userProfileSelectableOption-test_user');

await ensureApiKeysExist(['test_user_api_key']);
await testSubjects.click('userProfileSelectableOption-test_user');

await testSubjects.click('userProfileSelectableOption-system_indices_superuser');

await ensureApiKeysExist(['my api key', 'Alerting: Managed', 'test_cross_cluster']);
});

it.skip('search bar works as expected', async () => {
await pageObjects.apiKeys.setSearchBarValue('test_user_api_key');

await ensureApiKeysExist(['test_user_api_key']);

await pageObjects.apiKeys.setSearchBarValue('"my api key"');
await ensureApiKeysExist(['my api key']);
});
});
});
};
29 changes: 29 additions & 0 deletions x-pack/test/functional/page_objects/api_keys_page.ts
Original file line number Diff line number Diff line change
Expand Up @@ -157,5 +157,34 @@ export function ApiKeysPageProvider({ getService }: FtrProviderContext) {
const toast = await testSubjects.find('updateApiKeySuccessToast');
return toast.getVisibleText();
},

async clickExpiryFilters(type: 'active' | 'expired') {
const button = await testSubjects.find(
type === 'active' ? 'activeFilterButton' : 'expiredFilterButton'
);
return button.click();
},

async clickTypeFilters(type: 'personal' | 'managed' | 'cross_cluster') {
const buttonMap = {
personal: 'personalFilterButton',
managed: 'managedFilterButton',
cross_cluster: 'crossClusterFilterButton',
};

const button = await testSubjects.find(buttonMap[type]);
return button.click();
},

async clickUserNameDropdown() {
const button = await testSubjects.find('ownerFilterButton');
return button.click();
},

async setSearchBarValue(query: string) {
const searchBar = await testSubjects.find('apiKeysSearchBar');
await searchBar.clearValue();
return searchBar.type(query);
},
};
}

0 comments on commit b7ddad9

Please sign in to comment.