Skip to content

Add a Maven profile to remove GELF support - #22615

Merged
vmuzikar merged 1 commit into
keycloak:mainfrom
mabartos:gelfProductRemoval
Aug 29, 2023
Merged

Add a Maven profile to remove GELF support#22615
vmuzikar merged 1 commit into
keycloak:mainfrom
mabartos:gelfProductRemoval

Conversation

@mabartos

@mabartos mabartos commented Aug 22, 2023

Copy link
Copy Markdown
Member

Closes #22515

@mabartos mabartos added the status/hold PR should not be merged. On hold for later. label Aug 22, 2023
@mabartos mabartos self-assigned this Aug 22, 2023
@vmuzikar vmuzikar linked an issue Aug 23, 2023 that may be closed by this pull request
Comment thread quarkus/deployment/pom.xml Outdated
Comment thread quarkus/runtime/pom.xml Outdated
Comment thread quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/Environment.java Outdated
@mabartos
mabartos force-pushed the gelfProductRemoval branch from 346b1d4 to d0961c7 Compare August 24, 2023 16:50
@mabartos mabartos changed the title WiP - Remove GELF from product distribution Add a Maven profile to remove GELF support Aug 24, 2023
@mabartos mabartos removed the status/hold PR should not be merged. On hold for later. label Aug 24, 2023
@mabartos
mabartos marked this pull request as ready for review August 24, 2023 16:56
@mabartos
mabartos requested review from a team as code owners August 24, 2023 16:56
@mabartos
mabartos force-pushed the gelfProductRemoval branch 3 times, most recently from b299296 to 0246380 Compare August 24, 2023 17:03
@mabartos

Copy link
Copy Markdown
Member Author

Should be ready for review now.

@ghost ghost left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Unreported flaky test detected, please review

@ghost

ghost commented Aug 24, 2023

Copy link
Copy Markdown

Unreported flaky test detected

If the below flaky tests below are affected by the changes, please review and update the changes accordingly. Otherwise, a maintainer should report the flaky tests prior to merging the PR.

org.keycloak.testsuite.ui.account2.SessionTest#welcomeScreenAsyncLogoutTest

Keycloak CI - Account Console IT (firefox)

org.awaitility.core.ConditionTimeoutException: Assertion condition defined as a org.keycloak.testsuite.util.URLAssert URL expected to begin with: https://localhost:8543/auth/realms/test/protocol/openid-connect/auth ; actual URL: https://localhost:8543/auth/realms/test/account/#/personal-info within 10 seconds.
	at org.awaitility.core.ConditionAwaiter.await(ConditionAwaiter.java:167)
	at org.awaitility.core.AssertionCondition.await(AssertionCondition.java:119)
	at org.awaitility.core.AssertionCondition.await(AssertionCondition.java:31)
	at org.awaitility.core.ConditionFactory.until(ConditionFactory.java:985)
...

Report flaky test

@mabartos
mabartos requested review from Pepo48 and shawkins August 25, 2023 08:47
@mabartos
mabartos force-pushed the gelfProductRemoval branch from 0246380 to 2a28be3 Compare August 25, 2023 10:00
@mabartos

Copy link
Copy Markdown
Member Author

I've removed the comprehensive approach for HelpCommandDistTest to be working for the product. It'd bring a lot of maintenance difficulties. You can check out what'd be necessary to make it work here: mabartos@0246380

@vmuzikar vmuzikar left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think we should have some test coverage to check GELF is not present in the help. But I agree adding more approved help txts is a bit cumbersome.

Maybe we could create some CheckGelfRemoved test that would just assert the string gelf is not present in help?

@mabartos
mabartos force-pushed the gelfProductRemoval branch from 2a28be3 to 174b580 Compare August 25, 2023 10:54

@mabartos mabartos left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@vmuzikar That should be sufficient. I manually tested for GELF enabled/disabled and it works as expected.

Is it ok for you?

@ghost ghost left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Unreported flaky test detected, please review

@ghost

ghost commented Aug 25, 2023

Copy link
Copy Markdown

Unreported flaky test detected

If the below flaky tests below are affected by the changes, please review and update the changes accordingly. Otherwise, a maintainer should report the flaky tests prior to merging the PR.

org.keycloak.testsuite.forms.VerifyProfileTest#testAttributeRequiredAndSelectedByScope

Keycloak CI - Forms IT (chrome)

java.lang.IllegalArgumentException: No enum constant org.keycloak.testsuite.pages.AppPage.RequestType.
	at java.base/java.lang.Enum.valueOf(Enum.java:273)
	at org.keycloak.testsuite.pages.AppPage$RequestType.valueOf(AppPage.java:56)
	at org.keycloak.testsuite.pages.AppPage.getRequestType(AppPage.java:49)
	at jdk.internal.reflect.GeneratedMethodAccessor552.invoke(Unknown Source)
...

Report flaky test

Comment thread quarkus/server/pom.xml Outdated
@vmuzikar

Copy link
Copy Markdown
Contributor

We'll also need to update the docs to exclude GELF on -Dproduct.

Comment thread quarkus/config-api/src/main/java/org/keycloak/config/LoggingOptions.java Outdated
@ahus1

ahus1 commented Aug 28, 2023

Copy link
Copy Markdown
Member

@mabartos - the logging guide mentions GELF explicitly, so I assume it needs to be changed as well (either in this PR, or another PR).

@mabartos
mabartos marked this pull request as draft August 28, 2023 10:54
@mabartos

Copy link
Copy Markdown
Member Author

@ahus1 Yes, I'm on it.

Closes keycloak#22515

Co-authored-by: Václav Muzikář <vmuzikar@redhat.com>
@mabartos
mabartos force-pushed the gelfProductRemoval branch from 5765bea to f8a4b67 Compare August 29, 2023 13:36
@mabartos
mabartos marked this pull request as ready for review August 29, 2023 13:53
@mabartos

Copy link
Copy Markdown
Member Author

After a discussion with @pedroigor, the property persisting during the build time is not a blocker for this PR.

Documentation stuff works as expected; I've tried it with product doc.

@vmuzikar Could you please check it? (Sorry, I've already squashed all commits, but no big changes were provided since the last time)

@pedroigor pedroigor left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@mabartos Sure. We can do it as a follow-up.

@vmuzikar
vmuzikar enabled auto-merge (squash) August 29, 2023 14:02
@vmuzikar

Copy link
Copy Markdown
Contributor

@mabartos Thanks for the update! Can you please create an issue for the follow-up?

@mabartos

Copy link
Copy Markdown
Member Author

Created follow-up general task related to the static initialization : #22799

@vmuzikar
vmuzikar merged commit 7c013e8 into keycloak:main Aug 29, 2023

@ghost ghost left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Unreported flaky test detected, please review

@ghost

ghost commented Aug 29, 2023

Copy link
Copy Markdown

Unreported flaky test detected

If the below flaky tests below are affected by the changes, please review and update the changes accordingly. Otherwise, a maintainer should report the flaky tests prior to merging the PR.

org.keycloak.testsuite.adapter.example.cors.CorsExampleAdapterTest#angularCorsProductTest

Keycloak CI - Base IT (2)

junit.framework.AssertionFailedError
	at junit.framework.Assert.fail(Assert.java:55)
	at junit.framework.Assert.assertTrue(Assert.java:22)
	at junit.framework.Assert.assertNotNull(Assert.java:256)
	at junit.framework.Assert.assertNotNull(Assert.java:248)
...

Report flaky test

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a Maven profile to remove GELF support

5 participants