Copied cypress.d.ts values from endpoint management cypress suite to …

…serverless
paul-tavares · Jul 26, 2023 · 7e8b435 · 7e8b435
1 parent b7a268f
commit 7e8b435
Showing 1 changed file with 172 additions and 0 deletions.
diff --git a/x-pack/test_serverless/functional/test_suites/security/cypress/cypress.d.ts b/x-pack/test_serverless/functional/test_suites/security/cypress/cypress.d.ts
@@ -7,6 +7,32 @@
 
 // / <reference types="cypress" />
 
+import { SecuritySolutionDescribeBlockFtrConfig } from '@kbn/security-solution-plugin/scripts/run_cypress/utils';
+import {
+  DeleteIndexedFleetEndpointPoliciesResponse,
+  IndexedFleetEndpointPolicyResponse,
+} from '@kbn/security-solution-plugin/common/endpoint/data_loaders/index_fleet_endpoint_policy';
+import { CasePostRequest } from '@kbn/cases-plugin/common/api';
+import {
+  DeletedIndexedCase,
+  IndexedCase,
+} from '@kbn/security-solution-plugin/common/endpoint/data_loaders/index_case';
+import {
+  HostActionResponse,
+  IndexEndpointHostsCyTaskOptions,
+} from '@kbn/security-solution-plugin/public/management/cypress/types';
+import { IndexedHostsAndAlertsResponse } from '@kbn/security-solution-plugin/common/endpoint/index_data';
+import { DeleteIndexedEndpointHostsResponse } from '@kbn/security-solution-plugin/common/endpoint/data_loaders/index_endpoint_hosts';
+import {
+  DeletedIndexedEndpointRuleAlerts,
+  IndexedEndpointRuleAlerts,
+} from '@kbn/security-solution-plugin/common/endpoint/data_loaders/index_endpoint_rule_alerts';
+import {
+  HostPolicyResponse,
+  LogsEndpointActionResponse,
+} from '@kbn/security-solution-plugin/common/endpoint/types';
+import { IndexedEndpointPolicyResponse } from '@kbn/security-solution-plugin/common/endpoint/data_loaders/index_endpoint_policy_response';
+import { DeleteAllEndpointDataResponse } from '@kbn/security-solution-plugin/scripts/endpoint/common/delete_all_endpoint_data';
 import { LoadedRoleAndUser, ServerlessRoleName } from '../../../../shared/lib';
 
 export interface LoadUserAndRoleCyTaskOptions {
@@ -15,12 +41,158 @@ export interface LoadUserAndRoleCyTaskOptions {
 
 declare global {
   namespace Cypress {
+    interface SuiteConfigOverrides {
+      env: {
+        ftrConfig: SecuritySolutionDescribeBlockFtrConfig;
+      };
+    }
+
     interface Chainable<Subject = any> {
+      /**
+       * Get Elements by `data-test-subj`
+       * @param args
+       */
+      getByTestSubj<E extends Node = HTMLElement>(
+        ...args: Parameters<Cypress.Chainable<E>['get']>
+      ): Chainable<JQuery<E>>;
+
+      /**
+       * Finds elements by `data-test-subj` from within another. Can not be used directly from `cy`.
+       *
+       * @example
+       * // Correct:
+       * cy.get('someElement').findByTestSubj('some-subject);
+       *
+       * // Incorrect:
+       * cy.findByTestSubj('some-subject);
+       */
+      findByTestSubj<E extends Node = HTMLElement>(
+        ...args: Parameters<Cypress.Chainable<E>['find']>
+      ): Chainable<JQuery<E>>;
+
+      /**
+       * Continuously call provided callback function until it either return `true`
+       * or fail if `timeout` is reached.
+       * @param fn
+       * @param options
+       */
+      waitUntil(
+        fn: (subject?: any) => boolean | Promise<boolean> | Chainable<boolean>,
+        options?: Partial<{
+          interval: number;
+          timeout: number;
+        }>
+      ): Chainable<Subject>;
+
+      // ----------------------------------------------------
+      //
+      //                       TASKS
+      //
+      // ----------------------------------------------------
       task(
         name: 'loadUserAndRole',
         arg: LoadUserAndRoleCyTaskOptions,
         options?: Partial<Loggable & Timeoutable>
       ): Chainable<LoadedRoleAndUser>;
+
+      task(
+        name: 'indexFleetEndpointPolicy',
+        arg: {
+          policyName: string;
+          endpointPackageVersion: string;
+        },
+        options?: Partial<Loggable & Timeoutable>
+      ): Chainable<IndexedFleetEndpointPolicyResponse>;
+
+      task(
+        name: 'deleteIndexedFleetEndpointPolicies',
+        arg: IndexedFleetEndpointPolicyResponse,
+        options?: Partial<Loggable & Timeoutable>
+      ): Chainable<DeleteIndexedFleetEndpointPoliciesResponse>;
+
+      task(
+        name: 'indexCase',
+        arg?: Partial<CasePostRequest>,
+        options?: Partial<Loggable & Timeoutable>
+      ): Chainable<IndexedCase['data']>;
+
+      task(
+        name: 'deleteIndexedCase',
+        arg: IndexedCase['data'],
+        options?: Partial<Loggable & Timeoutable>
+      ): Chainable<DeletedIndexedCase>;
+
+      task(
+        name: 'indexEndpointHosts',
+        arg?: IndexEndpointHostsCyTaskOptions,
+        options?: Partial<Loggable & Timeoutable>
+      ): Chainable<IndexedHostsAndAlertsResponse>;
+
+      task(
+        name: 'deleteIndexedEndpointHosts',
+        arg: IndexedHostsAndAlertsResponse,
+        options?: Partial<Loggable & Timeoutable>
+      ): Chainable<DeleteIndexedEndpointHostsResponse>;
+
+      task(
+        name: 'indexEndpointRuleAlerts',
+        arg?: { endpointAgentId: string; count?: number },
+        options?: Partial<Loggable & Timeoutable>
+      ): Chainable<IndexedEndpointRuleAlerts['alerts']>;
+
+      task(
+        name: 'deleteIndexedEndpointRuleAlerts',
+        arg: IndexedEndpointRuleAlerts['alerts'],
+        options?: Partial<Loggable & Timeoutable>
+      ): Chainable<DeletedIndexedEndpointRuleAlerts>;
+
+      task(
+        name: 'indexEndpointPolicyResponse',
+        arg: HostPolicyResponse,
+        options?: Partial<Loggable & Timeoutable>
+      ): Chainable<IndexedEndpointPolicyResponse>;
+
+      task(
+        name: 'deleteIndexedEndpointPolicyResponse',
+        arg: IndexedEndpointPolicyResponse,
+        options?: Partial<Loggable & Timeoutable>
+      ): Chainable<null>;
+
+      task(
+        name: 'sendHostActionResponse',
+        arg: HostActionResponse,
+        options?: Partial<Loggable & Timeoutable>
+      ): Chainable<LogsEndpointActionResponse>;
+
+      task(
+        name: 'deleteAllEndpointData',
+        arg: { endpointAgentIds: string[] },
+        options?: Partial<Loggable & Timeoutable>
+      ): Chainable<DeleteAllEndpointDataResponse>;
+
+      task(
+        name: 'createFileOnEndpoint',
+        arg: { hostname: string; path: string; content: string },
+        options?: Partial<Loggable & Timeoutable>
+      ): Chainable<null>;
+
+      task(
+        name: 'uploadFileToEndpoint',
+        arg: { hostname: string; srcPath: string; destPath: string },
+        options?: Partial<Loggable & Timeoutable>
+      ): Chainable<null>;
+
+      task(
+        name: 'installPackagesOnEndpoint',
+        arg: { hostname: string; packages: string[] },
+        options?: Partial<Loggable & Timeoutable>
+      ): Chainable<null>;
+
+      task(
+        name: 'readZippedFileContentOnEndpoint',
+        arg: { hostname: string; path: string; password?: string },
+        options?: Partial<Loggable & Timeoutable>
+      ): Chainable<string>;
     }
   }
 }