Foster beeing OS agnostic by introducing other environments (like Windows) to GitHub Actions builds

[jonashackt]

As we have issues like #1617, we should be able to check, if SBA is not also working on the default GitHub Actions Ubuntu, but also on Windows (and maybe Mac - but I think that might be overengineered?).

[jonashackt]

Facing the build error

Error:  Unknown lifecycle phase ".javadoc.skip=true". You must specify a valid lifecycle phase or a goal in the format <plugin-prefix>:<goal> or <plugin-group-id>:<plugin-artifact-id>[:<plugin-version>]:<goal>. Available lifecycle phases are: validate, initialize, generate-sources, process-sources, generate-resources, process-resources, compile, process-classes, generate-test-sources, process-test-sources, generate-test-resources, process-test-resources, test-compile, process-test-classes, test, prepare-package, package, pre-integration-test, integration-test, post-integration-test, verify, install, deploy, pre-clean, clean, post-clean, pre-site, site, post-site, site-deploy. -> [Help 1]

which seems to be Windows Powershell related, where the Powershell tries to interpret . inside the JavaDoc skip command -D maven.javadoc.skip=true as described in https://stackoverflow.com/questions/38051787/maven-javadoc-skip-true-throws-an-error.

[ccoltx]

Remove it, it's not needed

[jonashackt]

No problem @ccoltx 🤪 works with the space between -D and the maven.javadoc parameter.

But now we have the next problem with the spring-javaformat-maven-plugin:

Error:  Failed to execute goal io.spring.javaformat:spring-javaformat-maven-plugin:0.0.27:validate (default) on project spring-boot-admin-server: Formatting violations found in the following files:
Error:   * D:\a\spring-boot-admin\spring-boot-admin\spring-boot-admin-server\src\main\java\de\codecentric\boot\admin\server\config\AdminServerAutoConfiguration.java

I found a workaround in 78e51b2 - but now I'm getting frustrated with the GitHub Actions Matrix build setup - since right now I need to bloat every workflow with "Windows specific" stuff like that:

      # since we also build on Windows Powershell, we need to add a space between -D maven.javadoc.skip=true
      # otherwise the build will fail https://stackoverflow.com/questions/38051787/maven-javadoc-skip-true-throws-an-error
      - name: Build with Maven
        run: |
          mvn -B spring-javaformat:apply --no-transfer-progress
          mvn -B install --no-transfer-progress -D maven.javadoc.skip=true

[jonashackt]

Hmm, now the maven-checkstyle-plugin runs amock:

[INFO] --- maven-checkstyle-plugin:3.1.2:check (checkstyle-validation) @ spring-boot-admin-server ---
[INFO] Starting audit...
Error:  D:\a\spring-boot-admin\spring-boot-admin\spring-boot-admin-server\src\main\java\de\codecentric\boot\admin\server\config\AdminServerAutoConfiguration.java:1: Expected line ending for file is LF(\n), but CRLF(\r\n) is detected. [NewlineAtEndOfFile]

This is related to #1555

[jonashackt]

Ok, seems that the GitHub Actions windows-latest environment has an issue with Docker (see this build log):

Could not find a valid Docker environment. Please see logs and check configuration

[jonashackt]

Ah, this is a known Testcontainers limitation right now with Windows Server 2019 and Docker:

Docker on Windows Server 2019 is currently not supported (also note this issue testcontainers/testcontainers-java#2960).

[jonashackt]

Hmm, sadly also not working with windows-server2016 GitHub Actions environment.

[jonashackt]

Seems that the problem is, that in Windows Server there are only Windows containers activated per default (no Linux containers): https://stackoverflow.com/questions/66077884/testcontainers-in-windows-environment-on-github-actions-could-not-find-a-valid As Sergei Egorov stated:

The problem with windows-latest is that it uses Windows containers, not Linux containers. It means that Testcontainers itself works, but all the images that it starts are Linux-based and, in Windows containers mode, they obviously fail to start :)

So a "fix" for that would be to have a GitHub Action environment with Linux containers enabled! But after some googeling this doesn't seem to be that easy. First I though LCOW (Linux Containers on Windows) would simply need to be enabled. But as this great elaboration states, it's not easy (or even possible) to activate LCOW on the GitHub Actions Windows env.

I digged deeper into the issue and found that LCOW was officially deprecated in 20.10 😢 in favour of WSL2, that brings in native Linux runtime and also Docker for Desktop on Windows 10 already favours this approach.

BUT: We are on Windows Server 2019, which is not Windows 10 Desktop. And on GitHub Actions we only have the server version in it's nano flavor. There's sadly an open issue for the WSL2 support in Windows Server 2019. And scanning the GitHub Actions Windows Server 2019 docs I found out that there's only WSLv1 installed right now.

[jonashackt]

If we don't want to create a private GitHub Actions runner this seems to be a dead end.

The testcontainers team uses Azure Pipelines to run the tests on Windows - maybe we should also switch to this approach. See the testcontainers pipeline at https://github.com/testcontainers/testcontainers-java/blob/master/azure-pipelines.yml

[ccoltx]

@jonashackt - how would you like to proceed? We could tag the testcases using docker and exclude them from the command line here.

[jonashackt]

@ccoltx oh yeah, that would be an approach. I don't see any benefit from also using Azure Pipelines... Do you know how to easily do that with Maven?