From 5ba499a99773309c049a4d3b00bbdd293a33919e Mon Sep 17 00:00:00 2001
From: jmcarcell <jmcarcell@users.noreply.github.com>
Date: Wed, 7 Aug 2024 15:50:08 +0200
Subject: [PATCH] Improve comments and remove duplicated include

---
 k4FWCore/components/MetadataSvc.cpp           |  2 --
 .../ExampleFunctionalMetadataConsumer.cpp     | 20 +++++++++++--------
 2 files changed, 12 insertions(+), 10 deletions(-)

diff --git a/k4FWCore/components/MetadataSvc.cpp b/k4FWCore/components/MetadataSvc.cpp
index eb672ae4..9c0b82f5 100644
--- a/k4FWCore/components/MetadataSvc.cpp
+++ b/k4FWCore/components/MetadataSvc.cpp
@@ -25,8 +25,6 @@
 #include <GaudiKernel/IDataProviderSvc.h>
 #include <GaudiKernel/Service.h>
 
-#include "podio/Frame.h"
-
 StatusCode MetadataSvc::initialize() {
   StatusCode sc = Service::initialize();
   if (sc.isFailure()) {
diff --git a/test/k4FWCoreTest/src/components/ExampleFunctionalMetadataConsumer.cpp b/test/k4FWCoreTest/src/components/ExampleFunctionalMetadataConsumer.cpp
index c2cae5c6..11bc49e4 100644
--- a/test/k4FWCoreTest/src/components/ExampleFunctionalMetadataConsumer.cpp
+++ b/test/k4FWCoreTest/src/components/ExampleFunctionalMetadataConsumer.cpp
@@ -32,23 +32,27 @@ struct ExampleFunctionalMetadataConsumer final : k4FWCore::Consumer<void(const e
   StatusCode initialize() override {
     m_particleNum = k4FWCore::getParameter<int>("NumberOfParticles", this).value_or(0);
     if (m_particleNum != 3) {
-      error() << "ExampleInt is not 3" << endmsg;
+      error() << "NumberOfParticles expected to be 3 but is " << m_particleNum << endmsg;
       return StatusCode::FAILURE;
     }
 
     m_particleTime = k4FWCore::getParameter<float>("ParticleTime", this).value_or(0);
     if (m_particleTime != 1.5) {
-      error() << "ExampleFloat is not 1.5" << endmsg;
+      error() << "ParticleTime expected to be 1.5 but is " << m_particleTime << endmsg;
       return StatusCode::FAILURE;
     }
     m_PDGValues = k4FWCore::getParameter<std::vector<int>>("PDGValues", this).value_or(std::vector<int>{});
     if (m_PDGValues != std::vector<int>{1, 2, 3, 4}) {
-      error() << "ExampleVector is not {1, 2, 3, 4}" << endmsg;
+      error() << "PDGValues expected to be {1, 2, 3, 4} but is {";
+      for (const auto& pdg : m_PDGValues) {
+        error() << pdg << ", ";
+      }
+      error() << "}" << endmsg;
       return StatusCode::FAILURE;
     }
     m_metadataString = k4FWCore::getParameter<std::string>("MetadataString", this).value_or("");
     if (m_metadataString != "hello") {
-      error() << "ExampleString is not 'hello'" << endmsg;
+      error() << "MetadataString expected to be 'hello' but is '" << m_metadataString << "'" << endmsg;
       return StatusCode::FAILURE;
     }
     return StatusCode::SUCCESS;
@@ -64,11 +68,11 @@ struct ExampleFunctionalMetadataConsumer final : k4FWCore::Consumer<void(const e
     int i = 0;
     for (const auto& particle : input) {
       if (particle.getTime() != m_particleTime) {
-        error() << "Particle time is not " << m_particleTime << endmsg;
+        error() << "ParticleTime expected to be " << m_particleTime << " but is " << particle.getTime() << endmsg;
         return;
       }
       if (particle.getPDG() != m_PDGValues[i]) {
-        error() << "Particle PDG is not " << m_PDGValues[i] << endmsg;
+        error() << "PDGValues expected to be " << m_PDGValues[i] << " but is " << particle.getPDG() << endmsg;
         return;
       }
       ++i;
@@ -78,7 +82,7 @@ struct ExampleFunctionalMetadataConsumer final : k4FWCore::Consumer<void(const e
   StatusCode finalize() override {
     auto particleNum = k4FWCore::getParameter<int>("NumberOfParticles", this).value_or(-1);
     if (particleNum != 3) {
-      error() << "Metadata parameter NumberOfParticles is not 3" << endmsg;
+      error() << "NumberOfParticles expected to be 3 but is " << particleNum << endmsg;
       return StatusCode::FAILURE;
     }
 
@@ -91,7 +95,7 @@ struct ExampleFunctionalMetadataConsumer final : k4FWCore::Consumer<void(const e
 
     auto finalizeMetadataInt = k4FWCore::getParameter<int>("FinalizeMetadataInt", this).value_or(-1);
     if (finalizeMetadataInt != 10) {
-      error() << "FinalizeMetadataInt is not 10" << endmsg;
+      error() << "FinalizeMetadataInt expected to be 10 but is " << finalizeMetadataInt << endmsg;
       return StatusCode::FAILURE;
     }