Merge pull request #36 from owncloud/unit-test-App-component

Add unit test for fetchVipMetadataInformation method

Author: Salipa-Gurung

src/App.vue

@@ -202,19 +202,16 @@ export default defineComponent({
     }
   },
   // vue js lifecylce functions
-  async created() {
-    // get resource, ensure resource url is not empty!
-    if (this.url != null && this.url != undefined && this.url != '') {
-      this.dicomUrl = await this.addWadouriPrefix(this.url)
-    }
 
-    // get vip metadata
-    await this.fetchVipMetadataInformation(await this.addWadouriPrefix(this.url))
-
-    // prefetch all other metadata (in separate function for performance reasons)
-    await this.fetchMetadataInformation(await this.addWadouriPrefix(this.url))
-  },
   async mounted() {
+    if (this.url) {
+      this.dicomUrl = await this.addWadouriPrefix(this.url)
+      // get vip metadata
+      await this.fetchVipMetadataInformation(this.dicomUrl)
+
+      // prefetch all other metadata (in separate function for performance reasons)
+      await this.fetchMetadataInformation(this.dicomUrl)
+    }
     // check if cornerstone core is initialized
     if (!cornerstone.isCornerstoneInitialized()) {
       await this.initCornerstoneCore()
@@ -248,11 +245,9 @@ export default defineComponent({
     this.viewport = <Types.IStackViewport>this.renderingEngine.getViewport(viewportId)
 
     // add resource to stack, ensure resource url is not empty!
-    if (this.url != null && this.url != undefined && this.url != '') {
-      let dicomResourceUrl = await this.addWadouriPrefix(this.url)
-
+    if (this.dicomUrl) {
       // define a stack containing a single image
-      const dicomStack = [dicomResourceUrl]
+      const dicomStack = [this.dicomUrl]
 
       // set stack on the viewport (currently only one image in the stack, therefore no frame # required)
       await this.viewport.setStack(dicomStack)
@@ -262,7 +257,7 @@ export default defineComponent({
       this.setViewportCameraParallelScaleFactor()
 
       // getting image metadata from viewport
-      this.getImageMetadataFromViewport(dicomResourceUrl)
+      this.getImageMetadataFromViewport(this.dicomUrl)
     }
   },
   updated() {
@@ -277,6 +272,7 @@ export default defineComponent({
     this.isImageMetadataExtractedFromViewport = false
     this.isDicomImageDataFetched = false
   },
+
   methods: {
     async initCornerstoneCore() {
       try {
@@ -291,10 +287,8 @@ export default defineComponent({
     async fetchVipMetadataInformation(imageId) {
       if (!this.isDicomImageDataFetched) {
         this.dicomImageData = await fetchDicomImageData(imageId)
-        if (!this.isDicomImageDataFetched) {
-          if (this.dicomImageData != null) {
-            this.isDicomImageDataFetched = true
-          }
+        if (this.dicomImageData != null) {
+          this.isDicomImageDataFetched = true
         }
       }
 

src/helper/extractMetadata.ts

@@ -31,11 +31,7 @@ export const addSopTagChecker = (tag: string): boolean => {
   return tag.endsWith('_addSOPuids') ? true : false
 }
 
-export const extractDicomMetadata = async (
-  imageData: object,
-  tags: string[],
-  language: string = 'en'
-) => {
+export const extractDicomMetadata = async (imageData: object, tags: string[], language = 'en') => {
   const extractedData: { label: string; value: string }[] = []
 
   // extracting data

tests/e2e/hooks.ts

@@ -41,7 +41,9 @@ After(async function (): Promise<void> {
 
 const sendRequest = function ({ method, path }): Promise<any> {
   const headers = {
-    Authorization: `Basic ${Buffer.from(`${config.adminUser}:${config.adminPassword}`).toString('base64')}`
+    Authorization: `Basic ${Buffer.from(`${config.adminUser}:${config.adminPassword}`).toString(
+      'base64'
+    )}`
   }
   return axios({
     method,

tests/unit/App.spec.ts

@@ -1,4 +1,4 @@
-import { shallowMount } from '@vue/test-utils'
+import { shallowMount, flushPromises } from '@vue/test-utils'
 import App from '../../src/App.vue'
 import { vi } from 'vitest'
 import { defaultPlugins } from '../../src/helper/defaultPlugins'
@@ -14,24 +14,39 @@ vi.mock('vue3-gettext', () => ({
 
 vi.mock('@cornerstonejs/core', () => {
   return {
-    successCallback: vi.fn(),
-    errorCallback: vi.fn(),
     RenderingEngine: class RenderingEngine {
       getViewport() {
         return {
           setStack: vi.fn(),
-          render: vi.fn()
+          render: vi.fn(),
+          getCamera: vi.fn().mockImplementation(() => {
+            return { parallelScale: 137.3853139193763 }
+          }),
+          getImageData: vi.fn().mockImplementation(() => {
+            return { dimensions: [] }
+          })
         }
       }
       enableElement() {}
     },
     Types: vi.fn(),
     Enums: {
       ViewportType: {
-        STACK: '' // "stack",
+        STACK: ''
       }
     },
-    metaData: vi.fn(),
+    metaData: {
+      get: vi.fn().mockImplementation(() => {
+        return {
+          pixelRepresentation: '',
+          bitsAllocated: '',
+          bitsStored: '',
+          highBit: '',
+          samplesPerPixel: ''
+        }
+      })
+    },
+
     init: vi.fn(),
     getConfiguration: vi.fn().mockImplementation(() => {
       return { rendering: '' }
@@ -60,12 +75,52 @@ vi.mock('dicom-parser', () => ({
 }))
 
 describe('App component', () => {
+  const spyFetchVipMetadataInformation = vi
+    .spyOn(App.methods, 'fetchVipMetadataInformation')
+    .mockImplementation(vi.fn())
+  const spyFetchMetadataInformation = vi
+    .spyOn(App.methods, 'fetchMetadataInformation')
+    .mockImplementation(vi.fn())
+  const spyAddWadouriPrefix = vi
+    .spyOn(App.methods, 'addWadouriPrefix')
+    .mockReturnValue('wadouri:https://test')
+  const spyInitCornerstoneCore = vi
+    .spyOn(App.methods, 'initCornerstoneCore')
+    .mockImplementation(vi.fn())
+
+  beforeEach(() => {
+    vi.clearAllMocks()
+  })
+
+  it('should not fetch overlay metadata when the url is not provided', async () => {
+    getWrapper()
+    await flushPromises()
+
+    expect(spyAddWadouriPrefix).toHaveBeenCalledTimes(0)
+    expect(spyFetchVipMetadataInformation).toHaveBeenCalledTimes(0)
+    expect(spyFetchMetadataInformation).toHaveBeenCalledTimes(0)
+    expect(spyInitCornerstoneCore).toHaveBeenCalledTimes(1)
+  })
+  it('should fetch overlay metadata when the url is provided', async () => {
+    getWrapper({ props: { url: 'https://test' } })
+    await flushPromises()
+
+    expect(spyAddWadouriPrefix).toHaveBeenCalledTimes(1)
+    expect(spyAddWadouriPrefix).toHaveBeenCalledWith('https://test')
+    expect(spyFetchVipMetadataInformation).toHaveBeenCalledTimes(1)
+    expect(spyFetchVipMetadataInformation).toHaveBeenCalledWith('wadouri:https://test')
+    expect(spyFetchMetadataInformation).toHaveBeenCalledTimes(1)
+    expect(spyFetchMetadataInformation).toHaveBeenCalledWith('wadouri:https://test')
+    expect(spyInitCornerstoneCore).toHaveBeenCalledTimes(1)
+  })
+
   describe('Methods', () => {
-    vi.spyOn(App.methods, 'fetchVipMetadataInformation').mockImplementation(vi.fn())
-    vi.spyOn(App.methods, 'fetchMetadataInformation').mockImplementation(vi.fn())
     const wrapper = getWrapper()
-
     describe('method: wadouri', () => {
+      beforeAll(() => {
+        spyAddWadouriPrefix.mockRestore()
+      })
+
       it('should add "wadouri" prefix', async () => {
         expect(await wrapper.vm.addWadouriPrefix('https://dummy_url')).toBe(
           'wadouri:https://dummy_url'