Files
gh-actions-cache/cmd/delete.go
Sankalp Kotewar 8365ebe619 Bugbash fixes and refactoring (#14)
* Completed List cmd and added API calls

* Minor comments and add delete code to pass linting

* Typo in descriptions

* Minor comments

* Validations

* Validations-1

* improved branch flag validation

* removed build

* working after refactory with bad names

* Command working, test not working

* Corrected creation of service

* Finalized structure using service

* Deleted tests

* cleanup

* cleanup

* cleanup

* removed space with tab

* aligned types in model.go

* Update model.go

* resolved comments

* Refactor

* removed long descriptions

* Working incomplete tests

* Completed tests

* cleanup

* checks

* PR comments

* PR comments

* minor comment issue

* minor comment issue

* Added test cases for Delete

* updated tests to work with workflow

* Added missing error condition

* Updated tests to support new option service

* Improved eror handling for list

* Fixed test case

* Improved error handling

* Error handling and test cases for delete API calls

* Added test case for user confirmation delete.

* Removed unused import from test

* Fixed test case for error scenario

* Upgraded go-gh

* reusing rest client error

* Fix for failing windows test cases

* help cmd removed when cache isnt present on delete

* Pretty print ratio and space between cols modified

* Error handling wrapping

* Reverted back error message after silencing help

* Bugbash fixes for int limit, zero cache list msg

* Test case fixes for error message changes

* Handling no cache list scenario with(out) key

* Minor Refactoring and avoided code duplication

* Removed unused inputs after resolving conflicts

* Formatted test file

* removed err5xx as they all have same value.

* Removed err5xx from list as well

* Help and error message enhancements for list.

* changing commandname to avoid conflicts

* Ran `go fmt` formatter against all .go files

* Removed command from root.go

* Updated version to 1.0.0

Co-authored-by: t-dedah <t-dedah@github.com>
Co-authored-by: Deepak Dahiya <59823596+t-dedah@users.noreply.github.com>
2022-07-18 14:51:28 +05:30

135 lines
4.1 KiB
Go

package cmd
import (
"fmt"
"net/url"
"strings"
"github.com/AlecAivazis/survey/v2"
"github.com/actions/gh-actions-cache/internal"
"github.com/actions/gh-actions-cache/service"
"github.com/actions/gh-actions-cache/types"
"github.com/spf13/cobra"
)
var choice string = ""
func NewCmdDelete() *cobra.Command {
deleteCommand := "delete"
f := types.DeleteOptions{}
var deleteCmd = &cobra.Command{
Use: "delete <key>",
Short: "Delete cache by key",
RunE: func(cmd *cobra.Command, args []string) error {
if len(args) != 1 {
return fmt.Errorf(fmt.Sprintf("accepts 1 arg(s), received %d", len(args)))
}
f.Key = args[0]
repo, err := internal.GetRepo(f.Repo)
if err != nil {
return err
}
// This will silence the usage (help) message as they are not needed for errors beyond this point
cmd.SilenceUsage = true
artifactCache, err := service.NewArtifactCache(repo, deleteCommand, VERSION)
if err != nil {
return types.HandledError{Message: err.Error(), InnerError: err}
}
queryParams := url.Values{}
f.GenerateBaseQueryParams(queryParams)
if !f.Confirm {
matchedCaches, err := getCacheListWithExactMatch(f, artifactCache)
if err != nil {
return internal.HttpErrorHandler(err, "The given repo does not exist.")
}
matchedCachesLen := len(matchedCaches)
if matchedCachesLen == 0 {
return fmt.Errorf(fmt.Sprintf("Cache with input key '%s' does not exist\n", f.Key))
}
fmt.Printf("You're going to delete %s", internal.PrintSingularOrPlural(matchedCachesLen, "cache entry\n\n", "cache entries\n\n"))
internal.PrettyPrintTrimmedCacheList(matchedCaches)
prompt := &survey.Select{
Message: "Are you sure you want to delete the cache entries?",
Options: []string{"Delete", "Cancel"},
}
err = survey.AskOne(prompt, &choice)
if err != nil {
fmt.Println("Error occured while taking input from user while trying to delete cache")
return types.HandledError{Message: "Error occured while taking input from user while trying to delete cache.", InnerError: err}
}
f.Confirm = choice == "Delete"
fmt.Println()
}
if f.Confirm {
cachesDeleted, err := artifactCache.DeleteCaches(queryParams)
if err != nil {
return internal.HttpErrorHandler(err, fmt.Sprintf("Cache with input key '%s' does not exist", f.Key))
}
if cachesDeleted > 0 {
fmt.Printf("%s Deleted %s with key '%s'\n", internal.RedTick(), internal.PrintSingularOrPlural(cachesDeleted, "cache entry", "cache entries"), f.Key)
} else {
fmt.Printf("Cache with input key '%s' does not exist\n", f.Key)
}
}
return nil
},
}
deleteCmd.Flags().StringVarP(&f.Repo, "repo", "R", "", "Select another repository for finding actions cache.")
deleteCmd.Flags().StringVarP(&f.Branch, "branch", "B", "", "Filter by branch")
deleteCmd.Flags().BoolVar(&f.Confirm, "confirm", false, "Delete the cache without asking user for confirmation.")
deleteCmd.SetHelpTemplate(getDeleteHelp())
return deleteCmd
}
func getDeleteHelp() string {
return `
gh-actions-cache: Works with GitHub Actions Cache.
USAGE:
gh actions-cache delete <key> [flags]
ARGUMENTS:
key cache key which needs to be deleted
FLAGS:
-R, --repo <[HOST/]owner/repo> Select another repository using the [HOST/]OWNER/REPO format
-B, --branch <string> Filter by branch
--confirm Confirm deletion without prompting
INHERITED FLAGS
--help Show help for command
EXAMPLES:
$ gh actions-cache delete Linux-node-f5dbf39c9d11eba80242ac13
`
}
func getCacheListWithExactMatch(f types.DeleteOptions, artifactCache service.ArtifactCacheService) ([]types.ActionsCache, error) {
listOption := types.ListOptions{BaseOptions: types.BaseOptions{Repo: f.Repo, Branch: f.Branch, Key: f.Key}, Limit: 100, Order: "", Sort: ""}
queryParams := url.Values{}
listOption.GenerateBaseQueryParams(queryParams)
caches, err := artifactCache.ListAllCaches(queryParams, f.Key)
if err != nil {
return nil, err
}
var exactMatchedKeys []types.ActionsCache
for _, cache := range caches {
if strings.EqualFold(f.Key, cache.Key) {
exactMatchedKeys = append(exactMatchedKeys, cache)
}
}
return exactMatchedKeys, nil
}