Merge branch 'pr3/time-based-actuator-base' into pr5/time-based-valve

Author: exciton

esphome/components/time_based/cover/time_based_cover.cpp

@@ -15,16 +15,6 @@ void TimeBasedCover::dump_config() {
                 this->open_duration_ / 1e3f, this->close_duration_ / 1e3f);
 }
 
-void TimeBasedCover::setup() {
-  auto restore = this->restore_state_();
-  if (restore.has_value()) {
-    restore->apply(this);
-  } else {
-    this->position = 0.5f;
-    this->publish_state();
-  }
-}
-
 CoverTraits TimeBasedCover::get_traits() {
   auto traits = CoverTraits();
   traits.set_supports_stop(true);

esphome/components/time_based/cover/time_based_cover.h

@@ -10,7 +10,6 @@ namespace esphome::time_based {
 class TimeBasedCover : public TimeBasedActuatorBase, public cover::Cover {
  public:
   TimeBasedCover() { this->set_actuator(this); }
-  void setup() override;
   cover::CoverTraits get_traits() override;
   void dump_config() override;
 

esphome/components/time_based/time_based_actuator.cpp

@@ -7,6 +7,14 @@ namespace esphome::time_based {
 
 using namespace esphome::actuator;
 
+void TimeBasedActuatorBase::setup() {
+  auto restored_pos = this->actuator_->do_restore_state();
+  if (!restored_pos.has_value()) {
+    this->actuator_->set_position(0.5f);
+    this->actuator_->do_publish_state(true);
+  }
+}
+
 void TimeBasedActuatorBase::loop() {
   if (this->actuator_->get_operation() == ACTUATOR_OPERATION_IDLE)
     return;

esphome/components/time_based/time_based_actuator.h

@@ -10,7 +10,7 @@ namespace esphome::time_based {
 class TimeBasedActuatorBase : public Component {
  public:
   void set_actuator(actuator::IActuator *actuator) { this->actuator_ = actuator; }
-  void setup() override {}
+  void setup() override;
   void loop() override;
 
   Trigger<> *get_open_trigger() { return &this->open_trigger_; }

tests/unit_tests/test_time_based_actuator.py

@@ -1,25 +1,67 @@
-"""Unit tests for the TimeBasedActuatorBase component."""
+"""Unit tests for the TimeBasedActuatorBase component.
 
+These tests verify:
+1. esphome.components.time_based.TimeBasedActuatorBase can be imported
+2. TimeBasedActuatorBase is exported from the time_based __init__.py
+3. The time_based cover Python class inherits from both TimeBasedActuatorBase and Cover
+"""
 
-def test_time_based_actuator_importable():
-    # pylint: disable-next=unused-import
-    from esphome.components.time_based import TimeBasedActuatorBase  # noqa: F401
 
+class TestTimeBasedActuatorImport:
+    """TimeBasedActuatorBase can be imported from the time_based component."""
 
-def test_time_based_cover_inherits_actuator_base():
-    """Verify TimeBasedCover inherits TimeBasedActuatorBase."""
-    from esphome.components.cover import Cover
-    from esphome.components.time_based import TimeBasedActuatorBase
-    from esphome.components.time_based.cover import TimeBasedCover
+    def test_time_based_actuator_importable(self):
+        """The TimeBasedActuatorBase must be importable from esphome.components.time_based."""
+        # pylint: disable-next=unused-import
+        from esphome.components.time_based import TimeBasedActuatorBase  # noqa: F401
 
-    # MockObjClass does not support Python's issubclass(); use inherits_from() instead
-    assert TimeBasedCover.inherits_from(TimeBasedActuatorBase), (
-        "TimeBasedCover does not inherit TimeBasedActuatorBase"
-    )
-    assert TimeBasedCover.inherits_from(Cover), "TimeBasedCover does not inherit Cover"
+    def test_time_based_actuator_class_exported(self):
+        """The TimeBasedActuatorBase must be exported from time_based __init__.py."""
+        import esphome.components.time_based as time_based_mod
 
+        assert hasattr(time_based_mod, "TimeBasedActuatorBase"), (
+            "TimeBasedActuatorBase not found in esphome.components.time_based"
+        )
 
-def test_time_based_actuator_class_exported():
-    import esphome.components.time_based as time_based_mod
+    def test_time_based_actuator_is_class(self):
+        """The TimeBasedActuatorBase must be a class-like object (MockObj)."""
+        from esphome.components.time_based import TimeBasedActuatorBase
 
-    assert hasattr(time_based_mod, "TimeBasedActuatorBase")
+        assert TimeBasedActuatorBase is not None
+
+
+class TestTimeBasedCoverInheritance:
+    """TimeBasedCover inherits TimeBasedActuatorBase and Cover."""
+
+    def test_time_based_cover_inherits_actuator_base(self):
+        """Verify TimeBasedCover inherits TimeBasedActuatorBase."""
+        from esphome.components.time_based import TimeBasedActuatorBase
+        from esphome.components.time_based.cover import TimeBasedCover
+
+        assert TimeBasedCover.inherits_from(TimeBasedActuatorBase), (
+            f"TimeBasedCover does not inherit from TimeBasedActuatorBase. "
+            f"TimeBasedCover parents: {getattr(TimeBasedCover, '_parents', 'N/A')}"
+        )
+
+    def test_time_based_cover_inherits_cover(self):
+        """The TimeBasedCover must inherit from Cover."""
+        from esphome.components.cover import Cover
+        from esphome.components.time_based.cover import TimeBasedCover
+
+        assert TimeBasedCover.inherits_from(Cover), (
+            f"TimeBasedCover does not inherit from Cover. "
+            f"TimeBasedCover parents: {getattr(TimeBasedCover, '_parents', 'N/A')}"
+        )
+
+    def test_time_based_cover_component_reachable_transitively(self):
+        """Component is reachable via TimeBasedActuatorBase, not as a direct parent of TimeBasedCover.
+
+        TimeBasedCover's direct parents are TimeBasedActuatorBase and Cover.
+        Component lifecycle flows through TimeBasedActuatorBase.
+        """
+        import esphome.codegen as cg
+        from esphome.components.time_based.cover import TimeBasedCover
+
+        assert TimeBasedCover.inherits_from(cg.Component), (
+            "TimeBasedCover must have Component reachable via TimeBasedActuatorBase"
+        )