Skip to content

style: test determinism and doxygen additions to guide. #870

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mattklein123 merged 3 commits into from
May 2, 2017
Merged

style: test determinism and doxygen additions to guide. #870

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b30eeec
style: test determinism and doxygen additions to guide.
htuch May 1, 2017
0c47abc
Fix mock links.
htuch May 1, 2017
67e9775
Weaken stance on internal comments.
htuch May 2, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions STYLE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,10 @@
fiasco](https://isocpp.org/wiki/faq/ctors#static-init-order-on-first-use) for
how to best handle this.
* API-level comments should follow normal Doxygen conventions. Use `@param` to describe
parameters, `@return <return-type>` for return values.
parameters and `@return <return-type>` for return values. Internal comments for
methods and member variables may be regular C++ `//` comments or Doxygen at
developer discretion. Where possible, methods should have meaningful
documentation on expected input and state preconditions.
* Header guards should use `#pragma once`.
* There are probably a few other things missing from this list. We will add them as they
are brought to our attention.
Expand Down Expand Up @@ -91,7 +94,7 @@ A few general notes on our error handling philosophy:
`RELEASE_ASSERT` as the uncommon case, but experience and judgment may dictate a particular approach
depending on the situation.

# Hermetic tests
# Hermetic and deterministic tests

Tests should be hermetic, i.e. have all dependencies explicitly captured and not depend on the local
environment. In general, there should be no non-local network access. In addition:
Expand All @@ -111,6 +114,11 @@ environment. In general, there should be no non-local network access. In additio
`{{ test_udsdir }}` is provided for pathname based Unix Domain Sockets, which must fit within a
108 character limit on Linux, a property that might not hold for `{{ test_tmpdir }}`.

Tests should be deterministic. They should not rely on randomness or details
such as the current time. Instead, mocks such as
[`MockRandomGenerator`](test/mocks/runtime/mocks.h) and
[`Mock*TimeSource`](test/mocks/common.h) should be used.

# Google style guides for other languages

* [Python](https://google.github.io/styleguide/pyguide.html)
Expand Down