Introduction of maven.top-level-basedir property and updated docs #17351

aloubyansky · 2021-05-19T11:07:25Z

I am not sure whether I should add this property to the project generation templates.

quarkus-bot · 2021-05-19T11:10:38Z

This workflow status is outdated as a new workflow run has been triggered.

🚫 This workflow run has been cancelled.

Failing Jobs - Building `f4a7b84`

⚠️ Artifacts of the workflow run were not available thus the report misses some details.

Status	Name	Step	Test failures	Logs	Raw logs
⌛	Initial JDK 11 Build	`Build`	⚠️ Check →	Logs	Raw logs

quarkus-bot · 2021-05-19T11:11:43Z

This workflow status is outdated as a new workflow run has been triggered.

🚫 This workflow run has been cancelled.

Failing Jobs - Building `3997354`

⚠️ Artifacts of the workflow run were not available thus the report misses some details.

Status	Name	Step	Test failures	Logs	Raw logs
⌛	Initial JDK 11 Build	`Reclaim Disk Space`	⚠️ Check →	Logs	Raw logs

famod · 2021-05-19T12:35:31Z

I will have to take a close look later, but have you considered maven.multiModuleProjectDirectory? This requires a toplevel .mvn directory, though.

aloubyansky · 2021-05-19T12:44:54Z

We actually had something similar by default https://github.com/quarkusio/quarkus/blob/main/independent-projects/bootstrap/maven-resolver/src/main/java/io/quarkus/bootstrap/resolver/maven/BootstrapMavenContext.java#L817
In the reported issue though there is no .mvn dir.

gsmet

Spotted a couple of minor things.

docs/src/main/asciidoc/maven-tooling.adoc

gsmet · 2021-05-19T13:15:28Z

.../maven-resolver/src/main/java/io/quarkus/bootstrap/resolver/maven/BootstrapMavenContext.java

+        if (config.rootProjectDir == null) {
+            final String topLevelBaseDirStr = PropertyUtils.getProperty(MAVEN_TOP_LEVEL_PROJECT_BASEDIR);
+            final Path tmp = topLevelBaseDirStr == null ? null : Paths.get(topLevelBaseDirStr);
+            this.rootProjectDir = tmp == null || !Files.exists(tmp) ? null : tmp;


This is quite convoluted.

Shouldn't we just check if it's defined and if so throw an error if it doesn't exist?

Makes sense. Done.

quarkus-bot · 2021-05-19T15:53:34Z

This workflow status is outdated as a new workflow run has been triggered.

🚫 This workflow run has been cancelled.

Failing Jobs - Building `90fa969`

⚠️ Artifacts of the workflow run were not available thus the report misses some details.

Status	Name	Step	Test failures	Logs	Raw logs
⌛	Initial JDK 11 Build	`Set up job`	⚠️ Check →	Logs	Raw logs
⌛	Attach pull request number	`Set up job`	⚠️ Check →	Logs	Raw logs
⌛	CI Sanity Check		⚠️ Check →	Logs	Raw logs

quarkus-bot · 2021-05-19T15:55:30Z

This workflow status is outdated as a new workflow run has been triggered.

🚫 This workflow run has been cancelled.

Failing Jobs - Building `cb25232`

⚠️ Artifacts of the workflow run were not available thus the report misses some details.

Status	Name	Step	Test failures	Logs	Raw logs
⌛	Initial JDK 11 Build	`Build`	⚠️ Check →	Logs	Raw logs

famod · 2021-05-19T19:35:09Z

docs/src/main/asciidoc/maven-tooling.adoc

+            <maven.home>${maven.hom}</maven.home> <1>
+            <maven.repo.local>${settings.localRepository}</maven.repo.local> <2>
+            <maven.settings>${session.request.userSettingsFile.path}</maven.settings> <3>
+            <maven.top-level-basedir>${session.topLevelProject.basedir.absolutePath}</maven.top-level-basedir> <4>


Doesn't seem to provide the correct dir when used with -f:

$ mvn -f integration-tests/flyway/ help:evaluate -Dexpression=session.topLevelProject.basedir.absolutePath -q -DforceStdout /home/famod/proj/quarkus/integration-tests/flyway

$ mvn -f integration-tests/flyway/ help:evaluate -Dexpression=maven.multiModuleProjectDirectory -q -DforceStdout /home/famod/proj/quarkus

Well, that's what Maven reports as the top-level project. Right?

When you use -f that's what you are asking for, right?

But I also see your point.

If I use the reproducer from the original report, either property works. So, I'm wondering whether maven.multiModuleProjectDirectory is a better choice.

AFAIK, maven.multiModuleProjectDirectory is not really documented. And it seems some Maven maintainers don't like users taking advantage of it:
https://lists.apache.org/thread.html/re9419b4792bd324eac4bbe5a5d21c11800b33c8d8fb2dfdf3eb55b28%40%3Cusers.maven.apache.org%3E

PS: Link fixed ⬆️.
PPS: I use that property in my projects regardless of that controversy. 🤷

Added a note that it's not an officially supported property.

Yeah ok. I mean it's out there, people are using it, for good reasons!
But to be on the safe side for a big public framework like Quarkus, this defensive approach makes sense.

Thanks @famod

docs/src/main/asciidoc/maven-tooling.adoc

quarkus-bot · 2021-05-19T20:35:07Z

This workflow status is outdated as a new workflow run has been triggered.

🚫 This workflow run has been cancelled.

Failing Jobs - Building `561b2d9`

⚠️ Artifacts of the workflow run were not available thus the report misses some details.

Status	Name	Step	Test failures	Logs	Raw logs
⌛	Devtools Tests - JDK 11	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Devtools Tests - JDK 11 Windows	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Gradle Tests - JDK 11	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Gradle Tests - JDK 11 Windows	`Build`	⚠️ Check →	Logs	Raw logs
⌛	JVM Tests - JDK 11	`Build`	⚠️ Check →	Logs	Raw logs
⌛	JVM Tests - JDK 11 Windows	`Build`	⚠️ Check →	Logs	Raw logs
⌛	JVM Tests - JDK 16	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Maven Tests - JDK 11	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Maven Tests - JDK 11 Windows	`Build`	⚠️ Check →	Logs	Raw logs
⌛	MicroProfile TCKs Tests	`Verify`	⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Amazon		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Cache		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Data1	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Data2	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Data3	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Data4	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Data5	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Data6	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Data7	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Native Tests - HTTP		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Main	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Messaging1		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Messaging2		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Misc1		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Misc2		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Misc3		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Misc4		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Security1		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Security2		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Security3		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Spring		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Windows - hibernate-validator		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - gRPC		⚠️ Check →	Logs	Raw logs

quarkus-bot · 2021-05-19T20:37:38Z

This workflow status is outdated as a new workflow run has been triggered.

🚫 This workflow run has been cancelled.

Failing Jobs - Building `db9dbac`

⚠️ Artifacts of the workflow run were not available thus the report misses some details.

Status	Name	Step	Test failures	Logs	Raw logs
⌛	Initial JDK 11 Build	`Build`	⚠️ Check →	Logs	Raw logs

docs/src/main/asciidoc/maven-tooling.adoc

famod · 2021-05-19T21:00:14Z

My opinion on:

I am not sure whether I should add this property to the project generation templates.

I wouldn't do it because:

session.topLevelProject.basedir.absolutePath doesn't work for -f in "standard setups" (where the bootstrapping doesn't have issues anyway).
maven.multiModuleProjectDirectory requires .mvn (which many might have anyway, but it's no must).

So, IMO, if someone with a more "exotic" setup runs into problems he or she can have a look at the docs you've just extended and pick one of the properties. If I were that person I would go for maven.multiModuleProjectDirectory because it works for more scenarios.

quarkus-bot · 2021-05-19T21:04:20Z

This workflow status is outdated as a new workflow run has been triggered.

🚫 This workflow run has been cancelled.

Failing Jobs - Building `fcbd71a`

⚠️ Artifacts of the workflow run were not available thus the report misses some details.

Status	Name	Step	Test failures	Logs	Raw logs
⌛	Devtools Tests - JDK 11	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Devtools Tests - JDK 11 Windows	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Gradle Tests - JDK 11	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Gradle Tests - JDK 11 Windows	`Build`	⚠️ Check →	Logs	Raw logs
⌛	JVM Tests - JDK 11	`Build`	⚠️ Check →	Logs	Raw logs
⌛	JVM Tests - JDK 11 Windows	`Build`	⚠️ Check →	Logs	Raw logs
⌛	JVM Tests - JDK 16	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Maven Tests - JDK 11	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Maven Tests - JDK 11 Windows	`Build`	⚠️ Check →	Logs	Raw logs
⌛	MicroProfile TCKs Tests	`Verify`	⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Amazon		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Cache		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Data1	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Data2	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Data3	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Data4	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Data5	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Data6	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Data7	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Native Tests - HTTP		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Main	`Build`	⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Messaging1		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Messaging2		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Misc1		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Misc2		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Misc3		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Misc4		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Security1		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Security2		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Security3		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Spring		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - Windows - hibernate-validator		⚠️ Check →	Logs	Raw logs
⌛	Native Tests - gRPC		⚠️ Check →	Logs	Raw logs

quarkus-bot · 2021-05-19T21:21:32Z

This workflow status is outdated as a new workflow run has been triggered.

🚫 This workflow run has been cancelled.

Failing Jobs - Building `03c7e3c`

⚠️ Artifacts of the workflow run were not available thus the report misses some details.

Status	Name	Step	Test failures	Logs	Raw logs
⌛	Calculate Test Jobs	`Run actions/checkout@v2`	⚠️ Check →	Logs	Raw logs

aloubyansky · 2021-05-21T18:06:04Z

@gsmet is this looking ok to you?

gsmet · 2021-05-25T09:24:16Z

I'm happy @famod had a closer look. I'll merge it to get in into CR1.

aloubyansky requested a review from famod May 19, 2021 11:07

quarkus-bot bot added area/devtools Issues/PR related to maven, gradle, platform and cli tooling/plugins area/documentation labels May 19, 2021

aloubyansky force-pushed the maven.top-level-basedir branch from f4a7b84 to 3997354 Compare May 19, 2021 11:09

aloubyansky force-pushed the maven.top-level-basedir branch from 3997354 to eba0361 Compare May 19, 2021 11:11

aloubyansky mentioned this pull request May 19, 2021

"mvn quarkus:dev" workspace discovery should respect default maven profiles #12715

Closed

gsmet changed the title ~~Introduction of mavem.top-level-basedir property and updated docs~~ Introduction of maven.top-level-basedir property and updated docs May 19, 2021

gsmet requested changes May 19, 2021

View reviewed changes

aloubyansky force-pushed the maven.top-level-basedir branch from cb25232 to 2d58577 Compare May 19, 2021 15:54

famod reviewed May 19, 2021

View reviewed changes

aloubyansky force-pushed the maven.top-level-basedir branch 2 times, most recently from 561b2d9 to db9dbac Compare May 19, 2021 20:32

aloubyansky force-pushed the maven.top-level-basedir branch from db9dbac to fcbd71a Compare May 19, 2021 20:36

famod reviewed May 19, 2021

View reviewed changes

docs/src/main/asciidoc/maven-tooling.adoc Outdated Show resolved Hide resolved

aloubyansky force-pushed the maven.top-level-basedir branch from fcbd71a to 03c7e3c Compare May 19, 2021 21:01

Introduction of mavem.top-level-basedir property and updated docs

4d22dd3

aloubyansky force-pushed the maven.top-level-basedir branch from 03c7e3c to 4d22dd3 Compare May 19, 2021 21:20

famod approved these changes May 19, 2021

View reviewed changes

gsmet approved these changes May 25, 2021

View reviewed changes

gsmet merged commit 8890df7 into quarkusio:main May 25, 2021

quarkus-bot bot added this to the 2.0 - main milestone May 25, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduction of maven.top-level-basedir property and updated docs #17351

Introduction of maven.top-level-basedir property and updated docs #17351

aloubyansky commented May 19, 2021

quarkus-bot bot commented May 19, 2021 •

edited

Failing Jobs - Building `f4a7b84`

quarkus-bot bot commented May 19, 2021 •

edited

Failing Jobs - Building `3997354`

famod commented May 19, 2021

aloubyansky commented May 19, 2021

gsmet left a comment

gsmet May 19, 2021

aloubyansky May 19, 2021

quarkus-bot bot commented May 19, 2021 •

edited

Failing Jobs - Building `90fa969`

quarkus-bot bot commented May 19, 2021 •

edited

Failing Jobs - Building `cb25232`

famod May 19, 2021 •

edited

aloubyansky May 19, 2021

aloubyansky May 19, 2021

aloubyansky May 19, 2021

aloubyansky May 19, 2021

famod May 19, 2021 •

edited

famod May 19, 2021

aloubyansky May 19, 2021

famod May 19, 2021

aloubyansky May 19, 2021

quarkus-bot bot commented May 19, 2021 •

edited

Failing Jobs - Building `561b2d9`

quarkus-bot bot commented May 19, 2021 •

edited

Failing Jobs - Building `db9dbac`

famod commented May 19, 2021

quarkus-bot bot commented May 19, 2021 •

edited

Failing Jobs - Building `fcbd71a`

quarkus-bot bot commented May 19, 2021 •

edited

Failing Jobs - Building `03c7e3c`

aloubyansky commented May 21, 2021

gsmet commented May 25, 2021

Introduction of maven.top-level-basedir property and updated docs #17351

Introduction of maven.top-level-basedir property and updated docs #17351

Conversation

aloubyansky commented May 19, 2021

quarkus-bot bot commented May 19, 2021 • edited

Failing Jobs - Building f4a7b84

quarkus-bot bot commented May 19, 2021 • edited

Failing Jobs - Building 3997354

famod commented May 19, 2021

aloubyansky commented May 19, 2021

gsmet left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

quarkus-bot bot commented May 19, 2021 • edited

Failing Jobs - Building 90fa969

quarkus-bot bot commented May 19, 2021 • edited

Failing Jobs - Building cb25232

famod May 19, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

famod May 19, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

quarkus-bot bot commented May 19, 2021 • edited

Failing Jobs - Building 561b2d9

quarkus-bot bot commented May 19, 2021 • edited

Failing Jobs - Building db9dbac

famod commented May 19, 2021

quarkus-bot bot commented May 19, 2021 • edited

Failing Jobs - Building fcbd71a

quarkus-bot bot commented May 19, 2021 • edited

Failing Jobs - Building 03c7e3c

aloubyansky commented May 21, 2021

gsmet commented May 25, 2021

quarkus-bot bot commented May 19, 2021 •

edited

Failing Jobs - Building `f4a7b84`

quarkus-bot bot commented May 19, 2021 •

edited

Failing Jobs - Building `3997354`

quarkus-bot bot commented May 19, 2021 •

edited

Failing Jobs - Building `90fa969`

quarkus-bot bot commented May 19, 2021 •

edited

Failing Jobs - Building `cb25232`

famod May 19, 2021 •

edited

famod May 19, 2021 •

edited

quarkus-bot bot commented May 19, 2021 •

edited

Failing Jobs - Building `561b2d9`

quarkus-bot bot commented May 19, 2021 •

edited

Failing Jobs - Building `db9dbac`

quarkus-bot bot commented May 19, 2021 •

edited

Failing Jobs - Building `fcbd71a`

quarkus-bot bot commented May 19, 2021 •

edited

Failing Jobs - Building `03c7e3c`