NAS-125772: Add tests for audit component (#9341)

src/app/core/testing/classes/mock-websocket.service.ts

@@ -10,7 +10,7 @@ import {
 } from 'app/core/testing/interfaces/mock-websocket-responses.interface';
 import { ApiCallDirectory, ApiCallMethod, ApiCallParams } from 'app/interfaces/api/api-call-directory.interface';
 import { ApiEventDirectory } from 'app/interfaces/api/api-event-directory.interface';
-import { ApiJobDirectory, ApiJobMethod } from 'app/interfaces/api/api-job-directory.interface';
+import { ApiJobDirectory, ApiJobMethod, ApiJobParams } from 'app/interfaces/api/api-job-directory.interface';
 import { ApiEvent } from 'app/interfaces/api-message.interface';
 import { Job } from 'app/interfaces/job.interface';
 import { WebsocketConnectionService } from 'app/services/websocket-connection.service';
@@ -59,9 +59,9 @@ export class MockWebsocketService extends WebSocketService {
   }
 
   mockCall<K extends ApiCallMethod>(method: K, response: CallResponseOrFactory<K>): void {
-    const mockedImplementation = (): Observable<unknown> => {
+    const mockedImplementation = (_: K, params: ApiCallParams<K>): Observable<unknown> => {
       if (response instanceof Function) {
-        return of(response());
+        return of(response(params));
       }
 
       return of(response);
@@ -79,10 +79,10 @@ export class MockWebsocketService extends WebSocketService {
       .mockReturnValueOnce(of(response));
   }
   mockJob<K extends ApiJobMethod>(method: K, response: JobResponseOrFactory<K>): void {
-    const getJobResponse = (): Job<ApiJobDirectory[K]['response']> => {
+    const getJobResponse = (params: ApiJobParams<K> = undefined): Job<ApiJobDirectory[K]['response']> => {
       let job: Job;
       if (response instanceof Function) {
-        job = response();
+        job = response(params);
       } else {
         job = response;
       }
@@ -95,7 +95,8 @@ export class MockWebsocketService extends WebSocketService {
     when(this.startJob).calledWith(method).mockReturnValue(of(this.jobIdCounter));
     when(this.startJob).calledWith(method, anyArgument).mockReturnValue(of(this.jobIdCounter));
     when(this.job).calledWith(method).mockImplementation(() => of(getJobResponse()));
-    when(this.job).calledWith(method, anyArgument).mockImplementation(() => of(getJobResponse()));
+    when(this.job).calledWith(method, anyArgument)
+      .mockImplementation((_, params) => of(getJobResponse(params)));
     when(this.call)
       .calledWith('core.get_jobs', [[['id', '=', this.jobIdCounter]]])
       .mockImplementation(() => of([getJobResponse()]));

src/app/core/testing/interfaces/mock-websocket-responses.interface.ts

@@ -1,5 +1,5 @@
-import { ApiCallDirectory, ApiCallMethod } from 'app/interfaces/api/api-call-directory.interface';
-import { ApiJobDirectory, ApiJobMethod } from 'app/interfaces/api/api-job-directory.interface';
+import { ApiCallDirectory, ApiCallMethod, ApiCallParams } from 'app/interfaces/api/api-call-directory.interface';
+import { ApiJobDirectory, ApiJobMethod, ApiJobParams } from 'app/interfaces/api/api-job-directory.interface';
 import { Job } from 'app/interfaces/job.interface';
 
 export enum MockWebsocketResponseType {
@@ -18,8 +18,13 @@ export interface MockWebsocketCallResponse {
 export interface MockWebsocketJobResponse {
   type: MockWebsocketResponseType.Job;
   method: ApiJobMethod;
-  response: Job | (() => Job);
+  response: Job | ((params: unknown) => Job);
   id?: number;
 }
-export type CallResponseOrFactory<M extends ApiCallMethod> = ApiCallDirectory[M]['response'] | (() => ApiCallDirectory[M]['response']);
-export type JobResponseOrFactory<M extends ApiJobMethod> = Job<ApiJobDirectory[M]['response']> | (() => Job<ApiJobDirectory[M]['response']>);
+export type CallResponseOrFactory<M extends ApiCallMethod> =
+  | ApiCallDirectory[M]['response']
+  | ((params: ApiCallParams<M>) => ApiCallDirectory[M]['response']);
+
+export type JobResponseOrFactory<M extends ApiJobMethod> =
+  | Job<ApiJobDirectory[M]['response']>
+  | ((params: ApiJobParams<M>) => Job<ApiJobDirectory[M]['response']>);

src/app/enums/audit.enum.ts

@@ -1,4 +1,47 @@
+import { marker as T } from '@biesbjerg/ngx-translate-extract-marker';
+
 export enum AuditService {
   Smb = 'SMB',
   Middleware = 'MIDDLEWARE',
 }
+
+export enum AuditEvent {
+  Connect = 'CONNECT',
+  Disconnect = 'DISCONNECT',
+  Create = 'CREATE',
+  Close = 'CLOSE',
+  Read = 'READ',
+  Write = 'WRITE',
+  OffloadRead = 'OFFLOAD_READ',
+  OffloadWrite = 'OFFLOAD_WRITE',
+  SetAcl = 'SET_ACL',
+  Rename = 'RENAME',
+  Unlink = 'UNLINK',
+  SetAttr = 'SET_ATTR',
+  SetQuota = 'SET_QUOTA',
+  Authentication = 'AUTHENTICATION',
+  MethodCall = 'METHOD_CALL',
+}
+
+export const auditServiceLabels = new Map<AuditService, string>([
+  [AuditService.Smb, T('SMB')],
+  [AuditService.Middleware, T('Middleware')],
+]);
+
+export const auditEventLabels = new Map<AuditEvent, string>([
+  [AuditEvent.Connect, T('Connect')],
+  [AuditEvent.Disconnect, T('Disconnect')],
+  [AuditEvent.Create, T('Create')],
+  [AuditEvent.Close, T('Close')],
+  [AuditEvent.Read, T('Read')],
+  [AuditEvent.Write, T('Write')],
+  [AuditEvent.OffloadRead, T('Offload Read')],
+  [AuditEvent.OffloadWrite, T('Offload Write')],
+  [AuditEvent.SetAcl, T('Set ACL')],
+  [AuditEvent.Rename, T('Rename')],
+  [AuditEvent.Unlink, T('Unlink')],
+  [AuditEvent.SetAttr, T('Set Attribute')],
+  [AuditEvent.SetQuota, T('Set Quota')],
+  [AuditEvent.Authentication, T('Authentication')],
+  [AuditEvent.MethodCall, T('Method Call')],
+]);

src/app/interfaces/api/api-call-directory.interface.ts

@@ -28,7 +28,7 @@ import {
 import { ApiTimestamp } from 'app/interfaces/api-date.interface';
 import { ApiKey, CreateApiKeyRequest, UpdateApiKeyRequest } from 'app/interfaces/api-key.interface';
 import { UpgradeSummary } from 'app/interfaces/application.interface';
-import { AuditConfig, AuditEntry } from 'app/interfaces/audit/audit.interface';
+import { AuditConfig, AuditEntry, AuditQueryParams } from 'app/interfaces/audit/audit.interface';
 import { AuthSession } from 'app/interfaces/auth-session.interface';
 import { LoginQuery } from 'app/interfaces/auth.interface';
 import { AvailableApp } from 'app/interfaces/available-app.interface';
@@ -314,7 +314,7 @@ export interface ApiCallDirectory {
   'app.latest': { params: QueryParams<AvailableApp>; response: AvailableApp[] };
 
   // Audit
-  'audit.query': { params: QueryParams<AuditEntry>; response: AuditEntry[] };
+  'audit.query': { params: [AuditQueryParams]; response: AuditEntry[] };
   'audit.update': { params: [AuditConfig]; response: AuditEntry[] };
   'audit.config': { params: void; response: AuditConfig };
 

src/app/interfaces/audit/audit.interface.ts

@@ -1,7 +1,14 @@
-import { AuditEvent } from 'app/enums/audit-event.enum';
+import { AuditEvent, AuditService } from 'app/enums/audit.enum';
 import { ApiTimestamp } from 'app/interfaces/api-date.interface';
 import { MiddlewareAuditEntry } from 'app/interfaces/audit/middleware-audit-entry.interface';
 import { SmbAuditEntry } from 'app/interfaces/audit/smb-audit-entry.interface';
+import { QueryFilters, QueryOptions } from 'app/interfaces/query-api.interface';
+
+export interface AuditQueryParams {
+  services?: AuditService[];
+  'query-filters'?: QueryFilters<AuditEntry>;
+  'query-options'?: QueryOptions<AuditEntry>;
+}
 
 export interface BaseAuditEntry {
   audit_id: string;

src/app/interfaces/audit/middleware-audit-entry.interface.ts

@@ -1,5 +1,4 @@
-import { AuditEvent } from 'app/enums/audit-event.enum';
-import { AuditService } from 'app/enums/audit.enum';
+import { AuditEvent, AuditService } from 'app/enums/audit.enum';
 import { AuditVersions, BaseAuditEntry } from 'app/interfaces/audit/audit.interface';
 import { CredentialType } from 'app/interfaces/credential-type.interface';
 

src/app/interfaces/audit/smb-audit-entry.interface.ts

@@ -1,5 +1,4 @@
-import { AuditEvent } from 'app/enums/audit-event.enum';
-import { AuditService } from 'app/enums/audit.enum';
+import { AuditEvent, AuditService } from 'app/enums/audit.enum';
 import { AuditVersions, BaseAuditEntry } from 'app/interfaces/audit/audit.interface';
 
 export interface BaseSmbAuditEntry extends BaseAuditEntry {

src/app/modules/ix-table2/components/ix-table2/ix-table2.harness.ts

@@ -116,6 +116,10 @@ export class IxTable2Harness extends ContentContainerComponentHarness {
     const texts = await parallel(() => cells.map((cell) => cell.getText()));
     const columnCount = await this.getColumnCount();
 
+    if (!columnCount) {
+      throw new Error('Could not determine column count');
+    }
+
     const result: string[][] = [];
     for (let i = 0; i < texts.length; i += columnCount) {
       result.push(texts.slice(i, i + columnCount));

src/app/modules/search-input/components/advanced-search/advanced-search.component.spec.ts

@@ -1,6 +1,6 @@
 import { TestbedHarnessEnvironment } from '@angular/cdk/testing/testbed';
 import { createComponentFactory, Spectator } from '@ngneat/spectator/jest';
-import { auditEventLabels, AuditService } from 'app/enums/audit-event.enum';
+import { auditEventLabels, AuditService } from 'app/enums/audit.enum';
 import { QueryFilters } from 'app/interfaces/query-api.interface';
 import { User } from 'app/interfaces/user.interface';
 import { AdvancedSearchComponent } from 'app/modules/search-input/components/advanced-search/advanced-search.component';

src/app/modules/search-input/services/query-to-api/query-to-api.service.spec.ts

@@ -1,6 +1,6 @@
 import { TranslateService } from '@ngx-translate/core';
 import { of } from 'rxjs';
-import { AuditService } from 'app/enums/audit-event.enum';
+import { AuditService } from 'app/enums/audit.enum';
 import { IxFormatterService } from 'app/modules/ix-forms/services/ix-formatter.service';
 import {
   ConnectorType,

src/app/pages/audit/components/audit/audit.component.html

@@ -24,10 +24,10 @@
       </button>
     </div>
     <ix-export-button
-      *ngIf="this.dataProvider.totalRows"
+      *ngIf="dataProvider.totalRows"
       method="audit.export"
       [searchQuery]="searchQuery"
-      [sorting]="this.dataProvider.sorting"
+      [sorting]="dataProvider.sorting"
       [defaultFilters]="basicQueryFilters"
     ></ix-export-button>
   </div>