actions/gh-actions-cache
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

E2E delete command using list API (#4)

Browse Source 
* Completed List cmd and added API calls

* Minor comments and add delete code to pass linting

* Typo in descriptions

* Added delete functionality using existing list API

* Updated limit param for list api to default 30

* Minor refactoring

* Linting fixes for survey output

* Implemented review comments

* Handling 404 response when confirm flag is passed

* Added COMMAND back to delete CLI

* Minor comments

* Check http err statuscode for 404

* Validations

* Validations-1

* improved branch flag validation

* removed build

* String match made case insensitive

* Added TODO for error handling

* Updated error message when args are not provided

* Worked on review comments

* Argument length check updated

* Separated direct and indirect dependencies

* Used SPrintF for formatting strings

* Updated lastAccessed time logic

* Removed extra variable userConfirmation

* Removed unnecessary computations

* Printing and formatting changes

* Passed key from input in queryparams

* Scan List API iteratively to get exact matches

* Added pretty print for trimmed list

* Update page number instead of re-generating params

* Added listAllCaches method and moved it to utils

* Moved redTick to utils

* Update internal/utils.go

Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com>

* Limited scope of `sb` to `if` block

* Fixed pretty print issue

* Error type checked for httpError

* Added PrintOneOrMore fn, moved listAll to service

* Implemented `Goment` for last accessed time

* Used percentage based on window size for printing

* Removed stringbuilder and updated fn name

* Made `ListAllCaches` member of `actions_cache.go`

* Updated prettyPrint logic cover better content

* Using PrettyPrint for List command as well.

* Separated direct and indirect modules

Co-authored-by: t-dedah <t-dedah@github.com>
Co-authored-by: Deepak Dahiya <59823596+t-dedah@users.noreply.github.com>
Co-authored-by: Bishal Prasad <bishal-pdmsft@github.com>
This commit is contained in:
Sankalp Kotewar
2022-06-28 14:40:11 +05:30
committed by GitHub
parent 9e752991d6
commit c98ebfe90b
8 changed files with 269 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

101
cmd/delete.go
View File

@@ -1,35 +1,77 @@
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"
// "github.com/actions/gh-actions-cache/internal"
// "github.com/actions/gh-actions-cache/client"
)
func init() {
rootCmd.AddCommand(deleteCmd)
deleteCmd.Flags().StringP("repo", "R", "", "Select another repository for finding actions cache.")
deleteCmd.Flags().StringP("branch", "B", "", "Filter by branch")
func NewCmdDelete() *cobra.Command {
COMMAND = "delete"
f := types.InputFlags{}
var deleteCmd = &cobra.Command{
Use: "delete",
Short: "Delete cache by key",
Run: func(cmd *cobra.Command, args []string) {
if len(args) != 1 {
fmt.Printf("accepts 1 arg(s), received %d\n", len(args))
return
}
key := args[0]
repo, err := internal.GetRepo(f.Repo)
if err != nil {
fmt.Println(err)
return
}
artifactCache := service.NewArtifactCache(repo, COMMAND, VERSION)
queryParams := internal.GenerateQueryParams(f.Branch, 100, key, "", "", 1)
if !f.Confirm {
var matchedCaches = getCacheListWithExactMatch(queryParams, key, artifactCache)
matchedCachesLen := len(matchedCaches)
if matchedCachesLen == 0 {
fmt.Printf("Cache with input key '%s' does not exist\n", key)
return
}
fmt.Printf("You're going to delete %s", internal.PrintSingularOrPlural(matchedCachesLen, "cache entry\n\n", "cache entries\n\n"))
internal.PrettyPrintTrimmedCacheList(matchedCaches)
choice := ""
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
}
f.Confirm = choice == "Delete"
fmt.Println()
}
if f.Confirm {
cachesDeleted := artifactCache.DeleteCaches(queryParams)
if cachesDeleted > 0 {
fmt.Printf("%s Deleted %s with key '%s'\n", internal.RedTick(), internal.PrintSingularOrPlural(cachesDeleted, "cache entry", "cache entries"), key)
} else {
fmt.Printf("Cache with input key '%s' does not exist\n", key)
}
}
},
}
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())
}
var deleteCmd = &cobra.Command{
Use: "delete",
Short: "Delete cache by key",
Long: `Delete cache by key`,
Run: func(cmd *cobra.Command, args []string) {
COMMAND = "delete"
// r, _ := cmd.Flags().GetString("repo")
// branch, _ := cmd.Flags().GetString("branch")
// repo, err := getRepo(r)
// if err != nil {
// log.Fatal(err)
// }
// queryParams := generateQueryParams(branch, 30, "", "", "")
// deleteCaches(repo, queryParams)
},
return deleteCmd
}
func getDeleteHelp() string {
@@ -54,3 +96,14 @@ EXAMPLES:
$ gh actions-cache delete Linux-node-f5dbf39c9d11eba80242ac13
`
}
func getCacheListWithExactMatch(queryParams url.Values, key string, artifactCache service.ArtifactCacheService) []types.ActionsCache {
caches := artifactCache.ListAllCaches(queryParams, key)
var exactMatchedKeys []types.ActionsCache
for _, cache := range caches {
if strings.EqualFold(key, cache.Key) {
exactMatchedKeys = append(exactMatchedKeys, cache)
}
}
return exactMatchedKeys
}

52
cmd/list.go
View File

@@ -6,24 +6,16 @@ import (
"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"
)
type InputFlags struct {
repo string
branch string
limit int
key string
order string
sort string
}
func NewCmdList() *cobra.Command {
COMMAND = "list"
f := InputFlags{}
f := types.InputFlags{}
var listCmd = &cobra.Command {
var listCmd = &cobra.Command{
Use: "list",
Short: "Lists the actions cache",
Run: func(cmd *cobra.Command, args []string) {
@@ -33,7 +25,7 @@ func NewCmdList() *cobra.Command {
return
}
repo, err := internal.GetRepo(f.repo)
repo, err := internal.GetRepo(f.Repo)
if err != nil {
log.Fatal(err)
}
@@ -42,30 +34,28 @@ func NewCmdList() *cobra.Command {
artifactCache := service.NewArtifactCache(repo, COMMAND, VERSION)
if f.branch == "" && f.key == "" {
if f.Branch == "" && f.Key == "" {
totalCacheSize := artifactCache.GetCacheUsage()
fmt.Printf("Total caches size %s\n\n", internal.FormatCacheSize(totalCacheSize))
}
queryParams := internal.GenerateQueryParams(f.branch, f.limit, f.key, f.order, f.sort, 1)
queryParams := internal.GenerateQueryParams(f.Branch, f.Limit, f.Key, f.Order, f.Sort, 1)
listCacheResponse := artifactCache.ListCaches(queryParams)
totalCaches := listCacheResponse.TotalCount
caches := listCacheResponse.ActionsCaches
fmt.Printf("Showing %d of %d cache entries in %s/%s\n\n", displayedEntriesCount(len(caches), f.limit), totalCaches, repo.Owner(), repo.Name())
for _, cache := range caches {
fmt.Printf("%s\t [%s]\t %s\t %s\n", cache.Key, internal.FormatCacheSize(cache.SizeInBytes), cache.Ref, cache.LastAccessedAt)
}
fmt.Printf("Showing %d of %d cache entries in %s/%s\n\n", displayedEntriesCount(len(caches), f.Limit), totalCaches, repo.Owner(), repo.Name())
internal.PrettyPrintCacheList(caches)
},
}
listCmd.Flags().StringVarP(&f.repo, "repo", "R", "", "Select another repository for finding actions cache.")
listCmd.Flags().StringVarP(&f.branch, "branch", "B", "", "Filter by branch")
listCmd.Flags().IntVarP(&f.limit, "limit", "", 30, "Maximum number of items to fetch (default is 30, max limit is 100)")
listCmd.Flags().StringVarP(&f.key, "key", "", "", "Filter by key")
listCmd.Flags().StringVarP(&f.order, "order", "", "", "Order of caches returned (asc/desc)")
listCmd.Flags().StringVarP(&f.sort, "sort", "", "", "Sort fetched caches (last-used/size/created-at)")
listCmd.Flags().StringVarP(&f.Repo, "repo", "R", "", "Select another repository for finding actions cache.")
listCmd.Flags().StringVarP(&f.Branch, "branch", "B", "", "Filter by branch")
listCmd.Flags().IntVarP(&f.Limit, "limit", "", 30, "Maximum number of items to fetch (default is 30, max limit is 100)")
listCmd.Flags().StringVarP(&f.Key, "key", "", "", "Filter by key")
listCmd.Flags().StringVarP(&f.Order, "order", "", "", "Order of caches returned (asc/desc)")
listCmd.Flags().StringVarP(&f.Sort, "sort", "", "", "Sort fetched caches (last-used/size/created-at)")
listCmd.SetHelpTemplate(getListHelp())
return listCmd
@@ -78,17 +68,17 @@ func displayedEntriesCount(totalCaches int, limit int) int {
return limit
}
func validateInputs(input InputFlags) {
if input.order != "" && input.order != "asc" && input.order != "desc" {
log.Fatal(fmt.Errorf(fmt.Sprintf("%s is not a valid value for order flag. Allowed values: asc/desc", input.order)))
func validateInputs(input types.InputFlags) {
if input.Order != "" && input.Order != "asc" && input.Order != "desc" {
log.Fatal(fmt.Errorf(fmt.Sprintf("%s is not a valid value for order flag. Allowed values: asc/desc", input.Order)))
}
if input.sort != "" && input.sort != "last-used" && input.sort != "size" && input.sort != "created-at" {
log.Fatal(fmt.Errorf(fmt.Sprintf("%s is not a valid value for sort flag. Allowed values: last-used/size/created-at", input.sort)))
if input.Sort != "" && input.Sort != "last-used" && input.Sort != "size" && input.Sort != "created-at" {
log.Fatal(fmt.Errorf(fmt.Sprintf("%s is not a valid value for sort flag. Allowed values: last-used/size/created-at", input.Sort)))
}
if input.limit < 1 || input.limit > 100 {
log.Fatal(fmt.Errorf(fmt.Sprintf("%d is not a valid value for limit flag. Allowed values: 1-100", input.limit)))
if input.Limit < 1 || input.Limit > 100 {
log.Fatal(fmt.Errorf(fmt.Sprintf("%d is not a valid value for limit flag. Allowed values: 1-100", input.Limit)))
}
}

1
cmd/root.go
View File

@@ -29,6 +29,7 @@ func init() {
func addCommandsToRoot() {
rootCmd.AddCommand(NewCmdList())
rootCmd.AddCommand(NewCmdDelete())
}
func getRootHelp() string {