Ignore generated-sources

[daniel-shuy]

Summary

Currently the predefined rules are also scanning class files in generated-sources, which I have no control over. Is there a way to configure the plugin to ignore generated-sources?

Type of Issue

It is a :

• bug
• request
• question regarding the documentation

Motivation

I don't have any control over the class files generated in generated-sources, thus have no way to resolve violations in the generated class files.

[vincent-fuchs]

Thanks for this request !

Indeed, it could be interesting to set have an optional parameter in the config, to give a list of folders to ignore. We would have to implement it in https://github.com/societe-generale/arch-unit-build-plugin-core though.

I faced the exact same issue, but found a workaround. Maybe it's not the same issue, but I'll mention the workaround anyway :

By default, Lombok will generate getters on collections that don't have the javax.annotation.Nonnull annotation. And I had DontReturnNullCollectionTest rule raising violations.

To avoid this, I found 2 solutions :

• write the getter yourself for these fields : in that case you can make sure that null is never returned by testing it before returning the value, and returning an empty list if it is.

• tweak the Lombok annotation, as described here : https://projectlombok.org/features/experimental/onX

     @Getter(onMethod_={@Nonnull})

But in that case, I am quite sure it's still possible that null is returned, even though the annotation says otherwise - so it may be misleading.

[daniel-shuy]

Thanks. Unfortunately my issue is not with Lombok, but MapStruct, which has no way of configuring the generated methods.

[vincent-fuchs]

fixed in v2.4.0

[daniel-shuy]

Still having this issue with arch-unit-maven-plugin 2.4.0 and arch-unit-build-plugin-core 2.5.2. Is there anything that I have to configure specifically?

[vincent-fuchs]

yes, I've added a new config parameter (see the documentation) :

<excludedPaths>
    <excludedPath>generated-sources</excludedPath>
</excludedPaths>

[daniel-shuy]

Just tried with that, seems like it doesn't work either. It only seems to match the package name or class name, not the full path.

[vincent-fuchs]

Just tried with that, seems like it doesn't work either. It only seems to match the package name or class name, not the full path.

archUnit looks at the compiled code, not the source code. Do you know in which folder your generated-sources code gets compiled ? you could try to configure this directory instead

[daniel-shuy]

archUnit looks at the compiled code, not the source code

Oh right, I forgot about that. Looks like there's no way I can just ignore all classes in generated-sources, as they are all compiled in their respective packages under target. The most I can do is to group all the MapStruct classes in the same package and ignore the package. Thanks.

[vincent-fuchs]

maybe you can change that behavior by tweaking the maven-compile plugin... but not sure !