Merge pull request #2485 from asfadmin/vitest-utility-functions

Vitest utility functions

Author: tylercchase

src/app/services/dataset-for-product.service.spec.ts

@@ -0,0 +1,98 @@
+import { TestBed } from '@angular/core/testing';
+
+import * as models from '@models';
+import { productFactory } from '@testing/product-factory';
+import { beforeEach, describe, expect, it } from 'vitest';
+
+import { DatasetForProductService } from './dataset-for-product.service';
+
+describe('DatasetForProductService', () => {
+  let service: DatasetForProductService;
+
+  beforeEach(() => {
+    TestBed.configureTestingModule({});
+    service = TestBed.inject(DatasetForProductService);
+  });
+
+  describe('match()', () => {
+    it('returns alos for ALOS dataset without AVNIR-2 instrument', () => {
+      const product = productFactory
+        .withBasicInfo('test-scene')
+        .withDataset('ALOS')
+        .build();
+      expect(service.match(product)).toBe(models.alos);
+    });
+
+    it('returns avnir for ALOS dataset with AVNIR-2 instrument', () => {
+      const product = productFactory
+        .withBasicInfo('test-scene')
+        .withDataset('ALOS')
+        .withInstrument('AVNIR-2')
+        .build();
+      expect(service.match(product)).toBe(models.avnir);
+    });
+
+    it('returns sentinel_1_bursts for BURST product type', () => {
+      const product = productFactory
+        .withBasicInfo('test-scene')
+        .withProductType('BURST')
+        .build();
+      expect(service.match(product)).toBe(models.sentinel_1_bursts);
+    });
+
+    it('returns tropo for TROPO-ZENITH product type', () => {
+      const product = productFactory
+        .withBasicInfo('test-scene')
+        .withProductType('TROPO-ZENITH')
+        .build();
+      expect(service.match(product)).toBe(models.tropo);
+    });
+
+    it('returns tropo for ECMWF_TROPO product type', () => {
+      const product = productFactory
+        .withBasicInfo('test-scene')
+        .withProductType('ECMWF_TROPO')
+        .build();
+      expect(service.match(product)).toBe(models.tropo);
+    });
+
+    it('returns opera_s1 for OPERA product id', () => {
+      const product = productFactory
+        .withBasicInfo('test-scene')
+        .withId('OPERA_L2_RTC-S1_T001')
+        .build();
+      expect(service.match(product)).toBe(models.opera_s1);
+    });
+
+    it('returns SENTINEL-1 INTERFEROGRAM (BETA) for S1-GUNW name', () => {
+      const product = productFactory
+        .withBasicInfo('test-scene')
+        .withName('S1-GUNW-D-N-123456-123456-HH-R-N-0001')
+        .build();
+      expect(service.match(product)).toBe(
+        models.datasets['SENTINEL-1 INTERFEROGRAM (BETA)'],
+      );
+    });
+
+    it('returns sentinel-1 dataset for exact SENTINEL-1 dataset match', () => {
+      const product = productFactory.withBasicInfo('test-scene').build();
+      expect(service.match(product)).toBe(models.datasets['SENTINEL-1']);
+    });
+
+    it('returns sentinel-1 dataset for Sentinel-1A via partial match', () => {
+      const product = productFactory
+        .withBasicInfo('test-scene')
+        .withDataset('Sentinel-1A')
+        .build();
+      expect(service.match(product)).toBe(models.datasets['SENTINEL-1']);
+    });
+    // TODO: Change this to default to SENTINEL-1 again?
+    it('returns NISAR for non matching dataset', () => {
+      const product = productFactory
+        .withBasicInfo('test-scene')
+        .withDataset('')
+        .build();
+      expect(service.match(product)).toBe(models.datasets.NISAR);
+    });
+  });
+});

src/app/testing/product-factory.ts

@@ -0,0 +1,114 @@
+import { CMRProduct, CMRProductMetadata, FlightDirection } from '@models';
+import moment from 'moment';
+
+function createProduct(product: CMRProduct): CMRProduct {
+  return product;
+}
+
+class ProductFactory {
+  withBasicInfo(name: string): NestedProductFactory {
+    return new NestedProductFactory(
+      createProduct({
+        name: name,
+        productTypeDisplay: '',
+        file: '',
+        id: '',
+        downloadUrl: '',
+        bytes: 100 * 1000000,
+        dataset: 'SENTINEL-1',
+        browses: [],
+        thumbnail: '',
+        groupId: '',
+        isUnzippedFile: false,
+        isDummyProduct: false,
+        metadata: {
+          date: moment(),
+          stopDate: moment().add(2),
+          polygon: '',
+
+          productType: '',
+          beamMode: '',
+          polarization: '',
+          flightDirection: FlightDirection.ASCENDING,
+
+          path: 0,
+          frame: 0,
+          absoluteOrbit: [],
+
+          collectionName: '',
+          collectionID: '',
+
+          stackSize: 0,
+          faradayRotation: 0,
+          offNadirAngle: 0,
+          instrument: '',
+          pointingAngle: '',
+          missionName: '',
+          flightLine: '',
+          perpendicular: 0,
+          temporal: 0,
+          canInSAR: false,
+          burst: undefined,
+          opera: undefined,
+          nisar: undefined,
+          fileName: '',
+          job: undefined,
+          pgeVersion: '',
+          subproducts: [],
+          parentID: '',
+          ariaVersion: '',
+        },
+      }),
+    );
+  }
+}
+
+class NestedProductFactory {
+  constructor(private _product: Readonly<CMRProduct>) {}
+
+  build() {
+    return this._product;
+  }
+
+  withAOI(): NestedProductFactory {
+    return this._extendWithMetadata({
+      polygon:
+        'POLYGON((-124.3885 36.7031,-120.6971 36.7031,-120.6971 38.9246,-124.3885 38.9246,-124.3885 36.7031))',
+    });
+  }
+
+  withDataset(dataset: string): NestedProductFactory {
+    return this._extendWith({ dataset });
+  }
+
+  withInstrument(instrument: string): NestedProductFactory {
+    return this._extendWithMetadata({ instrument });
+  }
+
+  withProductType(productType: string): NestedProductFactory {
+    return this._extendWithMetadata({ productType });
+  }
+
+  withId(id: string): NestedProductFactory {
+    return this._extendWith({ id });
+  }
+
+  withName(name: string): NestedProductFactory {
+    return this._extendWith({ name });
+  }
+
+  private _extendWith(product: Partial<CMRProduct>) {
+    return new NestedProductFactory({ ...this._product, ...product });
+  }
+  private _extendWithMetadata(productMetadata: Partial<CMRProductMetadata>) {
+    return new NestedProductFactory({
+      ...this._product,
+      metadata: {
+        ...this._product.metadata,
+        ...productMetadata,
+      },
+    });
+  }
+}
+
+export const productFactory = new ProductFactory();