custom rule to check component usage correctly

[rohithkrajan]

implemented a custom rule to check if a component used is correctly named and it exists in the path.

The rule will apply if any of following component usage is found

component implements = 'api.interface.ComponentName'
component extends = "components.xmlrpc.Service"
var defaults = new DefaultValues(); or configuration = new components.configuration.Manager('VoucherEngine')
`property name = 'reporter' inject = 'components.error.errorfunctions';
createObject('component', 'components.voucher.Driver')
exporter = server.di.getInstance('components.configuration.Manager');

The rule checks two things based on the configuration (.cflintrc)

{
        "code": "COMPONENT_NOT_FOUND"
    },
    {
        "code": "INVALID_COMPONENT_USAGE"
    }

It can also throw error if component does exist but the name used is not pascalcase.

we can avoid the invalid component usage by removing INVALID_COMPONENT_USAGE from cflintrc.

This PR contains some kind of integration tests and unit tests for possible combinations of component usage and all the tests

[cosminj]

It is quite a large PR, and I've only gone through the first file.

[cosminj]

These should be configurable in an external given file or environment variable.

[rohithkrajan]

👍 made a change where we can pass these values using properties . We have a default set of values now and can override the default set using java -Dknownsubdirs=api,voucherengine,components ...

[modernuniverse]

Let's hold on these changes. Since cflint story is back to SRE backlog, I would like to revisit the story and see what makes sense most sense to do from the SRE team's perspective.

[jbutkus]

@tonym128 shall this be handed over to your team, as part of the wider effort?

[modernuniverse]

In my direct conversation with Rohith, we agreed he was going to merge this and provide me a new jar file with these changes included. My impression was that there was not much work left on this. @rohith could you confirm?

[rohithkrajan]

In my direct conversation with Rohith, we agreed he was going to merge this and provide me a new jar file with these changes included. My impression was that there was not much work left on this. @rohith could you confirm?

yes @modernuniverse . i have pushed an update for the review comments and we should be good to merge after this.