Add useDockerComposeV2 property

[joecotton-wk]

Overview

As has been discussed in #322, #401, and this PR, Docker Compose V1 has reached its deprecation date and is no longer supported. While there are several workarounds (including one provided by Docker), these workarounds do not work for everyone and are not desirable in all cases. To this end, this PR adds the ability for ComposeExecutor to be configured to run using docker compose instead of docker-compose.

Additionally, this PR had the following goals:

• Provide a clear and easy way for consumers to opt into using Compose V2
• Make sure Compose V1 is enabled by default
• Make sure the changes did not break any existing APIs
• Make sure the functionality is properly tested
• Make sure the new option is properly documented

Usage

To use Compose V2, all the user needs to do is add the useDockerComposeV2 property to the dockerCompose section of their build.gradle file:

dockerCompose {
  useDockerComposeV2 = true
}

Verification

In addition to the unit test added in this PR, the code changes proposed here have been tested and verified to work in a real-world project before the PR was submitted.

Test Procedure

The following are the steps I used to test these changes in a real-world project:

• Build and publish the plugin to maven local using the following command:

# Signing tasks are excluded for local development purposes
$ ./gradlew clean publishToMavenLocal \
  --exclude-task signDockerComposePluginPluginMarkerMavenPublication \
  --exclude-task signPluginMavenPublication \
  -Pversion=0.16.13-SNAPSHOT

• Consume the snapshot version from the local maven repository within a real-world project:

[plugins]
avast-docker-compose = { id = "com.avast.gradle.docker-compose", version = "0.16.13-SNAPSHOT" }

Note: In my case, I had to add the following lines to the top of my project's settings.gradle file so that the project would pick up the plugin from the local maven repository:

pluginManagement {
    repositories {
        mavenLocal()
        gradlePluginPortal()
    }
}

• Run ./gradlew clean composeUp and ./gradlew clean composeDown

Test Results

Running the test version of the plugin without the useDockerComposeV2 property set resulted in the following console output. It can plainly be seen that the plugin is using Compose V1 to stand up the stack by the presence of the WARNING lines.

Running the test version of the plugin with useDockerComposeV2 = false resulted in the following console output. Once again, it's clear that the plugin is using Compose V1.

Running the test version of the plugin with useDockerComposeV2 = true resulted in the following console output. In this case, it's clear the plugin was using Compose V2 because the WARNING lines are no longer present.

These tests were performed on a MacBook Pro M1 Max running OSX 13.4.1 (Ventura), using gradle 7.5.1 and Java 17 (Amazon Corretto 17.0.8).

[augi]

Thank you very much for this PR! I have just minor comments, and I'm going to test it on Windows (with Docker Desktop).

[augi]

I can confirm it works on Windows 10 with Docker Desktop 4.21.1, with both V1 and V2.

[joecotton-wk]

Just getting to this, as it's relatively early morning my time. @augi thank you for merging this! Do you want me to open a new PR to address the comments?

[joecotton-wk]

Nevermind, it appears that you already beat me to it (link). Thank you for your help getting this merged!

[augi]

Yeah, and it is released 🎉 I'm also performing more updates of the project now, and will release the 0.17.0 version soon, and it will use V2 as default. It makes IMHO sense as V1 is deprecated now.