[functional/security/test-user] remove naked boolean (#126652)

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> (cherry picked from commit be1028c)
elastic · Mar 3, 2022 · 49c768c · 49c768c
1 parent b863048
commit 49c768c
Show file tree

Hide file tree

Showing 39 changed files with 99 additions and 86 deletions.
diff --git a/test/common/services/security/test_user.ts b/test/common/services/security/test_user.ts
@@ -40,29 +40,33 @@ export class TestUser extends FtrService {
     super(ctx);
   }
 
-  async restoreDefaults(shouldRefreshBrowser: boolean = true) {
-    if (this.enabled) {
-      await this.setRoles(this.config.get('security.defaultRoles'), shouldRefreshBrowser);
+  async restoreDefaults(options?: { skipBrowserRefresh?: boolean }) {
+    if (!this.enabled) {
+      return;
     }
+
+    await this.setRoles(this.config.get('security.defaultRoles'), options);
   }
 
-  async setRoles(roles: string[], shouldRefreshBrowser: boolean = true) {
-    if (this.enabled) {
-      this.log.debug(`set roles = ${roles}`);
-      await this.user.create(TEST_USER_NAME, {
-        password: TEST_USER_PASSWORD,
-        roles,
-        full_name: 'test user',
-      });
-
-      if (this.browser && this.testSubjects && shouldRefreshBrowser) {
-        if (await this.testSubjects.exists('kibanaChrome', { allowHidden: true })) {
-          await this.browser.refresh();
-          // accept alert if it pops up
-          const alert = await this.browser.getAlert();
-          await alert?.accept();
-          await this.testSubjects.find('kibanaChrome', this.config.get('timeouts.find') * 10);
-        }
+  async setRoles(roles: string[], options?: { skipBrowserRefresh?: boolean }) {
+    if (!this.enabled) {
+      return;
+    }
+
+    this.log.debug(`set roles = ${roles}`);
+    await this.user.create(TEST_USER_NAME, {
+      password: TEST_USER_PASSWORD,
+      roles,
+      full_name: 'test user',
+    });
+
+    if (this.browser && this.testSubjects && !options?.skipBrowserRefresh) {
+      if (await this.testSubjects.exists('kibanaChrome', { allowHidden: true })) {
+        await this.browser.refresh();
+        // accept alert if it pops up
+        const alert = await this.browser.getAlert();
+        await alert?.accept();
+        await this.testSubjects.find('kibanaChrome', this.config.get('timeouts.find') * 10);
       }
     }
   }

diff --git a/test/functional/apps/discover/_huge_fields.ts b/test/functional/apps/discover/_huge_fields.ts
@@ -18,7 +18,9 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
   describe('test large number of fields in sidebar', function () {
     before(async function () {
       await esArchiver.loadIfNeeded('test/functional/fixtures/es_archiver/huge_fields');
-      await security.testUser.setRoles(['kibana_admin', 'test_testhuge_reader'], false);
+      await security.testUser.setRoles(['kibana_admin', 'test_testhuge_reader'], {
+        skipBrowserRefresh: true,
+      });
       await kibanaServer.uiSettings.update({
         'timepicker:timeDefaults': `{ "from": "2016-10-05T00:00:00", "to": "2016-10-06T00:00:00"}`,
       });

diff --git a/test/functional/apps/visualize/_tsvb_chart.ts b/test/functional/apps/visualize/_tsvb_chart.ts
@@ -34,7 +34,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
     beforeEach(async () => {
       await security.testUser.setRoles(
         ['kibana_admin', 'test_logstash_reader', 'kibana_sample_admin'],
-        false
+        { skipBrowserRefresh: true }
       );
       await visualize.navigateToNewVisualization();
       await visualize.clickVisualBuilder();

diff --git a/x-pack/test/accessibility/apps/security_solution.ts b/x-pack/test/accessibility/apps/security_solution.ts
@@ -17,12 +17,12 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
   // FLAKY: https://github.com/elastic/kibana/issues/95707
   describe.skip('Security Solution', () => {
     before(async () => {
-      await security.testUser.setRoles(['superuser'], false);
+      await security.testUser.setRoles(['superuser'], { skipBrowserRefresh: true });
       await common.navigateToApp('security');
     });
 
     after(async () => {
-      await security.testUser.restoreDefaults(false);
+      await security.testUser.restoreDefaults({ skipBrowserRefresh: true });
     });
 
     describe('Detections', () => {

diff --git a/x-pack/test/functional/apps/api_keys/feature_controls/api_keys_security.ts b/x-pack/test/functional/apps/api_keys/feature_controls/api_keys_security.ts
@@ -21,7 +21,7 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) {
 
     describe('global all privileges (aka kibana_admin)', () => {
       before(async () => {
-        await security.testUser.setRoles(['kibana_admin'], true);
+        await security.testUser.setRoles(['kibana_admin']);
       });
       after(async () => {
         await security.testUser.restoreDefaults();
@@ -41,7 +41,7 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) {
 
     describe('global dashboard read with manage_security', () => {
       before(async () => {
-        await security.testUser.setRoles(['global_dashboard_read', 'manage_security'], true);
+        await security.testUser.setRoles(['global_dashboard_read', 'manage_security']);
       });
       after(async () => {
         await security.testUser.restoreDefaults();

diff --git a/x-pack/test/functional/apps/cross_cluster_replication/feature_controls/ccr_security.ts b/x-pack/test/functional/apps/cross_cluster_replication/feature_controls/ccr_security.ts
@@ -27,7 +27,7 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) {
 
     describe('global all privileges (aka kibana_admin)', () => {
       before(async () => {
-        await security.testUser.setRoles(['kibana_admin'], true);
+        await security.testUser.setRoles(['kibana_admin']);
       });
       after(async () => {
         await security.testUser.restoreDefaults();
@@ -47,7 +47,7 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) {
 
     describe('global dashboard read with ccr_user', () => {
       before(async () => {
-        await security.testUser.setRoles(['global_dashboard_read', 'ccr_user'], true);
+        await security.testUser.setRoles(['global_dashboard_read', 'ccr_user']);
       });
       after(async () => {
         await security.testUser.restoreDefaults();

diff --git a/x-pack/test/functional/apps/index_lifecycle_management/feature_controls/ilm_security.ts b/x-pack/test/functional/apps/index_lifecycle_management/feature_controls/ilm_security.ts
@@ -27,7 +27,7 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) {
 
     describe('global all privileges (aka kibana_admin)', () => {
       before(async () => {
-        await security.testUser.setRoles(['kibana_admin'], true);
+        await security.testUser.setRoles(['kibana_admin']);
       });
       after(async () => {
         await security.testUser.restoreDefaults();
@@ -47,7 +47,7 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) {
 
     describe('global dashboard read with manage_ilm', () => {
       before(async () => {
-        await security.testUser.setRoles(['global_dashboard_read', 'manage_ilm'], true);
+        await security.testUser.setRoles(['global_dashboard_read', 'manage_ilm']);
       });
       after(async () => {
         await security.testUser.restoreDefaults();

diff --git a/x-pack/test/functional/apps/index_lifecycle_management/home_page.ts b/x-pack/test/functional/apps/index_lifecycle_management/home_page.ts
@@ -21,7 +21,7 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => {
 
   describe('Home page', function () {
     before(async () => {
-      await security.testUser.setRoles(['manage_ilm'], true);
+      await security.testUser.setRoles(['manage_ilm']);
       const isCloud = await deployment.isCloud();
       if (!isCloud) {
         await esClient.snapshot.createRepository({

diff --git a/x-pack/test/functional/apps/index_management/feature_controls/index_management_security.ts b/x-pack/test/functional/apps/index_management/feature_controls/index_management_security.ts
@@ -27,7 +27,7 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) {
 
     describe('global all privileges (aka kibana_admin)', () => {
       before(async () => {
-        await security.testUser.setRoles(['kibana_admin'], true);
+        await security.testUser.setRoles(['kibana_admin']);
       });
       after(async () => {
         await security.testUser.restoreDefaults();
@@ -47,7 +47,7 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) {
 
     describe('global dashboard read with index_management_user', () => {
       before(async () => {
-        await security.testUser.setRoles(['global_dashboard_read', 'index_management_user'], true);
+        await security.testUser.setRoles(['global_dashboard_read', 'index_management_user']);
       });
       after(async () => {
         await security.testUser.restoreDefaults();

diff --git a/x-pack/test/functional/apps/ingest_pipelines/feature_controls/ingest_pipelines_security.ts b/x-pack/test/functional/apps/ingest_pipelines/feature_controls/ingest_pipelines_security.ts
@@ -27,7 +27,7 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) {
 
     describe('global all privileges (aka kibana_admin)', () => {
       before(async () => {
-        await security.testUser.setRoles(['kibana_admin'], true);
+        await security.testUser.setRoles(['kibana_admin']);
       });
       after(async () => {
         await security.testUser.restoreDefaults();
@@ -47,7 +47,7 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) {
 
     describe('global dashboard read with ingest_pipelines_user', () => {
       before(async () => {
-        await security.testUser.setRoles(['global_dashboard_read', 'ingest_pipelines_user'], true);
+        await security.testUser.setRoles(['global_dashboard_read', 'ingest_pipelines_user']);
       });
       after(async () => {
         await security.testUser.restoreDefaults();

diff --git a/x-pack/test/functional/apps/lens/add_to_dashboard.ts b/x-pack/test/functional/apps/lens/add_to_dashboard.ts
@@ -275,7 +275,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
       describe('dashboard no-access privileges', () => {
         before(async () => {
           await PageObjects.common.navigateToApp('visualize');
-          await security.testUser.setRoles(['test_logstash_reader', 'global_visualize_all'], true);
+          await security.testUser.setRoles(['test_logstash_reader', 'global_visualize_all']);
         });
 
         after(async () => {
@@ -317,10 +317,11 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
 
       describe('dashboard read-only privileges', () => {
         before(async () => {
-          await security.testUser.setRoles(
-            ['test_logstash_reader', 'global_visualize_all', 'global_dashboard_read'],
-            true
-          );
+          await security.testUser.setRoles([
+            'test_logstash_reader',
+            'global_visualize_all',
+            'global_dashboard_read',
+          ]);
         });
 
         after(async () => {

diff --git a/x-pack/test/functional/apps/lens/dashboard.ts b/x-pack/test/functional/apps/lens/dashboard.ts
@@ -44,7 +44,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
           'test_logstash_reader',
           'global_visualize_all',
         ],
-        false
+        { skipBrowserRefresh: true }
       );
     });
     after(async () => {

diff --git a/x-pack/test/functional/apps/lens/error_handling.ts b/x-pack/test/functional/apps/lens/error_handling.ts
@@ -24,7 +24,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
     before(async () => {
       await security.testUser.setRoles(
         ['global_discover_read', 'global_visualize_read', 'test_logstash_reader'],
-        false
+        { skipBrowserRefresh: true }
       );
       // loading an object without reference fails, so we load data view + lens object and then unload data view
       await kibanaServer.importExport.load(

diff --git a/x-pack/test/functional/apps/lens/lens_reporting.ts b/x-pack/test/functional/apps/lens/lens_reporting.ts
@@ -25,7 +25,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
           'global_dashboard_read',
           'reporting_user', // NOTE: the built-in role granting full reporting access is deprecated. See xpack.reporting.roles.enabled
         ],
-        false
+        { skipBrowserRefresh: true }
       );
     });
 

diff --git a/x-pack/test/functional/apps/lens/persistent_context.ts b/x-pack/test/functional/apps/lens/persistent_context.ts
@@ -28,7 +28,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
     before(async () => {
       await security.testUser.setRoles(
         ['global_discover_read', 'global_visualize_read', 'test_logstash_reader'],
-        false
+        { skipBrowserRefresh: true }
       );
     });
 

diff --git a/...k/test/functional/apps/license_management/feature_controls/license_management_security.ts b/...k/test/functional/apps/license_management/feature_controls/license_management_security.ts
@@ -27,7 +27,7 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) {
 
     describe('global all privileges (aka kibana_admin)', () => {
       before(async () => {
-        await security.testUser.setRoles(['kibana_admin'], true);
+        await security.testUser.setRoles(['kibana_admin']);
       });
       after(async () => {
         await security.testUser.restoreDefaults();
@@ -47,10 +47,7 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) {
 
     describe('global dashboard read with license_management_user', () => {
       before(async () => {
-        await security.testUser.setRoles(
-          ['global_dashboard_read', 'license_management_user'],
-          true
-        );
+        await security.testUser.setRoles(['global_dashboard_read', 'license_management_user']);
       });
       after(async () => {
         await security.testUser.restoreDefaults();

diff --git a/x-pack/test/functional/apps/logstash/feature_controls/logstash_security.ts b/x-pack/test/functional/apps/logstash/feature_controls/logstash_security.ts
@@ -27,7 +27,7 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) {
 
     describe('global all privileges (aka kibana_admin)', () => {
       before(async () => {
-        await security.testUser.setRoles(['kibana_admin'], true);
+        await security.testUser.setRoles(['kibana_admin']);
       });
       after(async () => {
         await security.testUser.restoreDefaults();
@@ -47,7 +47,7 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) {
 
     describe('global dashboard read with logstash_read_user', () => {
       before(async () => {
-        await security.testUser.setRoles(['global_dashboard_read', 'logstash_read_user'], true);
+        await security.testUser.setRoles(['global_dashboard_read', 'logstash_read_user']);
       });
       after(async () => {
         await security.testUser.restoreDefaults();

diff --git a/x-pack/test/functional/apps/management/feature_controls/management_security.ts b/x-pack/test/functional/apps/management/feature_controls/management_security.ts
@@ -28,7 +28,7 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) {
 
     describe('no management privileges', () => {
       before(async () => {
-        await security.testUser.setRoles(['global_dashboard_read'], true);
+        await security.testUser.setRoles(['global_dashboard_read']);
       });
       after(async () => {
         await security.testUser.restoreDefaults();
@@ -47,7 +47,7 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) {
 
     describe('global all privileges (aka kibana_admin)', () => {
       before(async () => {
-        await security.testUser.setRoles(['kibana_admin'], true);
+        await security.testUser.setRoles(['kibana_admin']);
       });
       after(async () => {
         await security.testUser.restoreDefaults();

diff --git a/x-pack/test/functional/apps/maps/documents_source/docvalue_fields.js b/x-pack/test/functional/apps/maps/documents_source/docvalue_fields.js
@@ -13,7 +13,9 @@ export default function ({ getPageObjects, getService }) {
 
   describe('docvalue_fields', () => {
     before(async () => {
-      await security.testUser.setRoles(['global_maps_read', 'test_logstash_reader'], false);
+      await security.testUser.setRoles(['global_maps_read', 'test_logstash_reader'], {
+        skipBrowserRefresh: true,
+      });
     });
 
     after(async () => {

diff --git a/x-pack/test/functional/apps/maps/documents_source/search_hits.js b/x-pack/test/functional/apps/maps/documents_source/search_hits.js
@@ -21,7 +21,7 @@ export default function ({ getPageObjects, getService }) {
           'antimeridian_points_reader',
           'antimeridian_shapes_reader',
         ],
-        false
+        { skipBrowserRefresh: true }
       );
       await PageObjects.maps.loadSavedMap('document example');
     });

diff --git a/x-pack/test/functional/apps/maps/documents_source/top_hits.js b/x-pack/test/functional/apps/maps/documents_source/top_hits.js
@@ -19,7 +19,9 @@ export default function ({ getPageObjects, getService }) {
   describe('geo top hits', () => {
     describe('split on string field', () => {
       before(async () => {
-        await security.testUser.setRoles(['global_maps_all', 'test_logstash_reader'], false);
+        await security.testUser.setRoles(['global_maps_all', 'test_logstash_reader'], {
+          skipBrowserRefresh: true,
+        });
         await PageObjects.maps.loadSavedMap('document example top hits');
       });
 

diff --git a/x-pack/test/functional/apps/maps/embeddable/add_to_dashboard.js b/x-pack/test/functional/apps/maps/embeddable/add_to_dashboard.js
@@ -31,7 +31,7 @@ export default function ({ getPageObjects, getService }) {
           'global_dashboard_all',
           'meta_for_geoshape_data_reader',
         ],
-        false
+        { skipBrowserRefresh: true }
       );
     });
 

diff --git a/x-pack/test/functional/apps/maps/embeddable/dashboard.js b/x-pack/test/functional/apps/maps/embeddable/dashboard.js
@@ -28,7 +28,7 @@ export default function ({ getPageObjects, getService }) {
           'meta_for_geoshape_data_reader',
           'global_dashboard_read',
         ],
-        false
+        { skipBrowserRefresh: true }
       );
       await kibanaServer.uiSettings.replace({
         defaultIndex: 'c698b940-e149-11e8-a35a-370a8516603a',

diff --git a/x-pack/test/functional/apps/maps/embeddable/embeddable_library.js b/x-pack/test/functional/apps/maps/embeddable/embeddable_library.js
@@ -26,7 +26,7 @@ export default function ({ getPageObjects, getService }) {
           'global_dashboard_all',
           'meta_for_geoshape_data_reader',
         ],
-        false
+        { skipBrowserRefresh: true }
       );
       await kibanaServer.uiSettings.replace({
         defaultIndex: 'c698b940-e149-11e8-a35a-370a8516603a',

diff --git a/x-pack/test/functional/apps/maps/embeddable/filter_by_map_extent.js b/x-pack/test/functional/apps/maps/embeddable/filter_by_map_extent.js
@@ -16,7 +16,7 @@ export default function ({ getPageObjects, getService }) {
     before(async () => {
       await security.testUser.setRoles(
         ['test_logstash_reader', 'global_maps_all', 'global_dashboard_all'],
-        false
+        { skipBrowserRefresh: true }
       );
       await PageObjects.common.navigateToApp('dashboard');
       await PageObjects.dashboard.gotoDashboardEditMode('filter by map extent dashboard');

diff --git a/x-pack/test/functional/apps/maps/embeddable/save_and_return.js b/x-pack/test/functional/apps/maps/embeddable/save_and_return.js
@@ -24,7 +24,7 @@ export default function ({ getPageObjects, getService }) {
           'global_dashboard_all',
           'meta_for_geoshape_data_reader',
         ],
-        false
+        { skipBrowserRefresh: true }
       );
     });
 

diff --git a/x-pack/test/functional/apps/maps/es_geo_grid_source.js b/x-pack/test/functional/apps/maps/es_geo_grid_source.js
@@ -20,7 +20,7 @@ export default function ({ getPageObjects, getService }) {
     before(async () => {
       await security.testUser.setRoles(
         ['global_maps_all', 'test_logstash_reader', 'geoshape_data_reader'],
-        false
+        { skipBrowserRefresh: true }
       );
     });
 

diff --git a/x-pack/test/functional/apps/maps/joins.js b/x-pack/test/functional/apps/maps/joins.js
@@ -26,7 +26,7 @@ export default function ({ getPageObjects, getService }) {
     before(async () => {
       await security.testUser.setRoles(
         ['global_maps_all', 'geoshape_data_reader', 'meta_for_geoshape_data_reader'],
-        false
+        { skipBrowserRefresh: true }
       );
       await PageObjects.maps.loadSavedMap('join example');
     });