Add MeterReadingControllerTest

Author: superxcgm

rest/configuration.h

@@ -6,6 +6,8 @@
 
 #include "generator.h"
 
+#include <unordered_map>
+
 constexpr auto DR_EVILS_DARK_ENERGY_ENERGY_SUPPLIER = "Dr Evil's Dark Energy";
 constexpr auto THE_GREEN_ECO_ENERGY_SUPPLIER = "The Green Eco";
 constexpr auto POWER_FOR_EVERYONE_ENERGY_SUPPLIER = "Power for Everyone";

rest/controller/MeterReadingController.h

@@ -64,6 +64,9 @@ class MeterReadingController {
     auto body = nlohmann::json::parse(req.body());
     auto smartMeterId = body["smartMeterId"];
     std::vector<ElectricityReading> electricityReadings;
+    if (!IsMeterReadingsValid(smartMeterId, body["electricityReadings"])) {
+      return {http::status::internal_server_error, 11};
+    }
     for (auto &electricityReading : body["electricityReadings"]) {
       electricityReadings.emplace_back(detail::fromRfc3339(electricityReading["time"]), electricityReading["reading"]);
     }
@@ -74,6 +77,13 @@ class MeterReadingController {
  private:
   ElectricityReadingService &electricityReadingService;
   MeterReadingService &meterReadingService;
+  bool IsMeterReadingsValid(const nlohmann::basic_json<> &smartMeterId,
+                            const nlohmann::basic_json<> &electricityReadings) {
+    if (smartMeterId.type() == nlohmann::json::value_t::null || electricityReadings.empty()) {
+      return false;
+    }
+    return true;
+  }
 };
 
 #endif  // DEVELOPER_JOYOFENERGY_CPP_BEAST_METERREADINGCONTROLLER_H

rest/domain/ElectricityReading.h

@@ -14,6 +14,9 @@ class ElectricityReading {
 
   size_t getReading() const { return reading; }
 
+  bool operator==(const ElectricityReading& rhs) const { return time == rhs.time && reading == rhs.reading; }
+  bool operator!=(const ElectricityReading& rhs) const { return !(rhs == *this); }
+
  private:
   time_point_type time;
   size_t reading;

test/CMakeLists.txt

@@ -4,4 +4,9 @@ find_package(GTest REQUIRED)
 find_package(nlohmann_json REQUIRED)
 target_link_libraries(endpoint_test PRIVATE GTest::gmock_main nlohmann_json::nlohmann_json rest)
 
-add_test(endpoint_test endpoint_test)
+add_executable(controller_test)
+target_sources(controller_test PRIVATE controller/MeterReadingControllerTest.cpp)
+target_link_libraries(controller_test PRIVATE GTest::gmock_main nlohmann_json::nlohmann_json rest)
+
+add_test(endpoint_test endpoint_test)
+add_test(controller_test controller_test)

test/controller/MeterReadingControllerTest.cpp

@@ -0,0 +1,137 @@
+#include <gmock/gmock.h>
+#include <rest/configuration.h>
+#include <rest/controller/MeterReadingController.h>
+
+#include <boost/beast/http.hpp>
+#include <nlohmann/json.hpp>
+
+using nlohmann::json;
+using ::testing::Eq;
+
+namespace http = boost::beast::http;
+
+class MeterReadingControllerTest : public ::testing::Test {
+ protected:
+  std::unordered_map<std::string, std::vector<ElectricityReading>> meterAssociatedReadings;
+  ElectricityReadingService electricityReadingService{meterAssociatedReadings};
+  MeterReadingService meterReadingService{meterAssociatedReadings};
+  MeterReadingController controller{electricityReadingService, meterReadingService};
+
+  http::request<http::string_body> BuildRequest(http::verb verb, boost::string_view target, const json &request_body) {
+    http::request<http::string_body> req{http::verb::post, "/readings/store", 11};
+    req.set(http::field::content_type, "application/json");
+    req.body() = request_body.dump();
+    req.prepare_payload();
+    return req;
+  }
+};
+
+TEST_F(MeterReadingControllerTest, StoreShouldResponseWithErrorGivenNoMeterIdIsSupplied) {
+  auto req = BuildRequest(http::verb::post, "/readings/store", R"({})"_json);
+  std::vector<std::string> queries;
+
+  auto response = controller.Store(req, queries);
+
+  EXPECT_THAT(response.result(), Eq(http::status::internal_server_error));
+}
+
+TEST_F(MeterReadingControllerTest, StoreShouldResponseWithErrorGivenEmptyMeterReading) {
+  json body = R"({
+            "smartMeterId": "smart-meter-0",
+            "electricityReadings": []
+    })"_json;
+  auto req = BuildRequest(http::verb::post, "/readings/store", body);
+  std::vector<std::string> queries;
+
+  auto response = controller.Store(req, queries);
+
+  EXPECT_THAT(response.result(), Eq(http::status::internal_server_error));
+}
+
+TEST_F(MeterReadingControllerTest, StoreShouldResponseWithErrorGivenNoMeterReadingIsSupplied) {
+  json body = R"({
+            "smartMeterId": "smart-meter-0"
+    })"_json;
+  auto req = BuildRequest(http::verb::post, "/readings/store", body);
+  std::vector<std::string> queries;
+
+  auto response = controller.Store(req, queries);
+
+  EXPECT_THAT(response.result(), Eq(http::status::internal_server_error));
+}
+
+TEST_F(MeterReadingControllerTest, StoreShouldStoreGivenMultipleBatchesOfMeterReadings) {
+  json body1 = R"({
+            "smartMeterId": "smart-meter-0",
+            "electricityReadings": [
+                    {
+                            "time": "2021-08-18T06:42:15.725202Z",
+                            "reading": 1
+                    }
+            ]
+    })"_json;
+  json body2 = R"({
+            "smartMeterId": "smart-meter-0",
+            "electricityReadings": [
+                    {
+                            "time": "2021-08-18T06:44:15.725202Z",
+                            "reading": 2
+                    }
+            ]
+    })"_json;
+  auto req1 = BuildRequest(http::verb::post, "/readings/store", body1);
+  auto req2 = BuildRequest(http::verb::post, "/readings/store", body2);
+  std::vector<std::string> queries;
+
+  controller.Store(req1, queries);
+  controller.Store(req2, queries);
+
+  std::vector<ElectricityReading> expectedElectricityReadings = {
+      {detail::fromRfc3339("2021-08-18T06:42:15.725202Z"), 1},
+      {detail::fromRfc3339("2021-08-18T06:44:15.725202Z"), 2}
+  };
+
+  EXPECT_THAT(meterReadingService.getReadings("smart-meter-0"), Eq(expectedElectricityReadings));
+}
+
+TEST_F(MeterReadingControllerTest, StoreShouldStoreAssociatedWithUserGivenMeterReadingsAssociatedWithTheUser) {
+  json body1 = R"({
+            "smartMeterId": "smart-meter-0",
+            "electricityReadings": [
+                    {
+                            "time": "2021-08-18T06:42:15.725202Z",
+                            "reading": 1
+                    }
+            ]
+    })"_json;
+  json body2 = R"({
+            "smartMeterId": "smart-meter-1",
+            "electricityReadings": [
+                    {
+                            "time": "2021-08-18T06:44:15.725202Z",
+                            "reading": 2
+                    }
+            ]
+    })"_json;
+  auto req1 = BuildRequest(http::verb::post, "/readings/store", body1);
+  auto req2 = BuildRequest(http::verb::post, "/readings/store", body2);
+  std::vector<std::string> queries;
+
+  controller.Store(req1, queries);
+  controller.Store(req2, queries);
+
+  std::vector<ElectricityReading> expectedElectricityReadings = {
+      {detail::fromRfc3339("2021-08-18T06:42:15.725202Z"), 1},
+  };
+
+  EXPECT_THAT(meterReadingService.getReadings("smart-meter-0"), Eq(expectedElectricityReadings));
+}
+
+TEST_F(MeterReadingControllerTest, ReadShouldReturnNotFoundGivenMeterIdThatIsNotRecognised) {
+  auto req = BuildRequest(http::verb::post, "/readings/store", R"({})"_json);
+  std::vector<std::string> queries = {"smart-meter-0"};
+
+  auto response = controller.Read(req, queries);
+
+  EXPECT_THAT(response.result(), Eq(http::status::not_found));
+}