[jira] [Updated] (MESOS-2287) Document undocumented tests

["Neil Conway (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/MESOS-2287?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Neil Conway updated MESOS-2287:
-------------------------------
    Component/s: test

> Document undocumented tests
> ---------------------------
>
>                 Key: MESOS-2287
>                 URL: https://issues.apache.org/jira/browse/MESOS-2287
>             Project: Mesos
>          Issue Type: Improvement
>          Components: test
>            Reporter: Niklas Quarfot Nielsen
>            Priority: Trivial
>              Labels: documentation, newbie, tests
>
> 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:
> {code}
> // 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);
>   ...
> {code}
> However, we still have many tests that haven't been documented. For example: 
> {code}
> }
> TEST_F(MasterTest, MetricsInStatsEndpoint)
> {
>   Try<PID<Master> > master = StartMaster();
>   ASSERT_SOME(master);
>   Future<process::http::Response> response =
>     process::http::get(master.get(), "stats.json");
>   ...
> {code}
> It would be great to do a scan and make sure all the tests are documented.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)