Я бы попробовал щелкнуть по нему левой кнопкой мыши.
QTest::mouseClick(myWizard.getNextButton(), Qt::LeftButton, Qt::NoModifier, QPoint(), 5000);
, а также убедиться, что в вашем тесте кнопка видна и активирована, например:
QCOMPARE( myWizard.getNextButton().isEnabled(), true);
QCOMPARE( myWizard.getNextButton().isVisible(), true);
Невидимый и отключенные кнопки ничего не делают при нажатии. А кнопки «Далее» в мастерах часто отключаются до тех пор, пока обязательные поля на странице мастера не будут заполнены.