vue unit test - data not updated after triggering

Question

I am testing that form data are sent after submit.

ContactForm.spec.js

import Vue from "vue";
import Vuex from "vuex";
import { mount, shallowMount } from "@vue/test-utils";

import VeeValidate from "vee-validate";
import i18n from "@/locales";
import Vuetify from "vuetify";

import ContactForm from "@/components/Home/ContactForm.vue";

Vue.use(VeeValidate, { errorBagName: "errors" });
Vue.use(Vuetify);

Vue.use(Vuex);

describe("ContactForm.vue", () => {
  let store;
  let wrapper;
  let options;
  let input;

  const v = new VeeValidate.Validator();


  beforeEach(() => {
    const el = document.createElement("div");
    el.setAttribute("data-app", true);
    document.body.appendChild(el);
  });

  it("should sendMessage - valid form", async () => {
    // given
    store = new Vuex.Store({
      state: {
        language: "en",
        loading: false
      }
    })
    options = {
      sync: false,
      provide: {
        $validator () {
          return new VeeValidate.Validator();
        }
      },
      i18n,
      store
    };
    wrapper = mount(ContactForm, options);
    // when
    const radioInput = wrapper.findAll('input[type="radio"]');
    radioInput.at(1).setChecked(); // input element value is changed, v-model is not
    radioInput.at(1).trigger("change"); // v-model updated

    input = wrapper.find('input[name="givenName"]');
    input.element.value = "John"; // input element value is changed, v-model is not
    input.trigger("input"); // v-model updated

    input = wrapper.find('input[name="familyName"]');
    input.element.value = "Doe"; // input element value is changed, v-model is not
    input.trigger("input"); // v-model updated

    input = wrapper.find('input[name="email"]');
    input.element.value = "[e-mail]"; // input element value is changed, v-model is not
    input.trigger("input"); // v-model updated

    input = wrapper.find('textarea[name="messageContent"]');
    input.element.value = "Hello World!"; // input element value is changed, v-model is not
    input.trigger("input"); // v-model updated

    const contactForm = wrapper.find("form");
    contactForm.trigger("submit");
    await wrapper.vm.$nextTick();

    // then
    console.log("DATA: ", wrapper.vm.$data.contactLang);
    expect(wrapper.vm.validForm).toEqual(true);
  });

});

Validation is successful ( so validForm is set to true in the component ) BUT the test does not pass

console.log

    ✕ should sendMessage - valid form (476ms)

  ● ContactForm.vue › should sendMessage - valid form

    expect(received).toEqual(expected)

    Expected value to equal:
      true
    Received:
      false

The component vue is

ContactForm.vue

<template>
  <form id="contactForm" @submit="sendMessage()">
    <input v-model="contactLang" type='hidden' data-vv-name="contactLang" v-validate="'required'" name='contactLang'>
    <v-layout row wrap align-center>
      <v-flex xs12 sm3 md3 lg3>
        <v-radio-group row :mandatory="false" v-model="gender" name="gender">
          <v-radio :label='genderLabel("f")' value="f" name="female"></v-radio>
          <v-radio :label='genderLabel("m")' value="m" name="male"></v-radio>
        </v-radio-group>
      </v-flex>
      <v-flex xs12 sm4 md4 lg4>
        <v-text-field
          v-model="givenName"
          browser-autocomplete="off"
          :label="$t('lang.views.home.contactForm.givenName')"
          data-vv-name="givenName"
          :error-messages="errors.collect('givenName')"
          v-validate="'required'"
          name="givenName">
        </v-text-field>
      </v-flex>
      <v-flex xs12 sm5 md5 lg5>
         <v-text-field
          v-model="familyName"
          browser-autocomplete="off"
          :label="$t('lang.views.home.contactForm.familyName')"
          data-vv-name="familyName"
          :error-messages="errors.collect('familyName')"
          v-validate="'required'"
          name="familyName">
        </v-text-field>
      </v-flex>
    </v-layout>
    <v-text-field
      browser-autocomplete="off"
      v-model="email"
      :label="$t('lang.views.home.contactForm.email')"
      data-vv-name="email"
      :error-messages="errors.collect('email')"
      v-validate="'required|email'"
      name="email">
    </v-text-field>
    <v-textarea v-model="messageContent" :label="$t('lang.views.home.contactForm.message')" :error-messages="errors.collect('messageContent')" :rules="[(v) => v.length <= 200 || 'Max 200 characters']" :counter="200" v-validate="'required'" data-vv-name="messageContent" name="messageContent"></v-textarea>
    <v-btn id="btnClear" round @click.native="clear">{{ $t('lang.views.global.clear') }}</v-btn>
    <v-btn round large color="primary" type="submit">{{ $t('lang.views.global.send') }}
      <v-icon right>email</v-icon><span slot="loader" class="custom-loader"><v-icon light>cached</v-icon></span>
    </v-btn>
  </form>
</template>

<script>
import swal from "sweetalert2";
import { mapState } from "vuex";
import appValidationDictionarySetup from "@/locales/appValidationDictionary";

export default {
  name: "contactForm",
  $_veeValidate: { validator: "new" },
  data() {
    return {
      contactLang: "",
      gender: "f",
      givenName: "",
      familyName: "",
      email: "",
      messageContent: "",
      validForm: false
    };
  },
   ...
  methods: {
   ...
    sendMessage: function() {
      console.log("sendMessage()...");
      this.$validator
        .validateAll()
        .then(isValid => {
          console.log("VALIDATION RESULT: ", isValid);
          this.validForm = isValid;
          if (!isValid) {
            console.log("VALIDATION ERROR");
            // console.log("Errors: ", this.$validator.errors.items.length);
            const alertTitle = this.$validator.dictionary.container[
              this.language
            ].custom.error;
            const textMsg = this.$validator.dictionary.container[this.language]
              .custom.correct_all;
            swal({
              title: alertTitle,
              text: textMsg,
              type: "error",
              confirmButtonText: "OK"
            });
            return;
          }
          console.log("validation success, form submitted validForm: ", this.validForm);
          return;
        })
        .catch(e => {
          // catch error from validateAll() promise
          console.log("error validation promise: ", e);
          this.validForm = false;
          return;
        });
    },
    clear: function() {
      this.contactLang = "";
      this.gender = "f";
      this.givenName = "";
      this.familyName = "";
      this.email = "";
      this.messageContent = "";
      this.validForm = false;
      this.$validator.reset();
    }
  },
  mounted() {
    appValidationDictionarySetup(this.$validator);
    this.$validator.localize(this.language);
    this.contactLang = this.language;
  }
};
</script>


</style>

and the console.log debugging is

 console.log src/components/Home/ContactForm.vue:90
    sendMessage()...

  console.log tests/unit/ContactForm.spec.js:242
    DATA:  en

  console.log src/components/Home/ContactForm.vue:94
    VALIDATION RESULT:  true

It's weird to see that the DATA ( contactLang ) value is false in the console.log from the spec ... displayed before the validation result

      console.log src/components/Home/ContactForm.vue:90
        sendMessage()...

      console.log tests/unit/ContactForm.spec.js:242
        DATA:  en

      console.log src/components/Home/ContactForm.vue:94
        VALIDATION RESULT:  true

      console.log src/components/Home/ContactForm.vue:112
        validation success, form submitted validForm:  true

I guess there is async problem ... timout ?

thanks for feedback

Answer 1

I propose to use jest faketimers

jest.useFakeTimers()

contactForm.trigger("submit");
await wrapper.vm.$nextTick();
// then
jest.runTimersToTime(2000)
expect(wrapper.vm.validForm).toEqual(true);

I suggest to first make the test fail to avoid false positives

for more information about jest faketimers https://jestjs.io/docs/en/timer-mocks.html

Answer 2

SOLVED It's actually a timeout issue

    contactForm.trigger("submit");
    await wrapper.vm.$nextTick();
    // then
    setTimeout(() => {
      expect(wrapper.vm.validForm).toEqual(true);
    }, 2000);