fix(6023): replace list with items #6437

kaanyalti · 2024-12-25T14:32:38Z

Bug

What does this PR do?

Replaces list with items from from kibanaFetchToken as the list is deprecated in the api response and will be removed.

Why is it important?

The list in the api response is going to be removed in favor of item

Checklist

My code follows the style guidelines of this project
~~[ ] I have commented my code, particularly in hard-to-understand areas~~
~~[ ] I have made corresponding changes to the documentation~~
~~[ ] I have made corresponding change to the default configuration files~~
I have added tests that prove my fix is effective or that my feature works
I have added an entry in ./changelog/fragments using the changelog tool
I have added an integration test or an E2E test

Disruptive User Impact

There shouldn't be any user impact

How to test this PR locally

Deploy ESS
Build the agent by running the following command

SNAPSHOT=true PLATFORMS="linux/arm64" PACKAGES="docker" EXTERNAL=true mage -v package

Then get the image id for any of the created elastic-agent images and run the following command

docker run \
  --env FLEET_ENROLL=1 \
  --env KIBANA_HOST=<KIBANA HOST> \
  --env KIBANA_USERNAME=<KIBANA USER NAME> \
  --env KIBANA_PASSWORD=<KIBANA PASSWORD> \
  --env FLEET_TOKEN_POLICY_NAME=<POLICY NAME> \
  --env FLEET_URL=<FLEET URL> \
  --rm <IMAGE ID>

Validate that the agent is able to enroll

Related issues

mergify · 2024-12-25T14:33:15Z

This pull request does not have a backport label. Could you fix it @kaanyalti? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

backport-./d./d is the label to automatically backport to the 8./d branch. /d is the digit

mergify · 2024-12-25T14:33:15Z

backport-v8.x has been added to help with the transition to the new branch 8.x.
If you don't need it please use backport-skip label and remove the backport-8.x label.

kaanyalti · 2024-12-27T00:38:09Z

testing/integration/validate_items_deprecated_list_test.go

+	Items []testKibanaApiKey `json:"items"`
+}
+
+// TODO: Remove test after list deprecation is complete


I would like to add an issue link to remove the link from the kibana api, if anyone knows of such an issue please comment here.

let's crete an issue in our repo. this change is breaking and will be removed in 9.0
we can create a PR targeting main with skip backport right away after this one is merge, removing this test

Created this issue https://github.com/orgs/elastic/projects/979/views/23?pane=issue&itemId=92232925&issue=elastic%7Celastic-agent%7C6451

… list

…omes from The integration test added in this pull request needs to be removed once the list component is removed from the kibana api

elastic-sonarqube · 2024-12-31T04:54:58Z

Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube

elasticmachine · 2024-12-31T11:49:37Z

Pinging @elastic/elastic-agent-control-plane (Team:Elastic-Agent-Control-Plane)

* fix(6023): replace list with items * fix(6023): added changelog * fix(6023): added test validating the new items matches the deprecated list * fix(6023): added comment to better trace where the integration test comes from The integration test added in this pull request needs to be removed once the list component is removed from the kibana api * fixs(6023): ran mage update * fix(6023): add build tag to integration test * fix(6023): added unit test for kibanaFetchToken * fix(6023): added error checks in unit test (cherry picked from commit 68d5833)

* fix(6023): replace list with items * fix(6023): added changelog * fix(6023): added test validating the new items matches the deprecated list * fix(6023): added comment to better trace where the integration test comes from The integration test added in this pull request needs to be removed once the list component is removed from the kibana api * fixs(6023): ran mage update * fix(6023): add build tag to integration test * fix(6023): added unit test for kibanaFetchToken * fix(6023): added error checks in unit test (cherry picked from commit 68d5833) Co-authored-by: Kaan Yalti <[email protected]>

mergify bot assigned kaanyalti Dec 25, 2024

mergify bot added the backport-8.x Automated backport to the 8.x branch with mergify label Dec 25, 2024

kaanyalti marked this pull request as ready for review December 27, 2024 00:32

kaanyalti requested a review from a team as a code owner December 27, 2024 00:32

kaanyalti requested review from andrzej-stencel and pchila December 27, 2024 00:32

kaanyalti force-pushed the fix/6023-remove_deprecated_list_property_in_favor_of_items branch from 40d8fbc to 3d55a2b Compare December 27, 2024 00:36

kaanyalti commented Dec 27, 2024

View reviewed changes

michalpristas added the bug Something isn't working label Dec 30, 2024

michalpristas approved these changes Dec 30, 2024

View reviewed changes

kaanyalti force-pushed the fix/6023-remove_deprecated_list_property_in_favor_of_items branch from 9f9c2b9 to 4853b06 Compare December 31, 2024 03:02

kaanyalti added 7 commits December 30, 2024 22:03

fix(6023): replace list with items

34a4aad

fix(6023): added changelog

fd422b7

fix(6023): added test validating the new items matches the deprecated…

94641b0

… list

fix(6023): added comment to better trace where the integration test c…

96867e6

…omes from The integration test added in this pull request needs to be removed once the list component is removed from the kibana api

fixs(6023): ran mage update

5714904

fix(6023): add build tag to integration test

e669456

fix(6023): added unit test for kibanaFetchToken

4d28b79

kaanyalti force-pushed the fix/6023-remove_deprecated_list_property_in_favor_of_items branch from 4853b06 to 4d28b79 Compare December 31, 2024 03:04

kaanyalti mentioned this pull request Dec 31, 2024

Remove validate_items_deprecated_list_test.go integration test #6451

Open

fix(6023): added error checks in unit test

7ae5a1b

swiatekm added the Team:Elastic-Agent-Control-Plane Label for the Agent Control Plane team label Dec 31, 2024

jlind23 merged commit 68d5833 into elastic:main Dec 31, 2024
14 checks passed

mergify bot mentioned this pull request Dec 31, 2024

[8.x](backport #6437) fix(6023): replace list with items #6459

Merged

4 tasks

kaanyalti deleted the fix/6023-remove_deprecated_list_property_in_favor_of_items branch December 31, 2024 15:30

kaanyalti mentioned this pull request Dec 31, 2024

cleanup(6451): removed validate_items_deprecated_list_test.go #6460

Draft

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(6023): replace list with items #6437

fix(6023): replace list with items #6437

kaanyalti commented Dec 25, 2024 •

edited

Loading

mergify bot commented Dec 25, 2024

mergify bot commented Dec 25, 2024

kaanyalti Dec 27, 2024

michalpristas Dec 30, 2024

kaanyalti Dec 31, 2024

elastic-sonarqube bot commented Dec 31, 2024

elasticmachine commented Dec 31, 2024

fix(6023): replace list with items #6437

fix(6023): replace list with items #6437

Conversation

kaanyalti commented Dec 25, 2024 • edited Loading

What does this PR do?

Why is it important?

Checklist

Disruptive User Impact

How to test this PR locally

Related issues

mergify bot commented Dec 25, 2024

mergify bot commented Dec 25, 2024

kaanyalti Dec 27, 2024

Choose a reason for hiding this comment

michalpristas Dec 30, 2024

Choose a reason for hiding this comment

kaanyalti Dec 31, 2024

Choose a reason for hiding this comment

elastic-sonarqube bot commented Dec 31, 2024

Quality Gate passed

elasticmachine commented Dec 31, 2024

kaanyalti commented Dec 25, 2024 •

edited

Loading