changes based on review

elastic · Apr 29, 2020 · a9f0df1 · a9f0df1
1 parent d70f40d
commit a9f0df1
Show file tree

Hide file tree

Showing 6 changed files with 131 additions and 44 deletions.
diff --git a/x-pack/plugins/ml/common/types/capabilities.ts b/x-pack/plugins/ml/common/types/capabilities.ts
@@ -19,6 +19,10 @@ export const userMlCapabilities = {
   canGetFilters: false,
   // Data Frame Analytics
   canGetDataFrameAnalytics: false,
+  // Annotations
+  canGetAnnotations: false,
+  canCreateAnnotation: false,
+  canDeleteAnnotation: false,
 };
 
 export const adminMlCapabilities = {
@@ -27,9 +31,11 @@ export const adminMlCapabilities = {
   canDeleteJob: false,
   canOpenJob: false,
   canCloseJob: false,
+  canUpdateJob: false,
   canForecastJob: false,
+  canCreateDatafeed: false,
+  canDeleteDatafeed: false,
   canStartStopDatafeed: false,
-  canUpdateJob: false,
   canUpdateDatafeed: false,
   canPreviewDatafeed: false,
   // Calendars

diff --git a/x-pack/plugins/ml/server/lib/capabilities/check_capabilities.test.ts b/x-pack/plugins/ml/server/lib/capabilities/check_capabilities.test.ts
@@ -36,7 +36,7 @@ describe('check_capabilities', () => {
       );
       const { capabilities } = await getCapabilities();
       const count = Object.keys(capabilities).length;
-      expect(count).toBe(23);
+      expect(count).toBe(28);
       done();
     });
   });
@@ -49,29 +49,42 @@ describe('check_capabilities', () => {
         mlLicense,
         mlIsEnabled
       );
-      const { capabilities, upgradeInProgress, mlFeatureEnabledInSpace } = await getCapabilities();
+      const {
+        capabilities,
+        upgradeInProgress,
+        mlFeatureEnabledInSpace,
+        isPlatinumOrTrialLicense,
+      } = await getCapabilities();
       expect(upgradeInProgress).toBe(false);
       expect(mlFeatureEnabledInSpace).toBe(true);
+      expect(isPlatinumOrTrialLicense).toBe(true);
+
       expect(capabilities.canAccessML).toBe(true);
       expect(capabilities.canGetJobs).toBe(true);
+      expect(capabilities.canGetDatafeeds).toBe(true);
+      expect(capabilities.canGetCalendars).toBe(true);
+      expect(capabilities.canFindFileStructure).toBe(true);
+      expect(capabilities.canGetFilters).toBe(true);
+      expect(capabilities.canGetDataFrameAnalytics).toBe(true);
+      expect(capabilities.canGetAnnotations).toBe(true);
+      expect(capabilities.canCreateAnnotation).toBe(true);
+      expect(capabilities.canDeleteAnnotation).toBe(true);
+
       expect(capabilities.canCreateJob).toBe(false);
       expect(capabilities.canDeleteJob).toBe(false);
       expect(capabilities.canOpenJob).toBe(false);
       expect(capabilities.canCloseJob).toBe(false);
       expect(capabilities.canForecastJob).toBe(false);
-      expect(capabilities.canGetDatafeeds).toBe(true);
       expect(capabilities.canStartStopDatafeed).toBe(false);
       expect(capabilities.canUpdateJob).toBe(false);
+      expect(capabilities.canCreateDatafeed).toBe(false);
+      expect(capabilities.canDeleteDatafeed).toBe(false);
       expect(capabilities.canUpdateDatafeed).toBe(false);
       expect(capabilities.canPreviewDatafeed).toBe(false);
-      expect(capabilities.canGetCalendars).toBe(true);
       expect(capabilities.canCreateCalendar).toBe(false);
       expect(capabilities.canDeleteCalendar).toBe(false);
-      expect(capabilities.canGetFilters).toBe(true);
       expect(capabilities.canCreateFilter).toBe(false);
       expect(capabilities.canDeleteFilter).toBe(false);
-      expect(capabilities.canFindFileStructure).toBe(true);
-      expect(capabilities.canGetDataFrameAnalytics).toBe(true);
       expect(capabilities.canDeleteDataFrameAnalytics).toBe(false);
       expect(capabilities.canCreateDataFrameAnalytics).toBe(false);
       expect(capabilities.canStartStopDataFrameAnalytics).toBe(false);
@@ -85,29 +98,42 @@ describe('check_capabilities', () => {
         mlLicense,
         mlIsEnabled
       );
-      const { capabilities, upgradeInProgress, mlFeatureEnabledInSpace } = await getCapabilities();
+      const {
+        capabilities,
+        upgradeInProgress,
+        mlFeatureEnabledInSpace,
+        isPlatinumOrTrialLicense,
+      } = await getCapabilities();
       expect(upgradeInProgress).toBe(false);
       expect(mlFeatureEnabledInSpace).toBe(true);
+      expect(isPlatinumOrTrialLicense).toBe(true);
+
       expect(capabilities.canAccessML).toBe(true);
       expect(capabilities.canGetJobs).toBe(true);
+      expect(capabilities.canGetDatafeeds).toBe(true);
+      expect(capabilities.canGetCalendars).toBe(true);
+      expect(capabilities.canFindFileStructure).toBe(true);
+      expect(capabilities.canGetFilters).toBe(true);
+      expect(capabilities.canGetDataFrameAnalytics).toBe(true);
+      expect(capabilities.canGetAnnotations).toBe(true);
+      expect(capabilities.canCreateAnnotation).toBe(true);
+      expect(capabilities.canDeleteAnnotation).toBe(true);
+
       expect(capabilities.canCreateJob).toBe(true);
       expect(capabilities.canDeleteJob).toBe(true);
       expect(capabilities.canOpenJob).toBe(true);
       expect(capabilities.canCloseJob).toBe(true);
       expect(capabilities.canForecastJob).toBe(true);
-      expect(capabilities.canGetDatafeeds).toBe(true);
       expect(capabilities.canStartStopDatafeed).toBe(true);
       expect(capabilities.canUpdateJob).toBe(true);
+      expect(capabilities.canCreateDatafeed).toBe(true);
+      expect(capabilities.canDeleteDatafeed).toBe(true);
       expect(capabilities.canUpdateDatafeed).toBe(true);
       expect(capabilities.canPreviewDatafeed).toBe(true);
-      expect(capabilities.canGetCalendars).toBe(true);
       expect(capabilities.canCreateCalendar).toBe(true);
       expect(capabilities.canDeleteCalendar).toBe(true);
-      expect(capabilities.canGetFilters).toBe(true);
       expect(capabilities.canCreateFilter).toBe(true);
       expect(capabilities.canDeleteFilter).toBe(true);
-      expect(capabilities.canFindFileStructure).toBe(true);
-      expect(capabilities.canGetDataFrameAnalytics).toBe(true);
       expect(capabilities.canDeleteDataFrameAnalytics).toBe(true);
       expect(capabilities.canCreateDataFrameAnalytics).toBe(true);
       expect(capabilities.canStartStopDataFrameAnalytics).toBe(true);
@@ -121,29 +147,42 @@ describe('check_capabilities', () => {
         mlLicense,
         mlIsEnabled
       );
-      const { capabilities, upgradeInProgress, mlFeatureEnabledInSpace } = await getCapabilities();
+      const {
+        capabilities,
+        upgradeInProgress,
+        mlFeatureEnabledInSpace,
+        isPlatinumOrTrialLicense,
+      } = await getCapabilities();
       expect(upgradeInProgress).toBe(true);
       expect(mlFeatureEnabledInSpace).toBe(true);
+      expect(isPlatinumOrTrialLicense).toBe(true);
+
       expect(capabilities.canAccessML).toBe(true);
       expect(capabilities.canGetJobs).toBe(true);
+      expect(capabilities.canGetDatafeeds).toBe(true);
+      expect(capabilities.canGetCalendars).toBe(true);
+      expect(capabilities.canFindFileStructure).toBe(true);
+      expect(capabilities.canGetFilters).toBe(true);
+      expect(capabilities.canGetDataFrameAnalytics).toBe(true);
+      expect(capabilities.canGetAnnotations).toBe(true);
+      expect(capabilities.canCreateAnnotation).toBe(false);
+      expect(capabilities.canDeleteAnnotation).toBe(false);
+
       expect(capabilities.canCreateJob).toBe(false);
       expect(capabilities.canDeleteJob).toBe(false);
       expect(capabilities.canOpenJob).toBe(false);
       expect(capabilities.canCloseJob).toBe(false);
       expect(capabilities.canForecastJob).toBe(false);
-      expect(capabilities.canGetDatafeeds).toBe(true);
       expect(capabilities.canStartStopDatafeed).toBe(false);
       expect(capabilities.canUpdateJob).toBe(false);
+      expect(capabilities.canCreateDatafeed).toBe(false);
+      expect(capabilities.canDeleteDatafeed).toBe(false);
       expect(capabilities.canUpdateDatafeed).toBe(false);
       expect(capabilities.canPreviewDatafeed).toBe(false);
-      expect(capabilities.canGetCalendars).toBe(true);
       expect(capabilities.canCreateCalendar).toBe(false);
       expect(capabilities.canDeleteCalendar).toBe(false);
-      expect(capabilities.canGetFilters).toBe(true);
       expect(capabilities.canCreateFilter).toBe(false);
       expect(capabilities.canDeleteFilter).toBe(false);
-      expect(capabilities.canFindFileStructure).toBe(true);
-      expect(capabilities.canGetDataFrameAnalytics).toBe(true);
       expect(capabilities.canDeleteDataFrameAnalytics).toBe(false);
       expect(capabilities.canCreateDataFrameAnalytics).toBe(false);
       expect(capabilities.canStartStopDataFrameAnalytics).toBe(false);
@@ -157,29 +196,42 @@ describe('check_capabilities', () => {
         mlLicense,
         mlIsEnabled
       );
-      const { capabilities, upgradeInProgress, mlFeatureEnabledInSpace } = await getCapabilities();
+      const {
+        capabilities,
+        upgradeInProgress,
+        mlFeatureEnabledInSpace,
+        isPlatinumOrTrialLicense,
+      } = await getCapabilities();
       expect(upgradeInProgress).toBe(true);
       expect(mlFeatureEnabledInSpace).toBe(true);
+      expect(isPlatinumOrTrialLicense).toBe(true);
+
       expect(capabilities.canAccessML).toBe(true);
       expect(capabilities.canGetJobs).toBe(true);
+      expect(capabilities.canGetDatafeeds).toBe(true);
+      expect(capabilities.canGetCalendars).toBe(true);
+      expect(capabilities.canFindFileStructure).toBe(true);
+      expect(capabilities.canGetFilters).toBe(true);
+      expect(capabilities.canGetDataFrameAnalytics).toBe(true);
+      expect(capabilities.canGetAnnotations).toBe(true);
+      expect(capabilities.canCreateAnnotation).toBe(false);
+      expect(capabilities.canDeleteAnnotation).toBe(false);
+
       expect(capabilities.canCreateJob).toBe(false);
       expect(capabilities.canDeleteJob).toBe(false);
       expect(capabilities.canOpenJob).toBe(false);
       expect(capabilities.canCloseJob).toBe(false);
       expect(capabilities.canForecastJob).toBe(false);
-      expect(capabilities.canGetDatafeeds).toBe(true);
       expect(capabilities.canStartStopDatafeed).toBe(false);
       expect(capabilities.canUpdateJob).toBe(false);
+      expect(capabilities.canCreateDatafeed).toBe(false);
+      expect(capabilities.canDeleteDatafeed).toBe(false);
       expect(capabilities.canUpdateDatafeed).toBe(false);
       expect(capabilities.canPreviewDatafeed).toBe(false);
-      expect(capabilities.canGetCalendars).toBe(true);
       expect(capabilities.canCreateCalendar).toBe(false);
       expect(capabilities.canDeleteCalendar).toBe(false);
-      expect(capabilities.canGetFilters).toBe(true);
       expect(capabilities.canCreateFilter).toBe(false);
       expect(capabilities.canDeleteFilter).toBe(false);
-      expect(capabilities.canFindFileStructure).toBe(true);
-      expect(capabilities.canGetDataFrameAnalytics).toBe(true);
       expect(capabilities.canDeleteDataFrameAnalytics).toBe(false);
       expect(capabilities.canCreateDataFrameAnalytics).toBe(false);
       expect(capabilities.canStartStopDataFrameAnalytics).toBe(false);
@@ -193,29 +245,42 @@ describe('check_capabilities', () => {
         mlLicense,
         mlIsNotEnabled
       );
-      const { capabilities, upgradeInProgress, mlFeatureEnabledInSpace } = await getCapabilities();
+      const {
+        capabilities,
+        upgradeInProgress,
+        mlFeatureEnabledInSpace,
+        isPlatinumOrTrialLicense,
+      } = await getCapabilities();
       expect(upgradeInProgress).toBe(false);
       expect(mlFeatureEnabledInSpace).toBe(false);
+      expect(isPlatinumOrTrialLicense).toBe(true);
+
       expect(capabilities.canAccessML).toBe(false);
       expect(capabilities.canGetJobs).toBe(false);
+      expect(capabilities.canGetDatafeeds).toBe(false);
+      expect(capabilities.canGetCalendars).toBe(false);
+      expect(capabilities.canFindFileStructure).toBe(false);
+      expect(capabilities.canGetFilters).toBe(false);
+      expect(capabilities.canGetDataFrameAnalytics).toBe(false);
+      expect(capabilities.canGetAnnotations).toBe(false);
+      expect(capabilities.canCreateAnnotation).toBe(false);
+      expect(capabilities.canDeleteAnnotation).toBe(false);
+
       expect(capabilities.canCreateJob).toBe(false);
       expect(capabilities.canDeleteJob).toBe(false);
       expect(capabilities.canOpenJob).toBe(false);
       expect(capabilities.canCloseJob).toBe(false);
       expect(capabilities.canForecastJob).toBe(false);
-      expect(capabilities.canGetDatafeeds).toBe(false);
       expect(capabilities.canStartStopDatafeed).toBe(false);
       expect(capabilities.canUpdateJob).toBe(false);
+      expect(capabilities.canCreateDatafeed).toBe(false);
+      expect(capabilities.canDeleteDatafeed).toBe(false);
       expect(capabilities.canUpdateDatafeed).toBe(false);
       expect(capabilities.canPreviewDatafeed).toBe(false);
-      expect(capabilities.canGetCalendars).toBe(false);
       expect(capabilities.canCreateCalendar).toBe(false);
       expect(capabilities.canDeleteCalendar).toBe(false);
-      expect(capabilities.canGetFilters).toBe(false);
       expect(capabilities.canCreateFilter).toBe(false);
       expect(capabilities.canDeleteFilter).toBe(false);
-      expect(capabilities.canFindFileStructure).toBe(false);
-      expect(capabilities.canGetDataFrameAnalytics).toBe(false);
       expect(capabilities.canDeleteDataFrameAnalytics).toBe(false);
       expect(capabilities.canCreateDataFrameAnalytics).toBe(false);
       expect(capabilities.canStartStopDataFrameAnalytics).toBe(false);
@@ -230,29 +295,43 @@ describe('check_capabilities', () => {
       mlLicenseBasic,
       mlIsNotEnabled
     );
-    const { capabilities, upgradeInProgress, mlFeatureEnabledInSpace } = await getCapabilities();
+    const {
+      capabilities,
+      upgradeInProgress,
+      mlFeatureEnabledInSpace,
+      isPlatinumOrTrialLicense,
+    } = await getCapabilities();
+
     expect(upgradeInProgress).toBe(false);
     expect(mlFeatureEnabledInSpace).toBe(false);
+    expect(isPlatinumOrTrialLicense).toBe(false);
+
     expect(capabilities.canAccessML).toBe(false);
     expect(capabilities.canGetJobs).toBe(false);
+    expect(capabilities.canGetDatafeeds).toBe(false);
+    expect(capabilities.canGetCalendars).toBe(false);
+    expect(capabilities.canFindFileStructure).toBe(false);
+    expect(capabilities.canGetFilters).toBe(false);
+    expect(capabilities.canGetDataFrameAnalytics).toBe(false);
+    expect(capabilities.canGetAnnotations).toBe(false);
+    expect(capabilities.canCreateAnnotation).toBe(false);
+    expect(capabilities.canDeleteAnnotation).toBe(false);
+
     expect(capabilities.canCreateJob).toBe(false);
     expect(capabilities.canDeleteJob).toBe(false);
     expect(capabilities.canOpenJob).toBe(false);
     expect(capabilities.canCloseJob).toBe(false);
     expect(capabilities.canForecastJob).toBe(false);
-    expect(capabilities.canGetDatafeeds).toBe(false);
     expect(capabilities.canStartStopDatafeed).toBe(false);
     expect(capabilities.canUpdateJob).toBe(false);
+    expect(capabilities.canCreateDatafeed).toBe(false);
+    expect(capabilities.canDeleteDatafeed).toBe(false);
     expect(capabilities.canUpdateDatafeed).toBe(false);
     expect(capabilities.canPreviewDatafeed).toBe(false);
-    expect(capabilities.canGetCalendars).toBe(false);
     expect(capabilities.canCreateCalendar).toBe(false);
     expect(capabilities.canDeleteCalendar).toBe(false);
-    expect(capabilities.canGetFilters).toBe(false);
     expect(capabilities.canCreateFilter).toBe(false);
     expect(capabilities.canDeleteFilter).toBe(false);
-    expect(capabilities.canFindFileStructure).toBe(false);
-    expect(capabilities.canGetDataFrameAnalytics).toBe(false);
     expect(capabilities.canDeleteDataFrameAnalytics).toBe(false);
     expect(capabilities.canCreateDataFrameAnalytics).toBe(false);
     expect(capabilities.canStartStopDataFrameAnalytics).toBe(false);

diff --git a/x-pack/plugins/ml/server/lib/capabilities/check_capabilities.ts b/x-pack/plugins/ml/server/lib/capabilities/check_capabilities.ts
@@ -44,4 +44,6 @@ function disableAdminPrivileges(capabilities: MlCapabilities) {
   Object.keys(adminMlCapabilities).forEach(k => {
     capabilities[k as keyof MlCapabilities] = false;
   });
+  capabilities.canCreateAnnotation = false;
+  capabilities.canDeleteAnnotation = false;
 }
diff --git a/x-pack/plugins/ml/server/routes/annotations.ts b/x-pack/plugins/ml/server/routes/annotations.ts
@@ -55,7 +55,7 @@ export function annotationRoutes(
         body: getAnnotationsSchema,
       },
       options: {
-        tags: ['access:ml:canGetJobs'],
+        tags: ['access:ml:canGetAnnotations'],
       },
     },
     mlLicense.fullLicenseAPIGuard(async (context, request, response) => {
@@ -90,7 +90,7 @@ export function annotationRoutes(
         body: indexAnnotationSchema,
       },
       options: {
-        tags: ['access:ml:canCreateJob'],
+        tags: ['access:ml:canCreateAnnotation'],
       },
     },
     mlLicense.fullLicenseAPIGuard(async (context, request, response) => {
@@ -137,7 +137,7 @@ export function annotationRoutes(
         params: deleteAnnotationSchema,
       },
       options: {
-        tags: ['access:ml:canCreateJob'],
+        tags: ['access:ml:canDeleteAnnotation'],
       },
     },
     mlLicense.fullLicenseAPIGuard(async (context, request, response) => {

diff --git a/x-pack/plugins/ml/server/routes/datafeeds.ts b/x-pack/plugins/ml/server/routes/datafeeds.ts
@@ -159,7 +159,7 @@ export function dataFeedRoutes({ router, mlLicense }: RouteInitialization) {
         body: datafeedConfigSchema,
       },
       options: {
-        tags: ['access:ml:canGetJobs'],
+        tags: ['access:ml:canCreateDatafeed'],
       },
     },
     mlLicense.fullLicenseAPIGuard(async (context, request, response) => {
@@ -235,7 +235,7 @@ export function dataFeedRoutes({ router, mlLicense }: RouteInitialization) {
         query: deleteDatafeedQuerySchema,
       },
       options: {
-        tags: ['access:ml:canDeleteJob'],
+        tags: ['access:ml:canDeleteDatafeed'],
       },
     },
     mlLicense.fullLicenseAPIGuard(async (context, request, response) => {

diff --git a/x-pack/plugins/ml/server/routes/job_service.ts b/x-pack/plugins/ml/server/routes/job_service.ts
@@ -674,7 +674,7 @@ export function jobServiceRoutes({ router, mlLicense }: RouteInitialization) {
         body: schema.object(topCategoriesSchema),
       },
       options: {
-        tags: ['access:ml:canCreateJob'],
+        tags: ['access:ml:canGetJobs'],
       },
     },
     mlLicense.fullLicenseAPIGuard(async (context, request, response) => {