[NIFI-10047] Refactor Groovy Tests to Java

• Type: Epic
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 2.0.0-M1
• Component/s: Core Framework, Extensions, NiFi Registry
• Epic Name: Refactor Groovy Tests to Java
• Epic Status: To Do
• Assignee: David Handermann
• Reporter: David Handermann
• Created: 24/May/22 13:29
• Updated: 23/Oct/23 15:32
• Resolved: 23/Oct/23 13:56

Description

A number of component modules include unit tests written in Groovy, while the majority of tests are written in Java. Although Groovy has some advantages for testing in particular, the lack of consistency across the framework presents several maintenance challenges.

Groovy is similar enough to Java that it is possible to read with minimal effort, but writing idiomatic Groovy requires a greater understanding of the language. Some unit tests have leveraged Groovy to bypass method visibility constraints, which violates standard class and method contracts. Compiling and running tests in Groovy requires additional Maven configuration and plugin execution, which contributes to the overall runtime of continuous integration workflows. Using Java as the standard language for both implementation and tests also makes it easier for contributors to maintain and review changes.

For these reasons, existing Groovy test classes should be rewritten in Java, with the exception of scripting components.

Refactoring and rewriting tests should be done in logical groups of work to avoid missing important test functions in the conversion process. Some of the modules with larger numbers of Groovy tests include the following:

• nifi-toolkit-encrypt-config
• nifi-toolkit-admin
• nifi-registry-core
• nifi-security-utils
• nifi-elasticsearch-restapi-processors
• nifi-elasticsearch-client-service
• nifi-framework-cluster
• nifi-framework-core
• nifi-web-api
• nifi-lookup-services
• nifi-standard-processors

Issue Links

• is related to: NIFI-12243 Refactor encrypt-config Command Implementation
• relates to: NIFI-12262 Remove Unused Groovy Dependency Definitions

Sub-Tasks

• Refactor Groovy tests in nifi-standard-processors to Java (and JUnit 5): Resolved
• Refactor NiFi elasticsearch client service module to no longer use Groovy unit tests: Resolved
• Refactor Groovy tests in nifi-dbcp-service to Java (Junit 5): Resolved
• Refactor Groovy tests in nifi-commons/nifi-utils to Java (and JUnit 5): Resolved
• Refactor Groovy tests in nifi-security-utils to Java: Resolved
• Refactor Groovy tests in nifi-commons/nifi-expression-language to Java (and JUnit 5): Resolved
• Refactor Groovy tests in nifi-commons/nifi-json-utils to Java (and JUnit 5): Resolved
• Refactor Groovy tests in nifi-commons/nifi-security-utils-api to Java (and JUnit 5): Resolved
• Refactor Groovy tests in nifi-commons/nifi-socket-utils to Java (and JUnit 5): Resolved
• Refactor Groovy tests in nifi-commons/nifi-web-utils to Java (and JUnit 5): Resolved
• Refactor Groovy tests in nifi-cdc/nifi-cdc-mysql-bundle/nifi-cdc-mysql-processors to Java (and JUnit 5): Resolved
• Refactor Groovy tests in nifi-web-api to Java (and JUnit 5): Resolved
• Refactor Groovy test in nifi-jetty to Java (and JUnit 5): Resolved
• Refactor Groovy tests in nifi-web-error and nifi-web-security to Java (and JUnit 5): Resolved
• Refactor Groovy tests in nifi-elasticsearch-restapi-processors to Java (and JUnit 5): Resolved
• Refactor PeerSelectorTest from Groovy to Java: Resolved
• Convert Groovy unit tests in nifi-toolkit-tls to Java: Resolved
• Convert Groovy tests in nifi-scripting-bundle/nifi-scripting-processors to Java: Resolved
• Refactor Groovy unit test in nifi-mock-record-utils to Java: Resolved
• Refactor Groovy Tests in nifi-lookup-services: Resolved
• Remove Groovy Tests using Spock Framework: Resolved