ORION-3127: initial implementation for fsoc solution delete #324

bemidji3 · 2024-03-27T00:03:51Z

Description

This PR contains changes to add a new solution command: fsoc solution delete. This will allow our users to delete non-stable tagged versions of their solutions via fsoc.

Type of Change

Checklist

I have read the contributing guidelines
Existing issues have been referenced (where applicable)
I have verified this change is not present in other open pull requests
Functionality is documented
All code style checks pass
New code contribution is covered by automated tests
All new and existing tests pass

codecov-commenter · 2024-03-27T00:10:40Z

Codecov Report

Attention: Patch coverage is 0% with 85 lines in your changes are missing coverage. Please review.

Project coverage is 10.33%. Comparing base (00d0c6f) to head (8e624fe).
Report is 28 commits behind head on main.

Files	Patch %	Lines
cmd/solution/delete.go	0.00%	84 Missing ⚠️
cmd/solution/solution.go	0.00%	1 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@             Coverage Diff             @@
##             main     #324       +/-   ##
===========================================
- Coverage   26.88%   10.33%   -16.56%     
===========================================
  Files          44      135       +91     
  Lines        4564    10513     +5949     
===========================================
- Hits         1227     1086      -141     
- Misses       3242     9352     +6110     
+ Partials       95       75       -20

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

…and user wants to delete it again and wait for deletion to complete

pnickolov · 2024-03-27T00:42:46Z

cmd/solution/delete.go

+Please also note this is an asynchronous operation and thus it may take some time for the status to reflect properly.`,
+	Example:          `fsoc solution delete mysolution`,
+	Run:              deleteSolution,
+	Annotations:      map[string]string{config.AnnotationForConfigBypass: ""},


This command relies on the configuration, as it reaches out to the API.

Suggested change

Annotations: map[string]string{config.AnnotationForConfigBypass: ""},

pnickolov · 2024-03-27T00:43:00Z

cmd/solution/delete.go

+
+var solutionDeleteCmd = &cobra.Command{
+	Use:   "delete <solution-name>",
+	Args:  cobra.MinimumNArgs(1),


Suggested change

Args: cobra.MinimumNArgs(1),

Args: cobra.NArgs(1),

pnickolov · 2024-03-27T00:46:18Z

cmd/solution/delete.go

+	Use:   "delete <solution-name>",
+	Args:  cobra.MinimumNArgs(1),
+	Short: "Delete a non-stable tagged version of a solution",
+	Long: `This command deletes a non-stable tagged version of a solution uploaded by your tenant.


In the descriptions, I propose we remove the "non-stable tagged" from most places and just have a simple sentence in the Long text that says something along the lines of "Solutions with stable tag cannot be deleted" (or may not be deleted), mostly to set expectations. Fsoc doesn't enforce this / we rely on the backend.

WRT removing "all active subscriptions": given that we support deleting only non-stable solutions and non-stable solutions are tenant-private, I propose we do unsubscribe as part of the delete (and there are no other subscriptions possible). This will remove the incidental complexity around subscriptions.

I agree that we should remove "non-stable tagged" from here and will replace it like you have suggested. Regarding the auto-unsubscribe functionality: I think this should be behind a cli flag as we want our users to be cognizant of their subscriptions to solutions and the subscription process. Wdyt?

pnickolov · 2024-03-27T00:55:26Z

cmd/solution/delete.go

+	}
+
+	if !skipConfirmationMessage {
+		fmt.Printf("WARNING! This command will remove all of the objects and types that are associated with this solution and will purge all data related to those objects and types.  It will also remove all solution metadata (including, but not limited to, subscriptions and other related objects).\nProceed with caution!  \nPlease type the name of the solution you want to delete and hit enter confirm that you want to delete the solution with name: %s and tag: %s \n", solutionName, solutionTag)


Suggested change

fmt.Printf("WARNING! This command will remove all of the objects and types that are associated with this solution and will purge all data related to those objects and types. It will also remove all solution metadata (including, but not limited to, subscriptions and other related objects).\nProceed with caution! \nPlease type the name of the solution you want to delete and hit enter confirm that you want to delete the solution with name: %s and tag: %s \n", solutionName, solutionTag)

fmt.Printf("WARNING! This command will remove all objects and types that are associated with this solution and will purge all data related to those objects and types. It will also remove all solution metadata (including, but not limited to, subscriptions and other related objects).\nProceed with caution! \nPlease type the name of the solution you want to delete and hit enter confirm that you want to delete the solution with name: %s and tag: %s \n", solutionName, solutionTag)

pnickolov · 2024-03-27T00:59:16Z

cmd/solution/delete.go

+	if !noWait {
+		output.PrintCmdStatus(cmd, fmt.Sprintf("Solution deletion initiated for solution with name: %s and tag: %s\n", solutionName, solutionTag))


Suggested change

if !noWait {

output.PrintCmdStatus(cmd, fmt.Sprintf("Solution deletion initiated for solution with name: %s and tag: %s\n", solutionName, solutionTag))

output.PrintCmdStatus(cmd, fmt.Sprintf("Solution deletion initiated for solution with name: %s and tag: %s\n", solutionName, solutionTag))

if !noWait {

pnickolov · 2024-03-27T00:59:53Z

cmd/solution/delete.go

+	} else {
+		output.PrintCmdStatus(cmd, "Solution deletion initiated, skip waiting for transaction to complete")
+	}


Suggested change

} else {

output.PrintCmdStatus(cmd, "Solution deletion initiated, skip waiting for transaction to complete")

}

pnickolov · 2024-03-27T01:03:22Z

cmd/solution/delete.go

+		for deletionObjData.Status == "" || deletionObjData.Status == "inProgress" || deletionObjData.IsEmpty() || newDeletionObjectId == existingSolutionDeletionObjectId {
+			output.PrintCmdStatus(cmd, fmt.Sprintf("Waited %f seconds for solution with name: %s and tag: %s to be marked as deleted\n", time.Since(waitStartTime).Seconds(), solutionName, solutionTag))
+			if time.Since(waitStartTime).Seconds() > float64(waitForDeletionDuration) {
+				log.Fatalf("Failed to validate solution with name %s and tag: %s was deleted: timed out", solutionName, solutionTag)


Suggested change

log.Fatalf("Failed to validate solution with name %s and tag: %s was deleted: timed out", solutionName, solutionTag)

log.Fatalf("Timed out waiting for solution with name %s and tag: %s to be deleted. Deletion continues, please check status for outcome.", solutionName, solutionTag)

pnickolov · 2024-03-27T01:04:25Z

cmd/solution/delete.go

+		if deletionObjData.Status == "successful" {
+			output.PrintCmdStatus(cmd, fmt.Sprintf("Solution with name: %s and tag: %s deleted successfully", solutionName, solutionTag))
+		} else {
+			output.PrintCmdStatus(cmd, fmt.Sprintf("Issue deleting solution with name: %s and tag %s.  Error message: %s", solutionName, solutionTag, deletionObjData.DeleteMessage))


Suggested change

output.PrintCmdStatus(cmd, fmt.Sprintf("Issue deleting solution with name: %s and tag %s. Error message: %s", solutionName, solutionTag, deletionObjData.DeleteMessage))

output.PrintCmdStatus(cmd, fmt.Sprintf("Failed to delete solution with name: %s and tag %s. Error message: %s", solutionName, solutionTag, deletionObjData.DeleteMessage))

pnickolov · 2024-03-27T01:08:38Z

cmd/solution/delete.go

+			deletionObj := getSolutionDeletionObject(solutionTag, solutionName)
+			deletionObjData = deletionObj.DeletionData
+			newDeletionObjectId = deletionObj.ID
+			log.Infof("Got value of new deletion objectID :%s", newDeletionObjectId)


Suggested change

log.Infof("Got value of new deletion objectID :%s", newDeletionObjectId)

Do you still need this? OK if yes, just let's use WithField or similar and reflect not only the objectID but maybe the status

…waiting if deletion is already in progress

ORION-3127: initial implementation for fsoc solution delete

33de92e

bemidji3 requested a review from pnickolov as a code owner March 27, 2024 00:03

ORION-3127: handle case where solution has already been deleted once …

8f8d9f9

…and user wants to delete it again and wait for deletion to complete

pnickolov reviewed Mar 27, 2024

View reviewed changes

Jack Morgan added 2 commits March 26, 2024 18:39

ORION-3127: address review comments + add functionality for resuming …

886187e

…waiting if deletion is already in progress

ORION-3127: address more review comments

8e624fe

pnickolov approved these changes Mar 27, 2024

View reviewed changes

pnickolov merged commit 381d774 into cisco-open:main Mar 27, 2024
8 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ORION-3127: initial implementation for fsoc solution delete #324

ORION-3127: initial implementation for fsoc solution delete #324

bemidji3 commented Mar 27, 2024

codecov-commenter commented Mar 27, 2024 •

edited

pnickolov Mar 27, 2024

bemidji3 Mar 27, 2024

pnickolov Mar 27, 2024

bemidji3 Mar 27, 2024

pnickolov Mar 27, 2024

bemidji3 Mar 27, 2024

pnickolov Mar 27, 2024

bemidji3 Mar 27, 2024

pnickolov Mar 27, 2024

bemidji3 Mar 27, 2024

pnickolov Mar 27, 2024

bemidji3 Mar 27, 2024

pnickolov Mar 27, 2024

bemidji3 Mar 27, 2024

pnickolov Mar 27, 2024

bemidji3 Mar 27, 2024

pnickolov Mar 27, 2024

bemidji3 Mar 27, 2024

		if !noWait {
		output.PrintCmdStatus(cmd, fmt.Sprintf("Solution deletion initiated for solution with name: %s and tag: %s\n", solutionName, solutionTag))

	} else {
	output.PrintCmdStatus(cmd, "Solution deletion initiated, skip waiting for transaction to complete")
	}

	log.Fatalf("Failed to validate solution with name %s and tag: %s was deleted: timed out", solutionName, solutionTag)
	log.Fatalf("Timed out waiting for solution with name %s and tag: %s to be deleted. Deletion continues, please check status for outcome.", solutionName, solutionTag)

ORION-3127: initial implementation for fsoc solution delete #324

ORION-3127: initial implementation for fsoc solution delete #324

Conversation

bemidji3 commented Mar 27, 2024

Description

Type of Change

Checklist

codecov-commenter commented Mar 27, 2024 • edited

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-commenter commented Mar 27, 2024 •

edited