2906 list custom attestation types (#430)

* Add code for list attestation-types command

* Add tests for list attestation-types command

* Don't use goldenFile for list attestation-types as results seem to be formatted differently in the CI

Author: FayeSGW

cmd/kosli/list.go

@@ -42,6 +42,7 @@ func newListCmd(out io.Writer) *cobra.Command {
 		newListSnapshotsCmd(out),
 		newListTrailsCmd(out),
 		newListPoliciesCmd(out),
+		newListAttestationTypesCmd(out),
 	)
 
 	return cmd

cmd/kosli/listAttestationTypes.go

@@ -0,0 +1,91 @@
+package main
+
+import (
+	"encoding/json"
+	"fmt"
+	"io"
+	"net/http"
+
+	"github.com/kosli-dev/cli/internal/output"
+	"github.com/kosli-dev/cli/internal/requests"
+	"github.com/spf13/cobra"
+)
+
+const listAttestationTypesDesc = `List all Kosli attestation types for an org.`
+
+type listAttestationTypesOptions struct {
+	output string
+}
+
+func newListAttestationTypesCmd(out io.Writer) *cobra.Command {
+	o := new(listAttestationTypesOptions)
+	cmd := &cobra.Command{
+		Use:   "attestation-types",
+		Short: listAttestationTypesDesc,
+		Long:  listAttestationTypesDesc,
+		Args:  cobra.NoArgs,
+		PreRunE: func(cmd *cobra.Command, args []string) error {
+			err := RequireGlobalFlags(global, []string{"Org", "ApiToken"})
+			if err != nil {
+				return ErrorBeforePrintingUsage(cmd, err.Error())
+			}
+			return nil
+		},
+		RunE: func(cmd *cobra.Command, args []string) error {
+			return o.run(out, args)
+		},
+	}
+
+	cmd.Flags().StringVarP(&o.output, "output", "o", "table", outputFlag)
+
+	return cmd
+}
+
+func (o *listAttestationTypesOptions) run(out io.Writer, args []string) error {
+	url := fmt.Sprintf("%s/api/v2/custom-attestation-types/%s", global.Host, global.Org)
+
+	reqParams := &requests.RequestParams{
+		Method: http.MethodGet,
+		URL:    url,
+		Token:  global.ApiToken,
+	}
+	response, err := kosliClient.Do(reqParams)
+	if err != nil {
+		return err
+	}
+
+	return output.FormattedPrint(response.Body, o.output, out, 0,
+		map[string]output.FormatOutputFunc{
+			"table": printAttestationTypesListAsTable,
+			"json":  output.PrintJson,
+		})
+}
+
+func printAttestationTypesListAsTable(raw string, out io.Writer, page int) error {
+	var attestationTypes []map[string]interface{}
+	err := json.Unmarshal([]byte(raw), &attestationTypes)
+	if err != nil {
+		return err
+	}
+
+	if len(attestationTypes) == 0 {
+		logger.Info("No attestation types were found.")
+		return nil
+	}
+
+	header := []string{"NAME", "DESCRIPTION", "LATEST VERSION"}
+	rows := []string{}
+
+	for _, attestationType := range attestationTypes {
+		description := attestationType["description"]
+		if description == nil {
+			description = ""
+		}
+		latestVersion := len(attestationType["versions"].([]interface{}))
+
+		rows = append(rows, fmt.Sprintf("%s\t%s\t%d", attestationType["name"], description, latestVersion))
+	}
+
+	tabFormattedPrint(out, header, rows)
+	return nil
+}

cmd/kosli/listAttestationTypes_test.go

@@ -0,0 +1,77 @@
+package main
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/stretchr/testify/suite"
+)
+
+// Define the suite, and absorb the built-in basic suite
+// functionality from testify - including a T() method which
+// returns the current testing context
+type ListAttestationTypesCommandTestSuite struct {
+	suite.Suite
+	defaultKosliArguments string
+	acmeOrgKosliArguments string
+	attestationName1      string
+	attestationName2      string
+}
+
+func (suite *ListAttestationTypesCommandTestSuite) SetupTest() {
+	suite.attestationName1 = "custom-attestation-type-1"
+	suite.attestationName2 = "custom-attestation-type-2"
+	global = &GlobalOpts{
+		ApiToken: "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6ImNkNzg4OTg5In0.e8i_lA_QrEhFncb05Xw6E_tkCHU9QfcY4OLTVUCHffY",
+		Org:      "docs-cmd-test-user",
+		Host:     "http://localhost:8001",
+	}
+	suite.defaultKosliArguments = fmt.Sprintf(" --host %s --org %s --api-token %s", global.Host, global.Org, global.ApiToken)
+	CreateCustomAttestationType(suite.attestationName1, "testdata/person-schema.json", []string{".age > 21"}, suite.T())
+	CreateCustomAttestationType(suite.attestationName2, "testdata/person-schema.json", []string{".age < 25"}, suite.T())
+	CreateCustomAttestationType(suite.attestationName1, "testdata/person-schema.json", []string{".age > 21", ".age < 85"}, suite.T()) //Make a second version
+
+	global.Org = "acme-org"
+	global.ApiToken = "v3OWZiYWu9G2IMQStYg9BcPQUQ88lJNNnTJTNq8jfvmkR1C5wVpHSs7F00JcB5i6OGeUzrKt3CwRq7ndcN4TTfMeo8ASVJ5NdHpZT7DkfRfiFvm8s7GbsIHh2PtiQJYs2UoN13T8DblV5C4oKb6-yWH73h67OhotPlKfVKazR-c"
+	suite.acmeOrgKosliArguments = fmt.Sprintf(" --host %s --org %s --api-token %s", global.Host, global.Org, global.ApiToken)
+
+}
+
+func (suite *ListAttestationTypesCommandTestSuite) TestListFlowsCmd() {
+	tests := []cmdTestCase{
+		{
+			name:   "listing custom attestation types works when some exist",
+			cmd:    fmt.Sprintf(`list attestation-types %s`, suite.defaultKosliArguments),
+			golden: "",
+		},
+		{
+			name:   "listing custom attestation types works when there are none",
+			cmd:    fmt.Sprintf(`list attestation-types %s`, suite.acmeOrgKosliArguments),
+			golden: "No attestation types were found.\n",
+		},
+		{
+			name:   "listing custom attestation types with --output json works when some exist",
+			cmd:    fmt.Sprintf(`list attestation-types --output json %s`, suite.defaultKosliArguments),
+			golden: "",
+		},
+		{
+			name:   "listing custom attestation types with --output json works when there are none",
+			cmd:    fmt.Sprintf(`list attestation-types --output json %s`, suite.acmeOrgKosliArguments),
+			golden: "[]\n",
+		},
+		{
+			wantError: true,
+			name:      "providing an argument causes an error",
+			cmd:       fmt.Sprintf(`list attestation-types xxx %s`, suite.defaultKosliArguments),
+			golden:    "Error: unknown command \"xxx\" for \"kosli list attestation-types\"\n",
+		},
+	}
+
+	runTestCmd(suite.T(), tests)
+}
+
+// In order for 'go test' to run this suite, we need to create
+// a normal test function and pass our suite to suite.Run
+func TestListAttestationTypesCommandTestSuite(t *testing.T) {
+	suite.Run(t, new(ListAttestationTypesCommandTestSuite))
+}