Remove signed plugin restrictions

lpetrora · lpetrora · commit f92b7e0fdc83 · 2025-04-23T12:35:54.000+02:00
Allow signed plugin to work in every environment.

Remove unsigned plugin build actions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -9,30 +9,11 @@ on:
     - cron: '38 0 * * *' # every day at randint(0, 60) minutes after midnight
 
 jobs:
-  test-plugin-json:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Install dependencies
-        run: |
-          sudo apt-get install jq
-
-      - name: plugin_json_to_cloud.sh should not change src.plugin.json
-        run: |
-          # src/plugin.json and plugin_json_to_cloud.sh
-          # should contain the same ids and strings
-          # this test makes sure they stay in sync
-          jq --sort-keys . src/plugin.json > /tmp/before.json
-          bash utils/plugin_json_to_cloud.sh
-          jq --sort-keys . src/plugin.json > /tmp/after.json
-          diff /tmp/before.json /tmp/after.json
-
   build:
     runs-on: ubuntu-latest
     outputs:
       signed-plugin-name: '${{ steps.build-signed.outputs.plugin_path }}'
-      unsigned-plugin-name: '${{ steps.build-unsigned.outputs.plugin_path }}'
+
     steps:
       - uses: actions/checkout@v4
 
@@ -63,16 +44,6 @@ jobs:
       - name: clean up repo
         uses: actions/checkout@v4
 
-      - name: Build frontend unsigned
-        id: build-unsigned
-        uses: ./.github/build/
-        with:
-          release: false
-          signed: false
-
-      - name: clean up repo
-        uses: actions/checkout@v4
-
       - name: Build frontend signed
         if: (github.event_name != 'pull_request') || (github.event.pull_request.head.repo.full_name == github.repository)
         id: build-signed
@@ -118,12 +89,12 @@ jobs:
       - name: Download package from build job
         uses: actions/download-artifact@v4
         with:
-          name: '${{ needs.build.outputs.unsigned-plugin-name }}'
+          name: '${{ needs.build.outputs.signed-plugin-name }}'
 
       - name: unpack and move plugin
         run: |
-          unzip tribe-29-checkmk-datasource*.zip
-          mv tribe-29-checkmk-datasource dist
+          unzip checkmk-cloud-datasource*.zip
+          mv checkmk-cloud-datasource dist
 
       - name: run the e2e tests
         run: |
@@ -140,3 +111,4 @@ jobs:
           name: playwright
           retention-days: 1
           path: tests/results
+          if-no-files-found: ignore
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -27,15 +27,6 @@ jobs:
 
       - uses: actions/checkout@v4
 
-      - name: build unsigned
-        id: build-unsigned
-        uses: ./.github/build/
-        with:
-          release: true
-          signed: false
-
-      - uses: actions/checkout@v4
-
       - name: download all action artifacs
         uses: actions/download-artifact@v4
         with:
@@ -54,8 +45,6 @@ jobs:
           files: |
             ${{ steps.build-signed.outputs.plugin_path }}
             ${{ steps.build-signed.outputs.plugin_checksum_path }}
-            ${{ steps.build-unsigned.outputs.plugin_path }}
-            ${{ steps.build-unsigned.outputs.plugin_checksum_path }}
 
       - uses: adelynx/github-actions-nodemailer@v1.0.3
         with:
diff --git a/.prettierignore b/.prettierignore
@@ -1,2 +1 @@
-dist/
-src/plugin.json
+dist/
diff --git a/README.md b/README.md
@@ -1,9 +1,8 @@
 # Checkmk data source
 
-[![Grafana 9.5](https://img.shields.io/badge/Grafana-9.5-orange)](https://www.grafana.com)
-[![Grafana 10.2](https://img.shields.io/badge/Grafana-10.2-orange)](https://www.grafana.com)
+[![Grafana 10.4](https://img.shields.io/badge/Grafana-10.4-orange)](https://www.grafana.com)
+[![Grafana 11.6](https://img.shields.io/badge/Grafana-11.6-orange)](https://www.grafana.com)
 [![Checkmk data source for Checkmk Cloud & MSP](https://img.shields.io/badge/dynamic/json?color=blue&label=Checkmk%20for%20Cloud%20Edition&query=%24.version&url=https%3A%2F%2Fgrafana.com%2Fapi%2Fplugins%2Fcheckmk-cloud-datasource)](https://grafana.com/grafana/plugins/checkmk-cloud-datasource)
-[![Checkmk unsigned data source](https://img.shields.io/badge/dynamic/json?color=blue&label=Checkmk&query=tag_name&url=https%3A%2F%2Fapi.github.com%2Frepos%2Ftribe29%2Fgrafana-checkmk-datasource%2Freleases%2Flatest)](https://github.com/Checkmk/grafana-checkmk-datasource)
 [![CI](https://github.com/Checkmk/grafana-checkmk-datasource/actions/workflows/ci.yml/badge.svg?branch=main&event=schedule)](https://github.com/Checkmk/grafana-checkmk-datasource/actions/workflows/ci.yml?query=event%3Aschedule)
 
 
@@ -16,19 +15,17 @@ This [data source][2] plugin for [Grafana][1] allows to address Checkmk as sourc
 
 To make use of the plugin, you need to take care the correct versions are installed. You need to match both, the Grafana and the Checkmk version:
 
-- **Grafana 9.5.15 or higher** Current and previous major version of Grafana
-- **Checkmk Cloud or Checkmk MSP 2.2.0 or higher** for the signed plugin available from [Grafana][6]
-- **Checkmk 2.2.0 or higher** for the unsigned plugin available from [Github][8]
+- **Grafana 10.4.18 or higher** Current and previous major version of Grafana
+- **Checkmk 2.2.0 or higher** for the plugin available from [Github][8] or from [Grafana marketplace][6]
 
 ## Installing the plug-in
 
-The signed plug-in can be installed from the [Grafana marketplace][6] or by using the `grafana-cli`:
+The plug-in can be installed from the [Grafana marketplace][6] or by using the `grafana-cli`:
 
 ```bash
 grafana-cli plugins install checkmk-cloud-datasource
 ```
 
-For the installation of the unsigned plugin, please take a look at the official [Checkmk User Guide][3].
 
 ## Official documentation
 
diff --git a/docker-compose.yaml b/docker-compose.yaml
@@ -2,7 +2,7 @@ version: '3.0'
 
 services:
   grafana:
-    container_name: 'tribe-29-checkmk-datasource'
+    container_name: 'checkmk-cloud-datasource'
     build:
       context: ./.config
       args:
@@ -14,14 +14,14 @@ services:
     extra_hosts:
       - checkmk.local:host-gateway
     volumes:
-      - ./dist:/var/lib/grafana/plugins/tribe-29-checkmk-datasource
+      - ./dist:/var/lib/grafana/plugins/checkmk-cloud-datasource
       - ./provisioning:/etc/grafana/provisioning
       - .:/root/checkmk-cmkgrafanadatasource2-datasource
 
     environment:
       NODE_ENV: development
-      GF_LOG_FILTERS: plugin.tribe-29-checkmk-datasource:debug
+      GF_LOG_FILTERS: plugin.checkmk-cloud-datasource:debug
       GF_LOG_LEVEL: debug
       GF_DATAPROXY_LOGGING: 1
-      GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS: tribe-29-checkmk-datasource
+      GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS: checkmk-cloud-datasource
 
diff --git a/package.json b/package.json
@@ -3,8 +3,8 @@
   "version": "3.4.1",
   "description": "Datasource for checkmk",
   "scripts": {
-    "build": "bash utils/plugin_json_to_unsigned.sh && webpack -c ./webpack.config.ts --env production",
-    "build:cloud": "bash utils/plugin_json_to_cloud.sh && BUILD_EDITION=CLOUD webpack -c ./webpack.config.ts --env production",
+    "build": "webpack -c ./webpack.config.ts --env production",
+    "build:cloud": "webpack -c ./webpack.config.ts --env production",
     "dev": "webpack -w -c ./webpack.config.ts --env development",
     "test": "jest --watch --onlyChanged",
     "test:ci": "jest --passWithNoTests --maxWorkers 4",
@@ -19,7 +19,8 @@
     "e2e": "playwright test",
     "e2e:ci": "playwright test",
     "e2e:debug": "playwright test --debug",
-    "e2e:gui": "playwright test --ui"
+    "e2e:gui": "playwright test --ui",
+    "e2e:show-trace": "playwright show-trace"
   },
   "author": "Checkmk",
   "license": "Apache-2.0",
diff --git a/src/backend/rest.ts b/src/backend/rest.ts
@@ -13,7 +13,6 @@ import {
   toDataFrame,
 } from '@grafana/data';
 import { BackendSrvRequest, FetchError, FetchResponse, getBackendSrv } from '@grafana/runtime';
-import * as process from 'process';
 import { lastValueFrom } from 'rxjs';
 
 import { Aggregation, GraphType, MetricFindQuery } from '../RequestSpec';
@@ -255,12 +254,6 @@ export default class RestApiBackend implements Backend {
     if (checkmkEdition === 'cse') {
       throw new Error('Cannot query data from Checkmk Cloud (SaaS).');
     }
-    const allowedEditions = new Set(['cce', 'cme']);
-    if (process.env.BUILD_EDITION === 'CLOUD' && !allowedEditions.has(checkmkEdition || '')) {
-      throw new Error(
-        'This Checkmk data source is only compatible with Checkmk Cloud and Checkmk MSP, but you are trying to connect to another edition.'
-      );
-    }
 
     return result;
   }
diff --git a/src/plugin.json b/src/plugin.json
@@ -1,18 +1,16 @@
 {
   "$schema": "https://raw.githubusercontent.com/grafana/grafana/master/docs/sources/developers/plugins/plugin.schema.json",
   "type": "datasource",
-  "name": "Checkmk data source for Checkmk Cloud & MSP",
+  "name": "Checkmk data source",
   "id": "checkmk-cloud-datasource",
   "metrics": true,
   "info": {
-    "description": "Checkmk data source for Checkmk Cloud or Checkmk MSP 2.2.0 or higher",
+    "description": "Checkmk data source for Checkmk 2.2.0 or higher",
     "author": {
       "name": "Checkmk GmbH",
       "url": "https://github.com/Checkmk/"
     },
-    "keywords": [
-      "checkmk"
-    ],
+    "keywords": ["checkmk"],
     "logos": {
       "small": "img/checkmk_logo.svg",
       "large": "img/checkmk_logo.svg"
diff --git a/src/ui/ConfigEditor.tsx b/src/ui/ConfigEditor.tsx
@@ -1,6 +1,5 @@
 import { DataSourcePluginOptionsEditorProps, SelectableValue } from '@grafana/data';
 import { FieldSet, InlineField, LegacyForms, Select } from '@grafana/ui';
-import * as process from 'process';
 import React, { ChangeEvent, useCallback } from 'react';
 
 import { Settings } from '../settings';
@@ -103,25 +102,20 @@ export const ConfigEditor = (props: Props) => {
             onChange={onUrlChange}
             value={settings.url || ''}
             tooltip="Which Checkmk Server to connect to. (Example: https://checkmk.server/site)"
-            data-test-id="checkmk-url"
+            data-testid="checkmk-url"
           />
         </div>
-        {process.env.BUILD_EDITION !== 'CLOUD' ? (
-          <>
-            <InlineField label="Edition" labelWidth={12}>
-              <Select
-                width={32}
-                options={cmkEditions}
-                onChange={onEditionChange}
-                value={settings.edition}
-                placeholder="Select your checkmk edition"
-                inputId="checkmk-edition"
-              />
-            </InlineField>
-          </>
-        ) : (
-          <></>
-        )}
+        <InlineField label="Edition" labelWidth={12}>
+          <Select
+            width={32}
+            options={cmkEditions}
+            onChange={onEditionChange}
+            value={settings.edition}
+            placeholder="Select your checkmk edition"
+            inputId="checkmk-edition"
+            data-testid="checkmk-edition"
+          />
+        </InlineField>
       </FieldSet>
       <FieldSet label="Authentication">
         <div className="gf-form">
@@ -132,7 +126,7 @@ export const ConfigEditor = (props: Props) => {
             onChange={onUsernameChange}
             value={settings.username}
             tooltip="A checkmk monitoring user. Don't use 'automation' user, because it has admin rights."
-            data-test-id="checkmk-username"
+            data-testid="checkmk-username"
           />
         </div>
         <div className="gf-form">
@@ -146,7 +140,7 @@ export const ConfigEditor = (props: Props) => {
             onReset={onResetSecret}
             onChange={onSecretChange}
             tooltip="You can find the secret for your user in your checkmk server under Users."
-            data-test-id="checkmk-password"
+            data-testid="checkmk-password"
           />
         </div>
       </FieldSet>
diff --git a/tests/docker-compose.yml b/tests/docker-compose.yml
@@ -18,7 +18,7 @@ services:
       GF_ANALYTICS_CHECK_FOR_PLUGIN_UPDATES: 'false'
       GF_SECURITY_ADMIN_USER: admin
       GF_SECURITY_ADMIN_PASSWORD: password
-      GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS: tribe-29-checkmk-datasource
+      GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS: checkmk-cloud-datasource
       GF_AUTH_ANONYMOUS_ORG_ROLE: Admin
       GF_AUTH_ANONYMOUS_ENABLED: 'true'
     extra_hosts:
diff --git a/tests/e2e/lib/grafana_rest_api.ts b/tests/e2e/lib/grafana_rest_api.ts
@@ -26,7 +26,7 @@ const createDatasource = async (edition: CmkEdition, url: string, username: stri
 
   const response = await requestContext.post(apiUrl, {
     data: {
-      type: 'tribe-29-checkmk-datasource',
+      type: 'checkmk-cloud-datasource',
       access: 'proxy',
       basicAuth: false,
 
diff --git a/tests/unit/CloudEdition.test.tsx b/tests/unit/CloudEdition.test.tsx
@@ -1,6 +1,6 @@
 import { DataSourceSettings } from '@grafana/data';
 import { expect, jest } from '@jest/globals';
-import { render } from '@testing-library/react';
+import { RenderResult, render } from '@testing-library/react';
 import * as process from 'process';
 import * as React from 'react';
 
@@ -31,22 +31,19 @@ describe('Cloud Edition Restrictions', () => {
   const onOptionsChange = jest.fn();
 
   afterAll(() => {
-    delete process.env.BUILD_EDITION;
     jest.resetModules();
     jest.restoreAllMocks();
   });
 
   describe('ConfigEditor', () => {
-    let screen;
+    let screen: RenderResult;
 
     beforeAll(() => {
-      process.env.BUILD_EDITION = 'CLOUD';
       screen = render(<ConfigEditor options={options} onOptionsChange={onOptionsChange} />);
     });
 
-    it("doesn't render the version and edition dropdowns", () => {
-      expect(screen.queryByLabelText('Edition')).toBeNull();
-      expect(screen.queryByLabelText('Version')).toBeNull();
+    it('always render the edition dropdown', () => {
+      expect(screen.queryByLabelText('Edition')).not.toBeNull();
     });
   });
 
@@ -60,7 +57,6 @@ describe('Cloud Edition Restrictions', () => {
     let subject: RestApiBackend;
 
     beforeAll(() => {
-      process.env.BUILD_EDITION = 'CLOUD';
       subject = new RestApiBackend(mockDatasource);
     });
 
diff --git a/utils/plugin_json_to_cloud.sh b/utils/plugin_json_to_cloud.sh
diff --git a/utils/plugin_json_to_unsigned.sh b/utils/plugin_json_to_unsigned.sh
diff --git a/webpack.config.ts b/webpack.config.ts
@@ -4,7 +4,6 @@ import defaultConfig from './.config/webpack/webpack.config';
 
 const config = async (env: Record<string, string>) => {
   const appliedConfig = await defaultConfig(env);
-  appliedConfig.plugins.push(new EnvironmentPlugin({ BUILD_EDITION: process.env.EDITION ?? 'NON_CLOUD' }));
   appliedConfig.plugins.push(new ProvidePlugin({ process: 'process/browser' }));
   return appliedConfig;
 };
