[tests] mock convert_to_localtime() to print in UTC time in tests

Author: sharder996

tests/mock_format_utils.h

@@ -0,0 +1,38 @@
+/*
+ * Copyright (C) Canonical, Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#ifndef MULTIPASS_MOCK_FORMAT_UTILS_H
+#define MULTIPASS_MOCK_FORMAT_UTILS_H
+
+#include "mock_singleton_helpers.h"
+
+#include <multipass/cli/format_utils.h>
+
+namespace multipass::test
+{
+class MockFormatUtils : public FormatUtils
+{
+public:
+    using FormatUtils::FormatUtils;
+
+    MOCK_METHOD(std::string, convert_to_localtime, (const google::protobuf::Timestamp&), (const, override));
+
+    MP_MOCK_SINGLETON_BOILERPLATE(MockFormatUtils, FormatUtils);
+};
+} // namespace multipass::test
+
+#endif // MULTIPASS_MOCK_FORMAT_UTILS_H

tests/test_output_formatter.cpp

@@ -16,6 +16,7 @@
  */
 
 #include "common.h"
+#include "mock_format_utils.h"
 #include "mock_settings.h"
 
 #include <multipass/cli/csv_formatter.h>
@@ -748,6 +749,11 @@ class BaseFormatterSuite : public testing::Test
         // The tests expected output are for the default C locale
         std::locale::global(std::locale("C"));
         EXPECT_CALL(mock_settings, get(Eq(mp::petenv_key))).WillRepeatedly(Return("pet"));
+
+        // Timestamps in tests need to be in a consistent locale
+        EXPECT_CALL(mock_format_utils, convert_to_localtime(_)).WillRepeatedly([](const auto timestamp) {
+            return google::protobuf::util::TimeUtil::ToString(timestamp);
+        });
     }
 
     ~BaseFormatterSuite()
@@ -759,6 +765,9 @@ class BaseFormatterSuite : public testing::Test
     mpt::MockSettings::GuardedMock mock_settings_injection = mpt::MockSettings::inject<StrictMock>();
     mpt::MockSettings& mock_settings = *mock_settings_injection.first;
 
+    mpt::MockFormatUtils::GuardedMock mock_format_utils_injection = mpt::MockFormatUtils::inject<NiceMock>();
+    mpt::MockFormatUtils& mock_format_utils = *mock_format_utils_injection.first;
+
 private:
     std::locale saved_locale;
 };