azure.yaml schema change to support Java build tool (maven, gradle)

[weikanglim]

Java build tool support

Our current plan is to support Maven build tool for the initial Java release. This also includes the support of the popular Maven wrapper / mvnw plugin that is packaged as part of Java repositories. The main usage of mvnw is to simplify maven installation for Java users, and also to lock down the specific maven version used to build a given Java repository.

With this change, we'll need to introduce a new field, buildTool in azure.yaml to define what build tool the user wants to target.

Question: How should we structure azure.yaml for build tool support?

Option A: Explicit

The schema explicitly requires the user to specify a buildTool value. If unset, a validation error is generated.

Case: buildTool unspecified

api:
    project: ./src/api
    language: java

Result:

An error is generated: Missing property "buildTool"

Case: buildTool specified

api:
    project: ./src/api
    language: java
    buildTool: maven

Result:

The schema is valid and azd uses maven as the build tool.

Option B: Implicit

The schema implicitly assumes buildTool is set to maven by default, allowing for an override value if specified.

Case: buildTool unspecified

api:
    project: ./src/api
    language: java

Result:

azd will use maven as part of packaging implicitly.

Case: buildTool specified

api:
    project: ./src/api
    language: java
    buildTool: gradle

Result:

azd will use gradle as part of packaging.

Option C: Implicit by presence of configuration files

We will infer the build-tool of choice by looking for project configuration files:

• Maven - pom.xml
• Gradle - settings.gradle or settings.gradle.kotl

Maven will be chosen by default if both are present -- Having two project builds isn't something I think we would support.

[jongio]

Default to maven, allow for gradle

Sync with Wallace on scheme property name.

Thanks

[wbreza]

@weikanglim - I'm not a big Java dev - but is there some sort of config file that would exist in a Java project that would describe the build tools being used or similar?

Outside of the name of the tool, would any other arguments need to be considered? Just trying to understand the use case before offering any suggestions.

[weikanglim]

@wbreza That's a very good point. We could infer from the following in the source project folder:

• Maven - pom.xml - Required project configuration
• Gradle - settings.gradle or settings.gradle.kotl - Required project configuration

I do like this approach, adding buildTool isn't quite as flexible as I'd like it to be.

[ellismg]

This also dovetails with what we plan to do for IaC providers, where we intend to sniff the extensions of files in the infra folder to decide what IaC provider to use.

I think in these cases were should error out if the sniffing is inconclusive (maybe they have both because they are moving from one system to another, or something) and then just let the user be explicit in azure.yaml.