Apache Hop plugins Samples

NOTE:
Latest Update: 2022/04/22
Hop Version 2.0.0

Pre-requisites for building the project:

• Maven, version 3+
• Java JDK 11

Overview

This project contains a series of examples demonstrating various use-cases for extended and embedding Apache Hop functionality. As a first implementation, the following plugins' examples are provided

• Hop Pipeline Transform
• Hop Workflow Action

More examples will be provided shortly

Building

From the main directory, or any of the module sub-directories, run mvn clean package.

For any module contained in the samples, a zip file will be generated that can be unzipped into the related Apache Hop plugin subdirectory for testing. This project is currently under improvement and any other samples wil lbe provided soon.

Using the debug Assembly

You can run Hop including some basic functionality using the debug assembly included, this will launch a stripped down version for Hop including a couple of transforms to test your custom transform or action.

Instructions on how to run debug using Intellij:

• Create a new Run/Debug Configuration
• Choose type application
• Give it a name
• From the Modify Options menu select following opitons
  • Add before launch task
  • Add VM Options
  • Add dependencies with "provided" scope to classpath
• In the before launch add build & run maven goal -> clean install
• Use Java 11
• set module to hop-assemblies-debug
• (if on mac) add -XstartOnFirstThread as VM option
• Main Class is org.apache.hop.ui.hopgui.HopGui
• Working director is your-git-location/pluginname/assemblies/debug/target/hop-assemblies-debug-{VERSION}

The {VERSION} should be replaced with the pom version you use.

Run this application and Hop should show up including your custom plugins.

How to debug your plugins HopGui with maven

• Add your hop plugins to hop-it-launcher(pom.xml 126 line)
• start hop-gui by mvn exec:exec@hop-gui -pl :hop-it-launcher
• In IntelliJ IDEA, attach to process: Run -> Attach to process...

By default mvn install will start HOP-GUI, the execution is bound to integration-test phase.

<!-- pom snippet -->
<pom>
  <!-- hop-it-launcher -->
  <!-- .... -->
  
  <dependencies>
    <!-- ....  -->
    
    <!-- add some plugins 126 line -->
    <dependency>
      <groupId>org.apache.hop</groupId>
      <artifactId>assemblies-action-sample</artifactId>
      <version>${project.version}</version>
      <type>zip</type>
    </dependency>
    <dependency>
      <groupId>org.apache.hop</groupId>
      <artifactId>assemblies-transform-sample</artifactId>
      <version>${project.version}</version>
      <type>zip</type>
    </dependency>
  </dependencies>
</pom>