Skip to content

Mention that tests should be run as root/admin in contribution guides. #358

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

Closed
cf-natali wants to merge 1 commit into from
Closed

Mention that tests should be run as root/admin in contribution guides. #358

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion docs/advanced-contribution.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,9 @@ Here is the standard procedure for proposing and making changes to Mesos:
2. `../configure`
3. `make`
4. Now all of the files generated by the build process will be contained in the build directory you created, instead of being spread throughout the src directory, which is a bit messier. This is both cleaner, and makes it easy to clean up if you want to get rid of the files generated by `configure` and `make`. I.e. You can reset your build process without risking changes you made in the src directory, by simply deleting the build directory, and creating a new one.
3. Make sure that all of the unit tests pass, including the new test cases you have added: `make check`.
3. Make sure that all of the unit tests pass, including the new test cases you have added: `make check`. The tests should preferably be run as root/administrator as certain tests are skipped when run as a non-privileged user.


1. To build all tests without executing them, use something like: `make tests`.
2. To execute a single unit test (helpful when trying to debug a test case failure), use something like: `make check GTEST_FILTER="HTTPTest.Delete"`.
3. If you added new tests, make sure you run them repeatedly in order to catch inconsistent failures. A command like the following can be used to run an individual test 1000 times:
Expand Down
2 changes: 1 addition & 1 deletion docs/beginner-contribution.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Once you know what you're going to change, you can make your intended modificati

If your changes are documentation-only, then you should view them with a markdown viewer to verify their appearance when rendered.

If you are changing any code in Mesos, then you should build and run the tests before opening a PR. You should run `make check` and ensure that all tests pass before opening a PR.
If you are changing any code in Mesos, then you should build and run the tests before opening a PR. You should run `make check` and ensure that all tests pass before opening a PR. The tests should preferably be run as root/administrator as certain tests are skipped when run as a non-privileged user.

## Open a PR

Expand Down