Files
privacy.sexy/tests/unit/presentation/components/Scripts/View/Tree/NodeContent/ToggleSwitch.spec.ts
undergroundwires ca81f68ff1 Migrate to Vue 3.0 #230
- Migrate from "Vue 2.X" to "Vue 3.X"
- Migrate from "Vue Test Utils v1" to "Vue Test Utils v2"

Changes in detail:

- Change `inserted` to `mounted`.
- Change `::v-deep` to `:deep`.
- Change to Vue 3.0 `v-modal` syntax.
- Remove old Vue 2.0 transition name, keep the ones for Vue 3.0.
- Use new global mounting API `createApp`.
- Change `destroy` to `unmount`.
- Bootstrapping:
  - Move `provide`s for global dependencies to a bootsrapper from
    `App.vue`.
  - Remove `productionTip` setting (not in Vue 3).
  - Change `IVueBootstrapper` for simplicity and Vue 3 compatible API.
  - Add missing tests.
- Remove `.text` access on `VNode` as it's now internal API of Vue.
- Import `CSSProperties` from `vue` instead of `jsx` package.
- Shims:
  - Remove unused `shims-tsx.d.ts`.
  - Remove `shims-vue.d.ts` that's missing in quickstart template.
- Unit tests:
  - Remove old typing workaround for mounting components.
  - Rename `propsData` to `props`.
  - Remove unneeded `any` cast workarounds.
  - Move stubs and `provide`s under `global` object.

Other changes:

- Add `dmg-license` dependency explicitly due to failing electron builds
  on macOS (electron-userland/electron-builder#6520,
  electron-userland/electron-builder#6489). This was a side-effect of
  updating dependencies for this commit.
2023-11-01 13:39:39 +01:00

238 lines
6.3 KiB
TypeScript

import { describe, it, expect } from 'vitest';
import {
VueWrapper, shallowMount,
mount,
} from '@vue/test-utils';
import { nextTick, defineComponent } from 'vue';
import ToggleSwitch from '@/presentation/components/Scripts/View/Tree/NodeContent/ToggleSwitch.vue';
const DOM_INPUT_TOGGLE_CHECKBOX_SELECTOR = 'input.toggle-input';
const DOM_INPUT_TOGGLE_LABEL_OFF_SELECTOR = 'span.label-off';
const DOM_INPUT_TOGGLE_LABEL_ON_SELECTOR = 'span.label-on';
describe('ToggleSwitch.vue', () => {
describe('initial state', () => {
const testCases = [
{
initialValue: false,
description: 'unchecked for false',
},
{
initialValue: true,
description: 'checked for true',
},
];
testCases.forEach(({ initialValue, description }) => {
it(`renders as ${description}`, () => {
// arrange
const expectedState = initialValue;
// act
const wrapper = mountComponent({
properties: {
modelValue: initialValue,
},
});
const { checkboxElement } = getCheckboxElement(wrapper);
// assert
expect(checkboxElement.checked).to.equal(expectedState);
});
});
});
describe('label rendering', () => {
const testCases = [
{
description: 'off label',
selector: DOM_INPUT_TOGGLE_LABEL_OFF_SELECTOR,
},
{
description: 'on label',
selector: DOM_INPUT_TOGGLE_LABEL_ON_SELECTOR,
},
];
testCases.forEach(({ selector, description }) => {
it(description, () => {
// arrange
const expectedLabel = 'expected-test-label';
// act
const wrapper = mountComponent({
properties: {
label: expectedLabel,
},
});
// assert
const element = wrapper.find(selector);
expect(element.text()).to.equal(expectedLabel);
});
});
});
describe('model updates', () => {
describe('emission on change', () => {
const testCases = [
{
initialValue: true,
newCheckValue: false,
},
{
initialValue: false,
newCheckValue: true,
},
];
testCases.forEach(({ initialValue, newCheckValue }) => {
it(`emits ${newCheckValue} when initial value is ${initialValue} and checkbox value changes`, async () => {
// arrange
const wrapper = mountComponent({
properties: {
modelValue: initialValue,
},
});
const { checkboxWrapper } = getCheckboxElement(wrapper);
// act
await checkboxWrapper.setValue(newCheckValue);
await nextTick();
// assert
expect(wrapper.emitted('update:modelValue')).to.deep.equal([[newCheckValue]]);
});
});
});
describe('no emission on identical value', () => {
const testCases = [
{
value: true,
description: 'true',
},
{
value: false,
description: 'false',
},
];
testCases.forEach(({ value, description }) => {
it(`does not emit for an unchanged value of ${description}`, async () => {
// arrange
const wrapper = mountComponent({
properties: {
modelValue: value,
},
});
const { checkboxWrapper } = getCheckboxElement(wrapper);
// act
await checkboxWrapper.setValue(value);
await nextTick();
// assert
expect(wrapper.emitted('update:modelValue')).to.deep.equal(undefined);
});
});
});
});
describe('click propagation', () => {
it('stops propagation `stopClickPropagation` is true', async () => {
// arrange
const { wrapper: parentWrapper, parentClickEventName } = mountToggleSwitchParent(
{ stopClickPropagation: true },
);
const switchWrapper = parentWrapper.getComponent(ToggleSwitch);
// act
switchWrapper.trigger('click');
await nextTick();
// assert
const receivedEvents = parentWrapper.emitted(parentClickEventName);
expect(receivedEvents).to.equal(undefined);
});
it('allows propagation `stopClickPropagation` is false', async () => {
// arrange
const { wrapper: parentWrapper, parentClickEventName } = mountToggleSwitchParent(
{ stopClickPropagation: false },
);
const switchWrapper = parentWrapper.getComponent(ToggleSwitch);
// act
switchWrapper.trigger('click');
await nextTick();
// assert
const receivedEvents = parentWrapper.emitted(parentClickEventName);
expect(receivedEvents).to.have.lengthOf(1);
});
});
});
function getCheckboxElement(wrapper: VueWrapper) {
const checkboxWrapper = wrapper.find(DOM_INPUT_TOGGLE_CHECKBOX_SELECTOR);
const checkboxElement = checkboxWrapper.element as HTMLInputElement;
return {
checkboxWrapper,
checkboxElement,
};
}
function mountComponent(options?: {
readonly properties?: {
readonly modelValue?: boolean,
readonly label?: string,
readonly stopClickPropagation?: boolean,
}
}) {
const wrapper = shallowMount(ToggleSwitch, {
props: {
modelValue: options?.properties?.modelValue,
label: options?.properties?.label ?? 'test-label',
stopClickPropagation: options?.properties?.stopClickPropagation,
},
});
return wrapper;
}
function mountToggleSwitchParent(options?: {
readonly stopClickPropagation?: boolean,
}) {
const parentClickEventName = 'parent-clicked';
const parentComponent = defineComponent({
components: {
ToggleSwitch,
},
emits: [parentClickEventName],
template: `
<div @click="handleParentClick">
<ToggleSwitch
:stopClickPropagation="stopClickPropagation"
:label="'test-label'"
/>
</div>
`,
setup(_, { emit }) {
const stopClickPropagation = options?.stopClickPropagation;
function handleParentClick() {
emit(parentClickEventName);
}
return {
handleParentClick,
stopClickPropagation,
};
},
});
const wrapper = mount(
parentComponent,
{
global: {
stubs: { ToggleSwitch: false },
},
},
);
return {
wrapper,
parentClickEventName,
};
}