#6992 Add SPDX checking for copyright/license (java)

[planetf1]

Signed-off-by: Nigel Jones [email protected]

Description

One of the missing aspects to the gradle build is SPDX header checking. There is a shortage of gradle plugins, or github actions.

My approximation so far is to use ‘checkstyle’ which allows specification of REGEXes which must match -for example one for copyright, one for license.

Due to the way the gradle build works, for now these only check java files.

In the process, I’ve noticed some omissions

• Some files incorrectly use /* SPDX-License-Identifier: Apache 2.0 */ whilst it should be /* SPDX-License-Identifier: Apache-2.0 */ . Subtle, but it breaches the SPDX spec which specifically requires certain identifiers. There are over 2500 source files breaching this.
• We do have a number, even of java, source files with no copyright, or incorrect ie typos. The most entertaining was in glossary author where we have /* Copyright Contributors to the ODPi Egeria category. */ where clearly a search/replace on project->category was done

Both are easy to fix, especially the former, (the latter is slightly more tedious) and I’m happy to do so, but it will result in thousands of file changes in a commit.

For now I can submit this additional check, ERROR will be reported in the output log, but will not fail the build.
Interesting that our previous maven based checks did not find these errors.

Related Issue(s)

Testing

Release Notes & Documentation

Additional notes

[planetf1]

Here's an example of the output in context:

[planetf1]

Note - It's possible to customize the message given for a rule violation

[planetf1]

There is a 3rd party checkstyle plugin for intelliJ. This may make it easier to find issues in the UI.

Note that currently (with these rules) there are many errors ie

Checkstyle found 2,973 item(s) in 2,946 file(s)

[planetf1]

This has been discussed in developer/tsc calls. No objects received so will now

• merge this change using checkstyle to add WARNINGS into the build
• raise new PRs to fix the warnings shown
• raise PR to change from warning to error