mozilla/release-services

Replace type by level in ClangTidyIssue

Closed this issue · 18 comments

La0 commented

As type is a reserved keyword in Python, it makes sense to rename all occurences of ClangTidyIssue.type to ClangTidyIssue.level.
Please take care to also fix the unit tests.
Bonus: make a PR for the staticanalysis/frontend which use the type information in the Tasks.vue

Hey can I work on this?
I understand that the PR should include changes to this file:
https://github.com/mozilla/release-services/blob/master/src/staticanalysis/bot/static_analysis_bot/clang/tidy.py
along with changing all the references of type in the code base.
Do correct me if I am missing something.

La0 commented

That's it ! You'll need to run the setup to test your modifications https://docs.mozilla-releng.net/develop/contribute.html

./please check staticanalysis/bot

Nice. I will do that then. Thanks.

I am facing a issue similar to one mentioned in this: #1027.
My stdout looks as follows: https://paste.ofcode.org/HWRpwARs9BnHXJBWv6DdiA
Should I make an account as mentioned in the above issue in Task Cluster?

La0 commented

You can create an account on Taskcluster, then add your credentials to the project using:

./please tools signin

Cool. I also found the page in the documentation page you shared: https://docs.mozilla-releng.net/projects/staticanalysis-bot.html
Guess, I should have looked more.
Thanks!

So, I was able to signin and follow the same steps mentioned in #1027. But I am facing the same issue: Missing value NIX_CACHE_SECRET_KEYS in secrets.
The stdout is as follows: https://paste.ofcode.org/3ttEmtz4YTYMBhjN9rtZeX.
Did I miss anything else in setting up the environment?

I was able to successfully run ./please check staticanalysis/bot after I adding NIX_CACHE_SECRET_KEYS with [] under common of the secrets configuration yaml, following #1027
After running, I got a DONE.
Please let me know if I am missing anything.

La0 commented

No it's all right. When you do your modifications, if a check fails it will be shown in this command.

You can also do:

./please shell staticanalysis/bot
pytest
flake8

To get more output

Hi,
I'm a newbie here and was looking forward to start contributing to open-source. If this issue isnt handled yet, Can I take it up?

@La0
I made a pull request for this issue. Can you check and let me know if it needs anymore changes?
#2011

La0 commented

Thank you @risingsmoke, i've made some comments in the PR.

Sorry @shahidikram0701, this issue is already being worked on. You can lookup other good-first-bug issues

@La0 Sure, Thanks I'll check out other issues!

@La0 I made the necessary changes to the pull request, but while running ./please check staticanalysis/bot the build fails with the following stderr: https://paste.ofcode.org/VCuUWharWmssZuUQkPYRc9
Can you take a look?

@La0 I have updated the pull request, can you review? I have checked that all the tests have passed. let me know if I have missed anything else.

La0 commented

The staticanalysis/bot side is now merged, a simple patch is now needed on staticanalysis/frontend to use the level variable

I am a bit unfamiliar with the javascript part actually, If you can guide me how ClangTidyIssue is being referenced in Tasks.vue, I can make a change for the Bonus part as well.

La0 commented

I checked the frontend project, and there is no need for changes !
The existing tests already support level.

Thanks @risingsmoke, i'm closing this issue.