Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use Quarkus Antora for testing and live-editting of the docs #459

Merged
merged 2 commits into from
Apr 12, 2024

Conversation

ppalaga
Copy link
Contributor

@ppalaga ppalaga commented Apr 11, 2024

No description provided.

@ppalaga ppalaga requested a review from a team as a code owner April 11, 2024 22:06
Copy link
Collaborator

@geoand geoand left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very interesting, thanks!

@geoand geoand merged commit 1d158e7 into quarkiverse:main Apr 12, 2024
10 of 11 checks passed
@jmartisk
Copy link
Collaborator

jmartisk commented Apr 15, 2024

I can't build quarkus-langchain4j anymore after this PR, after calling mvn clean install -DskipTests I get:

ERROR] Failed to execute goal io.quarkus:quarkus-maven-plugin:3.8.2:build (default) on project quarkus-langchain4j-docs: Failed to build quarkus application: io.quarkus.builder.BuildException: Build failure: Build failed due to errors
[ERROR] 	[error]: Build step io.quarkiverse.antora.deployment.AntoraProcessor#buildAntoraSite threw an exception: org.opentest4j.AssertionFailedError: null: Failed to create content cache directory: /antora/docs/target/antora-cache/content; EACCES: permission denied, mkdir '/antora/docs/target/antora-cache' Add the --stacktrace option to see the cause of the error.

@ppalaga got any tips what to do? I tried blindly running mkdir -p docs/antora/docs/target/antora-cache but that didn't help

@ppalaga
Copy link
Contributor Author

ppalaga commented Apr 15, 2024

Ouch, sorry about that @jmartisk. Which OS is that? Which line is throwing the error?

@jmartisk
Copy link
Collaborator

The full error

ERROR] Failed to execute goal io.quarkus:quarkus-maven-plugin:3.8.2:build (default) on project quarkus-langchain4j-docs: Failed to build quarkus application: io.quarkus.builder.BuildException: Build failure: Build failed due to errors
[ERROR] 	[error]: Build step io.quarkiverse.antora.deployment.AntoraProcessor#buildAntoraSite threw an exception: org.opentest4j.AssertionFailedError: null: Failed to create content cache directory: /antora/docs/target/antora-cache/content; EACCES: permission denied, mkdir '/antora/docs/target/antora-cache' Add the --stacktrace option to see the cause of the error.
[ERROR] 	at org.junit.jupiter.api.AssertionUtils.fail(AssertionUtils.java:38)
[ERROR] 	at org.junit.jupiter.api.Assertions.fail(Assertions.java:138)
[ERROR] 	at io.quarkiverse.antora.deployment.AntoraProcessor$AntoraFrameConsumer.assertNoErrors(AntoraProcessor.java:462)
[ERROR] 	at io.quarkiverse.antora.deployment.AntoraProcessor.buildAntoraSite(AntoraProcessor.java:141)
[ERROR] 	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
[ERROR] 	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:77)
[ERROR] 	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
[ERROR] 	at java.base/java.lang.reflect.Method.invoke(Method.java:568)
[ERROR] 	at io.quarkus.deployment.ExtensionLoader$3.execute(ExtensionLoader.java:849)
[ERROR] 	at io.quarkus.builder.BuildContext.run(BuildContext.java:256)
[ERROR] 	at org.jboss.threads.ContextHandler$1.runWith(ContextHandler.java:18)
[ERROR] 	at org.jboss.threads.EnhancedQueueExecutor$Task.run(EnhancedQueueExecutor.java:2513)
[ERROR] 	at org.jboss.threads.EnhancedQueueExecutor$ThreadBody.run(EnhancedQueueExecutor.java:1538)
[ERROR] 	at java.base/java.lang.Thread.run(Thread.java:842)
[ERROR] 	at org.jboss.threads.JBossThread.run(JBossThread.java:501)

I'm on Fedora

@maxandersen
Copy link
Member

I reckon you are running rootful podman or container writing files in group you aren't member of? Shouldn't happen but could explain it.

What's the owner/group permissions of that directory and contents ?

@jmartisk
Copy link
Collaborator

I can work around it by manually creating these directories in docs/target:

mkdir -p antora-cache/content/ui
mkdir -p antora-cache/ui

But then I start getting a different error

java.lang.RuntimeException: io.quarkus.builder.BuildException: Build failure: Build failed due to errors
	[error]: Build step io.quarkiverse.antora.deployment.AntoraProcessor#buildAntoraSite threw an exception: java.lang.RuntimeException: Could not parse AntoraFrame node:internal/process/promises:246

	at io.quarkiverse.antora.deployment.AntoraProcessor$AntoraFrameConsumer.assertNoErrors(AntoraProcessor.java:452)
	at io.quarkiverse.antora.deployment.AntoraProcessor.buildAntoraSite(AntoraProcessor.java:141)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:77)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.base/java.lang.reflect.Method.invoke(Method.java:568)
	at io.quarkus.deployment.ExtensionLoader$3.execute(ExtensionLoader.java:849)
	at io.quarkus.builder.BuildContext.run(BuildContext.java:256)
	at org.jboss.threads.ContextHandler$1.runWith(ContextHandler.java:18)
	at org.jboss.threads.EnhancedQueueExecutor$Task.run(EnhancedQueueExecutor.java:2513)
	at org.jboss.threads.EnhancedQueueExecutor$ThreadBody.run(EnhancedQueueExecutor.java:1538)
	at java.base/java.lang.Thread.run(Thread.java:842)
	at org.jboss.threads.JBossThread.run(JBossThread.java:501)
Caused by: com.fasterxml.jackson.core.JsonParseException: Unrecognized token 'node': was expecting (JSON String, Number, Array, Object or token 'null', 'true' or 'false')
 at [Source: REDACTED (`StreamReadFeature.INCLUDE_SOURCE_IN_LOCATION` disabled); line: 1, column: 5]
	at com.fasterxml.jackson.core.JsonParser._constructError(JsonParser.java:2481)
	at com.fasterxml.jackson.core.base.ParserMinimalBase._reportError(ParserMinimalBase.java:762)
	at com.fasterxml.jackson.core.json.ReaderBasedJsonParser._reportInvalidToken(ReaderBasedJsonParser.java:3042)
	at com.fasterxml.jackson.core.json.ReaderBasedJsonParser._reportInvalidToken(ReaderBasedJsonParser.java:3020)
	at com.fasterxml.jackson.core.json.ReaderBasedJsonParser._matchToken(ReaderBasedJsonParser.java:2794)
	at com.fasterxml.jackson.core.json.ReaderBasedJsonParser._matchNull(ReaderBasedJsonParser.java:2780)
	at com.fasterxml.jackson.core.json.ReaderBasedJsonParser.nextToken(ReaderBasedJsonParser.java:782)
	at com.fasterxml.jackson.databind.ObjectMapper._initForReading(ObjectMapper.java:4986)
	at com.fasterxml.jackson.databind.ObjectMapper._readMapAndClose(ObjectMapper.java:4892)
	at com.fasterxml.jackson.databind.ObjectMapper.readValue(ObjectMapper.java:3846)
	at com.fasterxml.jackson.databind.ObjectMapper.readValue(ObjectMapper.java:3814)
	at io.quarkiverse.antora.deployment.AntoraProcessor$AntoraFrameConsumer.accept(AntoraProcessor.java:421)
	at io.quarkiverse.antora.deployment.AntoraProcessor$AntoraFrameConsumer.accept(AntoraProcessor.java:404)
	at org.testcontainers.containers.output.FrameConsumerResultCallback$LineConsumer.consume(FrameConsumerResultCallback.java:141)
	at org.testcontainers.containers.output.FrameConsumerResultCallback$LineConsumer.processFrame(FrameConsumerResultCallback.java:106)
	at org.testcontainers.containers.output.FrameConsumerResultCallback.onNext(FrameConsumerResultCallback.java:47)
	at org.testcontainers.containers.output.FrameConsumerResultCallback.onNext(FrameConsumerResultCallback.java:20)
	at org.testcontainers.shaded.com.github.dockerjava.core.exec.AbstrAsyncDockerCmdExec$1.onNext(AbstrAsyncDockerCmdExec.java:41)
	at org.testcontainers.shaded.com.github.dockerjava.core.FramedInputStreamConsumer.accept(FramedInputStreamConsumer.java:78)
	at org.testcontainers.shaded.com.github.dockerjava.core.FramedInputStreamConsumer.accept(FramedInputStreamConsumer.java:12)
	at org.testcontainers.shaded.com.github.dockerjava.core.DefaultInvocationBuilder.lambda$executeAndStream$1(DefaultInvocationBuilder.java:275)
	at java.base/java.lang.Thread.run(Thread.java:842)

@ppalaga
Copy link
Contributor Author

ppalaga commented Apr 15, 2024

I'm on Fedora

OK, thanks. Then you have some special Podman setup as @maxandersen suggests?

The extension tries to run Antora container with the UID of the local user - that for sure is what does not work on your machine.

https://github.com/quarkiverse/quarkus-antora/blob/09cf481bfcbfd414ec57f24fcb180b0797d2fe82/deployment/src/main/java/io/quarkiverse/antora/deployment/AntoraProcessor.java#L126

Maybe I need to set the group ID as well?

@jmartisk
Copy link
Collaborator

I can get it working all the way by removing the explicit setting of the userID (https://github.com/quarkiverse/quarkus-antora/blob/0.0.2/deployment/src/main/java/io/quarkiverse/antora/deployment/AntoraProcessor.java#L126)

It behaves the same when I run the container manually

podman run  -it -v /home/jmartisk/Workspace/quarkus-langchain4j:/antora:Z antora/antora:3.0.1 --cache-dir=./antora-cache docs/antora-playbook.yml

this passes, but when I specify the userId of my current user:

podman run --user 1000 -it -v /home/jmartisk/Workspace/quarkus-langchain4j:/antora:Z antora/antora:3.0.1 --cache-dir=./antora-cache docs/antora-playbook.yml

then I get the same permission error. Which is weird, but I don't understand containers enough to tell what I might have configured wrong

@ppalaga
Copy link
Contributor Author

ppalaga commented Apr 15, 2024

@jmartisk it would be great if I could reproduce this on my Fedora. Is it just a stock Podman without any special config on your side?

@jmartisk
Copy link
Collaborator

I'm not aware of anything special, but yeah I can't remember all the stuff that I did with it over the years. It's podman 4.6.2. Running setenforce 0 didn't help. Doesn't anybody else have this problem? @cescoffier you talked about having some somewhat different problem?

@maxandersen
Copy link
Member

the issue is volume mounts permission aren't handled consistently between different docker environments.

i don't have a solution except at least for now turn this off and put in profile.

@maxandersen
Copy link
Member

PR for disabling as it just wont build as is on windows/mac using podman: #496

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants