Update / Add tests for exclude event data

Author: lucabelluccini

x-pack/plugins/fleet/public/applications/fleet/sections/agents/components/agent_request_diagnostics_modal/index.test.tsx

@@ -58,6 +58,7 @@ describe('AgentRequestDiagnosticsModal', () => {
 
     expect(mockSendPostRequestDiagnostics).toHaveBeenCalledWith('agent1', {
       additional_metrics: ['CPU'],
+      exclude_events_log: true,
     });
   });
 
@@ -70,6 +71,23 @@ describe('AgentRequestDiagnosticsModal', () => {
 
     expect(mockSendPostRequestDiagnostics).toHaveBeenCalledWith('agent1', {
       additional_metrics: [],
+      exclude_events_log: true,
+    });
+  });
+
+  it('should have Exclude Events Log set to false when checkbox is checked', async () => {
+    const { utils } = render();
+
+    act(() => {
+      fireEvent.click(utils.getByTestId('includeEventsLogCheckbox'));
+    });
+    act(() => {
+      fireEvent.click(utils.getByTestId('confirmModalConfirmButton'));
+    });
+
+    expect(mockSendPostRequestDiagnostics).toHaveBeenCalledWith('agent1', {
+      additional_metrics: [],
+      exclude_events_log: false,
     });
   });
 
@@ -86,6 +104,7 @@ describe('AgentRequestDiagnosticsModal', () => {
     expect(mockSendPostBulkRequestDiagnostics).toHaveBeenCalledWith({
       additional_metrics: ['CPU'],
       agents: ['agent1', 'agent2'],
+      exclude_events_log: true,
     });
   });
 
@@ -98,9 +117,25 @@ describe('AgentRequestDiagnosticsModal', () => {
 
     expect(mockSendPostBulkRequestDiagnostics).toHaveBeenCalledWith({
       additional_metrics: [],
+      exclude_events_log: true,
       agents: ['agent1', 'agent2'],
     });
   });
 
-  // TODO Create test
+  it('should have Exclude Events Log set to false when checkbox is checked within bulk action', async () => {
+    const { utils } = render({ agents: [{ id: 'agent1' }, { id: 'agent2' }], agentCount: 2 });
+
+    act(() => {
+      fireEvent.click(utils.getByTestId('includeEventsLogCheckbox'));
+    });
+    act(() => {
+      fireEvent.click(utils.getByTestId('confirmModalConfirmButton'));
+    });
+
+    expect(mockSendPostBulkRequestDiagnostics).toHaveBeenCalledWith({
+      additional_metrics: [],
+      exclude_events_log: false,
+      agents: ['agent1', 'agent2'],
+    });
+  });
 });

x-pack/plugins/fleet/public/applications/fleet/sections/agents/components/agent_request_diagnostics_modal/index.tsx

@@ -133,24 +133,20 @@ export const AgentRequestDiagnosticsModal: React.FunctionComponent<Props> = ({
           defaultMessage="Diagnostics files are stored in Elasticsearch, and as such can incur storage costs. By default, files are periodically deleted via an ILM policy."
         />
       </p>
-      <p>
-        <EuiCheckbox
-          id="cpuMetricsCheckbox"
-          data-test-subj="cpuMetricsCheckbox"
-          label="Collect additional CPU metrics"
-          checked={cpuMetricsEnabled}
-          onChange={() => setCPUMetricsEnabled(!cpuMetricsEnabled)}
-        />
-      </p>
-      <p>
-        <EuiCheckbox
-          id="includeEventsLogCheckbox"
-          data-test-subj="includeEventsLogCheckbox"
-          label="Include Events Logs (might contain sensible information)"
-          checked={includeEventsLogEnabled}
-          onChange={() => setIncludeEventsLog(!includeEventsLogEnabled)}
-        />
-      </p>
+      <EuiCheckbox
+        id="cpuMetricsCheckbox"
+        data-test-subj="cpuMetricsCheckbox"
+        label="Collect additional CPU metrics"
+        checked={cpuMetricsEnabled}
+        onChange={() => setCPUMetricsEnabled(!cpuMetricsEnabled)}
+      />
+      <EuiCheckbox
+        id="includeEventsLogCheckbox"
+        data-test-subj="includeEventsLogCheckbox"
+        label="Include Events Logs (might contain sensible information)"
+        checked={includeEventsLogEnabled}
+        onChange={() => setIncludeEventsLog(!includeEventsLogEnabled)}
+      />
     </EuiConfirmModal>
   );
 };

x-pack/plugins/fleet/server/routes/agent/request_diagnostics_handler.test.ts

@@ -36,7 +36,7 @@ describe('request diagnostics handler', () => {
   let mockRequest: KibanaRequest<
     { agentId: string },
     undefined,
-    { additional_metrics: RequestDiagnosticsAdditionalMetrics[] },
+    { additional_metrics: RequestDiagnosticsAdditionalMetrics[]; exclude_events_log?: boolean },
     any
   >;
 
@@ -59,7 +59,7 @@ describe('request diagnostics handler', () => {
     } as unknown as RequestHandlerContext;
     mockRequest = httpServerMock.createKibanaRequest({
       params: { agentId: 'agent1' },
-      body: { additional_metrics: ['CPU'] },
+      body: { additional_metrics: ['CPU'], exclude_events_log: false },
     });
   });
 

x-pack/test/fleet_api_integration/apis/agents/request_diagnostics.ts

@@ -162,7 +162,85 @@ export default function (providerContext: FtrProviderContext) {
       const action: any = actionsRes.hits.hits[0]._source;
       expect(action.data.additional_metrics).contain('CPU');
     });
+
+    it('should create action with exclude_events_log when api contains exclude_events_log option', async () => {
+      await supertest
+        .post(`/api/fleet/agents/agent1/request_diagnostics`)
+        .set('kbn-xsrf', 'xxx')
+        .send({
+          exclude_events_log: false,
+        })
+        .expect(200);
+      const actionsRes = await es.search({
+        index: '.fleet-actions',
+        body: {
+          sort: [{ '@timestamp': { order: 'desc' } }],
+        },
+      });
+      const action: any = actionsRes.hits.hits[0]._source;
+      expect(action.data.exclude_events_log).equal(false);
+    });
+
+    it('/agents/bulk_request_diagnostics should add exclude_events_log option to action doc', async () => {
+      await supertestWithoutAuth
+        .post(`/api/fleet/agents/bulk_request_diagnostics`)
+        .set('kbn-xsrf', 'xxx')
+        .auth(testUsers.fleet_agents_read_only.username, testUsers.fleet_agents_read_only.password)
+        .send({
+          agents: ['agent2', 'agent3'],
+          exclude_events_log: true,
+        });
+
+      const actionsRes = await es.search({
+        index: '.fleet-actions',
+        body: {
+          sort: [{ '@timestamp': { order: 'desc' } }],
+        },
+      });
+      const action: any = actionsRes.hits.hits[0]._source;
+      expect(action.data.exclude_events_log).equal(true);
+    });
+
+    it('should create action with exclude_events_log when api contains exclude_events_log and collect CPU option', async () => {
+      await supertest
+        .post(`/api/fleet/agents/agent1/request_diagnostics`)
+        .set('kbn-xsrf', 'xxx')
+        .send({
+          additional_metrics: ['CPU'],
+          exclude_events_log: false,
+        })
+        .expect(200);
+      const actionsRes = await es.search({
+        index: '.fleet-actions',
+        body: {
+          sort: [{ '@timestamp': { order: 'desc' } }],
+        },
+      });
+      const action: any = actionsRes.hits.hits[0]._source;
+      expect(action.data.exclude_events_log).equal(false);
+      expect(action.data.additional_metrics).contain('CPU');
+    });
+
+    it('/agents/bulk_request_diagnostics should add exclude_events_log and collect CPU option to action doc', async () => {
+      await supertestWithoutAuth
+        .post(`/api/fleet/agents/bulk_request_diagnostics`)
+        .set('kbn-xsrf', 'xxx')
+        .auth(testUsers.fleet_agents_read_only.username, testUsers.fleet_agents_read_only.password)
+        .send({
+          agents: ['agent2', 'agent3'],
+          additional_metrics: ['CPU'],
+          exclude_events_log: true,
+        });
+
+      const actionsRes = await es.search({
+        index: '.fleet-actions',
+        body: {
+          sort: [{ '@timestamp': { order: 'desc' } }],
+        },
+      });
+      const action: any = actionsRes.hits.hits[0]._source;
+      expect(action.data.exclude_events_log).equal(true);
+      expect(action.data.additional_metrics).contain('CPU');
+    });
   });
 }
-
-// TODO Add test