[system test] [doc] cruise control package #10615

see-quick · 2024-09-19T18:12:13Z

Type of change

Enhancement / new feature
Refactoring

Description

This PR adds system test documentation to the cruise control package.

Checklist

Write tests
Make sure all tests pass

Signed-off-by: see-quick <maros.orsak159@gmail.com>

im-konge

Few comments, thanks for the PR

systemtest/src/test/java/io/strimzi/systemtest/cruisecontrol/CruiseControlApiST.java

systemtest/src/test/java/io/strimzi/systemtest/cruisecontrol/CruiseControlConfigurationST.java

im-konge · 2024-09-19T22:02:03Z

systemtest/src/test/java/io/strimzi/systemtest/cruisecontrol/CruiseControlST.java

+    @TestDoc(
+        description = @Desc("Test the Cruise Control functionality when API security is disabled."),
+        steps = {
+            @Step(value = "Initialize test storage and resource manager objects", expected = "Test storage and resource manager objects are created"),
+            @Step(value = "Create Kafka Node Pools with 3 brokers each", expected = "Kafka Node Pools are successfully created and ready"),
+            @Step(value = "Create a Kafka cluster with Cruise Control having API security disabled", expected = "Kafka cluster with Cruise Control and no API security is deployed"),
+            @Step(value = "Create a Kafka Rebalance resource", expected = "Kafka Rebalance resource is successfully created"),
+            @Step(value = "Wait for the Kafka Rebalance custom resource state to become ProposalReady", expected = "Kafka Rebalance custom resource state is ProposalReady")
+        },
+        labels = {
+            @Label(value = "cruise-control"),
+        }
+    )


I guess it's not for this PR, but what benefit this test brings in comparison with the one in the CruiseControlApiST?

I mean, we can possibly remove such test case in CruiseControlST, because it seems it does less then test in CruiseControlApiST IMHO. So I can create different PR to removing such test?

systemtest/src/test/java/io/strimzi/systemtest/cruisecontrol/CruiseControlST.java

Signed-off-by: see-quick <maros.orsak159@gmail.com>

PaulRMellor

Looks good, Maros. I left a few suggestions for consistency and a couple of questions where I wasn't sure about the description.

development-docs/systemtests/io.strimzi.systemtest.cruisecontrol.CruiseControlApiST.md

...lopment-docs/systemtests/io.strimzi.systemtest.cruisecontrol.CruiseControlConfigurationST.md

development-docs/systemtests/io.strimzi.systemtest.cruisecontrol.CruiseControlST.md

…ol.CruiseControlApiST.md Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> Signed-off-by: Maros Orsak <maros.orsak159@gmail.com>

…ol.CruiseControlConfigurationST.md Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> Signed-off-by: Maros Orsak <maros.orsak159@gmail.com>

…ol.CruiseControlApiST.md Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> Signed-off-by: Maros Orsak <maros.orsak159@gmail.com>

…ol.CruiseControlConfigurationST.md Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> Signed-off-by: Maros Orsak <maros.orsak159@gmail.com>

…ol.CruiseControlST.md Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> Signed-off-by: Maros Orsak <maros.orsak159@gmail.com>

Signed-off-by: see-quick <maros.orsak159@gmail.com>

…notation Signed-off-by: see-quick <maros.orsak159@gmail.com>

PaulRMellor

LGTM. Couple of places with periods.

development-docs/systemtests/io.strimzi.systemtest.cruisecontrol.CruiseControlST.md

see-quick · 2024-09-20T13:28:15Z

LGTM. Couple of places with periods.

Thanks updated :)

Signed-off-by: see-quick <maros.orsak159@gmail.com>

im-konge

LGTM, thanks :)

im-konge · 2024-09-23T22:22:31Z

systemtest/src/test/java/io/strimzi/systemtest/cruisecontrol/CruiseControlApiST.java

+        @Step(value = "Deploy the cluster operator", expected = "Cluster operator is deployed")
+    },
+    labels = {
+        @Label(value = "cruise-control"),


I just got idea -> not for this PR, as you have it already hardcoded everywhere -> but what about creating some TestDocsLabels where all these values will be stored - then you can just use it everywhere else instead of copy-pasting it every time.

I just got idea -> not for this PR, as you have it already hardcoded everywhere -> but what about creating some TestDocsLabels where all these values will be stored - then you can just use it everywhere else instead of copy-pasting it every time.

TestTags help with that idea I assume :D; Sure +1 it's great. I will create a PR with such a change.

see-quick added 3 commits September 19, 2024 16:43

[system test] [doc] cruise control package

bd96155

Signed-off-by: see-quick <maros.orsak159@gmail.com>

a few updates

0364ba1

Signed-off-by: see-quick <maros.orsak159@gmail.com>

update also md files

fec7edf

Signed-off-by: see-quick <maros.orsak159@gmail.com>

see-quick self-assigned this Sep 19, 2024

see-quick requested a review from a team September 19, 2024 18:12

see-quick added needs review System tests labels Sep 19, 2024

see-quick added this to the 0.44.0 milestone Sep 19, 2024

im-konge reviewed Sep 19, 2024

View reviewed changes

review from Lukas

65ead6b

Signed-off-by: see-quick <maros.orsak159@gmail.com>

see-quick requested a review from PaulRMellor September 20, 2024 09:37

PaulRMellor reviewed Sep 20, 2024

View reviewed changes

see-quick and others added 13 commits September 20, 2024 13:00

Update development-docs/systemtests/io.strimzi.systemtest.cruisecontr…

e9ecdaa

…ol.CruiseControlApiST.md Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> Signed-off-by: Maros Orsak <maros.orsak159@gmail.com>

Update development-docs/systemtests/io.strimzi.systemtest.cruisecontr…

3f963db

…ol.CruiseControlConfigurationST.md Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> Signed-off-by: Maros Orsak <maros.orsak159@gmail.com>

Update development-docs/systemtests/io.strimzi.systemtest.cruisecontr…

33d1e41

…ol.CruiseControlApiST.md Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> Signed-off-by: Maros Orsak <maros.orsak159@gmail.com>

Update development-docs/systemtests/io.strimzi.systemtest.cruisecontr…

3e2733f

…ol.CruiseControlConfigurationST.md Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> Signed-off-by: Maros Orsak <maros.orsak159@gmail.com>

Update development-docs/systemtests/io.strimzi.systemtest.cruisecontr…

2980c7b

…ol.CruiseControlConfigurationST.md Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> Signed-off-by: Maros Orsak <maros.orsak159@gmail.com>

Update development-docs/systemtests/io.strimzi.systemtest.cruisecontr…

78fa930

…ol.CruiseControlST.md Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> Signed-off-by: Maros Orsak <maros.orsak159@gmail.com>

Update development-docs/systemtests/io.strimzi.systemtest.cruisecontr…

786ede7

…ol.CruiseControlST.md Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> Signed-off-by: Maros Orsak <maros.orsak159@gmail.com>

Update development-docs/systemtests/io.strimzi.systemtest.cruisecontr…

211c2ec

…ol.CruiseControlST.md Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> Signed-off-by: Maros Orsak <maros.orsak159@gmail.com>

Update development-docs/systemtests/io.strimzi.systemtest.cruisecontr…

d2ba824

…ol.CruiseControlST.md Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> Signed-off-by: Maros Orsak <maros.orsak159@gmail.com>

Update development-docs/systemtests/io.strimzi.systemtest.cruisecontr…

cf5c5eb

…ol.CruiseControlST.md Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> Signed-off-by: Maros Orsak <maros.orsak159@gmail.com>

review from Paul

3987d64

Signed-off-by: see-quick <maros.orsak159@gmail.com>

update docs

20c4d5b

Signed-off-by: see-quick <maros.orsak159@gmail.com>

update a test case testCruiseControlWithRebalanceResourceAndRefreshAn…

a07c3cb

…notation Signed-off-by: see-quick <maros.orsak159@gmail.com>

PaulRMellor approved these changes Sep 20, 2024

View reviewed changes

development-docs/systemtests/io.strimzi.systemtest.cruisecontrol.CruiseControlST.md Outdated Show resolved Hide resolved

development-docs/systemtests/io.strimzi.systemtest.cruisecontrol.CruiseControlST.md Outdated Show resolved Hide resolved

see-quick added 2 commits September 20, 2024 15:28

a few periods

4ad03ea

Signed-off-by: see-quick <maros.orsak159@gmail.com>

update for identical test case

a4b52a9

Signed-off-by: see-quick <maros.orsak159@gmail.com>

im-konge approved these changes Sep 23, 2024

View reviewed changes

see-quick added ready for merge Label for PRs which are ready for merge and removed needs review labels Sep 24, 2024

see-quick merged commit a09c20e into strimzi:main Sep 24, 2024
13 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[system test] [doc] cruise control package #10615

[system test] [doc] cruise control package #10615

see-quick commented Sep 19, 2024 •

edited

Loading

im-konge left a comment

im-konge Sep 19, 2024

see-quick Sep 20, 2024

PaulRMellor left a comment

PaulRMellor left a comment

see-quick commented Sep 20, 2024

im-konge left a comment

im-konge Sep 23, 2024

see-quick Sep 24, 2024

[system test] [doc] cruise control package #10615

[system test] [doc] cruise control package #10615

Conversation

see-quick commented Sep 19, 2024 • edited Loading

Type of change

Description

Checklist

im-konge left a comment

Choose a reason for hiding this comment

im-konge Sep 19, 2024

Choose a reason for hiding this comment

see-quick Sep 20, 2024

Choose a reason for hiding this comment

PaulRMellor left a comment

Choose a reason for hiding this comment

PaulRMellor left a comment

Choose a reason for hiding this comment

see-quick commented Sep 20, 2024

im-konge left a comment

Choose a reason for hiding this comment

im-konge Sep 23, 2024

Choose a reason for hiding this comment

see-quick Sep 24, 2024

Choose a reason for hiding this comment

see-quick commented Sep 19, 2024 •

edited

Loading