add tests, rename to showNextEvent

Author: bughaver

CHANGELOG.md

@@ -13,7 +13,7 @@ planned for 2025-07-01
 
 ### Added
 
-- [clock] Added option showSunNextEvent to show/hide next sun event.
+- [clock] Added option showNextEvent to show/hide next sun event.
 
 ### Changed
 

modules/default/clock/clock.js

@@ -25,7 +25,7 @@ Module.register("clock", {
 		analogShowDate: "top", // OBSOLETE, can be replaced with analogPlacement and showTime, options: false, 'top', or 'bottom'
 		secondsColor: "#888888", // DEPRECATED, use CSS instead. Class "clock-second-digital" for digital clock, "clock-second" for analog clock.
 
-		showSunTimes: false, // options: boolean, { showSunNextEvent: boolean }
+		showSunTimes: false, // options: boolean, { showNextEvent: boolean }
 		showMoonTimes: false, // options: false, 'times' (rise/set), 'percent' (lit percent), 'phase' (current phase), or 'both' (percent & phase)
 		lat: 47.630539,
 		lon: -122.344147
@@ -173,7 +173,7 @@ Module.register("clock", {
 			const isVisible = now.isBetween(sunTimes.sunrise, sunTimes.sunset);
 			let sunWrapperInnerHTML = "";
 
-			if (this.config.showSunTimes.showSunNextEvent !== false) {
+			if (this.config.showSunTimes.showNextEvent !== false) {
 				let nextEvent;
 				if (now.isBefore(sunTimes.sunrise)) {
 					nextEvent = sunTimes.sunrise;

tests/configs/modules/clock/clock_showSunNoEvent.js

@@ -0,0 +1,20 @@
+let config = {
+	address: "0.0.0.0",
+	ipWhitelist: [],
+	timeFormat: 12,
+
+	modules: [
+		{
+			module: "clock",
+			position: "middle_center",
+			config: {
+				showSunTimes: { showNextEvent: false }
+			}
+		}
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {
+	module.exports = config;
+}

tests/e2e/modules/clock_spec.js

@@ -92,6 +92,9 @@ describe("Clock module", () => {
 		it("should show the sun times", async () => {
 			const elem = await helpers.waitForElement(".clock .digital .sun");
 			expect(elem).not.toBeNull();
+
+			const elem2 = await helpers.waitForElement(".clock .digital .sun .fas.fa-sun");
+			expect(elem2).not.toBeNull();
 		});
 
 		it("should show the moon times", async () => {
@@ -100,6 +103,21 @@ describe("Clock module", () => {
 		});
 	});
 
+	describe("with showSunTimes.showNextEvent disabled", () => {
+		beforeAll(async () => {
+			await helpers.startApplication("tests/configs/modules/clock/clock_showSunNoEvent.js");
+			await helpers.getDocument();
+		});
+
+		it("should show the sun times", async () => {
+			const elem = await helpers.waitForElement(".clock .digital .sun");
+			expect(elem).not.toBeNull();
+
+			const elem2 = document.querySelector(".clock .digital .sun .fas.fa-sun");
+			expect(elem2).toBeNull();
+		});
+	});
+
 	describe("with showWeek config enabled", () => {
 		beforeAll(async () => {
 			await helpers.startApplication("tests/configs/modules/clock/clock_showWeek.js");