cmu-sei / redemption

Redemption is a tool that automatically repairs C/C++ code given a set of static-analysis alerts
Other
4 stars 1 forks source link

Not able to set up any of the three analysis tools #6

Open PrachiP29 opened 2 months ago

PrachiP29 commented 2 months ago

Hi, I'm trying to set up the three tools on my machine as a prerequisite for Redemption to work but I'm not able to. For the cpp-checkers tool and rosecheckers, the issue is that my organization is blocking it. And for clang-tidy tool, I'm unable to set it up on my machine. Even though it is installed, and I can see its version, I can't run any of the cpp repos against it.

Can you please suggest a good documentation that I should refer to so that the tool works for me and ultimately, I can perform Redemption analysis on my repos? Also, is there any other tool that could be used in place of the three mentioned?

sei-dsvoboda commented 2 months ago

Hello. I believe you are referring to the three static-analysis tools, cppcheck, rosecheckers, and clang-tidy.

The 'Static Analysis Tools' section in the toplevel README gives some instructions for obtaining containers that run the analysis tools. It is easier to run the tools in their own containers than to try to install the tools on your host. If you must install the tool on your host, see the 'Origin's for instructions for installing each tool.

The Redemption project does assume you have a working knowledge of Docker and how to manage Docker containers. This includes the ability to share filesystems between your host and the various containers. For that you want the '-v' switch in your docker run command:

https://docs.docker.com/reference/cli/docker/container/run/#volume

I have amended the "Static Analysis Tools" section with some of this info to help you. (Note that it may take 1-2 days for my improvements to show up on Github.)