ControllerDebug: Clean up method names and add a way to disable testing

src/control/controlobjectscript.cpp

@@ -6,7 +6,7 @@
 #include "moc_controlobjectscript.cpp"
 
 ControlObjectScript::ControlObjectScript(const ConfigKey& key, QObject* pParent)
-        : ControlProxy(key, pParent, ControllerDebug::shouldAssertForInvalidControlObjects()) {
+        : ControlProxy(key, pParent, ControllerDebug::controlFlags()) {
 }
 
 bool ControlObjectScript::addScriptConnection(const ScriptConnection& conn) {

src/controllers/controller.cpp

@@ -110,7 +110,7 @@ void Controller::receive(const QByteArray& data, mixxx::Duration timestamp) {
     triggerActivity();
 
     int length = data.size();
-    if (ControllerDebug::enabled()) {
+    if (ControllerDebug::isEnabled()) {
         // Formatted packet display
         QString message = QString("%1: t:%2, %3 bytes:\n")
                                   .arg(m_sDeviceName,

src/controllers/controllerdebug.cpp

@@ -8,6 +8,6 @@ bool ControllerDebug::s_enabled = false;
 bool ControllerDebug::s_testing = false;
 
 //static
-bool ControllerDebug::enabled() {
+bool ControllerDebug::isEnabled() {
     return s_enabled || CmdlineArgs::Instance().getMidiDebug();
 }

src/controllers/controllerdebug.h

@@ -13,25 +13,25 @@ class ControllerDebug {
     static constexpr const char kLogMessagePrefix[] = "CDBG";
     static constexpr int kLogMessagePrefixLength = sizeof(kLogMessagePrefix) - 1;
 
-    static bool enabled();
+    static bool isEnabled();
 
     /// Override the command-line argument (for testing)
-    static void enable() {
-        s_enabled = true;
+    static void setEnabled(bool enabled) {
+        s_enabled = enabled;
     }
 
-    /// Override the command-line argument (for testing)
-    static void disable() {
-        s_enabled = false;
-    }
-
-    static void enableTesting() {
-        s_enabled = true;
-        s_testing = true;
+    static void setTesting(bool isTesting) {
+        s_testing = isTesting;
     }
 
-    static ControlFlags shouldAssertForInvalidControlObjects() {
-        if (s_enabled && !s_testing) {
+    /// Return the appropriate flag for ControlProxies in mappings.
+    ///
+    /// Normally, accessing an invalid control from a mapping should *not*
+    /// throw a debug assertion because controller mappings are considered
+    /// user data. If we're testing or controller debugging is enabled, we *do*
+    /// want assertions to prevent overlooking bugs in controller mappings.
+    static ControlFlags controlFlags() {
+        if (s_enabled || s_testing) {
             return ControlFlag::None;
         }
 
@@ -55,7 +55,7 @@ class ControllerDebug {
 // output for mixxx.log with .noquote(), because in qt5 QDebug() is quoted by default.
 #define controllerDebug(stream)                                                           \
     {                                                                                     \
-        if (ControllerDebug::enabled()) {                                                 \
+        if (ControllerDebug::isEnabled()) {                                               \
             QDebug(QtDebugMsg).noquote() << ControllerDebug::kLogMessagePrefix << stream; \
         }                                                                                 \
     }

src/controllers/hid/hidcontroller.cpp

@@ -204,7 +204,7 @@ void HidController::sendBytesReport(QByteArray data, unsigned int reportID) {
 
     int result = hid_write(m_pHidDevice, (unsigned char*)data.constData(), data.size());
     if (result == -1) {
-        if (ControllerDebug::enabled()) {
+        if (ControllerDebug::isEnabled()) {
             qWarning() << "Unable to send data to" << getName()
                        << "serial #" << m_deviceInfo.serialNumber() << ":"
                        << mixxx::convertWCStringToQString(

src/controllers/midi/midicontroller.cpp

@@ -109,7 +109,7 @@ void MidiController::createOutputHandlers() {
             qWarning() << errorLog;
 
             int deckNum = 0;
-            if (ControllerDebug::enabled()) {
+            if (ControllerDebug::isEnabled()) {
                 failures.append(errorLog);
             } else if (PlayerManager::isDeckGroup(group, &deckNum)) {
                 int numDecks = PlayerManager::numDecks();

src/controllers/scripting/legacy/controllerscriptenginelegacy.cpp

@@ -148,7 +148,7 @@ bool ControllerScriptEngineLegacy::initialize() {
     } else { // m_pController is nullptr in tests.
         args << QJSValue();
     }
-    args << QJSValue(ControllerDebug::enabled());
+    args << QJSValue(ControllerDebug::isEnabled());
     if (!callFunctionOnObjects(m_scriptFunctionPrefixes, "init", args, true)) {
         shutdown();
         return false;

src/controllers/scripting/legacy/controllerscriptinterfacelegacy.cpp

@@ -121,7 +121,7 @@ void ControllerScriptInterfaceLegacy::setValue(
 
     if (coScript != nullptr) {
         ControlObject* pControl = ControlObject::getControl(
-                coScript->getKey(), ControllerDebug::shouldAssertForInvalidControlObjects());
+                coScript->getKey(), ControllerDebug::controlFlags());
         if (pControl &&
                 !m_st.ignore(
                         pControl, coScript->getParameterForValue(newValue))) {
@@ -152,7 +152,7 @@ void ControllerScriptInterfaceLegacy::setParameter(
 
     if (coScript != nullptr) {
         ControlObject* pControl = ControlObject::getControl(
-                coScript->getKey(), ControllerDebug::shouldAssertForInvalidControlObjects());
+                coScript->getKey(), ControllerDebug::controlFlags());
         if (pControl && !m_st.ignore(pControl, newParameter)) {
             coScript->setParameter(newParameter);
         }
@@ -498,7 +498,7 @@ void ControllerScriptInterfaceLegacy::timerEvent(QTimerEvent* event) {
 void ControllerScriptInterfaceLegacy::softTakeover(
         const QString& group, const QString& name, bool set) {
     ControlObject* pControl = ControlObject::getControl(
-            ConfigKey(group, name), ControllerDebug::shouldAssertForInvalidControlObjects());
+            ConfigKey(group, name), ControllerDebug::controlFlags());
     if (!pControl) {
         return;
     }
@@ -512,7 +512,7 @@ void ControllerScriptInterfaceLegacy::softTakeover(
 void ControllerScriptInterfaceLegacy::softTakeoverIgnoreNextValue(
         const QString& group, const QString& name) {
     ControlObject* pControl = ControlObject::getControl(
-            ConfigKey(group, name), ControllerDebug::shouldAssertForInvalidControlObjects());
+            ConfigKey(group, name), ControllerDebug::controlFlags());
     if (!pControl) {
         return;
     }

src/test/controllerscriptenginelegacy_test.cpp

@@ -34,7 +34,7 @@ class ControllerScriptEngineLegacyTest : public MixxxTest {
         QThread::currentThread()->setObjectName("Main");
         cEngine = new ControllerScriptEngineLegacy(nullptr);
         cEngine->initialize();
-        ControllerDebug::enableTesting();
+        ControllerDebug::setTesting(true);
     }
 
     void TearDown() override {
@@ -80,19 +80,29 @@ TEST_F(ControllerScriptEngineLegacyTest, setValue) {
 }
 
 TEST_F(ControllerScriptEngineLegacyTest, getValue_InvalidKey) {
-    ControllerDebug::disable();
+    ControllerDebug::setEnabled(false);
+    ControllerDebug::setTesting(false);
     EXPECT_TRUE(evaluateAndAssert("engine.getValue('', '');"));
     EXPECT_TRUE(evaluateAndAssert("engine.getValue('', 'invalid');"));
     EXPECT_TRUE(evaluateAndAssert("engine.getValue('[Invalid]', '');"));
-    ControllerDebug::enable();
+    ControllerDebug::setTesting(true);
+    ControllerDebug::setEnabled(true);
 }
 
 TEST_F(ControllerScriptEngineLegacyTest, setValue_InvalidControl) {
+    ControllerDebug::setEnabled(false);
+    ControllerDebug::setTesting(false);
     EXPECT_TRUE(evaluateAndAssert("engine.setValue('[Nothing]', 'nothing', 1.0);"));
+    ControllerDebug::setTesting(true);
+    ControllerDebug::setEnabled(true);
 }
 
 TEST_F(ControllerScriptEngineLegacyTest, getValue_InvalidControl) {
+    ControllerDebug::setEnabled(false);
+    ControllerDebug::setTesting(false);
     EXPECT_TRUE(evaluateAndAssert("engine.getValue('[Nothing]', 'nothing');"));
+    ControllerDebug::setTesting(true);
+    ControllerDebug::setEnabled(true);
 }
 
 TEST_F(ControllerScriptEngineLegacyTest, setValue_IgnoresNaN) {