Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

25880 court order unit testing #719

Merged
merged 9 commits into from
Feb 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "business-filings-ui",
"version": "7.4.19",
"version": "7.4.20",
"private": true,
"appName": "Filings UI",
"sbcName": "SBC Common Components",
Expand Down
8 changes: 4 additions & 4 deletions src/views/CourtOrder.vue
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,6 @@ export default class CourtOrderView extends Mixins(DateMixin, FilingMixin, Commo
file: File = null // court order file object
fileKey: string = null // court order file key
courtOrderValid = true
staffPaymentValid = false

// other variables
totalFee = 0
Expand All @@ -304,7 +303,8 @@ export default class CourtOrderView extends Mixins(DateMixin, FilingMixin, Commo
haveChanges = false

// variables for staff payment
staffPaymentData = { option: StaffPaymentOptions.FAS } as StaffPaymentIF
staffPaymentValid = true
staffPaymentData = { option: StaffPaymentOptions.NO_FEE } as StaffPaymentIF

paymentErrorDialog = false

Expand Down Expand Up @@ -352,7 +352,7 @@ export default class CourtOrderView extends Mixins(DateMixin, FilingMixin, Commo

get isPageValid (): boolean {
const filingDataValid = (this.filingData.length > 0)
return (filingDataValid && this.courtOrderValid)
return (filingDataValid && this.courtOrderValid && this.staffPaymentValid)
}

/**
Expand Down Expand Up @@ -441,9 +441,9 @@ export default class CourtOrderView extends Mixins(DateMixin, FilingMixin, Commo

// add Waive Fees flag to all filing codes
this.updateFilingData('add', FilingCodes.COURT_ORDER, val.isPriority, waiveFees)

this.haveChanges = true
}

@Watch('dialog')
onDialogChanged (val: boolean): void {
// when dialog is hidden, reset everything
Expand Down
219 changes: 219 additions & 0 deletions tests/unit/CourtOrder.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,219 @@
import Vue from 'vue'
import Vuetify from 'vuetify'
import { createLocalVue, mount, shallowMount } from '@vue/test-utils'
import { createPinia, setActivePinia } from 'pinia'
import { useBusinessStore, useConfigurationStore, useRootStore } from '@/stores'
import CourtOrder from '@/views/CourtOrder.vue'
import { FileUploadPdf } from '@/components/common'
import { CourtOrderPoa } from '@bcrs-shared-components/court-order-poa'
import mockRouter from './mockRouter'
import VueRouter from 'vue-router'
import { CorpTypeCd } from '@bcrs-shared-components/corp-type-module'
import SbcFeeSummary from 'sbc-common-components/src/components/SbcFeeSummary.vue'
import vuetify from 'sbc-common-components/src/plugins/vuetify'

// suppress various warnings:
// - "Unknown custom element <affix>" warnings
// - "$listeners is readonly"
// - "Avoid mutating a prop directly"
// ref: https://github.com/vuejs/vue-test-utils/issues/532
Vue.config.silent = true

Vue.use(Vuetify)

const localVue = createLocalVue()
localVue.use(VueRouter)
setActivePinia(createPinia())
const businessStore = useBusinessStore()
const rootStore = useRootStore()
const configurationStore = useConfigurationStore()

describe('Court Order View', () => {
beforeAll(() => {
// mock the window.location.assign function
delete window.location
window.location = { assign: vi.fn() } as any

// set configurations
const configuration = {
'VUE_APP_AUTH_WEB_URL': 'https://auth.web.url/'
}
configurationStore.setConfiguration(configuration)

// set necessary session variables
sessionStorage.setItem('BASE_URL', 'https://base.url/')
sessionStorage.setItem('CURRENT_ACCOUNT', '{ "id": "2288" }')
})

beforeEach(() => {
// init store
rootStore.currentDate = '2020-03-04'
businessStore.setLegalType(CorpTypeCd.COOP)
businessStore.setLegalName('My Test Entity')
businessStore.setIdentifier('CP1234567')
businessStore.setFoundingDate('1971-05-12T00:00:00-00:00')
rootStore.filingData = []
rootStore.keycloakRoles = ['staff']
const localVue = createLocalVue()
localVue.use(VueRouter)
})

it('mounts the sub-components properly', async () => {
const $route = { query: { filingId: '0' } }
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What happens if filing id isn't 0? Is that worth testing?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pass


// create local Vue and mock router
const $router = mockRouter.mock()

const wrapper = shallowMount(CourtOrder, { mocks: { $route, $router } })

wrapper.vm.$data.dataLoaded = true
await Vue.nextTick()

// verify sub-components
expect(wrapper.findComponent(CourtOrderPoa).exists()).toBe(true)
expect(wrapper.findComponent(FileUploadPdf).exists()).toBe(true)
expect(wrapper.findComponent(SbcFeeSummary).exists()).toBe(true)

wrapper.destroy()
})

it('should validate fields when saving', async () => {
const $route = { query: { filingId: '0' } }
const $router = mockRouter.mock()

const wrapper = shallowMount(CourtOrder, { mocks: { $route, $router } })

await wrapper.setData({
notation: '', // Empty notation
courtOrderNumber: '12345'
})

// Trigger save action
const saveButton = wrapper.find('#dialog-save-button')
await saveButton.trigger('click')

// Check for validation error
expect(wrapper.vm.showErrors).toBe(true)
expect(wrapper.vm.isPageValid).toBe(false)
})

it('sets computed states properly', async () => {
// mock $route
const $route = { query: { filingId: '0' } }
const $router = mockRouter.mock()

const wrapper = shallowMount(CourtOrder, { mocks: { $route, $router },
data () {
return {
filingData: ['0'], // Non-empty array
courtOrderValid: true, // courtOrderValid is true
staffPaymentValid: true // staffPaymentValid is true
}
} })
const vm: any = wrapper.vm

// Trigger a re-evaluation of the computed property (could be necessary for async changes)
await wrapper.vm.$nextTick()

// Check if the computed property isPageValid returns true
expect(vm.isPageValid).toBe(true)

// verify "validated" - invalid Staff Payment form
vm.staffPaymentValid = false
vm.courtOrderValid = true
expect(vm.isPageValid).toBe(false)

// verify "validated" - invalid Court Order section
vm.staffPaymentValid = true
vm.courtOrderValid = false
expect(vm.isPageValid).toBe(false)

wrapper.destroy()
})

it('saves a new filing when the File & Pay button is clicked', async () => {
const localVue = createLocalVue()
localVue.use(VueRouter)
const router = mockRouter.mock()
router.push({ name: 'court-order', query: { filingId: '0' } })

const wrapper = mount(CourtOrder, {
localVue,
router,
stubs: {
CourtOrderPoa: true,
SbcFeeSummary: true
},
vuetify
})
const vm: any = wrapper.vm

// make sure form is validated
await wrapper.setData({
courtOrderValid: true
})

wrapper.vm.$data.dataLoaded = true
await Vue.nextTick()

expect(vm.isPageValid).toEqual(true)

// make sure a fee is required
vm.totalFee = 20

const saveButton = wrapper.find('#dialog-save-button')
expect(saveButton.attributes('disabled')).toBeUndefined()

// click the File & Pay button
await saveButton.trigger('click')

// Check for validation error
expect(wrapper.vm.showErrors).toBe(false)
})
})

describe('Court Order View User', () => {
beforeAll(() => {
// mock the window.location.assign function
delete window.location
window.location = { assign: vi.fn() } as any

// set configurations
const configuration = {
'VUE_APP_AUTH_WEB_URL': 'https://auth.web.url/'
}
configurationStore.setConfiguration(configuration)

// set necessary session variables
sessionStorage.setItem('BASE_URL', 'https://base.url/')
sessionStorage.setItem('CURRENT_ACCOUNT', '{ "id": "2288" }')
})

beforeEach(() => {
// init store

rootStore.keycloakRoles = ['user']
})

it('throws an error when user is not staff', async () => {
const $route = { query: { filingId: '0' } }

// create local Vue and mock router
const $router = mockRouter.mock()

let errorThrown = false

try {
// Mocking the condition where the user is not staff
shallowMount(CourtOrder, {
mocks: { $route, $router }
})
} catch (error) {
errorThrown = true
expect(error.message).toBe('This is a Staff only Filing.')
}

// Assert that the error was thrown
expect(errorThrown).toBe(true)
})
})
Loading