test: add integration_test.flash_tested

.github/workflows/ci.yml

@@ -27,19 +27,19 @@ jobs:
         with:
           configurePreset: "host"
           buildPreset: "host-Debug-WithPackage"
-          #testPreset: "host"
+          testPreset: "host"
           configurePresetAdditionalArgs: "['-DCMAKE_C_COMPILER_LAUNCHER=sccache', '-DCMAKE_CXX_COMPILER_LAUNCHER=sccache']"
       - uses: actions/upload-artifact@50769540e7f4bd5e21e526ee35c689e35e0d6874 # v4.4.0
         with:
           name: hal_st
           path: build/host/hal_st-*-Linux.tar.gz
           if-no-files-found: error
-      #- name: Upload test logs
-      #  if: ${{ failure() }}
-      #  uses: actions/upload-artifact@50769540e7f4bd5e21e526ee35c689e35e0d6874 # v4.4.0
-      #  with:
-      #    name: test-logs
-      #    path: build/host/Testing/Temporary/
+      - name: Upload test logs
+        if: ${{ failure() }}
+        uses: actions/upload-artifact@50769540e7f4bd5e21e526ee35c689e35e0d6874 # v4.4.0
+        with:
+          name: test-logs
+          path: build/host/Testing/Temporary/
   host_build_test:
     name: Host Build & Test
     runs-on: ${{ matrix.os }}
@@ -58,14 +58,14 @@ jobs:
         with:
           configurePreset: "host-single-Debug"
           buildPreset: "host-single-Debug"
-          #testPreset: "host-single-Debug"
+          testPreset: "host-single-Debug"
           configurePresetAdditionalArgs: "['-DCMAKE_C_COMPILER_LAUNCHER=sccache', '-DCMAKE_CXX_COMPILER_LAUNCHER=sccache']"
-      #- name: Upload test logs
-      #  if: ${{ failure() }}
-      #  uses: actions/upload-artifact@50769540e7f4bd5e21e526ee35c689e35e0d6874 # v4.4.0
-      #  with:
-      #    name: test-logs
-      #    path: build/host/Testing/Temporary/
+      - name: Upload test logs
+        if: ${{ failure() }}
+        uses: actions/upload-artifact@50769540e7f4bd5e21e526ee35c689e35e0d6874 # v4.4.0
+        with:
+          name: test-logs
+          path: build/host/Testing/Temporary/
   embedded_build:
     name: Embedded Build
     runs-on: ubuntu-latest

CMakeLists.txt

@@ -5,12 +5,19 @@ if (CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
 endif()
 
 option(CMAKE_COMPILE_WARNING_AS_ERROR "Enable warnings-as-error" ON)
+option(HALST_BUILD_TESTS "Enable building the tests" Off)
 option(HALST_INCLUDE_DEFAULT_INIT "Include default initialization code; turn off when providing custom initialization" ON)
 option(HALST_BUILD_EXAMPLES "Enable build of the examples" OFF)
 option(HALST_BUILD_EXAMPLES_FREERTOS "Enable build of the FreeRTOS example" OFF)
 set(HALST_XML_GPIO "" CACHE STRING "XML GPIO table")
 set(HALST_XML_STM32 "" CACHE STRING "XML STM32 table")
 
+if (HALST_BUILD_TESTS)
+    # CTest cannot be included before the first project() statement, but amp-embedded-infa-lib
+    # needs to see that test utilities need to be built.
+    set(BUILD_TESTING On)
+endif()
+
 if (HALST_STANDALONE)
     set(EMIL_INCLUDE_FREERTOS ${HALST_BUILD_EXAMPLES_FREERTOS})
 
@@ -49,6 +56,11 @@ else()
     set(HALST_EXCLUDE_FROM_ALL "EXCLUDE_FROM_ALL")
 endif()
 
+if (HALST_BUILD_TESTS)
+    include(CTest)
+    emil_enable_testing()
+endif()
+
 add_subdirectory(st)
 add_subdirectory(hal_st)
 add_subdirectory(hal_st_lwip)

CMakePresets.json

@@ -17,7 +17,8 @@
       "inherits": "defaults",
       "cacheVariables": {
         "CMAKE_CONFIGURATION_TYPES": "Debug;Release;RelWithDebInfo;MinSizeRel",
-        "EMIL_BUILD_ECHO_COMPILERS": true
+        "EMIL_BUILD_ECHO_COMPILERS": true,
+        "HALST_BUILD_TESTS": true
       },
       "generator": "Ninja Multi-Config"
     },
@@ -26,15 +27,17 @@
       "displayName": "Configuration for Host Tooling and Tests, Single Config Generator, Debug",
       "inherits": "defaults",
       "cacheVariables": {
-        "CMAKE_BUILD_TYPE": "Debug"
+        "CMAKE_BUILD_TYPE": "Debug",
+        "HALST_BUILD_TESTS": true
       }
     },
     {
       "name": "host-single-MinSizeRel",
       "displayName": "Configuration for Host Tooling and Tests, Single Config Generator, MinSizeRel",
       "inherits": "defaults",
       "cacheVariables": {
-        "CMAKE_BUILD_TYPE": "MinSizeRel"
+        "CMAKE_BUILD_TYPE": "MinSizeRel",
+        "HALST_BUILD_TESTS": true
       }
     },
     {

hal_st/stm32fxxx/FlashInternalStm.cpp

@@ -128,7 +128,7 @@ namespace hal
     }
 #endif
 
-    FlashInternalStm::FlashInternalStm(infra::MemoryRange<uint32_t> sectorSizes, infra::ConstByteRange flashMemory)
+    FlashInternalStm::FlashInternalStm(infra::MemoryRange<const uint32_t> sectorSizes, infra::ConstByteRange flashMemory)
         : FlashInternalStmBase(flashMemory)
         , sectorSizes(sectorSizes)
     {}

hal_st/stm32fxxx/FlashInternalStm.hpp

@@ -33,15 +33,15 @@ namespace hal
         : public FlashInternalStmBase
     {
     public:
-        FlashInternalStm(infra::MemoryRange<uint32_t> sectorSizes, infra::ConstByteRange flashMemory);
+        FlashInternalStm(infra::MemoryRange<const uint32_t> sectorSizes, infra::ConstByteRange flashMemory);
 
         uint32_t NumberOfSectors() const override;
         uint32_t SizeOfSector(uint32_t sectorIndex) const override;
         uint32_t SectorOfAddress(uint32_t address) const override;
         uint32_t AddressOfSector(uint32_t sectorIndex) const override;
 
     private:
-        infra::MemoryRange<uint32_t> sectorSizes;
+        infra::MemoryRange<const uint32_t> sectorSizes;
     };
 
     class FlashHomogeneousInternalStm

integration_test/CMakeLists.txt

@@ -2,3 +2,4 @@ add_subdirectory(logic)
 add_subdirectory(tested)
 add_subdirectory(tester)
 add_subdirectory(runner)
+add_subdirectory(flasher)

integration_test/flasher/CMakeLists.txt

@@ -0,0 +1,21 @@
+add_executable(integration_test.flasher)
+emil_build_for(integration_test.flasher HOST All)
+
+target_sources(integration_test.flasher PRIVATE
+    Main.cpp
+)
+
+target_link_libraries(integration_test.flasher PRIVATE
+    args
+    integration_test.logic
+    hal.generic
+    services.network_instantiations
+)
+
+if (EMIL_BUILD_WIN)
+    target_link_libraries(integration_test.flasher PRIVATE hal.windows)
+endif()
+
+if (EMIL_BUILD_UNIX OR EMIL_BUILD_DARWIN)
+    target_link_libraries(integration_test.flasher PRIVATE hal.unix)
+endif()

integration_test/flasher/Main.cpp

@@ -0,0 +1,130 @@
+#include "args.hxx"
+#include "generated/echo/Testing.pb.hpp"
+#include "generated/echo/TracingFlash.pb.hpp"
+#include "generated/echo/TracingTesting.pb.hpp"
+#include "hal/generic/FileSystemGeneric.hpp"
+#include "hal/generic/TimerServiceGeneric.hpp"
+#include "integration_test/logic/Flash.hpp"
+#include "services/network_instantiations/EchoInstantiation.hpp"
+#include "services/network_instantiations/NetworkAdapter.hpp"
+#include "services/tracer/GlobalTracer.hpp"
+#include "services/tracer/TracerOnIoOutputInfrastructure.hpp"
+
+namespace
+{
+    const std::array<uint32_t, 12> stm32f767SectorSizes{ { 32 * 1024,
+        32 * 1024,
+        32 * 1024,
+        32 * 1024,
+        128 * 1024,
+        256 * 1024,
+        256 * 1024,
+        256 * 1024,
+        256 * 1024,
+        256 * 1024,
+        256 * 1024,
+        256 * 1024 } };
+}
+
+class FirmwareSender
+{
+public:
+    FirmwareSender(const std::vector<uint8_t>& firmware, services::Echo& echo)
+        : firmware(firmware)
+        , flash(echo, infra::MakeRange(stm32f767SectorSizes))
+        , tester(echo)
+    {
+        tester.RequestSend([this]()
+            {
+                tester.SetTestedMode(testing::TestedMode::reset);
+                tester.RequestSend([this]()
+                    {
+                        tester.SetTestedMode(testing::TestedMode::programming);
+
+                        services::GlobalTracer().Trace() << "Erasing chip...";
+                        flash.EraseAll([this]()
+                            {
+                                services::GlobalTracer().Trace() << "Writing firmware...";
+                                flash.WriteBuffer(infra::MakeRange(this->firmware), 0, [this]()
+                                    {
+                                        services::GlobalTracer().Trace() << "Uploading done";
+                                        done = true;
+                                    });
+                            });
+                    });
+            });
+    }
+
+    bool Done() const
+    {
+        return done;
+    }
+
+private:
+    std::vector<uint8_t> firmware;
+    application::FlashProxy flash;
+    testing::TesterProxy tester;
+    bool done = false;
+
+    infra::TimerSingleShot timeoutTimer{ std::chrono::minutes(2), [this]()
+        {
+            done = true;
+        } };
+};
+
+struct FlashTracer
+{
+    FlashTracer(services::TracingEchoOnStreams& echoTracer)
+        : testerTracer(echoTracer)
+        , testerObserverTracer(echoTracer)
+        , flashTracer(echoTracer)
+        , flashResultTracer(echoTracer)
+    {}
+
+    testing::TesterTracer testerTracer;
+    testing::TesterObserverTracer testerObserverTracer;
+    flash::FlashTracer flashTracer;
+    flash::FlashResultTracer flashResultTracer;
+};
+
+int main(int argc, char** argv)
+{
+    args::ArgumentParser parser("Flasher");
+    args::Group positionals(parser, "Positional arguments:");
+    args::Positional<std::string> targetArgument(positionals, "target", "COM port or hostname", args::Options::Required);
+    args::Positional<std::string> firmwareArgument(positionals, "firmware", "Binary firmware with which the target attached to Postmaster is upgraded");
+    args::HelpFlag help(parser, "help", "display this help menu.", { 'h', "help" });
+
+    try
+    {
+        parser.ParseCLI(argc, argv);
+
+        static hal::TimerServiceGeneric timerService;
+        static main_::TracerOnIoOutputInfrastructure tracer;
+        static main_::NetworkAdapter network;
+        static hal::FileSystemGeneric fileSystem;
+
+        auto firmware = firmwareArgument ? fileSystem.ReadBinaryFile(args::get(firmwareArgument)) : std::vector<uint8_t>{};
+        auto [echo, echoTracer] = application::OpenTracingEcho(args::get(targetArgument), network.ConnectionFactoryWithNameResolver(), tracer.tracer);
+
+        FlashTracer flashTracer(*echoTracer);
+        FirmwareSender sender(firmware, *echo);
+
+        network.ExecuteUntil([&]()
+            {
+                return sender.Done();
+            });
+    }
+    catch (const args::Help&)
+    {
+        std::cout << parser;
+        return 1;
+    }
+    catch (const std::exception& ex)
+    {
+        std::cout << ex.what() << std::endl;
+        return 1;
+    }
+
+    return 0;
+}

integration_test/logic/CMakeLists.txt

@@ -5,8 +5,11 @@ target_include_directories(integration_test.logic PUBLIC
 )
 
 protocol_buffer_echo_cpp(integration_test.logic Testing.proto)
+protocol_buffer_echo_cpp(integration_test.logic Flash.proto)
 
 target_sources(integration_test.logic PRIVATE
+    Flash.cpp
+    Flash.hpp
     Gpio.cpp
     Gpio.hpp
     Peripheral.cpp
@@ -23,3 +26,5 @@ target_link_libraries(integration_test.logic PUBLIC
     services.util
     protobuf.echo
 )
+
+add_subdirectory(test)