File indexing completed on 2024-04-21 14:47:24

 /*  KStars UI tests
     SPDX-FileCopyrightText: 2020 Eric Dejouhanet <eric.dejouhanet@gmail.com>
 
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 
 #ifndef TESTEKOSGUIDE_H
 #define TESTEKOSGUIDE_H
 
 #include "config-kstars.h"
 
 #if defined(HAVE_INDI) && HAVE_INDI
 
 #include <QObject>
 #include <QPushButton>
 #include <QComboBox>
 #include <QDoubleSpinBox>
 #include <QSpinBox>
 #include <QCheckBox>
 #include <QTest>
 
 /** @brief Helper to show the Guide tab
  */
 #define KTRY_GUIDE_SHOW() do { \
     QTRY_VERIFY_WITH_TIMEOUT(Ekos::Manager::Instance()->guideModule() != nullptr, 5000); \
     KTRY_EKOS_GADGET(QTabWidget, toolsWidget); \
     QTRY_VERIFY_WITH_TIMEOUT(-1 != toolsWidget->indexOf(Ekos::Manager::Instance()->guideModule()), 5000); \
     toolsWidget->setCurrentWidget(Ekos::Manager::Instance()->guideModule()); \
     QTRY_COMPARE_WITH_TIMEOUT(toolsWidget->currentWidget(), Ekos::Manager::Instance()->guideModule(), 5000); \
     QTRY_VERIFY_WITH_TIMEOUT(!Ekos::Manager::Instance()->guideModule()->camera().isEmpty(), 5000); } while (false)
 
 /** @brief Helper to retrieve a gadget in the Guide tab specifically.
  * @param klass is the class of the gadget to look for.
  * @param name is the gadget name to look for in the UI configuration.
  * @warning Fails the test if the gadget "name" of class "klass" does not exist in the Focus module
  */
 #define KTRY_GUIDE_GADGET(klass, name) klass * const name = Ekos::Manager::Instance()->guideModule()->findChild<klass*>(#name); \
     QVERIFY2(name != nullptr, QString(#klass " '%1' does not exist and cannot be used").arg(#name).toStdString().c_str())
 
 /** @brief Helper to click a button in the Guide tab specifically.
  * @param button is the gadget name of the button to look for in the UI configuration.
  * @warning Fails the test if the button is not currently enabled.
  */
 #define KTRY_GUIDE_CLICK(button) do { \
     QTimer::singleShot(100, Ekos::Manager::Instance(), []() { \
         KTRY_GUIDE_GADGET(QPushButton, button); \
         QVERIFY2(button->isEnabled(), QString("QPushButton '%1' is disabled and cannot be clicked").arg(#button).toStdString().c_str()); \
         QTest::mouseClick(button, Qt::LeftButton); }); \
     QTest::qWait(200); } while(false)
 
 /** @brief Helper to set a string text into a QComboBox in the Focus module.
  * @param combobox is the gadget name of the QComboBox to look for in the UI configuration.
  * @param text is the string text to set in the gadget.
  * @note This is a contrived method to set a text into a QComboBox programmatically *and* emit the "activated" message.
  * @warning Fails the test if the name does not exist in the Focus UI or if the text cannot be set in the gadget.
  */
 #define KTRY_GUIDE_COMBO_SET(combobox, text) do { \
     KTRY_GUIDE_GADGET(QComboBox, combobox); \
     int const cbIndex = combobox->findText(text); \
     QVERIFY(0 <= cbIndex); \
     combobox->setCurrentIndex(cbIndex); \
     combobox->activated(cbIndex); \
     QCOMPARE(combobox->currentText(), QString(text)); } while(false);
 
 /** @brief Helper for exposure.
  * @param exposure is the amount of seconds to expose for.
  * @param averaged is the number of frames the procedure should average before computation.
  * @note The Focus capture button is disabled during exposure.
  * @warning Fails the test if the exposure cannot be entered or if the capture button is
  * disabled or does not toggle during exposure or if the stop button is not the opposite of the capture button.
  */
 /** @{ */
 #define KTRY_GUIDE_DETECT(exposure, averaged) do { \
     KTRY_GUIDE_GADGET(QDoubleSpinBox, exposureIN); \
     exposureIN->setValue(exposure); \
     KTRY_GUIDE_GADGET(QSpinBox, focusFramesSpin); \
     focusFramesSpin->setValue(averaged); \
     KTRY_GUIDE_GADGET(QPushButton, captureB); \
     KTRY_GUIDE_GADGET(QPushButton, stopFocusB); \
     QTRY_VERIFY_WITH_TIMEOUT(captureB->isEnabled(), 1000); \
     QTRY_VERIFY_WITH_TIMEOUT(!stopFocusB->isEnabled(), 1000); \
     KTRY_GUIDE_CLICK(captureB); \
     QTRY_VERIFY_WITH_TIMEOUT(!captureB->isEnabled(), 1000); \
     QVERIFY(stopFocusB->isEnabled()); \
     QTest::qWait(exposure*averaged*1000); \
     QTRY_VERIFY_WITH_TIMEOUT(captureB->isEnabled(), 5000); \
     QVERIFY(!stopFocusB->isEnabled()); } while (false)
 /** @} */
 
 class TestEkosGuide : public QObject
 {
     Q_OBJECT
 
 public:
     explicit TestEkosGuide(QObject *parent = nullptr);
 
 protected:
     QProcess * phd2 { nullptr };
     QString testProfileName { "phd2_test_profile" };
     QString const guider_host { "localhost" };
     QString const guider_port { "4400" };
     void stopPHD2();
 
 private slots:
     void initTestCase();
     void cleanupTestCase();
 
     void init();
     void cleanup();
 
     void testPHD2ConnectionStability();
     void testPHD2CaptureStability();
     void testPHD2Calibration();
 };
 
 #endif // HAVE_INDI
 #endif // TESTEKOSGUIDE_H