mvn-finisher

KO | EN

gitlite — search

#javascript #python #react #golang #machine-learning #rust #deep-learning #macos #awesome #cli #awesome-list #vue #pytorch #open-source

(★ 9)

Maven extension to call finishing tasks after session processing

mvn-finisher 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![License Apache 2.0](https://img.shields.io/badge/license-Apache%20License%202.0-green.svg)](http://www.apache.org/licenses/LICENSE-2.0)
[![Java 8.0+](https://img.shields.io/badge/java-8.0%2b-green.svg)](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
[![Maven central](https://maven-badges.herokuapp.com/maven-central/com.igormaznitsa/mvn-finisher-extension/badge.svg)](http://search.maven.org/#artifactdetails|com.igormaznitsa|mvn-finisher-extension|1.1.1|jar)
[![Maven 3.3.1+](https://img.shields.io/badge/maven-3.3.1%2b-green.svg)](https://maven.apache.org/)
[![PayPal donation](https://img.shields.io/badge/donation-PayPal-cyan.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=AHWJHJFBAWGL2)
[![YooMoney donation](https://img.shields.io/badge/donation-Yoo.money-blue.svg)](https://yoomoney.ru/to/41001158080699)

![banner](https://raw.githubusercontent.com/raydac/mvn-finisher/master/assets/banner.png)

# Changelog

__1.1.1 (08-feb-2020)__
 - added property for finish task timeout `mvn.finisher.task.timeout` in seconds, by default 120 seconds
 - added property to skip execution `mvn.finisher.skip`
 - added properties `mvn.finisher.log.save` and `mvn,finisher.log.folder` to save finish task log
 - minor improvements and bug fixing

__1.1.0 (02-feb-2020)__
 - finish tasks started as external processes

__1.0.1 (31-jan-2020)__
 - added catch of JVM shutdown, its phase __finish-force__
 
__1.0.0 (29-sep-2019)__
 - initial release

# What is it
Small [maven](https://maven.apache.org/) extesion adds three new phases into build process:
 - __finish__ is called in any case if session is started (also called in JVM shutdown)
 - __finish-ok__ is called only if session is built without errors (called in JVM shutdown only if session build completed)
 - __finish-error__ is called only if session is built with errors (called in JVM shutdown only if session buuld completed)
 - __finish-force__ is called only if JVM shutdown (press CTRL+C for instance)
 
 It's behavior very similar to well-known `try...catch...finally` mechanism where __finish-error__ situated in the `catch` section and __finish__ situated in the `finally` section, __finish-ok__ will be called as the last ones in the body.

# How to add in a project?
 Just add extension into the build extensions section
```xml
<build>
    <extensions>
        <extension>
            <groupId>com.igormaznitsa</groupId>
                <artifactId>mvn-finisher-extension</artifactId>
                <version>1.1.1</version>
        </extension>
    </extensions>
</build>
```
after end of session build, the extenstion finds finishing tasks in all session projects, for instance task to print some message into console:
```xml
<plugin>
    <groupId>com.github.ekryd.echo-maven-plugin</groupId>
    <artifactId>echo-maven-plugin</artifactId>
    <version>1.2.0</version>
    <executions>
        <execution>
            <id>print-echo</id>
            <phase>finish</phase>
            <goals>
                <goal>echo</goal>
            </goals>
            <configuration>
                <message>Hello World from finishing task</message>
            </configuration>
        </execution>
    </executions>
</plugin>
```
in the code snippet above, there is `print-echo` task to be executed during finish phase. If the maven build process was interrupted then `force finish` is activated.   
Since 1.1.0 all finishing tasks are executed as __external__ processes through call of maven.

If defined several finishing tasks then they will be sorted in such manner:
- list of projects in order provided in maven session project list
- only projects with provided build status will be processed 
- if any error in session build then execution order is:
  - __finish-error__
  - __finish__
- if session build is ok then execution order is:
  - __finish-ok__
  - __finish__
- if session canceled (for instance by CTRL+C) then execution order is:
  - __finish-force__
  - __finish__
  
__Each detected task is called separately in its own maven request so that all them will be executed even if some of them can be error.__

# Extension properties

## mvn.finisher.skip

It is a boolean property and can be either `true` or `false`. By default it is `false`. If it is `true` then execution of the extension will be skipped.

## mvn.finisher.log.save

Flag to save log of finishing tasks as text files with name pattern `artifactId_finishTaskId.log`. By default is `false`.

## mvn.finisher.log.folder

Folder to save log files. By defaul it is `mvn.finisher.logs` in the project build folder.

## mvn.finisher.task.timeout

It allows to define finish task timeout __in seconds__. By default it is 120 seconds.

# Example
Below you can see some example of extension use. The example starts some docker image and then stop and remove it in finishing tasks.
```xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

<groupId>com.igormaznitsa</groupId>
    <artifactId>mvn-finisher-test-docker</artifactId>
    <version>0.0.0-SNAPSHOT</version>

<build>
        <extensions>
            <extension>
                <groupId>com.igormaznitsa</groupId>
                <artifactId>mvn-finisher-extension</artifactId>
                <version>1.1.1</version>
            </extension>
        </extensions>
        <plugins>
            <plugin>
                <groupId>io.fabric8</groupId>
                <artifactId>docker-maven-plugin</artifactId>
                <version>0.31.0</version>
                <executions>
                    <execution>
                        <id>start-docker-container</id>
                        <phase>validate</phase>
                        <goals>
                            <goal>start</goal>
                        </goals>
                        <configuration>
                            <containerNamePattern>test-container-finisher</containerNamePattern>
                            <showLogs>true</showLogs>
                            <images>
                                <image>
                                    <name>docker.bintray.io/jfrog/artifactory-oss:latest</name>
                                    <run>
                                        <wait>
                                            <time>60000</time>
                                            <log>#+\s*Artifactory successfully started \([0-9.]+ seconds\)\s*#+</log>
                                        </wait>
                                    </run>
                                </image>
                            </images>
                        </configuration>
                    </execution>
                    <execution>
                        <id>stop-docker-container</id>
                        <phase>finish</phase>
                        <goals>
                            <goal>stop</goal>
                        </goals>
                        <configuration>
                            <stopNamePattern>test-container-finisher</stopNamePattern>
                            <allContainers>true</allContainers>
                            <removeVolumes>true</removeVolumes>
                        </configuration>
                    </execution>
                    <execution>
                        <id>remove-docker-container</id>
                        <phase>finish</phase>
                        <goals>
                            <goal>remove</goal>
                        </goals>
                        <configuration>
                            <removeMode>run</removeMode>
                            <removeNamePattern>test-container-finisher</removeNamePattern>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

</project>

```

mvn-finisher

mvn-finisher 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

mvn-finisher

mvn-finisher 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README