Move 'api_helpers' functions to Cypress 'api_commands'

In this way we make all API-related functions new Cypress custom
commands.
Moreover, redundant input parameters are removed where possible.

Author: MatteoStifano

tests/cypress/e2e/spec.cy.ts

@@ -1,12 +1,5 @@
+import '../support/api_commands';
 import '../support/commands';
-import {
-  activateCmkChanges,
-  createCmkAutomationUser,
-  createCmkHost,
-  deleteCmkAutomationUser,
-  deleteCmkHost,
-  executeServiceDiscovery,
-} from './api_helpers';
 import {
   inputFilterSelector,
   inputGraphTypeSelector,
@@ -28,15 +21,15 @@ describe('e2e tests', () => {
   const hostName1 = 'localhost_grafana1';
 
   before(function () {
-    deleteCmkAutomationUser(cmkUser, cmkPassword, false); // clean-up possible existing user
-    createCmkAutomationUser(cmkUser, cmkPassword);
+    cy.deleteCmkAutomationUser(false); // clean-up possible existing user
+    cy.createCmkAutomationUser();
 
-    createCmkHost(hostName0);
-    createCmkHost(hostName1);
+    cy.createCmkHost(hostName0);
+    cy.createCmkHost(hostName1);
 
-    executeServiceDiscovery(hostName0, 'new');
-    executeServiceDiscovery(hostName1, 'new');
-    activateCmkChanges('cmk');
+    cy.executeServiceDiscovery(hostName0, 'new');
+    cy.executeServiceDiscovery(hostName1, 'new');
+    cy.activateCmkChanges('cmk');
 
     cy.loginGrafana();
     cy.addCmkDatasource(cmkUser, cmkPassword);
@@ -170,10 +163,10 @@ describe('e2e tests', () => {
   after(function () {
     cy.rmCmkDatasource();
 
-    deleteCmkHost(hostName0);
-    deleteCmkHost(hostName1);
+    cy.deleteCmkHost(hostName0);
+    cy.deleteCmkHost(hostName1);
 
-    deleteCmkAutomationUser(cmkUser, cmkPassword);
-    activateCmkChanges('cmk');
+    cy.deleteCmkAutomationUser(true);
+    cy.activateCmkChanges('cmk');
   });
 });

tests/cypress/e2e/api_helpers.ts tests/cypress/support/api_commands.tstests/cypress/e2e/api_helpers.ts renamed to tests/cypress/support/api_commands.ts

@@ -1,44 +1,39 @@
-/* TODO:
- * - Inline arguments as much as possible.
- *   e.g. `cmkUsername` as param -> Cypress.env('cmkUsername') in function body.
- *   (we can't call it with anything else, so I don't see the point in having to
- *   specify them at each call site.)
- * - Move these helpers to custom Cypress commands.
- *   See https://docs.cypress.io/api/cypress-api/custom-commands
- *   This way, they integrate better into the framework.
- */
+export {};
 
-export function createCmkAutomationUser(cmkUser: string, cmkPassword: string) {
+const cmkAutomationUser = 'cmkuser';
+const cmkAutomationPassword = 'somepassword123457';
+
+Cypress.Commands.add('createCmkAutomationUser', () => {
   cy.request({
     method: 'POST',
     url: Cypress.env('cypressToCheckmkUrl') + '/check_mk/api/1.0/domain-types/user_config/collections/all',
     auth: {
       bearer: `${Cypress.env('cmkUsername')} ${Cypress.env('cmkPassword')}`,
     },
     body: {
-      username: cmkUser,
-      fullname: cmkUser,
+      username: cmkAutomationUser,
+      fullname: cmkAutomationUser,
       roles: ['admin'],
       auth_option: {
         auth_type: 'automation',
-        secret: cmkPassword,
+        secret: cmkAutomationPassword,
       },
     },
   });
-}
+});
 
-export function deleteCmkAutomationUser(cmkUser: string, cmkPassowrd: string, failOnStatusCode: boolean = true) {
+Cypress.Commands.add('deleteCmkAutomationUser', (failOnStatusCode: boolean) => {
   cy.request({
     method: 'DELETE',
-    url: Cypress.env('cypressToCheckmkUrl') + '/check_mk/api/1.0/objects/user_config/' + cmkUser,
+    url: Cypress.env('cypressToCheckmkUrl') + '/check_mk/api/1.0/objects/user_config/' + cmkAutomationUser,
     auth: {
       bearer: `${Cypress.env('cmkUsername')} ${Cypress.env('cmkPassword')}`,
     },
     failOnStatusCode: failOnStatusCode,
   });
-}
+});
 
-export function createCmkHost(hostName: string) {
+Cypress.Commands.add('createCmkHost', (hostName: string) => {
   cy.request({
     method: 'POST',
     url: Cypress.env('cypressToCheckmkUrl') + '/check_mk/api/1.0/domain-types/host_config/collections/all',
@@ -55,9 +50,9 @@ export function createCmkHost(hostName: string) {
       },
     },
   });
-}
+});
 
-export function deleteCmkHost(hostName: string) {
+Cypress.Commands.add('deleteCmkHost', (hostName: string) => {
   cy.request({
     method: 'DELETE',
     url: Cypress.env('cypressToCheckmkUrl') + '/check_mk/api/1.0/objects/host_config/' + hostName,
@@ -66,16 +61,16 @@ export function deleteCmkHost(hostName: string) {
       bearer: `${Cypress.env('cmkUsername')} ${Cypress.env('cmkPassword')}`,
     },
   });
-}
+});
 
-function waitForActivation(activation_id: string, waitingTime: number = 1000) {
+Cypress.Commands.add('waitForActivation', (activationID: string, waitingTime: number) => {
   cy.wait(waitingTime);
   cy.request({
     method: 'GET',
     url:
       Cypress.env('cypressToCheckmkUrl') +
       '/check_mk/api/1.0/objects/activation_run/' +
-      activation_id +
+      activationID +
       '/actions/wait-for-completion/invoke',
     followRedirect: false,
     headers: { accept: 'application/json' },
@@ -85,11 +80,11 @@ function waitForActivation(activation_id: string, waitingTime: number = 1000) {
   }).then((response) => {
     if (response.status === 204) return;
 
-    waitForActivation(activation_id);
+    cy.waitForActivation(activationID, 1000);
   });
-}
+});
 
-export function activateCmkChanges(siteName: string) {
+Cypress.Commands.add('activateCmkChanges', (siteName: string) => {
   cy.on('uncaught:exception', (err, runnable) => {
     // activating changes is raising an uncaught exception
     // with no error message.
@@ -124,11 +119,11 @@ export function activateCmkChanges(siteName: string) {
     const activation_id = response.body.id;
     cy.log('Activation ID: ' + activation_id);
 
-    waitForActivation(activation_id);
+    cy.waitForActivation(activation_id, 1000);
   });
-}
+});
 
-export function executeServiceDiscovery(hostName: string, mode: string) {
+Cypress.Commands.add('executeServiceDiscovery', (hostName: string, mode: string) => {
   cy.request({
     method: 'POST',
     url:
@@ -145,4 +140,18 @@ export function executeServiceDiscovery(hostName: string, mode: string) {
   }).then((response) => {
     expect(response.status).is.equal(200);
   });
+});
+
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      createCmkAutomationUser(): Chainable<void>;
+      deleteCmkAutomationUser(failOnStatusCode: boolean): Chainable<void>;
+      createCmkHost(hostName: string): Chainable<void>;
+      deleteCmkHost(hostName: string): Chainable<void>;
+      waitForActivation(activationID: string, waitingTime: number): Chainable<void>;
+      activateCmkChanges(siteName: string): Chainable<void>;
+      executeServiceDiscovery(hotname: string, mode: string): Chainable<void>;
+    }
+  }
 }