Skip to contentSkip to conversation

trace-cruncher: Update CONTRIBUTING doc with tests

PATCH Applied Tzvetomir Stoyanov (VMware) 2 participants 3 messages Jan 27, 2022 – Jan 28, 2022

v1 of 2 Applied Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 trace-cruncher: Update CONTRIBUTING doc with tests

All trace-cruncher code should be covered by the unit tests. Added instructions how to run the tests in CONTRIBUTING document.

---
 CONTRIBUTING.md | 5 +++++
 1 file changed, 5 insertions(+)
CONTRIBUTING.md +5 -0
index 1f73807..7f6c5af 100644
@@ -20,6 +20,11 @@ The preferred coding style for the project is the [Linux kernel coding style](ht
 The project follows the conventions for [submitting patches](https://www.kernel.org/doc/html/v5.4/process/submitting-patches.html)
 as described by the Linux kernel.
 
+### Tests
+
+Make sure that all your changes are covered by the tests. Before submitting your patch, make sure everything works at 100% running the tests in **tracecruncher/tests**. As trace-cruncher interacts with the Linux kernel tracing infrastructure, the tests must be run with root privileges:
+`sudo python3 -m unittest discover .`
+
 ## Reporting Bugs and Creating Issues
 For bug reports and issues, please file it [bugzilla](https://bugzilla.kernel.org/buglist.cgi?component=Trace-cmd%2FKernelshark&product=Tools&resolution=---)
 
Signature · 1 line
2.34.1
#1 lore raw
Quoted 13 lines · Tzvetomir Stoyanov (VMware)

All trace-cruncher code should be covered by the unit tests. Added instructions how to run the tests in CONTRIBUTING document.

---
  CONTRIBUTING.md | 5 +++++
  1 file changed, 5 insertions(+)
CONTRIBUTING.md +0 -0
index 1f73807..7f6c5af 100644

CONTRIBUTING.md The preferred coding style for the project is the [Linux kernel coding style](ht · line 25

Quoted 6 lines
CONTRIBUTING.md +3 -0
@@ -20,6 +20,11 @@ The preferred coding style for the project is the [Linux kernel coding style](ht
  The project follows the conventions for [submitting patches](https://www.kernel.org/doc/html/v5.4/process/submitting-patches.html)
  as described by the Linux kernel.
 
+### Tests
+
+Make sure that all your changes are covered by the tests. Before submitting your patch, make sure everything works at 100% running the tests in **tracecruncher/tests**. As trace-cruncher interacts with the Linux kernel tracing infrastructure, the tests must be run with root privileges:

Thanks a lot for spotting this insufficiency in the documentation. However let's make it even better. First of all, we need to add an empty line here in order to have the command showing up on a new line on github.

And second, note that if you run this in the trunck of the repository this is not going to work. First you have to do cd tracecruncher/tests

Also it is good to mention that before testing your modifications you have to make sure the modified module is installed. (sudo make install)

Thanks!
Yordan

Quoted 6 lines
CONTRIBUTING.md +2 -0
+`sudo python3 -m unittest discover .`
+
  ## Reporting Bugs and Creating Issues
  For bug reports and issues, please file it [bugzilla](https://bugzilla.kernel.org/buglist.cgi?component=Trace-cmd%2FKernelshark&product=Tools&resolution=---)
 
#2 lore raw

Applied.

Thanks Ceco!
Yordan

Quoted 40 lines · Yordan Karadzhov
Quoted 18 lines · Tzvetomir Stoyanov (VMware)

All trace-cruncher code should be covered by the unit tests. Added instructions how to run the tests in CONTRIBUTING document.

---
  CONTRIBUTING.md | 5 +++++

  1 file changed, 5 insertions(+)
CONTRIBUTING.md +0 -0
index 1f73807..7f6c5af 100644
@@ -20,6 +20,11 @@ The preferred coding style for the project is the [Linux kernel coding style](ht
   The project follows the conventions for [submitting patches](https://www.kernel.org/doc/html/v5.4/process/submitting-patches.html)

  as described by the Linux kernel.

CONTRIBUTING.md +3 -0
+### Tests
+
+Make sure that all your changes are covered by the tests. Before submitting your patch, make sure everything works at 
Quoted 1 line

100% running the tests in **tracecruncher/tests**. As trace-cruncher interacts with the Linux kernel tracing infrastructure, the tests must be run with root privileges:

Thanks a lot for spotting this insufficiency in the documentation. However let's make it even better. First of all, we need to add an empty line here in order to have the command showing up on a new line on github.

And second, note that if you run this in the trunck of the repository this is not going to work. First you have to do cd tracecruncher/tests

Also it is good to mention that before testing your modifications you have to make sure the modified module is installed. (sudo make install)

Thanks!
Yordan

Quoted 5 lines

+sudo python3 -m unittest discover .
+
  ## Reporting Bugs and Creating Issues
  For bug reports and issues, please file it [bugzilla](https://bugzilla.kernel.org/buglist.cgi?component=Trace-cmd%2FKernelshark&product=Tools&resolution=---)