Skip to content

Pex 653/verioning activation rollback #457

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.

Sign up for GitHub

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

Merged
xqi-splunk merged 3 commits into from
Dec 10, 2025
+55 −45
Merged

Pex 653/verioning activation rollback #457

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
309d358
Add versioning activation for 8.3
xqi-splunk Nov 18, 2025
504dd84
Comment original kvstore activation logic
xqi-splunk Dec 4, 2025
ac021d1
Add comment for version confirmation workflow
xqi-splunk Dec 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 55 additions & 45 deletions contentctl/objects/content_versioning_service.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,19 +197,23 @@ def _query_content_versioning_service(

# Query the content versioning service
try:
if method == "GET" and self.kvstore_content_versioning:
response = self.service.request(
method=method,
path_segment="content_versioning/versioning_apps",
app="SA-ContentVersioning",
)
if self.indexbased_content_versioning:
response = self.service.request( # type: ignore
method=method,
path_segment="configs/conf-feature_flags/general",
body=body,
app="SA-ContentVersioning",
)
# TODO: The comment out section is for validating versioning is enabled and ready to go. The validation
# workflow (whether to be part of wait_for_cms_main or a separate function) is planed to be implemented
# in later contentctl-ng.
# API endpoint for checking versioning status after ES 8.3.0
# if method == "GET" and self.kvstore_content_versioning:
# response = self.service.request(
# method=method,
# path_segment="content_versioning/versioning_apps",
# app="SA-ContentVersioning",
# )
# if self.indexbased_content_versioning:
response = self.service.request( # type: ignore
method=method,
path_segment="configs/conf-feature_flags/general",
body=body,
app="SA-ContentVersioning",
)
except HTTPError as e:
# Raise on any HTTP errors
raise HTTPError(f"Error querying content versioning service: {e}") from e
Expand Down Expand Up @@ -248,26 +252,30 @@ def is_versioning_activated(self) -> bool:

# Find the versioning_activated field and report any errors
try:
if self.kvstore_content_versioning:
if "content" in data:
for app in data["content"]:
if app.get("name") == "DA-ESS-ContentUpdate":
# If there is error message versioning is not activated properly
if "message" in app:
return False

# If the installed verion is not the same as the test version
if app.get("version") != self.global_config.app.version:
return False

if app.get("status") == "active":
return True
else:
return False
if self.indexbased_content_versioning:
for entry in data["entry"]:
if entry["name"] == "general":
return bool(int(entry["content"]["versioning_activated"]))
# TODO: The comment out section is for validating versioning is enabled and ready to go. The validation
# workflow (whether to be part of wait_for_cms_main or a separate function) is planed to be implemented
# in later contentctl-ng.
# Validating response by checking `status` field in `DA-ESS-ContentUpdate` app
# if self.kvstore_content_versioning:
# if "content" in data:
# for app in data["content"]:
# if app.get("name") == "DA-ESS-ContentUpdate":
# # If there is error message versioning is not activated properly
# if "message" in app:
# return False

# # If the installed verion is not the same as the test version
# if app.get("version") != self.global_config.app.version:
# return False

# if app.get("status") == "active":
# return True
# else:
# return False
# if self.indexbased_content_versioning:
for entry in data["entry"]:
if entry["name"] == "general":
return bool(int(entry["content"]["versioning_activated"]))
except KeyError as e:
raise KeyError(
"Cannot retrieve versioning status, unable to determine versioning status using "
Expand All @@ -283,19 +291,21 @@ def activate_versioning(self) -> None:
Activate the content versioning service
"""
# Post to the SA-ContentVersioning service to set versioning status
if self.indexbased_content_versioning:
self._query_content_versioning_service(
method="POST", body={"versioning_activated": True}
)
self._query_content_versioning_service(
method="POST", body={"versioning_activated": True}
)

# Wait for versioning to be activated for ES 8.3.0+
if self.kvstore_content_versioning:
timeout = 600
while not self.is_versioning_activated:
time.sleep(60)
timeout -= 60
if timeout <= 0:
break
# TODO: The comment out section is for validating versioning is enabled and ready to go. The validation
# workflow (whether to be part of wait_for_cms_main or a separate function) is planed to be implemented
# in later contentctl-ng.
# The versioning is expected to be ready within 10 minutes
# if self.kvstore_content_versioning:
# timeout = 600
# while not self.is_versioning_activated:
# time.sleep(60)
# timeout -= 60
# if timeout <= 0:
# break

# Confirm versioning has been enabled
if not self.is_versioning_activated:
Expand Down
Loading