[PATCH] trace-cruncher: Update CONTRIBUTING doc with tests

[PATCH] trace-cruncher: Update CONTRIBUTING doc with tests

[Tzvetomir Stoyanov (VMware)]

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

Signed-off-by: Tzvetomir Stoyanov (VMware) <tz.stoyanov@gmail.com>
---
 CONTRIBUTING.md | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 1f73807..7f6c5af 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -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=---)
 
-- 
2.34.1

Re: [PATCH] trace-cruncher: Update CONTRIBUTING doc with tests

[Yordan Karadzhov]

On 27.01.22 г. 8:16 ч., Tzvetomir Stoyanov (VMware) wrote:
> All trace-cruncher code should be covered by the unit tests. Added
> instructions how to run the tests in CONTRIBUTING document.
> 
> Signed-off-by: Tzvetomir Stoyanov (VMware) <tz.stoyanov@gmail.com>
> ---
>   CONTRIBUTING.md | 5 +++++
>   1 file changed, 5 insertions(+)
> 
> diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
> index 1f73807..7f6c5af 100644
> --- a/CONTRIBUTING.md
> +++ b/CONTRIBUTING.md
> @@ -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


> +`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=---)
>   
> 

Re: [PATCH] trace-cruncher: Update CONTRIBUTING doc with tests

[Yordan Karadzhov]

Applied.

Thanks Ceco!
Yordan


On 27.01.22 г. 12:55 ч., Yordan Karadzhov wrote:
> 
> 
> On 27.01.22 г. 8:16 ч., Tzvetomir Stoyanov (VMware) wrote:
>> All trace-cruncher code should be covered by the unit tests. Added
>> instructions how to run the tests in CONTRIBUTING document.
>>
>> Signed-off-by: Tzvetomir Stoyanov (VMware) <tz.stoyanov@gmail.com>
>> ---
>>   CONTRIBUTING.md | 5 +++++
>>   1 file changed, 5 insertions(+)
>>
>> diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
>> index 1f73807..7f6c5af 100644
>> --- a/CONTRIBUTING.md
>> +++ b/CONTRIBUTING.md
>> @@ -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
> 
> 
>> +`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=---)
>>