Skip to content
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.

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

Resolves #458 - Add support for more resources #471

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions cmd/create.go
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ func NewCreateCommand(parentCmd *cobra.Command) func() {
return err
}

err = json.PrintJson(string(outputJson))
err = json.PrintJsonToStdout(string(outputJson))

if err != nil {
return err
Expand All @@ -146,7 +146,7 @@ func NewCreateCommand(parentCmd *cobra.Command) func() {
}
}

return json.PrintJson(body)
return json.PrintJsonToStdout(body)
}

}
Expand Down Expand Up @@ -343,7 +343,7 @@ func createInternal(ctx context.Context, overrides *httpclient.HttpParameterOver

// Check if error response
if resp.StatusCode >= 400 && resp.StatusCode <= 600 {
json.PrintJson(string(resBody))
json.PrintJsonToStdout(string(resBody))
return "", fmt.Errorf(resp.Status)
}

Expand Down
14 changes: 13 additions & 1 deletion cmd/delete-all.go
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,19 @@ func deleteAllInternal(ctx context.Context, args []string) error {
return err
}

ids, totalCount, err := apihelper.GetResourceIdsFromHttpResponse(resp)
if resp.StatusCode >= 400 {
log.Warnf("Could not retrieve page of data, aborting")
break
}

bodyTxt, err := io.ReadAll(resp.Body)

if err != nil {
return err
}

ids, totalCount, err := apihelper.GetResourceIdsFromHttpResponse(bodyTxt)

resp.Body.Close()

allIds := make([][]id.IdableAttributes, 0)
Expand Down
4 changes: 2 additions & 2 deletions cmd/delete.go
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ func NewDeleteCommand(parentCmd *cobra.Command) func() {
if err != nil {
if body != "" {
if !noBodyPrint {
json.PrintJson(body)
json.PrintJsonToStdout(body)
}
}
return err
Expand All @@ -108,7 +108,7 @@ func NewDeleteCommand(parentCmd *cobra.Command) func() {
if noBodyPrint {
return nil
} else {
return json.PrintJson(body)
return json.PrintJsonToStdout(body)
}
}

Expand Down
289 changes: 289 additions & 0 deletions cmd/get-all.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,289 @@
package cmd

import (
"context"
gojson "encoding/json"
"fmt"
"github.com/elasticpath/epcc-cli/external/apihelper"
"github.com/elasticpath/epcc-cli/external/httpclient"
"github.com/elasticpath/epcc-cli/external/id"
"github.com/elasticpath/epcc-cli/external/json"
"os"
"sync"

"github.com/elasticpath/epcc-cli/external/resources"
log "github.com/sirupsen/logrus"
"github.com/spf13/cobra"
"github.com/thediveo/enumflag"
"io"
"net/url"
"reflect"
"strconv"
)

type OutputFormat enumflag.Flag

const (
Jsonl OutputFormat = iota
Csv
EpccCli
)

var OutputFormatIds = map[OutputFormat][]string{
Jsonl: {"jsonl"},
Csv: {"csv"},
EpccCli: {"epcc-cli"},
}

func NewGetAllCommand(parentCmd *cobra.Command) func() {

var getAll = &cobra.Command{
Use: "get-all",
Short: "Get all of a resource",
SilenceUsage: false,
RunE: func(cmd *cobra.Command, args []string) error {
if len(args) == 0 {
return fmt.Errorf("please specify a resource, epcc get-all [RESOURCE], see epcc delete-all --help")
} else {
return fmt.Errorf("invalid resource [%s] specified, see all with epcc delete-all --help", args[0])
}
},
}

for _, resource := range resources.GetPluralResources() {
if resource.GetCollectionInfo == nil {
continue
}

resourceName := resource.PluralName

var outputFile string
var outputFormat OutputFormat

var getAllResourceCmd = &cobra.Command{
Use: resourceName,
Short: GetGetAllShort(resource),
Hidden: false,
RunE: func(cmd *cobra.Command, args []string) error {
return getAllInternal(context.Background(), outputFormat, outputFile, append([]string{resourceName}, args...))
},
}

getAllResourceCmd.Flags().StringVarP(&outputFile, "output-file", "", "", "The file to output results to")

getAllResourceCmd.Flags().VarP(
enumflag.New(&outputFormat, "output-format", OutputFormatIds, enumflag.EnumCaseInsensitive),
"output-format", "",
"sets output format; can be 'jsonl', 'csv', 'epcc-cli'")

getAll.AddCommand(getAllResourceCmd)
}

parentCmd.AddCommand(getAll)
return func() {}

}

func getAllInternal(ctx context.Context, outputFormat OutputFormat, outputFile string, args []string) error {
// Find Resource
resource, ok := resources.GetResourceByName(args[0])
if !ok {
return fmt.Errorf("could not find resource %s", args[0])
}

if resource.GetCollectionInfo == nil {
return fmt.Errorf("resource %s doesn't support GET collection", args[0])
}

allParentEntityIds, err := getParentIds(ctx, resource)

if err != nil {
return fmt.Errorf("could not retrieve parent ids for for resource %s, error: %w", resource.PluralName, err)
}

if len(allParentEntityIds) == 1 {
log.Debugf("Resource %s is a top level resource need to scan only one path to delete all resources", resource.PluralName)
} else {
log.Debugf("Resource %s is not a top level resource, need to scan %d paths to delete all resources", resource.PluralName, len(allParentEntityIds))
}

var syncGroup = sync.WaitGroup{}

syncGroup.Add(1)

type idableAttributesWithType struct {
id.IdableAttributes
Type string `yaml:"type,omitempty" json:"type,omitempty"`
EpccCliType string `yaml:"epcc_cli_type,omitempty" json:"epcc_cli_type,omitempty"`
}

type msg struct {
txt []byte
id []idableAttributesWithType
}
var sendChannel = make(chan msg, 0)

var writer io.Writer
if outputFile == "" {
writer = os.Stdout
} else {
file, err := os.Create(outputFile)
if err != nil {
panic(err)
}
defer file.Close()
writer = file
}

outputWriter := func() {
defer syncGroup.Done()

for msgs := 0; ; msgs++ {
select {
case result, ok := <-sendChannel:

if !ok {
log.Debugf("Channel closed, we are done.")
return
}
var obj interface{}
err = gojson.Unmarshal(result.txt, &obj)

if err != nil {
log.Errorf("Couldn't unmarshal JSON response %s due to error: %v", result, err)
continue
}

newObjs, err := json.RunJQWithArray(".data[]", obj)

if err != nil {
log.Errorf("Couldn't process response %s due to error: %v", result, err)
continue
}

for _, newObj := range newObjs {

wrappedObj := map[string]interface{}{
"data": newObj,
"meta": map[string]interface{}{
"_epcc_cli_parent_resources": result.id,
},
}

line, err := gojson.Marshal(&wrappedObj)

if err != nil {
log.Errorf("Could not create JSON for %s, error: %v", line, err)
continue
}

_, err = writer.Write(line)

if err != nil {
log.Errorf("Could not save line %s, error: %v", line, err)
continue
}

_, err = writer.Write([]byte{10})

if err != nil {
log.Errorf("Could not save line %s, error: %v", line, err)
continue
}

}

}
}
}

go outputWriter()

for _, parentEntityIds := range allParentEntityIds {
lastIds := make([][]id.IdableAttributes, 1)
for offset := 0; offset <= 10000; offset += 100 {
resourceURL, err := resources.GenerateUrlViaIdableAttributes(resource.GetCollectionInfo, parentEntityIds)

if err != nil {
return err
}

types, err := resources.GetSingularTypesOfVariablesNeeded(resource.GetCollectionInfo.Url)

if err != nil {
return err
}

params := url.Values{}
params.Add("page[limit]", "100")
params.Add("page[offset]", strconv.Itoa(offset))

resp, err := httpclient.DoRequest(ctx, "GET", resourceURL, params.Encode(), nil)

if err != nil {
return err
}

if resp.StatusCode >= 400 {
log.Warnf("Could not retrieve page of data, aborting")

break
}

bodyTxt, err := io.ReadAll(resp.Body)

if err != nil {

return err
}

ids, totalCount, err := apihelper.GetResourceIdsFromHttpResponse(bodyTxt)
resp.Body.Close()

allIds := make([][]id.IdableAttributes, 0)
for _, id := range ids {
allIds = append(allIds, append(parentEntityIds, id))
}

if reflect.DeepEqual(allIds, lastIds) {
log.Warnf("Data on the previous two pages did not change. Does this resource support pagination? Aborting export", resource.PluralName, len(allIds))

Check failure on line 249 in cmd/get-all.go

View workflow job for this annotation

GitHub Actions / Build

github.com/sirupsen/logrus.Warnf call has arguments but no formatting directives

break
} else {
lastIds = allIds
}

idsWithType := make([]idableAttributesWithType, len(types))

for i, t := range types {
idsWithType[i].IdableAttributes = parentEntityIds[i]
idsWithType[i].EpccCliType = t
idsWithType[i].Type = resources.MustGetResourceByName(t).JsonApiType
}

sendChannel <- msg{
bodyTxt,
idsWithType,
}

if len(allIds) == 0 {
log.Infof("Total ids retrieved for %s in %s is %d, we are done", resource.PluralName, resourceURL, len(allIds))

break
} else {
if totalCount >= 0 {
log.Infof("Total number of %s in %s is %d", resource.PluralName, resourceURL, totalCount)
} else {
log.Infof("Total number %s in %s is unknown", resource.PluralName, resourceURL)
}
}

}
}

close(sendChannel)

syncGroup.Wait()

return nil
}
6 changes: 3 additions & 3 deletions cmd/get.go
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ func NewGetCommand(parentCmd *cobra.Command) func() {
return err
}

err = json.PrintJson(string(outputJson))
err = json.PrintJsonToStdout(string(outputJson))

if err != nil {
return err
Expand All @@ -214,7 +214,7 @@ func NewGetCommand(parentCmd *cobra.Command) func() {
}
}

printError := json.PrintJson(body)
printError := json.PrintJsonToStdout(body)

if retriesFailedError != nil {
return retriesFailedError
Expand Down Expand Up @@ -326,7 +326,7 @@ func getInternal(ctx context.Context, overrides *httpclient.HttpParameterOverrid

// Check if error response
if resp.StatusCode >= 400 && resp.StatusCode <= 600 {
json.PrintJson(string(body))
json.PrintJsonToStdout(string(body))
return "", fmt.Errorf(resp.Status)
}

Expand Down
4 changes: 4 additions & 0 deletions cmd/helper.go
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,10 @@ func GetDeleteAllShort(resource resources.Resource) string {
return fmt.Sprintf("Calls DELETE %s for every resource in GET %s", GetHelpResourceUrls(resource.DeleteEntityInfo.Url), GetHelpResourceUrls(resource.GetCollectionInfo.Url))
}

func GetGetAllShort(resource resources.Resource) string {
return fmt.Sprintf("Calls GET %s and iterates over all pages and parent resources (if applicable)", GetHelpResourceUrls(resource.GetCollectionInfo.Url))
}

func GetGetLong(resourceName string, resourceUrl string, usageGetType string, completionVerb int, urlInfo *resources.CrudEntityInfo, resource resources.Resource) string {

if DisableLongOutput {
Expand Down
Loading
Loading