Skip to main content

Java application

You can build and test a Java application using a Linux platform on Harness Cloud or a self-hosted Kubernetes cluster build infrastructure.

This guide assumes you've created a Harness CI pipeline. For more information about creating pipelines, go to:

tip

If you don't have a Harness account yet, you can create one for free at app.harness.io.

Install dependencies

Use Run step to install dependencies in the build environment.

              - step:
type: Run
name: build
identifier: build
spec:
connectorRef: account.harnessImage
image: maven:3.8-jdk-11
shell: Sh
command: |-
mvn clean package dependency:copy-dependencies
- step:
type: Run
name: check dependencies
identifier: check_dependencies
spec:
connectorRef: account.harnessImage
image: maven:3.8-jdk-11
shell: Sh
command: |-
mvn dependency-check:check -U -DskipTests
reports:
type: JUnit
spec:
paths:
- /harness/target/*.xml
tip

In addition to Run steps, Plugin steps are also useful for installing dependencies.

You can use Background steps to run dependent services that are needed by multiple steps in the same stage.

Cache dependencies

Cache your Java dependencies with Cache Intelligence. Add caching.enabled.true to your stage.spec.

    - stage:
spec:
caching:
enabled: true

Build and run tests

You can use Run or Run Tests steps to run tests in CI pipelines.

This example uses two Run steps to build and test with Maven.

              - step:
type: Run
name: build
identifier: build
spec:
shell: Sh
command: |
mvn clean package dependency:copy-dependencies
- step:
type: Run
name: run test
identifier: run_test
spec:
shell: Sh
command: |-
mvn test
reports:
type: JUnit
spec:
paths:
- target/surefire-reports/*.xml

Visualize test results

If you want to view test results in Harness, make sure your test commands produce reports in JUnit XML format and that your steps include the reports specification.

                    reports:
type: JUnit
spec:
paths:
- target/surefire-reports/*.xml

Specify version

Java is pre-installed on Hosted Cloud runners. For details about all available tools and versions, go to Platforms and image specifications.

If your application requires a specific version of Java, you can use a Run or Plugin step to install it.

This example uses the GitHub Action plugin step to run the setup-java action.

              - step:
type: Action
name: setup java
identifier: setup_java
spec:
uses: actions/setup-java@v3
with:
distribution: 'temurin'
java-version: '16'

Full pipeline examples

Here's a YAML example of a pipeline that:

  1. Tests a Java code repo.
  2. Builds and pushes an image to Docker Hub.

This pipeline uses Harness Cloud build infrastructure, Cache Intelligence, and Test Intelligence.

If you copy this example, replace the placeholder values with appropriate values for your Harness project, connector IDs, account/user names, and repo names.

Pipeline YAML
pipeline:
name: Build java
identifier: Build_java
projectIdentifier: default
orgIdentifier: default
properties:
ci:
codebase:
connectorRef: YOUR_CODE_REPO_CONNECTOR_ID
repoName: YOUR_REPO_NAME
build: <+input>
stages:
- stage:
name: Build
identifier: Build
description: ""
type: CI
spec:
caching:
enabled: true
cloneCodebase: true
platform:
os: Linux
arch: Amd64
runtime:
type: Cloud
spec: {}
execution:
steps:
- step:
type: RunTests
name: RunTests_1
identifier: RunTests_1
spec:
language: Java
buildTool: Maven
args: test
packages: io.harness
runOnlySelectedTests: true
postCommand: mvn package -DskipTests
reports:
type: JUnit
spec:
paths:
- "target/surefire-reports/*.xml"
- step:
type: BuildAndPushDockerRegistry
name: BuildAndPushDockerRegistry_1
identifier: BuildAndPushDockerRegistry_1
spec:
connectorRef: YOUR_DOCKER_CONNECTOR_ID
repo: YOUR_DOCKER_HUB_USERNAME/DOCKER_REPO_NAME
tags:
- <+pipeline.sequenceId>

Next steps

Now that you have created a pipeline that builds and tests a Java app, you could: