Rebranding I

This change welcomes Community, Pro, Ultimate, Ultimate with
multi-tenancy and Cloud edition descriptors.

The restrictions over the editions are preserved.
Internally, still working with RAW and CEE types.
Cloud (former SaaS) not supported.

Author: lpetrora

src/DataSource.ts

@@ -7,6 +7,7 @@ import {
   TestDataSourceResponse,
 } from '@grafana/data';
 import { FetchResponse } from '@grafana/runtime';
+import { EditionFamily, getEditionFamily } from 'edition';
 import { replaceVariables } from 'utils';
 
 import { MetricFindQuery, RequestSpec } from './RequestSpec';
@@ -82,4 +83,8 @@ export class DataSource extends DataSourceApi<CmkQuery> {
   getUsername(): string {
     return this.settings.username;
   }
+
+  getEditionFamily(): EditionFamily {
+    return getEditionFamily(this.settings.edition);
+  }
 }

src/backend/rest.ts

@@ -13,6 +13,7 @@ import {
   toDataFrame,
 } from '@grafana/data';
 import { BackendSrvRequest, FetchError, FetchResponse, getBackendSrv } from '@grafana/runtime';
+import { EditionFamily, getEditionFamily, isCloudEdition } from 'edition';
 import { lastValueFrom } from 'rxjs';
 
 import { Aggregation, GraphType, MetricFindQuery } from '../RequestSpec';
@@ -181,17 +182,23 @@ export default class RestApiBackend implements Backend {
     if (checkMkVersion.startsWith('2.0') || checkMkVersion.startsWith('2.1') || checkMkVersion.startsWith('1.')) {
       throw new Error(`A Checkmk version below 2.2.0 is not supported for this plugin.`);
     }
-    if (this.datasource.getEdition() !== 'RAW' && result.data.edition === 'cre') {
+    if (
+      this.datasource.getEditionFamily() !== EditionFamily.COMMUNITY &&
+      getEditionFamily(result.data.edition) === EditionFamily.COMMUNITY
+    ) {
       throw new Error(
-        'The data source specified the Checkmk commercial editions, but Checkmk Raw Edition was detected. Choose the raw edition in the data source settings.'
+        'The data source specified the Checkmk commercial editions, but Checkmk Community Edition was detected. Choose the Community Edition in the data source settings.'
       );
     }
-    if (this.datasource.getEdition() === 'RAW' && result.data.edition !== 'cre') {
+    if (
+      this.datasource.getEditionFamily() === EditionFamily.COMMUNITY &&
+      getEditionFamily(result.data.edition) !== EditionFamily.COMMUNITY
+    ) {
       throw new Error(
-        'The data source specified the Checkmk Raw Edition, but a Checkmk commercial edition was detected. Some functionality may not be available. Choose commercial editions in the data source settings to enable all features.'
+        'The data source specified the Checkmk Community Edition, but a Checkmk commercial edition was detected. Some functionality may not be available. Choose commercial editions in the data source settings to enable all features.'
       );
     }
-    if (result.data.edition === 'cse') {
+    if (isCloudEdition(result.data.edition)) {
       throw new Error('Detected Checkmk Cloud (SaaS). Can not query data from Checkmk Cloud (SaaS).');
     }
     // The REST API would be ok with other users, but the autocompleter are not
@@ -251,7 +258,7 @@ export default class RestApiBackend implements Backend {
     // check for cloud edition header
     const checkmkEdition = result.headers.get('X-Checkmk-Edition');
     // CSE is never supported
-    if (checkmkEdition === 'cse') {
+    if (checkmkEdition && isCloudEdition(checkmkEdition)) {
       throw new Error('Cannot query data from Checkmk Cloud (SaaS).');
     }
 
@@ -264,7 +271,6 @@ export default class RestApiBackend implements Backend {
     // our api only supports a single chart/query per api call.
     updateQuery(query);
 
-    // prepare data required by cre and cee
     if (
       query.requestSpec === undefined ||
       (query.requestSpec.graph_type !== 'single_metric' && query.requestSpec.graph_type !== 'predefined_graph') ||
@@ -290,8 +296,8 @@ export default class RestApiBackend implements Backend {
     }
 
     let response: FetchResponse<RestApiGraphResponse>;
-    if (this.datasource.getEdition() === 'RAW') {
-      // send request for cre
+    if (this.datasource.getEditionFamily() === EditionFamily.COMMUNITY) {
+      // send request for community edition
       if (
         query.requestSpec.site === undefined ||
         query.requestSpec.host_name === undefined ||
@@ -315,7 +321,7 @@ export default class RestApiBackend implements Backend {
         data: request,
       });
     } else {
-      // send request for cee
+      // send request for commercial editions
       const request: RestApiFilterRequest = {
         filter: createCmkContext(query.requestSpec),
         aggregation: query.requestSpec.aggregation,

src/backend/types.ts

@@ -1,4 +1,5 @@
 import { DataQueryRequest, DataQueryResponse, MetricFindValue, TestDataSourceResponse } from '@grafana/data';
+import { EditionFamily } from 'edition';
 
 import { MetricFindQuery } from '../RequestSpec';
 import { CmkQuery, Edition } from '../types';
@@ -14,4 +15,5 @@ export interface DatasourceOptions {
   getEdition: () => Edition;
   getUrl: () => string | undefined;
   getUsername(): string;
+  getEditionFamily: () => EditionFamily;
 }

src/backend/validate.ts

@@ -1,3 +1,5 @@
+import { EditionFamily, getEditionFamily } from 'edition';
+
 import { RequestSpec } from '../RequestSpec';
 import { Edition } from '../types';
 import { labelForRequestSpecKey } from '../ui/utils';
@@ -11,7 +13,7 @@ const missingRequiredFields = (rq: Partial<RequestSpec>, edition: Edition): stri
     result.push('graph');
   }
 
-  if (edition === 'RAW') {
+  if (getEditionFamily(edition) === EditionFamily.COMMUNITY) {
     if (rq.site === undefined) {
       result.push('site');
     }

src/edition.ts

@@ -0,0 +1,52 @@
+export enum EditionFamily {
+  COMMUNITY = 'COMMUNITY',
+  COMMERCIAL = 'COMMERCIAL',
+}
+
+export enum EditionFamilyLabel {
+  COMMUNITY = 'Community Edition',
+  COMMERCIAL = 'Commercial editions',
+}
+
+export enum Edition {
+  // Pre 2.5.0
+  CRE = 'raw',
+  CEE = 'cee',
+  CCE = 'cce',
+  CME = 'cme',
+  CSE = 'cse',
+
+  //2.5.0
+  COMMUNITY = 'community',
+  PRO = 'pro',
+  ULTIMATE = 'ultimate',
+  ULTIMATE_MULTI_TENANCY = 'ultimatemt',
+  CLOUD = 'cloud',
+}
+
+export const getEditionFamily = (editionString: string | Edition): EditionFamily => {
+  const commercialEditions: Array<string | Edition> = [
+    'CEE',
+    'cee',
+    'cce',
+    'cme',
+    'cse',
+    'pro',
+    'ultimate',
+    'ultimatemt',
+    'cloud',
+    Edition.CEE,
+    Edition.CCE,
+    Edition.CME,
+    Edition.CSE,
+    Edition.PRO,
+    Edition.ULTIMATE,
+    Edition.ULTIMATE_MULTI_TENANCY,
+    Edition.CLOUD,
+  ];
+  return commercialEditions.includes(editionString) ? EditionFamily.COMMERCIAL : EditionFamily.COMMUNITY;
+};
+
+export const isCloudEdition = (editionString: string): boolean => {
+  return ['cse', 'cloud'].includes(editionString);
+};

src/ui/ConfigEditor.tsx

@@ -1,5 +1,6 @@
 import { DataSourcePluginOptionsEditorProps, SelectableValue } from '@grafana/data';
 import { FieldSet, InlineField, LegacyForms, Select } from '@grafana/ui';
+import { EditionFamilyLabel } from 'edition';
 import React, { ChangeEvent, useCallback } from 'react';
 
 import { Settings } from '../settings';
@@ -16,8 +17,8 @@ interface EditionOption {
 }
 
 const cmkEditions: EditionOption[] = [
-  { value: 'CEE', label: 'Commercial editions' },
-  { value: 'RAW', label: 'Raw Edition' },
+  { value: 'CEE', label: EditionFamilyLabel.COMMERCIAL },
+  { value: 'RAW', label: EditionFamilyLabel.COMMUNITY },
 ];
 
 export const ConfigEditor = (props: Props) => {

tests/e2e/constants.ts

@@ -4,8 +4,9 @@ export const HOSTNAME1 = 'localhost_grafana1';
 export const TESTDATASOURCENAME0 = 'cmk_test_datasource_0';
 export const TESTDATASOURCENAME1 = 'cmk_test_datasource_1';
 
+// Must match EditionFamilyLabel elements
 export enum CmkEdition {
-  CRE = 'Raw Edition',
+  CRE = 'Community Edition',
   CEE = 'Commercial editions',
 }
 

tests/e2e/tests/autocompleters.test.ts

@@ -63,7 +63,7 @@ test.describe('Comercial editions tests', () => {
   });
 });
 
-test.describe('Raw edition tests', () => {
+test.describe('Community edition tests', () => {
   test.slow();
   test('Filtering autocompleters', async ({ panelEditPage, page, selectors }) => {
     const panelPage = new CmkRawQueryEditorPage(page, selectors, panelEditPage);

tests/e2e/tests/e2e.test.ts

@@ -154,7 +154,7 @@ test.describe('Comercial editions tests', () => {
   });
 });
 
-test.describe('RAW edition tests', () => {
+test.describe('Community edition tests', () => {
   test.slow();
 
   test('time-usage panel by service (Single host)', async ({ page, selectors, panelEditPage }, testInfo) => {