Enables the feature catalogue registry to be controlled via uiCapabil… (

#27945) * Enables the feature catalogue registry to be controlled via uiCapabilities * update snapshot * xpack_main populates uiCapabilities with the full list of catalogue entries * builds application privileges using catalogue actions * prevent 'catalogue' from being registered as a feature id * fix mocha tests
elastic · Jan 5, 2019 · 2503995 · 2503995
1 parent 7fcfc13
commit 2503995
Show file tree

Hide file tree

Showing 31 changed files with 439 additions and 25 deletions.
diff --git a/src/legacy/core_plugins/kibana/index.js b/src/legacy/core_plugins/kibana/index.js
@@ -165,6 +165,15 @@ export default function (kibana) {
             dashboard: {
               showWriteControls: true
             },
+            catalogue: {
+              discover: true,
+              dashboard: true,
+              visualize: true,
+              console: true,
+              advanced_settings: true,
+              saved_objects: true,
+              index_patterns: true,
+            },
             management: {
               /*
                * Management settings correspond to management section/link ids, and should not be changed

diff --git a/src/ui/public/capabilities/ui_capabilities.ts b/src/ui/public/capabilities/ui_capabilities.ts
@@ -24,6 +24,7 @@ export interface UICapabilities {
   management: {
     [sectionId: string]: Record<string, boolean>;
   };
+  catalogue: Record<string, boolean>;
   [key: string]: Record<string, boolean | Record<string, boolean>>;
 }
 

diff --git a/src/ui/public/registry/feature_catalogue.js b/src/ui/public/registry/feature_catalogue.js
@@ -18,13 +18,17 @@
  */
 
 import { uiRegistry } from './_registry';
+import { uiCapabilities } from '../capabilities';
 
 export const FeatureCatalogueRegistryProvider = uiRegistry({
   name: 'featureCatalogue',
   index: ['id'],
   group: ['category'],
   order: ['title'],
-  filter: featureCatalogItem => Object.keys(featureCatalogItem).length > 0
+  filter: featureCatalogItem => {
+    const isDisabledViaCapabilities = uiCapabilities.catalogue[featureCatalogItem.id] === false;
+    return !isDisabledViaCapabilities && Object.keys(featureCatalogItem).length > 0;
+  }
 });
 
 export const FeatureCatalogueCategory = {

diff --git a/src/ui/public/registry/feature_catalogue.test.js b/src/ui/public/registry/feature_catalogue.test.js
@@ -0,0 +1,102 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+jest.mock('ui/chrome', () => ({
+  getInjected: key => {
+    if (key === 'uiCapabilities') {
+      return {
+        navLinks: {},
+        management: {},
+        catalogue: {
+          item1: true,
+          item2: false,
+          item3: true,
+        },
+      };
+    }
+    throw new Error(`Unexpected call to chrome.getInjected with key ${key}`);
+  },
+}));
+import { FeatureCatalogueCategory, FeatureCatalogueRegistryProvider } from './feature_catalogue';
+
+describe('FeatureCatalogueRegistryProvider', () => {
+
+  beforeAll(() => {
+    FeatureCatalogueRegistryProvider.register(() => {
+      return {
+        id: 'item1',
+        title: 'foo',
+        description: 'this is foo',
+        icon: 'savedObjectsApp',
+        path: '/app/kibana#/management/kibana/objects',
+        showOnHomePage: true,
+        category: FeatureCatalogueCategory.ADMIN,
+      };
+    });
+
+    FeatureCatalogueRegistryProvider.register(() => {
+      return {
+        id: 'item2',
+        title: 'bar',
+        description: 'this is bar',
+        icon: 'savedObjectsApp',
+        path: '/app/kibana#/management/kibana/objects',
+        showOnHomePage: true,
+        category: FeatureCatalogueCategory.ADMIN,
+      };
+    });
+
+    // intentionally not listed in uiCapabilities.catalogue above
+    FeatureCatalogueRegistryProvider.register(() => {
+      return {
+        id: 'item4',
+        title: 'secret',
+        description: 'this is a secret',
+        icon: 'savedObjectsApp',
+        path: '/app/kibana#/management/kibana/objects',
+        showOnHomePage: true,
+        category: FeatureCatalogueCategory.ADMIN,
+      };
+    });
+  });
+
+  it('should not return items hidden by uiCapabilities', () => {
+    const mockPrivate = entityFn => entityFn();
+    const mockInjector = () => null;
+
+    // eslint-disable-next-line new-cap
+    const foo = FeatureCatalogueRegistryProvider(mockPrivate, mockInjector).inTitleOrder;
+    expect(foo).toEqual([{
+      id: 'item1',
+      title: 'foo',
+      description: 'this is foo',
+      icon: 'savedObjectsApp',
+      path: '/app/kibana#/management/kibana/objects',
+      showOnHomePage: true,
+      category: FeatureCatalogueCategory.ADMIN,
+    }, {
+      id: 'item4',
+      title: 'secret',
+      description: 'this is a secret',
+      icon: 'savedObjectsApp',
+      path: '/app/kibana#/management/kibana/objects',
+      showOnHomePage: true,
+      category: FeatureCatalogueCategory.ADMIN,
+    }]);
+  });
+});
diff --git a/x-pack/plugins/__mocks__/ui/capabilities.ts b/x-pack/plugins/__mocks__/ui/capabilities.ts
@@ -9,6 +9,7 @@ import { UICapabilities } from 'ui/capabilities';
 let internals: UICapabilities = {
   navLinks: {},
   management: {},
+  catalogue: {},
   spaces: {
     manage: true,
   },

diff --git a/x-pack/plugins/apm/index.js b/x-pack/plugins/apm/index.js
@@ -76,6 +76,7 @@ export function apm(kibana) {
         navLinkId: 'apm',
         privileges: {
           all: {
+            catalogue: ['apm'],
             app: ['apm'],
             savedObject: {
               all: [],

diff --git a/x-pack/plugins/canvas/init.js b/x-pack/plugins/canvas/init.js
@@ -42,6 +42,7 @@ export default async function(server /*options*/) {
     navLinkId: 'canvas',
     privileges: {
       all: {
+        catalogue: ['canvas'],
         app: ['canvas'],
         savedObject: {
           all: ['canvas'],
@@ -50,6 +51,7 @@ export default async function(server /*options*/) {
         ui: [],
       },
       read: {
+        catalogue: ['canvas'],
         app: ['canvas'],
         savedObject: {
           all: [],

diff --git a/x-pack/plugins/graph/index.js b/x-pack/plugins/graph/index.js
@@ -57,6 +57,7 @@ export function graph(kibana) {
         navLinkId: 'graph',
         privileges: {
           all: {
+            catalogue: ['graph'],
             app: ['graph'],
             savedObject: {
               all: ['graph-workspace'],
@@ -65,6 +66,7 @@ export function graph(kibana) {
             ui: [],
           },
           read: {
+            catalogue: ['graph'],
             app: ['graph'],
             savedObject: {
               all: [],

diff --git a/x-pack/plugins/infra/server/kibana.index.ts b/x-pack/plugins/infra/server/kibana.index.ts
@@ -37,6 +37,7 @@ export const initServerWithKibana = (kbnServer: KbnServer) => {
     navLinkId: 'infra:home',
     privileges: {
       all: {
+        catalogue: ['infraops'],
         app: ['infra'],
         savedObject: {
           all: [],
@@ -54,6 +55,7 @@ export const initServerWithKibana = (kbnServer: KbnServer) => {
     navLinkId: 'infra:logs',
     privileges: {
       all: {
+        catalogue: ['infralogging'],
         app: ['infra'],
         savedObject: {
           all: [],

diff --git a/x-pack/plugins/ml/index.js b/x-pack/plugins/ml/index.js
@@ -78,6 +78,7 @@ export const ml = (kibana) => {
                 defaultMessage: 'The machine_learning_user or machine_learning_admin role should be assigned to grant access'
               })
             },
+            catalogue: ['ml'],
             app: ['ml'],
             savedObject: {
               all: [],

diff --git a/x-pack/plugins/monitoring/init.js b/x-pack/plugins/monitoring/init.js
@@ -67,6 +67,7 @@ export const init = (monitoringPlugin, server) => {
             defaultMessage: 'The monitoring_user role should be assigned to grant access'
           })
         },
+        catalogue: ['monitoring'],
         app: ['monitoring'],
         savedObject: {
           all: [],

diff --git a/...ment/edit_role/components/privileges/kibana/__snapshots__/kibana_privileges.test.tsx.snap b/...ment/edit_role/components/privileges/kibana/__snapshots__/kibana_privileges.test.tsx.snap
@@ -44,6 +44,7 @@ exports[`<KibanaPrivileges> renders without crashing 1`] = `
     }
     uiCapabilities={
       Object {
+        "catalogue": Object {},
         "management": Object {},
         "navLinks": Object {},
         "spaces": Object {

diff --git a/...public/views/management/edit_role/components/privileges/kibana/kibana_privileges.test.tsx b/...public/views/management/edit_role/components/privileges/kibana/kibana_privileges.test.tsx
@@ -43,6 +43,7 @@ const buildProps = (customProps = {}) => {
     uiCapabilities: {
       navLinks: {},
       management: {},
+      catalogue: {},
       spaces: {
         manage: true,
       },

diff --git a/x-pack/plugins/security/server/lib/authorization/actions/ui.test.ts b/x-pack/plugins/security/server/lib/authorization/actions/ui.test.ts
@@ -20,6 +20,13 @@ describe('#allNavlinks', () => {
   });
 });
 
+describe('#allCatalogueEntries', () => {
+  test('returns ui:catalogue/*', () => {
+    const uiActions = new UIActions();
+    expect(uiActions.allCatalogueEntries).toBe('ui:catalogue/*');
+  });
+});
+
 describe('#get', () => {
   [null, undefined, '', 1, true, {}].forEach((featureId: any) => {
     test(`featureId of ${JSON.stringify(featureId)} throws error`, () => {

diff --git a/x-pack/plugins/security/server/lib/authorization/actions/ui.ts b/x-pack/plugins/security/server/lib/authorization/actions/ui.ts
@@ -11,6 +11,7 @@ const prefix = 'ui:';
 export class UIActions {
   public all = `${prefix}*`;
   public allNavLinks = `${prefix}navLinks/*`;
+  public allCatalogueEntries = `${prefix}catalogue/*`;
   public allManagementLinks = `${prefix}management/*`;
 
   public get(featureId: keyof UICapabilities, ...uiCapabilityParts: string[]) {

diff --git a/x-pack/plugins/security/server/lib/authorization/disable_ui_capabilities.test.ts b/x-pack/plugins/security/server/lib/authorization/disable_ui_capabilities.test.ts
@@ -88,6 +88,7 @@ describe('usingPrivileges', () => {
               indices: true,
             },
           },
+          catalogue: {},
           fooFeature: {
             foo: true,
             bar: true,
@@ -109,6 +110,7 @@ describe('usingPrivileges', () => {
             indices: false,
           },
         },
+        catalogue: {},
         fooFeature: {
           foo: false,
           bar: false,
@@ -169,6 +171,7 @@ describe('usingPrivileges', () => {
               indices: true,
             },
           },
+          catalogue: {},
           fooFeature: {
             foo: true,
             bar: true,
@@ -190,6 +193,7 @@ describe('usingPrivileges', () => {
             indices: false,
           },
         },
+        catalogue: {},
         fooFeature: {
           foo: false,
           bar: false,
@@ -239,6 +243,7 @@ describe('usingPrivileges', () => {
               indices: true,
             },
           },
+          catalogue: {},
         })
       ).rejects.toThrowErrorMatchingSnapshot();
       expect(mockServer.log).not.toHaveBeenCalled();
@@ -291,6 +296,7 @@ describe('usingPrivileges', () => {
             settings: false,
           },
         },
+        catalogue: {},
         fooFeature: {
           foo: true,
           bar: true,
@@ -314,6 +320,7 @@ describe('usingPrivileges', () => {
           settings: false,
         },
       },
+      catalogue: {},
       fooFeature: {
         foo: true,
         bar: false,
@@ -367,6 +374,7 @@ describe('usingPrivileges', () => {
             indices: false,
           },
         },
+        catalogue: {},
         fooFeature: {
           foo: false,
           bar: false,
@@ -388,6 +396,7 @@ describe('usingPrivileges', () => {
           indices: false,
         },
       },
+      catalogue: {},
       fooFeature: {
         foo: false,
         bar: false,
@@ -427,6 +436,7 @@ describe('all', () => {
             indices: true,
           },
         },
+        catalogue: {},
         fooFeature: {
           foo: true,
           bar: true,
@@ -447,6 +457,7 @@ describe('all', () => {
           indices: false,
         },
       },
+      catalogue: {},
       fooFeature: {
         foo: false,
         bar: false,

diff --git a/x-pack/plugins/security/server/lib/authorization/features_privileges_builder.ts b/x-pack/plugins/security/server/lib/authorization/features_privileges_builder.ts
@@ -53,6 +53,19 @@ export class FeaturesPrivilegesBuilder {
     );
   }
 
+  public getCatalogueReadActions(features: Feature[]): string[] {
+    return flatten(
+      features.map(feature => {
+        const { privileges } = feature;
+        if (!privileges || !privileges.read || !privileges.read.catalogue) {
+          return [];
+        }
+
+        return this.buildCatalogueFeaturePrivileges(privileges.read);
+      })
+    );
+  }
+
   public getManagementReadActions(features: Feature[]): string[] {
     return flatten(
       features.map(feature => {
@@ -86,10 +99,23 @@ export class FeaturesPrivilegesBuilder {
       ),
       ...privilegeDefinition.ui.map(ui => this.actions.ui.get(feature.id, ui)),
       ...(feature.navLinkId ? [this.actions.ui.get('navLinks', feature.navLinkId)] : []),
+      ...this.buildCatalogueFeaturePrivileges(privilegeDefinition),
       ...this.buildManagementFeaturePrivileges(privilegeDefinition),
     ]);
   }
 
+  private buildCatalogueFeaturePrivileges(
+    privilegeDefinition: FeaturePrivilegeDefinition
+  ): string[] {
+    if (!privilegeDefinition.catalogue) {
+      return [];
+    }
+
+    return privilegeDefinition.catalogue.map(catalogueEntryId =>
+      this.actions.ui.get('catalogue', catalogueEntryId)
+    );
+  }
+
   private buildManagementFeaturePrivileges(
     privilegeDefinition: FeaturePrivilegeDefinition
   ): string[] {