Api server test for dispatch operator #128

ACEmilG · 2018-04-04T14:58:19Z

This is a fresh attempt at testing the API server. See PR #123 for previous try.

igorpeshansky · 2018-04-05T03:47:52Z

test/api_server_unittest.cc

+};
+
+TEST_F(ApiServerTest, BasicDispacher) {
+  BasicDispatcher();


Hmm... Do you have to put the whole test into a static function in the fixture? Would it make more sense to add functions to create and invoke the dispatcher instead? Also below.

The problem is that HttpServer, Handler, HandlerMap, and even Dispatcher, are all declared private. We could attempt to pull out small portions of the test, but that seems confusing and difficult without any gain.

It should be enough to expose a Dispatcher test factory and an invoker, e.g.:

class ApiServerTest : public ::testing::Test { protected: using Dispatcher = MetadataApiServer::Dispatcher; std::unique_ptr<Dispatcher> CreateDispatcher( const std::map<std::pair<std::string, std::string>, std::function<void()>>& handlers) { Dispatcher::HandlerMap handler_map; for (const auto& element : handlers) { std::function<void()> handler = element.second; handler_map.emplace(element.first, [handler]( const MetadataApiServer::HttpServer::request& request, std::shared_ptr<MetadataApiServer::HttpServer::connection> conn) { handler(); }); } return std::unique_ptr<Dispatcher>(new Dispatcher(handler_map, false)); } void InvokeDispatcher( const std:: unique_ptr<Dispatcher>& dispatcher, const std::string& method, const std::string& path) { MetadataApiServer::HttpServer::request request; request.method = method; request.destination = path; (*dispatcher)(request, nullptr); }

Then you can use the following in the test, e.g.:

bool handler_called; std:: unique_ptr<Dispatcher> dispatcher = CreateDispatcher({ {{"GET", "/testPath/"}, [&handler_called]() { handler_called = true; }}, }); InvokeDispatcher(dispatcher, "GET", "/testPathFoo/"); EXPECT_FALSE(handler_called); InvokeDispatcher(dispatcher, "GET", "/test/"); EXPECT_FALSE(handler_called); InvokeDispatcher(dispatcher, "GET", "/testFooPath/"); EXPECT_FALSE(handler_called);

Very cool, changed, much better.

igorpeshansky · 2018-04-05T03:52:06Z

test/store_unittest.cc

 protected:
  MetadataStoreTest() : config(), store(config) {}

+  std::map<MonitoredResource, MetadataStore::Metadata> GetMetadataMap() const {


Why is this needed? Isn't GetMetadataMap public?

Backed out these changes - sorry about that, I should have remembered before pushing.

igorpeshansky · 2018-04-10T02:09:31Z

test/api_server_unittest.cc

+};
+
+TEST_F(ApiServerTest, BasicDispacher) {
+  BasicDispatcher();


It should be enough to expose a Dispatcher test factory and an invoker, e.g.:

class ApiServerTest : public ::testing::Test { protected: using Dispatcher = MetadataApiServer::Dispatcher; std::unique_ptr<Dispatcher> CreateDispatcher( const std::map<std::pair<std::string, std::string>, std::function<void()>>& handlers) { Dispatcher::HandlerMap handler_map; for (const auto& element : handlers) { std::function<void()> handler = element.second; handler_map.emplace(element.first, [handler]( const MetadataApiServer::HttpServer::request& request, std::shared_ptr<MetadataApiServer::HttpServer::connection> conn) { handler(); }); } return std::unique_ptr<Dispatcher>(new Dispatcher(handler_map, false)); } void InvokeDispatcher( const std:: unique_ptr<Dispatcher>& dispatcher, const std::string& method, const std::string& path) { MetadataApiServer::HttpServer::request request; request.method = method; request.destination = path; (*dispatcher)(request, nullptr); }

Then you can use the following in the test, e.g.:

bool handler_called; std:: unique_ptr<Dispatcher> dispatcher = CreateDispatcher({ {{"GET", "/testPath/"}, [&handler_called]() { handler_called = true; }}, }); InvokeDispatcher(dispatcher, "GET", "/testPathFoo/"); EXPECT_FALSE(handler_called); InvokeDispatcher(dispatcher, "GET", "/test/"); EXPECT_FALSE(handler_called); InvokeDispatcher(dispatcher, "GET", "/testFooPath/"); EXPECT_FALSE(handler_called);

igorpeshansky · 2018-04-10T03:55:36Z

test/api_server_unittest.cc

+class ApiServerTest : public ::testing::Test {
+ protected:
+  static void BasicDispatcher() {
+    bool handler_called;


Did you forget to initialize this? Also below.

igorpeshansky · 2018-04-10T05:32:48Z

src/api_server.h


 private:
+  friend class ApiServerTest;
+


There is actually a bug in line 43 of api_server.cc — reverse iterators should still be incremented with ++. Can you please change --it to ++it?

igorpeshansky · 2018-04-10T05:33:25Z

src/api_server.h


 private:
+  friend class ApiServerTest;
+


Another thing we can clean up here is making both operator() and log() const in Dispatcher. Can you please do this?

igorpeshansky

This is looking better. Some more comments.

igorpeshansky · 2018-04-10T16:42:01Z

test/api_server_unittest.cc

+  }
+
+  void InvokeDispatcher(
+      const std:: unique_ptr<Dispatcher>& dispatcher,


Sigh, I thought I've caught them all... That's what I get for typing in code on my phone.
Let's remove the space after the ::.

Sorry - I should have caught this myself

igorpeshansky · 2018-04-10T16:45:47Z

test/api_server_unittest.cc

+  }
+};
+
+TEST_F(ApiServerTest, BasicDispacher) {


How about better test names? I'd call this one DispatcherMatchesFullPath.

Sure, changed

igorpeshansky · 2018-04-10T16:47:10Z

test/api_server_unittest.cc

+      handler_called = true;
+    }},
+    {{"GET", "/badPath/"}, [&handler_called]() {
+      handler_called = false;


There's not enough signal here (e.g., imagine if the implementation accidentally called every handler — if this one got called first, you'd never know). How about adding a bad_handler_called boolean for this one (and setting it to true in the handler)?

Makes sense, added.

igorpeshansky · 2018-04-10T16:47:46Z

test/api_server_unittest.cc

+  EXPECT_TRUE(handler_called);
+}
+
+TEST_F(ApiServerTest, DispatcherMethodCheck) {


How about DispatcherUnmatchedMethod?

Sure, changed

igorpeshansky · 2018-04-10T16:48:56Z

test/api_server_unittest.cc

+  EXPECT_FALSE(handler_called);
+}
+
+TEST_F(ApiServerTest, DispatcherSubstringCheck) {


Should this also check that an actual substring does match (e.g., /testPath/subPath/)?

Good idea, added

igorpeshansky

LGTM

Does this need rebasing against master?

supriyagarg

A rebase against master is required, but otherwise LGTM.

ACEmilG · 2018-04-10T19:39:44Z

Rebased

igorpeshansky · 2018-04-10T20:01:14Z

test/api_server_unittest.cc

+  EXPECT_FALSE(handler_called);
+  InvokeDispatcher(dispatcher, "GET", "/testFooPath/");
+  EXPECT_FALSE(handler_called);
+  InvokeDispatcher(dispatcher, "GET", "/testPath/subPath");


Should this have been "/testPath/subPath/" (note the trailing /)?

igorpeshansky

LGTM

igorpeshansky requested review from bmoyles0117, igorpeshansky and supriyagarg April 5, 2018 03:42

igorpeshansky suggested changes Apr 5, 2018

View reviewed changes

igorpeshansky suggested changes Apr 10, 2018

View reviewed changes

igorpeshansky approved these changes Apr 10, 2018

View reviewed changes

supriyagarg approved these changes Apr 10, 2018

View reviewed changes

ACEmilG force-pushed the ACEmilG-api-server-test-2 branch from 7e9b10a to dab7c88 Compare April 10, 2018 19:39

dhrupadb and others added 10 commits April 10, 2018 15:57

Stub local API server test

15ede52

Restore deleted store_unittest.cc.

f996db9

Add appropriate includes and object dependencies.

419570c

Fix parallel builds.

8aad264

Added unit tests for api server dispatcher operator()

e7e081b

Remove unused fixture function

b64f73d

Fix spacing

3919d16

Back out unneeded changes to store

cd1f822

Address code review comments

e804af8

Updated unittest based on code review

40965ca

ACEmilG force-pushed the ACEmilG-api-server-test-2 branch from dab7c88 to 40965ca Compare April 10, 2018 19:58

igorpeshansky suggested changes Apr 10, 2018

View reviewed changes

Added trailing slash to test case

9a04008

igorpeshansky approved these changes Apr 10, 2018

View reviewed changes

igorpeshansky merged commit 88b5c43 into master Apr 10, 2018

igorpeshansky deleted the ACEmilG-api-server-test-2 branch April 10, 2018 20:11

Api server test for dispatch operator #128

Api server test for dispatch operator #128

Uh oh!

Conversation

ACEmilG commented Apr 4, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ACEmilG Apr 5, 2018 • edited by igorpeshansky Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

igorpeshansky left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

igorpeshansky left a comment

Choose a reason for hiding this comment

Uh oh!

supriyagarg left a comment

Choose a reason for hiding this comment

Uh oh!

ACEmilG commented Apr 10, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

igorpeshansky left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ACEmilG Apr 5, 2018 •

edited by igorpeshansky

Loading