Skip to content

Latest commit

 

History

History
127 lines (107 loc) · 4.54 KB

README.md

File metadata and controls

127 lines (107 loc) · 4.54 KB
Raw

Mule Linter Maven Plugin

The mule linter can be run as mvn plugin. The maven plugin is located in module mule-linter-maven-plugin.

Plugin goal is by default attached to validate which is the first phase of maven lifecycle.

Parameters

  • appDir: Defaults to ${basedir}
  • ruleConfiguration: Defaults to ${basedir}/muleLinter.groovy
  • outputDirectory: Defaults to ${project.build.directory}/mule-linter
  • formats: Defaults to CONSOLE and JSON.
  • failBuild: Defaults to false. If failBuild is set to true, then rule violations with severity higher than MINOR will cause build to fail.

Previous steps for use the plugin

Step0: Configure AVIO Github Package Registry

In your POM, add following plugin repository in pluginRepositories tag (add if doesn't exist) -

    <pluginRepository>
        <id>github-avio-pkg</id>
        <name>AVIO Github Package Repository</name>
        <url>https://maven.pkg.github.com/avioconsulting/public-packages/</url>
        <layout>default</layout>
    </pluginRepository>

In your ~/.m2/settings.xml, add credentials for server id github-avio-pkg, like below -

    <server>
        <id>github-avio-pkg</id>
        <username>YOUR_GIT_USER</username>
        <password>YOUR_GIT_PERSONAL_TOKEN</password>
    </server>

See working-with-the-apache-maven-registry#authenticating-with-a-personal-access-token for more details on Github Package Authentication.

NOTE: The Github Personal Token must have read:packages permission.

Usage

To use plugin in your maven project, add following plugin configuratin in project pom -

<plugin>
    <groupId>com.avioconsulting.mule</groupId>
    <artifactId>mule-linter-maven-plugin</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <executions>
        <execution>
            <id>validate</id>
            <phase>validate</phase>
            <goals>
                <goal>validate</goal>
            </goals>
            <configuration>
                <appDir>${basedir}</appDir>
                <ruleConfiguration>muleLinter.groovy</ruleConfiguration>
                <outputDirectory>${project.build.directory}/reports</outputDirectory>
                <formats>
                    <format>CONSOLE</format>
                    <format>JSON</format>
                </formats>
            </configuration>
        </execution>
    </executions>
</plugin>

You can adjust configuration parameters as applicable to your project.

The plugin will run during validate phase (very first in lifecycle) of Maven. The validation report will either be generated in maven log for console format or written to a json file inside outputDirectory.

External Rule Dependencies

You can extend the core linter library for adding components or rules by implementing mule-linter-spi. When you have an external components or rules provider, you can add those as a dependency to plugin.

For example, mule-linter-spi-test module implements an extension and adds a new HttpListenerPathRule. Adding this library to plugin to use new rule, we can configure it like below -

<plugin>
    <groupId>com.avioconsulting.mule</groupId>
    <artifactId>mule-linter-maven-plugin</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <executions>
        <execution>
            <id>validate</id>
            <phase>validate</phase>
            <goals>
                <goal>validate</goal>
            </goals>
            <configuration>
                <appDir>${basedir}</appDir>
                <ruleConfiguration>muleLinter.groovy</ruleConfiguration>
                <outputDirectory>${project.build.directory}/reports</outputDirectory>
                <formats>
                    <format>CONSOLE</format>
                    <format>JSON</format>
                </formats>
            </configuration>
        </execution>
    </executions>
    <dependencies>
        <!-- Plugin dependencies for external rules/components go here -->
        <dependency>
            <groupId>com.avioconsulting.mule</groupId>
            <artifactId>mule-linter-spi-test</artifactId>
            <version>1.0.0-SNAPSHOT</version>
        </dependency>
    </dependencies>
</plugin>

Once you add required dependencies, you can add new rule in the rules configuration file -

    MULE_ARTIFACT_SECURE_PROPERTIES {
        properties = [
                'anypoint.platform.db.password'
        ]
        includeDefaults = false
    }