Skip to content

Latest commit

 

History

History
286 lines (224 loc) · 24 KB

CONTRIBUTING.md

File metadata and controls

286 lines (224 loc) · 24 KB
Raw

How to contribute

Thanks for reading this we're glad you're taking an interest in contributing to our framework. We want you working on things you're excited about, there are however plenty of issues that can be picked up.

Before getting started it's recommended to get acquainted with the core classes in the framework. They've been documented pretty well, check out:

  • Receiver: org.frankframework.receivers.Receiver
  • Listener: org.frankframework.core.IPullingListener and org.frankframework.core.IPushingListener
  • Adapter: org.frankframework.core.Adapter
  • Pipe: org.frankframework.pipes.AbstractPipe
  • Sender: org.frankframework.senders.FrankSender

Running the Frank!Framework

If you want to experiment with the Frank!Framework, you can use the Frank!Runner or follow the instructions for running the Frank!Framework inside your IDE (See Developing with Eclipse or Developing with IntelliJ).

Submitting changes

Please send a GitHub Pull Request with a clear list of what you've done (read more about pull requests). When you send a pull request, make sure all of your commits are atomic (one feature per commit) and that the title is clear, obvious and informative!

Always write a clear log message for your commits. Add the current year, the name of the copyright owner and the copyright notice (when not already present) to adjusted and new files. See:

When relevant to the end-user first add a line to release notes at the end of section 'Upcoming' with a functional description targeted to end-user. There's no limit on the length of this line. After that create the commit message targeted to developers and Git tools with a short one-line description in the first line (in some cases the same as the release notes line) and if necessary a more detailed explanatory text after a blank line. See:

One-line messages are fine for small changes, but bigger changes should look like this:

$ git commit -m "A brief summary of the commit
> 
> A paragraph describing what changed and its impact."

When you have created a pull request, you can visit it on GitHub. If your work needs improvement, other Frank!Framework contributors will add comments that are visible inside your pull request. For each comment, GitHub keeps a property whether the comment has been resolved. This is useful when a pull request goes through many iterations of improvements. When you want to follow-up on the latest comments, it is confusing to see comments that have been resolved already.

What is our policy to setting comments to resolved? First, please always answer to the comment stating what you did with it. Even if you simply granted it, please say so.

After answering, you can set the comment to resolved if it was clear and if you have fully granted it. If the comment was not clear to you or if you only partially granted it, then do not resolve the comment yourself. Frank!Framework maintainers should resolve the comment when they are satisfied.

If a comment you answered to is very old and if no additional answer has been added to the conversation for a long time, you can also set it to resolved to ease the review process.

Coding conventions

Start reading our code, and you'll get the hang of it. We optimize for readability:

  • We indent using tabs, not spaces.
  • We ALWAYS put spaces after list items and method parameters ([1, 2, 3], not [1,2,3]) and around operators (x += 1, not x+=1).
  • When you have long method calls or method definitions, please keep them on one line. When you have many similar lines of long method calls, they are easier to read without artificial line breaks. Lines are allowed to be as long as 150 characters.
  • This is open source software. Consider the people who will read your code, and make it look nice for them. It's sort of like driving a car: Perhaps you love doing donuts when you're alone, but with passengers the goal is to make the ride as smooth as possible.
  • Use Unix style newlines.
  • Each class that can be used in a configuration must contain the following documentation:
    • Class level Frank!Doc, not larger than 5 to 10 lines
    • For each configurable attribute, Frank!Doc must not be larger than 2 lines
    • Any examples and more detailed information, that has to be incorporated in to the Frank!Manual, should be provided as a separate file(s) attached to the pull request
  • In JavaDoc comments, do not use the ’ character. It breaks the Frank!Doc. You can use ' instead.
  • Please do not modify files purely for the sake of formatting, or do so in a dedicated pull request. Formatting changes make a pull request harder to understand for reviewers.
  • You can experiment with Eclipse's formatting capabilities. In the preferences window, search for the string "tab". You will get an overview of all the options about formatting. The following options are interesting in particular:
    • There are many screens in which you can define that you use tabs instead of spaces for indentation. Please visit them all to configure that you use tabs.
    • In Java | Code Style, you can define your own named code style. When you open the dialog, you see many options on how to format Java code. You can set the maximum length of lines here, for example, to avoid artificial line breaks.

The Frank!Framework community has introduced Project Lombok in this source code. Please keep the following in mind when using it:

  • With Lombok, you do not have to code getters and setters anymore. You can generate them by putting annotations @Getter and @Setter on the backing field. This is very useful. But please do NOT put the @Getter or @Setter on a non-private class. This makes fewer lines of code, but there is a drawback. You cannot see the call hierarchy anymore of a getter or a setter. When you put the annotations on the method level, you can still see the call hierarchy: right-click the @Getter or @Setter and select "Open Call Hierarchy" in Eclipse.
  • For the sake of readability, please put the @Getter or @Setter annotations inside the variable declaration: "private @Getter @Setter MyType myField".

See our Additional Coding Guidelines for code examples to help create more readable, testable and maintainable code.

Testing

Before creating a pull request with your changes, please run the iaf-test module's test scenarios. If all tests pass, the chance of Frank developers running into unexpected errors will be reduced to a minimum. Instructions on how to run the iaf-test scenarios can be found here.

Checking differences within Larva

The iaf-test module runs Larva tests, see https://frank-manual.readthedocs.io/en/latest/gettingStarted/testPipelines.html. Larva tests execute some system-under-test, for example a Frank configuration. The output of the system-under-test is often compared to some expected value. The Graphical User Interface of Larva shows these differences, but sometimes it works better to use a third-party tool like WinMerge.

If you are developing under Windows, you can do the following to set this up:

  • Follow the instructions of section Developing with Eclipse or Developing with IntelliJ, see below.
  • Download the WinMerge installer from https://winmerge.org/. After accepting cookies, you may have to refresh your browser before the download starts.
  • Run the installer you downloaded. Make sure that WinMerge is added to the system path.
  • Lookup the path to the WinMerge executable. You may do this by viewing the system path.
  • In the Eclipse Project Explorer, you have a folder "Servers". Your Tomcat installation appears as a subfolder. Under that subfolder, open file catalina.properties.
  • In catalina.properties, add: larva.windiff.command=c:/Program Files (x86)/WinMerge/winmergeu, but replace the value after the = by the path to WinMerge on your laptop.
  • Start module iaf-test.
  • If you see a "Differences:" panel, you have a button "windiff" above it. Please press it to see the differences in WinMerge. NOTE: You only see a "Differences:" panel if you select a low log level. Mind the pull-down menu labeled "Log level".
  • If all your tests succeed, you do not have "Differences:" panels, and you have no "windiff" buttons. To test your WinMerge integration, you may have to temporarily edit a test scenario to make it fail.

Developing with Eclipse

You can download Eclipse and load the Frank!Framework sources into it using the Frank!Runner. It will also take care of project Lombok. If you want to understand what you are doing, you can do it manually using the instructions of this section. If you use the Frank!Runner, you still need to do the Eclipse configurations that are explained here.

Install Eclipse

  • Open the webpage with downloads of Eclipse. At the top of this page, you see a link to download an installer. We recommend that you do not use an installer, because you can also download a .zip file with the sources of Eclipse. When you use a zip file instead of an installer, it is easier to have different versions of Eclipse on your development computer.
  • Click the link "Eclipse IDE for Enterprise Java and Web Developers". A page opens with a big Download button to the right. Skip that one because it is an installer. Click a link to the left of that, under "Download Links". We tested our instructions with version 2021-12, but older versions should also work. To install Eclipse, just unzip your download to a directory of your choice.
  • You may get an error "path too long". You can fix that by giving your .zip file a shorter name and trying again.

Configure Eclipse

  • Make sure you have Lombok installed!
  • If you want to change -vm options in eclipse.ini, please be aware that that option is present already. Update the existing option and do not introduce a duplicate -vm.
  • Start Eclipse and close Welcome.
  • Make sure that the default text file line delimiter is set to Unix and default encoding is set to UTF-8: Window, Preferences, General, Workspace, New text file line delimiter: Unix, Text file encoding: UTF-8.
  • We prefer to run the Frank!Framework on Java 17. Please install a Java 17 JDK in addition to the JRE that is included in your Eclipse installation. You can find it here. This is a distribution of the OpenJDK, so no issues with copyright. After downloading, install it in Windows | Preferences | Java | Installed JREs. (You may have to delete the JRE that came with Eclipse there.)

Note: the Frank!Console is an NPM project, if you choose to import this module (in a later step) you will need to run 'Run as -> Maven install'

Set up a Lombok in Eclipse

  • Download the Lombok dependency. Please open it as a Java application.
  • You see a GUI. The GUI may automatically find your Eclipse installation. If this does not work, use the button "Specify location".
  • Press Install / Update.
  • If you have trouble with these instructions, then you can get help on the https://projectlombok.org/ site. On the top menu, choose "install" | "Eclipse".
  • You must restart Eclipse to start using the Lombok integration.

Import the source code

  • Make sure Maven is able to access the internet. E.g. when behind a proxy: Window, Preferences, Maven, User Settings, settings.xml should exist and contain proxy configuration.
  • Window, Open Perspective, Other..., Git, OK, Clone a Git repository, URI: https://github.com/frankframework/frankframework.git, Next, Next, Finish.
  • Optionally (when you have access to the proprietary jars some modules depend on) add your Nexus credentials and enable the proprietary profile in your maven settings.xml
  • In the Git Perspective, right-click the IAF Repository and click 'Import Projects...'
  • The Import wizard appears which allows you to import many different kinds of projects.
  • deselect: iaf-sap, iaf-tibco, iaf-idin, docker* and ear (unless you have access to the proprietary repository), Finish.
  • Window, Open Perspective, Other..., Java EE.
  • Right click iaf, Maven, Update Project..., OK. Now Eclipse will update the classpath settings according to the module pom file. (Updating the project may take a while!)

Set up a Tomcat server in Eclipse

  • Servers, No servers are available. Click this link to create a new server..., Apache, Tomcat v10.0 Server, Next, Browse..., select the root folder of a Tomcat installation (when not available download Tomcat version 10.1.20 or a later version of Tomcat 10), OK, Finish.
  • Double click Tomcat v10.0 Server at localhost, Open launch configuration, Arguments, VM arguments, add -Ddtap.stage=LOC, OK, Modules, Add Web Module..., iaf-example, OK, File, Save
  • Right click Tomcat v10.0 Server at localhost, Start.
  • Browse the IAF console at http://localhost:8080/iaf-example/.

Install latest LTS NodeJS

  • Download the latest LTS version of NodeJS or check the Angular Version compatability to decide which version to install.
  • Test if NodeJS is correctly installed then you should be able to open a terminal/cmd and type in node -v and npm -v without any errors.

In some cases you might want/need to:

  • Right click iaf, Maven, Update Project..., OK.
  • Delete .setting folder(s) in broken iaf module(s), followed by right click iaf, Maven, Update Project..., OK.
  • Enable Project, Build Automatically
  • Right click Tomcat Server at localhost, Clean...
  • Change newlines in .classpath and org.eclipse.wst.common.component files back to Unix newlines.
  • Right click pom.xml (in iaf), Run As, Maven build..., JRE, make sure a JDK (not a JRE) is used, Refresh, Refresh resources upon completion, Specific resources, Specify Resources..., iaf (Using "The project containing the selected resource" doesn't seem to work), Finish, Run.
  • The local Maven repository might contain corrupt jar files which for example will result in java.lang.NoClassDefFoundError: org/aspectj/lang/ProceedingJoinPoint when starting Tomcat. Remove the jar file from the repository to make Maven download the file again.
  • When changing IAF versions Eclipse doesn't always automatically clean the tomcat deploy folder (wtpwebapps). Right click project, Run As, Maven Clean, followed by Right click Tomcat v7.0 Server at localhost, Clean...
  • Check the deployment assemblies:
    • Right-click iaf-webapp and choose Properties. In the left-hand menu select "Deployment Assembly". To the right, you see what Eclipse directories are mapped to what directories within Apache Tomcat. You should have:
      • src/main/webapp to /
      • target/m2e-wtp/web-resources to /
      • iaf-akamai to WEB-INF/lib/frankframework-akamai-X.Y-SNAPSHOT.jar
      • ...
      • iaf-larva to WEB-INF/lib/frankframework-larva-X.Y-SNAPSHOT.jar
      • Maven Dependencies to WEB-INF/lib
    • Sometimes, an additional mapping / to / is present. This is wrong; if you see it, delete it!
    • Right-click iaf-example and choose Properties. In the left-hand menu select "Deployment Assembly". To the right, you see what Eclipse directories are mapped to what directories within Apache Tomcat. You should have:
      • /src/main/java to WEB-INF/classes
      • /src/main/resources to WEB-INF/classes
      • /src/main/webapp to /
      • /target/m2e-wtp/web-resources to /
      • iaf-core to WEB-INF/lib/frankframework-core-X.Y-SNAPSHOT.jar
      • iaf-example to -
      • ...
      • iaf-webapp to -
      • Maven Dependencies to WEB-INF/lib
    • Sometimes, an additional mapping / to / is present. This is wrong; if you see it, delete it!
  • When running Tomcat v8.5 or higher, you can disable its pluggability scans to prevent unnecessarily long startup times. Background info: https://tomcat.apache.org/tomcat-10.0-doc/config/jar-scan-filter.html To do this, add the following element within the Context element of your Tomcat server's context.xml file:
<JarScanner>
    <JarScanFilter defaultPluggabilityScan="false" />
</JarScanner>
  • In case Eclipse is continuously downloading javadoc and source files, you might need to upgrade your M2E installation.

Let Eclipse check Javadoc comments

Please ensure that your Javadoc comments are correct. Eclipse can check this for you. Please do the following:

  • In the main menu, open Windows | Preferences.
  • Go to Java | Compiler | Javadoc.
  • Check checkbox "Process Javadoc comments".
  • In pull-down menu "Malformed Javadoc comments", select "Error".
  • In pull-down menu "Only consider members as visible as", choose "Private".
  • Check checkbox "Validate tag arguments".
  • Uncheck "Report non-visible references" and "Report deprecated references".
  • In pull-down menu "Missing tag descriptions", select "Ignore".
  • In pull-down menu "Missing Javadoc tags", select "Ignore".

Developing with IntelliJ

Install latest LTS NodeJS

  • Download the latest LTS version of NodeJS or check the Angular Version compatability to decide which version to install.
  • Test if NodeJS is correctly installed then you should be able to open a terminal/cmd and type in node -v and npm -v without any errors.

Setup IntelliJ

This guide assumes that you are using IntelliJ Ultimate, because application servers and WAR exploded are not included in the community edition.

  • Clone the source any way you like. E.g. "New | Project from Version Control", or at the commandline: git clone git@github.com:frankframework/frankframework.git
  • If you cloned from the command line, then: From File -> Open... Select iaf folder and import it as a Maven project.
  • When asked to open the Eclipse project or the Maven project, choose opening the Maven project.
  • Make sure to select Java 17 as a default JDK.
  • In the Maven tool window, open the "Profiles" section and make sure to select the profile database-drivers amongst other profiles that are selected by default. After doing this, make sure to reload the Maven project to add the extra dependencies from this profile to your project classpath.
  • You may need to install / enable the Lombok plugin if it is not already installed / enabled, so that IntelliJ will properly understand the code with all the Lombok annotations in it. If the plugin is installed you may get a notification from IntelliJ when the project is built that annotation processing needs to be enabled in the project for Lombok to work, enable this.
  • Download Tomcat 10 from https://tomcat.apache.org/download-10.cgi and unzip it anywhere you like. (On Windows, make sure to extract it on a folder which can be edited by non-admin users), or install it via brew (on macOS) or sdkman. Make sure that all scripts are executable, for instance: chmod a+x ~/.sdkman/candidates/tomcat/current/bin/*.sh
  • Open Settings | Build, Execution, Deployment | Application Servers, add the Tomcat installation you just did.
  • A run configuration can be created for each individual project. Provided are examples for the example project and test project, but these can be adapted to work for other projects as well.
    • Example project:
      • Create a run configuration for a Tomcat server.
      • In the tab "Deployments", choose the module "frankframework-example:war exploded". Make sure that it is a war exploded and not a war.
      • Set the context to /iaf-example.
      • Set the following VM options: -Ddtap.stage=LOC.
      • In the "On Update" section, select "Update Classes and Resources", so classes can be automatically updated and reloaded after project build (providing this is supported by your JDK)
      • Under the section "Before launch", add a build step to build the console-frontend project via Maven. Add a Maven Goal action, running command install in the project "frankframework-console-frontend". These build steps should be in the following order:
        1. Build console-frontend
        2. Build the war exploded artifact.
      • Name your configuration and save it.
    • Test project:
      • TESTING WITH IAF-TEST contains detailed information on how to use this project.
      • Create a run configuration for a Tomcat server.
      • In the tab "Deployments", choose the module "frankframework-test:war exploded". Make sure that it is a war exploded and not a war.
      • Set the context to /iaf-test. NB: This is very important, otherwise a lot of tests will fail!
      • Set the following VM options: -Ddtap.stage=LOC -DauthAliases.expansion.allowed=testalias -Dweb.port=8080 -DcredentialFactory.class=org.frankframework.credentialprovider.FileSystemCredentialFactory -DcredentialFactory.filesystem.root=/<path to source>/frankframework/test/src/main/secrets
      • In the "On Update" section, select "Update Classes and Resources", so classes can be automatically updated and reloaded after project build (providing this is supported by your JDK)
      • Under the section "Before launch", add a build step to build the console-frontend project via Maven. Add a Maven Goal action, running command install in the project "frankframework-console-frontend". These build steps should be in the following order:
        1. Build console-frontend
        2. Build the war exploded artifact.
      • Name your configuration and save it.
  • Run your configuration and you are ready to go. The IAF-Test configuration has all scenarios built-in for testing the Frank!Framework from the Larva test-tool.

Frank!Doc - Documentation for Frank developers

The Frank!Framework is used by Frank developers. They write XML files (Frank configurations) to solve software integration problems. These XML files are translated to Java objects that will collaborate to do the intended job. The Java objects have the types that are available in this repository. For example, when a Frank configuration contains a tag <XsltPipe>, an object of type XsltPipe is instantiated.

The syntax and the meaning of Frank configurations are documented in the following files (the Frank!Doc):

  • ./target/frankDoc/js/frankDoc.json. This file is read by a web application implemented in sub-project webapp. This web application will render the information in the JSON file. Frank developers use the website as a reference manual. See https://frankdoc.frankframework.org.
  • ./target/frankDoc/xml/xsd/FrankConfig-strict.xsd. This file is given to Frank developers. They reference this XSD in their Frank config XML files. When they open an XML file, their text editor will use FrankConfig-strict.xsd to support autocomplete and to provide tooltip information.
  • ./target/frankDoc/xml/xsd/FrankConfig-compatibility.xsd. This file is added to the Frank!Framework .jar file during the Maven build. The file is then used at runtime to parse Frank configurations.

The Frank!Doc is created by a doclet (see https://docs.oracle.com/javase/8/docs/technotes/guides/javadoc/doclet/overview.html) that is implemented in our project https://github.com/frankframework/frank-doc. The doclet is executed during the Maven build of this project. The information in the Frank!Doc is based on the Java source files in this repository. As a developer of the F!F, please take care that the Frank!Doc remains correct and helpful for Frank developers. For further instructions, see FRANKDOC.md.

Thanks, The Frank!Framework Team