introduce secretsService to mock includes for CI builds

Author: ModischFabrications

src/inputs/telegram.h

@@ -6,12 +6,12 @@
 
 // Telegram Bot is technically a connector, especially with admin notifications. Might want to rename it.
 
-#include "secrets.h"
+#include "shared/secretsService.h"
 #include "shared/serialWrapper.h"
 #include <Arduino.h>
+#include <SafeString.h>
 #include <UniversalTelegramBot.h> // https://github.com/witnessmenow/Universal-Arduino-Telegram-Bot
 #include <WiFiClientSecure.h>
-#include <SafeString.h>
 
 namespace Input_Telegram {
 
@@ -36,8 +36,7 @@ void logMsg(const telegramMessage& msg) {
 }
 
 void sendModeKeyboard(const String& chat_id) {
-    bot.sendMessageWithReplyKeyboard(chat_id, F("Choose a command: "), "",
-                                     F("[[\"/off\",\"/on\"], \"/clock\"]"), true);
+    bot.sendMessageWithReplyKeyboard(chat_id, F("Choose a command: "), "", F("[[\"/off\",\"/on\"], \"/clock\"]"), true);
 }
 
 void displayPairingKey() {
@@ -47,8 +46,7 @@ void displayPairingKey() {
 }
 
 void pairUser(const String& chat_id) {
-    if (iPairs >= N_MAX_PAIRED)
-        iPairs -= N_MAX_PAIRED;
+    if (iPairs >= N_MAX_PAIRED) iPairs -= N_MAX_PAIRED;
     // add to Set of IDs
     pairedKeys[iPairs++] = chat_id.c_str();
 }
@@ -58,27 +56,22 @@ bool isPaired(const String& chat_id) {
     for (const char* i : pairedKeys) {
         printRaw(i);
         println(F(", "));
-        if (chat_id.equals(i))
-            return true;
+        if (chat_id.equals(i)) return true;
     }
     return false;
 }
 
 void handleCommand(const String& chat_id, SafeString& cmd, SafeString& param1, SafeString& param2) {
     if (cmd == "/pair") {
-        if (param1.isEmpty()) {
-            bot.sendMessage(chat_id, F("Missing key, I expect \"/pair KEY\""));
-        }
+        if (param1.isEmpty()) { bot.sendMessage(chat_id, F("Missing key, I expect \"/pair KEY\"")); }
         if (param1 != pairingKey) {
             bot.sendMessage(chat_id, F("Sorry, that's not my key"));
             return;
         }
         pairUser(chat_id);
         bot.sendMessage(chat_id, F("Paired successfully!"));
     } else if (!isPaired(chat_id)) {
-        bot.sendMessage(
-            chat_id,
-            F("I don't know you yet, let's pair! \nCall /pair KEY with the displayed characters"));
+        bot.sendMessage(chat_id, F("I don't know you yet, let's pair! \nCall /pair KEY with the displayed characters"));
         displayPairingKey();
         return;
     }
@@ -88,9 +81,8 @@ void handleCommand(const String& chat_id, SafeString& cmd, SafeString& param1, S
 
 void handleCommand(const telegramMessage& msg) {
     if (msg.text.startsWith("/start") || msg.text.startsWith("/help")) {
-        bot.sendMessage(
-            msg.chat_id,
-            F("Hello there 👋🏼 I'm here to give you easy access to ModischMatrix functions."));
+        bot.sendMessage(msg.chat_id,
+                        F("Hello there 👋🏼 I'm here to give you easy access to ModischMatrix functions."));
         // probably useless, Telegram offers native command selection now
         sendModeKeyboard(msg.chat_id);
         return;
@@ -149,9 +141,7 @@ void setup() {
     // secured_client.setInsecure();   // this shouldn't be necessary with active Cert
     bot.waitForResponse = 5 * 1000;
 
-    if (!bot.getMe()) {
-        logWarning(F("T: Can't find myself!"));
-    }
+    if (!bot.getMe()) { logWarning(F("T: Can't find myself!")); }
 
     // pairUser(T_ADMIN_ID);
 
@@ -161,8 +151,7 @@ void setup() {
 
 uint32_t t_last_poll = 0;
 void loop() {
-    if (!ready)
-        return;
+    if (!ready) return;
 
     uint32_t now = millis();
     if (now - t_last_poll > POLL_DELAY) {

src/main.cpp

@@ -1,12 +1,7 @@
 #include <Arduino.h>
-//#include <loopTimer.h>    // part of SafeStrings
 
 #define DEBUG
 
-#ifdef CI_BUILD
-#pragma message "-- CI Build --"
-#endif
-
 #include "pinout.h"
 
 #include "shared/fileServer.h"
@@ -63,16 +58,15 @@ void setup() {
 void loop() {
     TimeService::loop();
     WeatherService::loop();
+
     Input_Touch::loop();
+    // Input_Telegram::loop();
     Controller::loop();
 
     PersistenceManager::loop();
 
-    // Input_Telegram::loop();
-
     RebootManager::loop();
 
-    // loopTimer.check(Serial);
     // heartbeatSerial();
     delay(1);
 }

src/secrets_template.h

@@ -0,0 +1,10 @@
+#pragma once
+
+// COPY, FILL WITH YOUR VALUES AND RENAME TO "secrets.h"
+
+const char OWM_LOCATION_KEY[] = "69420,TW";                 // Postcode, ISO 3166 Country ID
+const char OWM_API_KEY[] = "lbilgu453l345g232vj432mj4f2";   // get from https://openweathermap.org/
+
+// disabled for now, but might be reactivated eventually
+//const char T_BOT_TOKEN[] = "457654:ibfeaililuafilhafli";    // ask @BotFather
+//const char T_ADMIN_ID[] = "872392349"; // Telegram user account

src/shared/secretsService.h

@@ -0,0 +1,11 @@
+#pragma once
+
+// pun intended. 
+
+// CI and other pipelines need something to work with, using the template should be fine. 
+#ifdef CI_BUILD
+#pragma message(-- CI Build, mocking secrets --)
+#include "secrets_template.h"
+#else
+#include "secrets.h"
+#endif

src/shared/weatherService.h

@@ -1,6 +1,6 @@
 #pragma once
 
-#include "secrets.h"
+#include "shared/secretsService.h"
 #include "shared/serialWrapper.h"
 #include <ArduinoJson.h>
 #include <HTTPClient.h>