bentolor / idea-cli-inspector Goto Github PK

Hello. I've been looking everywhere for documentation on how to run groovy scripts from the jenkins pipeline script with parameters, but to no avail. Do you have any recommendations on how to run the inspector in a pipeline?

This is the output I get when running /usr/local/bin/groovy ideainspect.groovy:

#
# Inspecting produced result files in /Users/Shared/Jenkins/Home/workspace/Dev/build/reports/inspection-results
#
# Looking for levels    : [[ERROR]]
--- XmlHighlighting.xml
[ERROR] checkstyle.xml:4 -- URI is not registered (Settings | Languages & Frameworks | Schemas and DTDs) #loc

Line 4 of checkstyle.xml has:
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd"
which was giving an error in my local IDE but I fixed it locally. I cannot figure out how to fix that error without writing a workaround on my Jenkins CI build machine.

I should note that I was running v1.2 - is this issue resolved now? I can attempt using the latest version.

Hey, I can't find any information on errors that come out of the inspector run. Do you know of any current documentation for specific errors (like the configure library issue in your example run)? I'm having some issues with the environment, as a wiped repo on my dev machine runs just fine, but a wiped repo on the jenkins server results in errors.

Hey,

quick question: does this tool run with other Jetbrain IDEs like PyCharm, RubyMine or CLion?

If so, could you include a sentence that it does so in the first paragraph of the project README?

Thanks :)

It turns out, that the path-based heuristics to switch between idea.sh and studio.sh is insufficient and does not work for non-MacOS installations.

⋊> ~ ideainspect.groovy  -i /home/ben/devel/android-studio
= IntellIJ IDEA Code Analysis Wrapper - v1.4 - @bentolor
IDEA Installation directory /home/ben/devel/android-studio/bin/idea.sh not found!
Use a IDEA_HOME environment variable or the `ideahome` property in `.ideainspect` 
or the `-i` command line option to point me to a valid IntelliJ installation

CC @ianshowell

See sylvainlaurent/docker-intellij-inspect#1

On OSX, the default installation for intellij puts the launch binary at

/Applications/IntelliJ\ IDEA.app/Contents/MacOS/idea

The groovy script looks like it handles windows/linux correctly but not OSX, as it expects bin/idea.sh to exist under the installation directory.

Our JDK version is pointed to by a Path Variable.

Which causes a failure and a false pass.

Initializing project...Loaded profile 'Default' from file 'D:\path\.idea\inspectionProfiles\Default.xml'
done.
Inspecting with profile 'Default'
The JDK is not configured properly for this project. Inspection cannot proceed.
$PROJECT_JDK_NAME$ not found
Java HotSpot(TM) Server VM warning: ignoring option MaxPermSize=250m; support was removed in 8.0
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

#
# Inspecting produced result files in D:\path\target\inspection-results
#
# Looking for levels    : [[WARNING], [ERROR]]
# Ignoring result files : []
# Ignoring source files : []

#
# Analysis Result
#
Looks great - everything seems to be ok!

Inspection, compilation, etc. works just fine in the IDE. Support would be nice, but isn't required. False pass is not ok.

For completeness, the variable is stored in .IdeaIC\config\options\path.macros.xml

<macro name="PROJECT_JDK_NAME" value="1.8" />

It seems that if a setting is defined in the .ideainspect file, then it is not possible to pass a different setting through the command line arguments.
This is quite counter-intuitive and not convenient when trying to setup a CI build

Hello!

I'm trying to run the idea-cli-inspector inside a docker container. IntelliJ IDEA should be installed correctly. When executing the inspections I get the following error:

Plugin Error: Plugin 'org.jetbrains.android' failed to initialize and will be disabled. Please restart IntelliJ IDEA.

java.lang.NoClassDefFoundError: Could not initialize class org.intellij.images.fileTypes.impl.ImageFileTypeManagerImpl
at java.lang.Class.forName0(Native Method)
at java.lang.Class.forName(Class.java:348)
at com.intellij.openapi.components.impl.ServiceManagerImpl$MyComponentAdapter.getDelegate(ServiceManagerImpl.java:242)

Can you point me to what the problem is? Which IDEA project files (from .idea) are needed to start the inspections? Is there maybe configurations from my local machine leaking into the docker image? How can I make sure the inspections can be run on another machine?

Thanks!
Jochen

I the README it says:

IDEA allows you to check for new violations introduced with your changes while you are trying to commit them

How? Is there a way to configure this tool to generate build failures when new warnings/errors are introduced?

Hello @bentolor ,

I find your project quite useful and I even created a docker image to run inspections more easily: https://github.com/sylvainlaurent/docker-intellij-inspect

My goal is to help running inspections on maven projects (not pure IJ projects), and until recently I thought I always had to commit many IntelliJ-specific files to VCS.
But I recently played with TeamCity and found out that you can actually specify the path to a pom.xml rather than the root of the IJ project. I observed what TeamCity actually does to launch the inspections: in such a case it does the same thing as your groovy script except that the first argument is the full path to the pom.xml.

Thus, I wonder if your groovy script could be modified to allow specifying a full path to a pom.xml rather than requiring a directory?
I also noticed that the inspection profile XML file is not required to be in .idea/inspectionProfiles, one could have it elsewhere...

Would you like me to work on a pull-request for this enhancement?

I would like to run "inspect" on a maven project without checking in .idea files into repo.
This tool takes the path to pom.xml. Will it also generate .iml file and .xml files in .idea folder needed to complete the inspection?

Bintray+JCenter is being terminated so usages of jcenter should be replaced.

Thanks for making this great tool by the way!

Hi,

I'm trying to use your script to integrate the inspections in CI environment. Unfortunately I keep receiving the following error:
Startup Error: Application cannot start in headless mode

Do you have any idea how to solve this problem? Could it be that it doesn't work anymore in the latest Android Studio version (2.2 preview 5)?

Goals:

• Allow users to use custom scopes defined in either Android Studio or IDEA in this app.
• Allow users to pull the custom scopes from their xml files in the .idea/scopes directory in their project.

Leads:

• Apparently passing "-Didea.analyze.scope=SCOPE_NAME" as an argument is supposed to work, but I haven't been able to achieve the same results. https://youtrack.jetbrains.com/issue/IDEA-135512#comment=27-1446289
• System property setting could also help as the inspection code checks it: https://github.com/JetBrains/intellij-community/blob/master/platform/lang-impl/src/com/intellij/codeInspection/InspectionApplication.java#L164