Add test service to manage observability test users

[weltenwort]

📝 Summary

This adds a functional test service to create, assign, restore and delete security roles for testing the observability app.

closes #110627

🎨 New APIs

The observability test service is available in function tests via

const observability = getService('observability');

observability.user.defineBasicObservabilityRole(observabilityFeatures)

Generates a role definition for use with setTestUserRole(roleDefinition) with commonly used combinations of index and feature privileges in test for the observability app.

observability.user.setTestUserRole(roleDefinition)

Creates an observability test role in the system using the given definition and assigns it to the global test user. It also performs a page refresh to apply the new permissions, but doesn't require a re-login. Suitable for use in a test's before clause. Must be reverted and deleted again after use, for example in an after clause.

observability.user.restoreDefaultTestUserRole()

Deletes the observability test role from the system and restores the test user's roles to the default. It also performs a page refresh to apply the new permissions, but doesn't require a re-login. Suitable for use in a test's after clause.

💡 Example usage

export default function ({ getService }: FtrProviderContext) {
  const observability = getService('observability');

  describe('my test suite that requires logs ui permissions', () => {
    before(async () => {
      await observability.users.setTestUserRole(
        // this grants access to the Kibana feature and the `logs-*,filebeat-*` indices
        observability.users.defineBasicObservabilityRole({
          logs: ['all'],
        })
      );
    });

    after(async () => {
      await observability.users.restoreDefaultTestUserRole();
    });

    // tests go here
  });
}

🕵️‍♀️ Review notes

• This also converts the observability feature control tests to use the new service.
• To only run the observability functional tests I apply the following patch:

only-obervability-tests

diff --git a/x-pack/test/functional/config.js b/x-pack/test/functional/config.js
index 226cebb9afb..9117cfe1881 100644
--- a/x-pack/test/functional/config.js
+++ b/x-pack/test/functional/config.js
@@ -23,46 +23,46 @@ export default async function ({ readConfigFile }) {
   return {
     // list paths to the files that contain your plugins tests
     testFiles: [
-      resolve(__dirname, './apps/advanced_settings'),
-      resolve(__dirname, './apps/canvas'),
-      resolve(__dirname, './apps/graph'),
-      resolve(__dirname, './apps/monitoring'),
-      resolve(__dirname, './apps/watcher'),
-      resolve(__dirname, './apps/dashboard'),
-      resolve(__dirname, './apps/discover'),
-      resolve(__dirname, './apps/security'),
-      resolve(__dirname, './apps/spaces'),
-      resolve(__dirname, './apps/lens'),
-      resolve(__dirname, './apps/logstash'),
-      resolve(__dirname, './apps/grok_debugger'),
-      resolve(__dirname, './apps/infra'),
-      resolve(__dirname, './apps/ml'),
-      resolve(__dirname, './apps/rollup_job'),
-      resolve(__dirname, './apps/maps'),
-      resolve(__dirname, './apps/status_page'),
-      resolve(__dirname, './apps/timelion'),
-      resolve(__dirname, './apps/upgrade_assistant'),
-      resolve(__dirname, './apps/visualize'),
-      resolve(__dirname, './apps/uptime'),
-      resolve(__dirname, './apps/saved_objects_management'),
-      resolve(__dirname, './apps/dev_tools'),
-      resolve(__dirname, './apps/apm'),
-      resolve(__dirname, './apps/api_keys'),
-      resolve(__dirname, './apps/index_patterns'),
-      resolve(__dirname, './apps/index_management'),
-      resolve(__dirname, './apps/index_lifecycle_management'),
-      resolve(__dirname, './apps/ingest_pipelines'),
-      resolve(__dirname, './apps/snapshot_restore'),
-      resolve(__dirname, './apps/cross_cluster_replication'),
-      resolve(__dirname, './apps/remote_clusters'),
-      resolve(__dirname, './apps/transform'),
-      resolve(__dirname, './apps/reporting_management'),
-      resolve(__dirname, './apps/management'),
-      resolve(__dirname, './apps/reporting'),
+      // resolve(__dirname, './apps/advanced_settings'),
+      // resolve(__dirname, './apps/canvas'),
+      // resolve(__dirname, './apps/graph'),
+      // resolve(__dirname, './apps/monitoring'),
+      // resolve(__dirname, './apps/watcher'),
+      // resolve(__dirname, './apps/dashboard'),
+      // resolve(__dirname, './apps/discover'),
+      // resolve(__dirname, './apps/security'),
+      // resolve(__dirname, './apps/spaces'),
+      // resolve(__dirname, './apps/lens'),
+      // resolve(__dirname, './apps/logstash'),
+      // resolve(__dirname, './apps/grok_debugger'),
+      // resolve(__dirname, './apps/infra'),
+      // resolve(__dirname, './apps/ml'),
+      // resolve(__dirname, './apps/rollup_job'),
+      // resolve(__dirname, './apps/maps'),
+      // resolve(__dirname, './apps/status_page'),
+      // resolve(__dirname, './apps/timelion'),
+      // resolve(__dirname, './apps/upgrade_assistant'),
+      // resolve(__dirname, './apps/visualize'),
+      // resolve(__dirname, './apps/uptime'),
+      // resolve(__dirname, './apps/saved_objects_management'),
+      // resolve(__dirname, './apps/dev_tools'),
+      // resolve(__dirname, './apps/apm'),
+      // resolve(__dirname, './apps/api_keys'),
+      // resolve(__dirname, './apps/index_patterns'),
+      // resolve(__dirname, './apps/index_management'),
+      // resolve(__dirname, './apps/index_lifecycle_management'),
+      // resolve(__dirname, './apps/ingest_pipelines'),
+      // resolve(__dirname, './apps/snapshot_restore'),
+      // resolve(__dirname, './apps/cross_cluster_replication'),
+      // resolve(__dirname, './apps/remote_clusters'),
+      // resolve(__dirname, './apps/transform'),
+      // resolve(__dirname, './apps/reporting_management'),
+      // resolve(__dirname, './apps/management'),
+      // resolve(__dirname, './apps/reporting'),
       resolve(__dirname, './apps/observability'),
 
       // This license_management file must be last because it is destructive.
-      resolve(__dirname, './apps/license_management'),
+      // resolve(__dirname, './apps/license_management'),
     ],
 
     services,

[brianseeders]

@elasticmachine merge upstream

[elasticmachine]

Pinging @elastic/logs-metrics-ui (Team:logs-metrics-ui)

[Kerry350]

LGTM, this is much cleaner / nicer 🎉

[weltenwort]

@elasticmachine merge upstream

[kibanamachine]

💚 Build Succeeded

• continuous-integration/kibana-ci/pull-request
• Commit: a042a81
• Storybooks Preview

Metrics [docs]

✅ unchanged

History

• 💚 Build #150918 succeeded 3f88112
• 💔 Build #150708 failed bcecabe
• 💔 Build #150320 failed 4cd1cb170284265d25924cdb63d7162abc32d09c

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @weltenwort

[kibanamachine]

💚 Backport successful

Status	Branch	Result
✅	7.15
✅	7.x

The backport PRs will be merged automatically after passing CI.