[MESOS-2287] Document undocumented tests

• Type: Improvement
• Status: Accepted
• Priority: Trivial
• Resolution: Unresolved
• Component/s: test
• Labels: documentation newbie tests
• Assignee: Unassigned
• Reporter: Niklas Quarfot Nielsen
• Created: 28/Jan/15 18:29
• Updated: 30/Mar/16 08:43

Description

We have a inconsistency in the way we document tests. It has become a rule of thumb to include a small blob about the test. For example:

// This tests the 'active' field in slave entries from state.json. We
// first verify an active slave, deactivate it and verify that the
// 'active' field is false.
TEST_F(MasterTest, SlaveActiveEndpoint)
{
  // Start a master.
  Try<PID<Master>> master = StartMaster();
  ASSERT_SOME(master);
  ...

However, we still have many tests that haven't been documented. For example:

}


TEST_F(MasterTest, MetricsInStatsEndpoint)
{
  Try<PID<Master> > master = StartMaster();
  ASSERT_SOME(master);

  Future<process::http::Response> response =
    process::http::get(master.get(), "stats.json");
  ...

It would be great to do a scan and make sure all the tests are documented.