FPP v2.3.0a1

FppTest/CMakeLists.txt

@@ -20,14 +20,20 @@ add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/struct/")
 set(SOURCE_FILES "source.cpp")
 set(MOD_DEPS
     ${PROJECT_NAME}/array
+    ${PROJECT_NAME}/component/active
+    ${PROJECT_NAME}/component/empty
+    ${PROJECT_NAME}/component/passive
+    ${PROJECT_NAME}/component/queued
     ${PROJECT_NAME}/dp
-    ${PROJECT_NAME}/state_machine
     ${PROJECT_NAME}/enum
+    ${PROJECT_NAME}/state_machine/external_instance
+    ${PROJECT_NAME}/state_machine/internal/initial
+    ${PROJECT_NAME}/state_machine/internal/junction
+    ${PROJECT_NAME}/state_machine/internal/state
+    ${PROJECT_NAME}/state_machine/internal_instance/initial
+    ${PROJECT_NAME}/state_machine/internal_instance/junction
+    ${PROJECT_NAME}/state_machine/internal_instance/state
     ${PROJECT_NAME}/struct
-    ${PROJECT_NAME}/component/empty
-    ${PROJECT_NAME}/component/active
-    ${PROJECT_NAME}/component/queued
-    ${PROJECT_NAME}/component/passive
 )
 
 register_fprime_deployment()

FppTest/state_machine/CMakeLists.txt

@@ -1,21 +1,3 @@
-set(SOURCE_FILES
-  "${CMAKE_CURRENT_LIST_DIR}/SmTest.cpp"
-  "${CMAKE_CURRENT_LIST_DIR}/SmTest.fpp"
-  "${CMAKE_CURRENT_LIST_DIR}/DeviceSm.cpp"
-  "${CMAKE_CURRENT_LIST_DIR}/HackSm.cpp"
-)
-set(MOD_DEPS Fw/Sm)
-
-register_fprime_module()
-
-set(UT_SOURCE_FILES
-  "${CMAKE_CURRENT_LIST_DIR}/SmTest.fpp"
-  "${CMAKE_CURRENT_LIST_DIR}/test/ut/SmTestTestMain.cpp"
-  "${CMAKE_CURRENT_LIST_DIR}/test/ut/SmTestTester.cpp"
-  "${CMAKE_CURRENT_LIST_DIR}/DeviceSm.cpp"
-  "${CMAKE_CURRENT_LIST_DIR}/HackSm.cpp"
-)
-
-set(UT_MOD_DEPS STest)
-set(UT_AUTO_HELPERS ON)
-register_fprime_ut()
+add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/external_instance/")
+add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/internal/")
+add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/internal_instance/")

FppTest/state_machine/README.md

@@ -0,0 +1,3 @@
+# state_machine
+
+Tests for FPP state machines.

FppTest/state_machine/external_instance/CMakeLists.txt

@@ -0,0 +1,20 @@
+set(SOURCE_FILES
+  "${CMAKE_CURRENT_LIST_DIR}/SmTest.cpp"
+  "${CMAKE_CURRENT_LIST_DIR}/SmTest.fpp"
+  "${CMAKE_CURRENT_LIST_DIR}/DeviceSm.cpp"
+  "${CMAKE_CURRENT_LIST_DIR}/HackSm.cpp"
+)
+set(MOD_DEPS Fw/Sm)
+
+register_fprime_module()
+
+set(UT_SOURCE_FILES
+  "${CMAKE_CURRENT_LIST_DIR}/SmTest.fpp"
+  "${CMAKE_CURRENT_LIST_DIR}/test/ut/SmTestTestMain.cpp"
+  "${CMAKE_CURRENT_LIST_DIR}/test/ut/SmTestTester.cpp"
+  "${CMAKE_CURRENT_LIST_DIR}/DeviceSm.cpp"
+  "${CMAKE_CURRENT_LIST_DIR}/HackSm.cpp"
+)
+set(UT_MOD_DEPS STest)
+set(UT_AUTO_HELPERS ON)
+register_fprime_ut()

FppTest/state_machine/SmTest.cpp → FppTest/state_machine/external_instance/SmTest.cpp

@@ -6,7 +6,7 @@
 
 #include <cstdio>
 
-#include "FppTest/state_machine/SmTest.hpp"
+#include "FppTest/state_machine/external_instance/SmTest.hpp"
 #include "Fw/Types/Assert.hpp"
 
 namespace FppTest {

FppTest/state_machine/SmTest.hpp → FppTest/state_machine/external_instance/SmTest.hpp

@@ -9,7 +9,7 @@
 
 #include <array>
 
-#include "FppTest/state_machine/SmTestComponentAc.hpp"
+#include "FppTest/state_machine/external_instance/SmTestComponentAc.hpp"
 #include "Fw/Types/String.hpp"
 
 namespace FppTest {

FppTest/state_machine/test/ut/SmTestTestMain.cpp → FppTest/state_machine/external_instance/test/ut/SmTestTestMain.cpp

@@ -2,7 +2,7 @@
 // SmTestTestMain.cpp
 // ----------------------------------------------------------------------
 
-#include "FppTest/state_machine/test/ut/SmTestTester.hpp"
+#include "FppTest/state_machine/external_instance/test/ut/SmTestTester.hpp"
 #include "Fw/Test/UnitTest.hpp"
 #include "STest/Random/Random.hpp"
 

FppTest/state_machine/test/ut/SmTestTester.cpp → FppTest/state_machine/external_instance/test/ut/SmTestTester.cpp

@@ -6,7 +6,7 @@
 
 #include <cstring>
 
-#include "FppTest/state_machine/test/ut/SmTestTester.hpp"
+#include "FppTest/state_machine/external_instance/test/ut/SmTestTester.hpp"
 #include "Fw/Types/ExternalString.hpp"
 #include "STest/Pick/Pick.hpp"
 

FppTest/state_machine/test/ut/SmTestTester.hpp → FppTest/state_machine/external_instance/test/ut/SmTestTester.hpp

@@ -8,7 +8,7 @@
 #define FppTest_SmTest_Tester_HPP
 
 #include "SmTestGTestBase.hpp"
-#include "FppTest/state_machine/SmTest.hpp"
+#include "FppTest/state_machine/external_instance/SmTest.hpp"
 #include "STest/Pick/Pick.hpp"
 
 namespace FppTest {

FppTest/state_machine/internal/CMakeLists.txt

@@ -0,0 +1,4 @@
+add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/choice/")
+add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/harness/")
+add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/initial/")
+add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/state/")

FppTest/state_machine/internal/README.md

@@ -0,0 +1,4 @@
+# state_machine/internal
+
+Tests for internal FPP state machines, i.e., state machines whose behavior
+is expressed in FPP.

FppTest/state_machine/internal/choice/Basic.cpp

@@ -0,0 +1,82 @@
+// ======================================================================
+//
+// \title  Basic.hpp
+// \author R. Bocchino
+// \brief  Test class for basic state machine with a choice (implementation)
+//
+// \copyright
+// Copyright 2024, by the California Institute of Technology.
+// ALL RIGHTS RESERVED. United States Government Sponsorship
+// acknowledged.
+//
+// ======================================================================
+
+#include <gtest/gtest.h>
+
+#include "FppTest/state_machine/internal/choice/Basic.hpp"
+#include "STest/STest/Pick/Pick.hpp"
+
+namespace FppTest {
+
+namespace SmChoice {
+
+Basic::Basic() : BasicStateMachineBase(), m_action_a_history(), m_action_b_history(), m_guard_g() {}
+
+void Basic::action_a(Signal signal) {
+    this->m_action_a_history.push(signal);
+}
+
+void Basic::action_b(Signal signal) {
+    this->m_action_b_history.push(signal);
+}
+
+bool Basic::guard_g(Signal signal) const {
+    return this->m_guard_g.call(signal);
+}
+
+void Basic::testTrue() {
+    this->m_action_a_history.clear();
+    this->m_action_b_history.clear();
+    this->m_guard_g.reset();
+    this->m_guard_g.setReturnValue(true);
+    const FwEnumStoreType id = SmHarness::Pick::stateMachineId();
+    this->initBase(id);
+    ASSERT_EQ(this->m_id, id);
+    ASSERT_EQ(this->getState(), State::S1);
+    ASSERT_EQ(this->m_guard_g.getCallHistory().getSize(), 0);
+    ASSERT_EQ(this->m_action_a_history.getSize(), 0);
+    ASSERT_EQ(this->m_action_b_history.getSize(), 0);
+    this->sendSignal_s();
+    this->sendSignal_s();
+    ASSERT_EQ(this->m_guard_g.getCallHistory().getSize(), 1);
+    ASSERT_EQ(this->m_guard_g.getCallHistory().getItemAt(0), Signal::s);
+    ASSERT_EQ(this->m_action_a_history.getSize(), 1);
+    ASSERT_EQ(this->m_action_a_history.getItemAt(0), Signal::s);
+    ASSERT_EQ(this->m_action_b_history.getSize(), 0);
+    ASSERT_EQ(this->getState(), State::S2);
+}
+
+void Basic::testFalse() {
+    this->m_action_a_history.clear();
+    this->m_action_b_history.clear();
+    this->m_guard_g.reset();
+    const FwEnumStoreType id = SmHarness::Pick::stateMachineId();
+    this->initBase(id);
+    ASSERT_EQ(this->m_id, id);
+    ASSERT_EQ(this->getState(), State::S1);
+    ASSERT_EQ(this->m_guard_g.getCallHistory().getSize(), 0);
+    ASSERT_EQ(this->m_action_a_history.getSize(), 0);
+    ASSERT_EQ(this->m_action_b_history.getSize(), 0);
+    this->sendSignal_s();
+    this->sendSignal_s();
+    ASSERT_EQ(this->m_guard_g.getCallHistory().getSize(), 1);
+    ASSERT_EQ(this->m_guard_g.getCallHistory().getItemAt(0), Signal::s);
+    ASSERT_EQ(this->m_action_a_history.getSize(), 0);
+    ASSERT_EQ(this->m_action_b_history.getSize(), 1);
+    ASSERT_EQ(this->m_action_b_history.getItemAt(0), Signal::s);
+    ASSERT_EQ(this->getState(), State::S3);
+}
+
+}  // namespace SmChoice
+
+}  // end namespace FppTest

FppTest/state_machine/internal/choice/Basic.fpp

@@ -0,0 +1,9 @@
+module FppTest {
+
+  module SmChoice {
+
+    include "include/Basic.fppi"
+
+  }
+
+}

FppTest/state_machine/internal/choice/Basic.hpp

@@ -0,0 +1,69 @@
+// ======================================================================
+//
+// \title  Basic.hpp
+// \author R. Bocchino
+// \brief  Test class for basic state machine with a choice (header)
+//
+// \copyright
+// Copyright 2024, by the California Institute of Technology.
+// ALL RIGHTS RESERVED. United States Government Sponsorship
+// acknowledged.
+//
+// ======================================================================
+
+#ifndef FppTest_State_Basic_HPP
+#define FppTest_State_Basic_HPP
+
+#include "FppTest/state_machine/internal/choice/BasicStateMachineAc.hpp"
+#include "FppTest/state_machine/internal/harness/Harness.hpp"
+
+namespace FppTest {
+
+namespace SmChoice {
+
+//! A basic state machine with a choice
+class Basic final : public BasicStateMachineBase {
+  public:
+    //! The history size
+    static constexpr FwSizeType historySize = 10;
+
+  public:
+    //! Constructor
+    Basic();
+
+  private:
+    //! Implementation of action a
+    void action_a(Signal signal  //!< The signal
+                  ) final;
+
+    //! Implementation of action b
+    void action_b(Signal signal  //!< The signal
+                  ) final;
+
+    //! Implementation of guard g
+    bool guard_g(Signal signal  //!< The signal
+    ) const final;
+
+  public:
+    //! Run the test with the true guard
+    void testTrue();
+
+    //! Run the test with the false guard
+    void testFalse();
+
+  private:
+    //! The history associated with action a
+    SmHarness::History<Signal, historySize> m_action_a_history;
+
+    //! The history associated with action b of Basic
+    SmHarness::History<Signal, historySize> m_action_b_history;
+
+    //! The guard g
+    SmHarness::NoArgGuard<Signal, historySize> m_guard_g;
+};
+
+}  // namespace SmChoice
+
+}  // end namespace FppTest
+
+#endif

FppTest/state_machine/internal/choice/BasicU32.cpp

@@ -0,0 +1,87 @@
+// ======================================================================
+//
+// \title  BasicU32.hpp
+// \author R. Bocchino
+// \brief  Test class for basic state machine with a U32 choice (implementation)
+//
+// \copyright
+// Copyright 2024, by the California Institute of Technology.
+// ALL RIGHTS RESERVED. United States Government Sponsorship
+// acknowledged.
+//
+// ======================================================================
+
+#include <gtest/gtest.h>
+
+#include "FppTest/state_machine/internal/choice/BasicU32.hpp"
+#include "STest/STest/Pick/Pick.hpp"
+
+namespace FppTest {
+
+namespace SmChoice {
+
+BasicU32::BasicU32() : BasicU32StateMachineBase(), m_action_a_history(), m_action_b_history(), m_guard_g() {}
+
+void BasicU32::action_a(Signal signal, U32 value) {
+    this->m_action_a_history.push(signal, value);
+}
+
+void BasicU32::action_b(Signal signal) {
+    this->m_action_b_history.push(signal);
+}
+
+bool BasicU32::guard_g(Signal signal, U32 value) const {
+    return this->m_guard_g.call(signal, value);
+}
+
+void BasicU32::testTrue() {
+    this->m_action_a_history.clear();
+    this->m_action_b_history.clear();
+    this->m_guard_g.reset();
+    this->m_guard_g.setReturnValue(true);
+    const FwEnumStoreType id = SmHarness::Pick::stateMachineId();
+    this->initBase(id);
+    ASSERT_EQ(this->m_id, id);
+    ASSERT_EQ(this->getState(), State::S1);
+    ASSERT_EQ(this->m_guard_g.getCallHistory().getSize(), 0);
+    ASSERT_EQ(this->m_action_a_history.getSize(), 0);
+    ASSERT_EQ(this->m_action_b_history.getSize(), 0);
+    const U32 value = STest::Pick::any();
+    this->sendSignal_s(value);
+    this->sendSignal_s(value);
+    ASSERT_EQ(this->m_guard_g.getCallHistory().getSize(), 1);
+    ASSERT_EQ(this->m_guard_g.getCallHistory().getSignals().getItemAt(0), Signal::s);
+    ASSERT_EQ(this->m_guard_g.getCallHistory().getValues().getItemAt(0), value);
+    ASSERT_EQ(this->m_action_a_history.getSize(), 1);
+    ASSERT_EQ(this->m_action_a_history.getSignals().getItemAt(0), Signal::s);
+    ASSERT_EQ(this->m_action_a_history.getValues().getItemAt(0), value);
+    ASSERT_EQ(this->m_action_b_history.getSize(), 0);
+    ASSERT_EQ(this->getState(), State::S2);
+}
+
+void BasicU32::testFalse() {
+    this->m_action_a_history.clear();
+    this->m_action_b_history.clear();
+    this->m_guard_g.reset();
+    const FwEnumStoreType id = SmHarness::Pick::stateMachineId();
+    this->initBase(id);
+    ASSERT_EQ(this->m_id, id);
+    ASSERT_EQ(this->getState(), State::S1);
+    ASSERT_EQ(this->m_guard_g.getCallHistory().getSize(), 0);
+    ASSERT_EQ(this->m_action_a_history.getSize(), 0);
+    ASSERT_EQ(this->m_action_b_history.getSize(), 0);
+    const U32 value = STest::Pick::any();
+    this->sendSignal_s(value);
+    this->sendSignal_s(value);
+    ASSERT_EQ(this->m_guard_g.getCallHistory().getSize(), 1);
+    ASSERT_EQ(this->m_guard_g.getCallHistory().getSignals().getItemAt(0), Signal::s);
+    ASSERT_EQ(this->m_guard_g.getCallHistory().getValues().getItemAt(0), value);
+    ASSERT_EQ(this->m_action_a_history.getSize(), 0);
+    ASSERT_EQ(this->m_action_b_history.getSize(), 1);
+    ASSERT_EQ(this->m_action_b_history.getItemAt(0), Signal::s);
+    ASSERT_EQ(this->getState(), State::S3);
+}
+
+}  // namespace SmChoice
+
+}  // end namespace FppTest

FppTest/state_machine/internal/choice/BasicU32.fpp

@@ -0,0 +1,9 @@
+module FppTest {
+
+  module SmChoice {
+
+    include "include/BasicU32.fppi"
+
+  }
+
+}