Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/exasol/error-code-crawler-maven-plugin

Validator and crawler for exasol-error-codes in Java code
https://github.com/exasol/error-code-crawler-maven-plugin

catalog crawler error-handling error-report error-reporting exasol exasol-integration java unification

Last synced: about 2 months ago
JSON representation

Validator and crawler for exasol-error-codes in Java code

Host: GitHub
URL: https://github.com/exasol/error-code-crawler-maven-plugin
Owner: exasol
License: mit
Created: 2020-10-09T13:04:39.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2024-04-12T14:29:06.000Z (9 months ago)
Last Synced: 2024-04-16T18:50:26.122Z (9 months ago)
Topics: catalog, crawler, error-handling, error-report, error-reporting, exasol, exasol-integration, java, unification
Language: Java
Homepage:
Size: 259 KB
Stars: 1
Watchers: 7
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Error Code Crawler

[![Build Status](https://github.com/exasol/error-code-crawler-maven-plugin/actions/workflows/ci-build.yml/badge.svg)](https://github.com/exasol/error-code-crawler-maven-plugin/actions/workflows/ci-build.yml)

[![Maven Central – error-code-crawler-maven-plugin](https://img.shields.io/maven-central/v/com.exasol/error-code-crawler-maven-plugin)](https://search.maven.org/artifact/com.exasol/error-code-crawler-maven-plugin)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=com.exasol%3Aerror-code-crawler-maven-plugin&metric=alert_status)](https://sonarcloud.io/dashboard?id=com.exasol%3Aerror-code-crawler-maven-plugin)

[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=com.exasol%3Aerror-code-crawler-maven-plugin&metric=security_rating)](https://sonarcloud.io/dashboard?id=com.exasol%3Aerror-code-crawler-maven-plugin)

[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=com.exasol%3Aerror-code-crawler-maven-plugin&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=com.exasol%3Aerror-code-crawler-maven-plugin)

[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=com.exasol%3Aerror-code-crawler-maven-plugin&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=com.exasol%3Aerror-code-crawler-maven-plugin)

[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=com.exasol%3Aerror-code-crawler-maven-plugin&metric=sqale_index)](https://sonarcloud.io/dashboard?id=com.exasol%3Aerror-code-crawler-maven-plugin)

[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=com.exasol%3Aerror-code-crawler-maven-plugin&metric=code_smells)](https://sonarcloud.io/dashboard?id=com.exasol%3Aerror-code-crawler-maven-plugin)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=com.exasol%3Aerror-code-crawler-maven-plugin&metric=coverage)](https://sonarcloud.io/dashboard?id=com.exasol%3Aerror-code-crawler-maven-plugin)

[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=com.exasol%3Aerror-code-crawler-maven-plugin&metric=duplicated_lines_density)](https://sonarcloud.io/dashboard?id=com.exasol%3Aerror-code-crawler-maven-plugin)

[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=com.exasol%3Aerror-code-crawler-maven-plugin&metric=ncloc)](https://sonarcloud.io/dashboard?id=com.exasol%3Aerror-code-crawler-maven-plugin)

This maven plugin analyzes invocations of the [Exasol error code builder](https://github.com/exasol/error-reporting-java/) from Java source code. It runs some validations on these definitions, for example, that no error code is defined twice.

[Features](doc/requirements.md)

## Installation

Add the plugin to your `pom.xml`:

```xml

    

        com.exasol

        error-code-crawler-maven-plugin

        LATEST VERSION

        

            

                

                    verify

                

            

        

    

```

This will add the plugin to the maven `verify` lifecycle phase.

## Configuration

Each project has an individual error-tag (e.g. `EXM`). Different sub packages within the project can have different sub tags (`EXM-MODEL`). This plugin validates that the classes of the project only use the corresponding short tag.

For that you need to configure the project's error-tag mapping in the `error_code_config.yml` file stored in your project's root directory.

Example:

```yaml

error-tags:

  EXM:

    packages:

      - com.exasol.example

    highest-index: 3

  EXM-MODEL:

    packages:

      - com.exasol.example.model

    highest-index: 0

```

This configuration defines which java-packages or classes belong to which error code short tag. A package always includes all sub packages. If two error-tags match, the crawler will take the more specific one.

For example the class `com.exasol.example.model.Test` belongs to a sub package of `com.exasol.example` --> `ECM` and to `com.exasol.example.model` --> `ECM-MODEL`. Since the last package name is more specific (longer) this crawler will validate the tag `ECM-MODEL` for these classes. It will not accept `ECM` there.

The `highest-index` property contains the index of the last error code declaration. So in the example the highest error code could be `E-EXM-3`. This plugin validates that value of this property is higher or equal than the actual highest. You can safely use this property to determine the next error code.

For the moment the value of this property needs to be updated manually.

### Excludes

In some very rare cases you may want to exclude some files from crawling. But we don't recommend excluding files.

You can define the excludes by adding the following configuration to the maven-plugin:

```xml

    

        **/MyTest.java

    

```

The excludes only affect the validation — not compiling. So if the specific file has syntax errors, excluding won't help.

**Keep in mind that error codes from excluded files will not show up in the error catalog and are not validated. So use this option with care!**

### Source Path

ECM allows you to override the source directories that it crawls.

A common use case for this is when you use [project Lombok](https://projectlombok.org/) in your project. In that case crawling the regular sources will fail since the ECM can't find some sources. To fix this you can use the [lombok-maven-plugin](http://anthonywhitford.com/lombok.maven/lombok-maven-plugin/). This plugin applies the Lombok annotations and generates new source code. To tell ECM to crawl these sources instead use:

```xml

    

        target/generated-sources/delombok

        target/generated-test-sources/delombok

    

```

For a working example project with Lombok and error-code-crawler take a look at the [virtual-schema-common-document](https://github.com/exasol/virtual-schema-common-document).

If you specify a source path, the plugin assumes that it's generated sources, and for that reason will not add the source location (file + line number) to the report.

## Usage

You can also invoke this plugin manually using `mvn error-code-crawler:verify`.

You can skip the execution of this plugin by either 

* adding `-Derror-code-crawler.skip=true` to your Maven command

* setting the property in your `pom.xml` (recommended):

    ```xml

    true

    ````

* specifying the following configuration in `pom.xml`:

    ```xml

    

        true

    

    ```

## Additional Information

* [Changelog](doc/changes/changelog.md)

* [License](LICENSE)

* [Dependencies](dependencies.md)

* [Features and Requirements](doc/requirements.md)

* [Design](doc/design.md)