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

Added Unit test case for events sub commands #305

Merged
merged 1 commit into from
Aug 31, 2023
Merged
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
3 changes: 3 additions & 0 deletions internal/events/event.go
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,9 @@ func (c *Client) NewCommand() *cobra.Command {
type Servicer interface {
MetalAPI(*cobra.Command) *metal.APIClient
Format() outputs.Format
Filters() map[string]string
Includes(defaultIncludes []string) (incl []string)
Excludes(defaultExcludes []string) (excl []string)
}

func NewClient(s Servicer, out outputs.Outputer) *Client {
Expand Down
26 changes: 15 additions & 11 deletions internal/events/retrieve.go
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@ func (c *Client) Retrieve() *cobra.Command {
var err error
header := []string{"ID", "Body", "Type", "Created"}
inc := []string{}
exc := []string{}

// only fetch extra details when rendered
switch c.Servicer.Format() {
Expand All @@ -70,34 +69,39 @@ func (c *Client) Retrieve() *cobra.Command {
if deviceID != "" && projectID != "" && organizationID != "" && eventID != "" {
return fmt.Errorf("id, project-id, device-id, and organization-id parameters are mutually exclusive")
} else if deviceID != "" {
events, err = pager.GetDeviceEvents(c.EventService, deviceID, inc, exc)
deviceRequest := c.EventService.FindDeviceEvents(context.Background(), deviceID).Include(c.Servicer.Includes(inc)).Exclude(c.Servicer.Excludes(nil))
events, err = pager.GetDeviceEvents(deviceRequest)
if err != nil {
return fmt.Errorf("Could not list Device Events: %w", err)
return fmt.Errorf("could not list Device Events: %w", err)
}
} else if projectID != "" {
events, err = pager.GetProjectEvents(c.EventService, projectID, inc, exc)
projRequest := c.EventService.FindProjectEvents(context.Background(), projectID).Include(c.Servicer.Includes(inc)).Exclude(c.Servicer.Excludes(nil))
events, err = pager.GetProjectEvents(projRequest)
if err != nil {
return fmt.Errorf("Could not list Project Events: %w", err)
return fmt.Errorf("could not list Project Events: %w", err)
}
} else if organizationID != "" {
events, err = pager.GetOrganizationEvents(c.EventService, organizationID, inc, exc)

orgRequest := c.EventService.FindOrganizationEvents(context.Background(), organizationID).Include(c.Servicer.Includes(inc)).Exclude(c.Servicer.Excludes(nil))
events, err = pager.GetOrganizationEvents(orgRequest)
if err != nil {
return fmt.Errorf("Could not list Organization Events: %w", err)
return fmt.Errorf("could not list Organization Events: %w", err)
}
} else if eventID != "" {
event, _, err := c.EventService.FindEventById(context.Background(), eventID).Include(inc).Exclude(exc).Execute()
event, _, err := c.EventService.FindEventById(context.Background(), eventID).Include(c.Servicer.Includes(inc)).Exclude(c.Servicer.Excludes(nil)).Execute()
if err != nil {
return fmt.Errorf("Could not get Event: %w", err)
return fmt.Errorf("could not get Event: %w", err)
}

data := make([][]string, 1)

data[0] = []string{event.GetId(), event.GetBody(), event.GetType(), event.GetCreatedAt().String()}
return c.Out.Output(event, header, &data)
} else {
events, err = pager.GetAllEvents(c.EventService, inc, exc)
request := c.EventService.FindEvents(context.Background()).Include(c.Servicer.Includes(inc)).Exclude(c.Servicer.Excludes(nil))
events, err = pager.GetAllEvents(request)
if err != nil {
return fmt.Errorf("Could not list Events: %w", err)
return fmt.Errorf("could not list Events: %w", err)
}
}

Expand Down
17 changes: 8 additions & 9 deletions internal/pagination/pager.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,14 @@ func GetAllProjects(s metal.ProjectsApiService, include []string, exclude []stri
}
}

func GetDeviceEvents(s metal.EventsApiService, deviceId string, include []string, exclude []string) ([]metal.Event, error) {
func GetDeviceEvents(s metal.ApiFindDeviceEventsRequest) ([]metal.Event, error) {
var events []metal.Event

page := int32(1) // int32 | Page to return (optional) (default to 1)
perPage := int32(20) // int32 | Items returned per page (optional) (default to 10)

for {
eventsPage, _, err := s.FindDeviceEvents(context.Background(), deviceId).Include(include).Exclude(exclude).Page(page).PerPage(perPage).Execute()
eventsPage, _, err := s.Page(page).PerPage(perPage).Execute()
if err != nil {
return nil, err
}
Expand All @@ -46,14 +46,14 @@ func GetDeviceEvents(s metal.EventsApiService, deviceId string, include []string
}
}

func GetProjectEvents(s metal.EventsApiService, projectId string, include []string, exclude []string) ([]metal.Event, error) {
func GetProjectEvents(s metal.ApiFindProjectEventsRequest) ([]metal.Event, error) {
var events []metal.Event

page := int32(1) // int32 | Page to return (optional) (default to 1)
perPage := int32(20) // int32 | Items returned per page (optional) (default to 10)

for {
eventsPage, _, err := s.FindProjectEvents(context.Background(), projectId).Include(include).Exclude(exclude).Page(page).PerPage(perPage).Execute()
eventsPage, _, err := s.Page(page).PerPage(perPage).Execute()
if err != nil {
return nil, err
}
Expand All @@ -67,14 +67,14 @@ func GetProjectEvents(s metal.EventsApiService, projectId string, include []stri
}
}

func GetOrganizationEvents(s metal.EventsApiService, orgId string, include []string, exclude []string) ([]metal.Event, error) {
func GetOrganizationEvents(s metal.ApiFindOrganizationEventsRequest) ([]metal.Event, error) {
var events []metal.Event

page := int32(1) // int32 | Page to return (optional) (default to 1)
perPage := int32(20) // int32 | Items returned per page (optional) (default to 10)

for {
eventsPage, _, err := s.FindOrganizationEvents(context.Background(), orgId).Include(include).Exclude(exclude).Page(page).PerPage(perPage).Execute()
eventsPage, _, err := s.Page(page).PerPage(perPage).Execute()
if err != nil {
return nil, err
}
Expand All @@ -88,14 +88,13 @@ func GetOrganizationEvents(s metal.EventsApiService, orgId string, include []str
}
}

func GetAllEvents(s metal.EventsApiService, include []string, exclude []string) ([]metal.Event, error) {
func GetAllEvents(s metal.ApiFindEventsRequest) ([]metal.Event, error) {
var events []metal.Event

page := int32(1) // int32 | Page to return (optional) (default to 1)
perPage := int32(20) // int32 | Items returned per page (optional) (default to 10)

for {
eventsPage, _, err := s.FindEvents(context.Background()).Include(include).Exclude(exclude).Page(page).PerPage(perPage).Execute()
eventsPage, _, err := s.Page(page).PerPage(perPage).Execute()
if err != nil {
return nil, err
}
Expand Down
94 changes: 94 additions & 0 deletions test/e2e/events/deviceeventstest/device_event_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
package eventsprojtest

import (
"io"
"os"
"strings"
"testing"

root "github.com/equinix/metal-cli/internal/cli"
"github.com/equinix/metal-cli/internal/events"
outputPkg "github.com/equinix/metal-cli/internal/outputs"
"github.com/equinix/metal-cli/test/helper"
"github.com/spf13/cobra"
)

func TestCli_Events_Get(t *testing.T) {
var projectId, deviceId string
var err error
var status bool
subCommand := "event"
consumerToken := ""
apiURL := ""
Version := "metal"
rootClient := root.NewClient(consumerToken, apiURL, Version)
type fields struct {
MainCmd *cobra.Command
Outputer outputPkg.Outputer
}
tests := []struct {
name string
fields fields
want *cobra.Command
cmdFunc func(*testing.T, *cobra.Command)
}{
{
name: "get_events_by_dev_id",
fields: fields{
MainCmd: events.NewClient(rootClient, outputPkg.Outputer(&outputPkg.Standard{})).NewCommand(),
Outputer: outputPkg.Outputer(&outputPkg.Standard{}),
},
want: &cobra.Command{},
cmdFunc: func(t *testing.T, c *cobra.Command) {
root := c.Root()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You even added a device events test! Nice!


projectId, err = helper.CreateTestProject("metal-cli-events-pro")
if err != nil {
t.Error(err)
}
deviceId, err = helper.CreateTestDevice(projectId, "metal-cli-events-dev")
if err != nil {
t.Error(err)
}
status, err = helper.IsDeviceStateActive(deviceId)
if err != nil {
status, err = helper.IsDeviceStateActive(deviceId)
if err != nil || !status {
t.Error(err)
}
}
root.SetArgs([]string{subCommand, "get", "-d", deviceId})
rescueStdout := os.Stdout
r, w, _ := os.Pipe()
os.Stdout = w
if err := root.Execute(); err != nil {
t.Error(err)
}
w.Close()
out, _ := io.ReadAll(r)
os.Stdout = rescueStdout
if !strings.Contains(string(out[:]), "Queued for provisioning") &&
!strings.Contains(string(out[:]), "Connected to magic install system") &&
!strings.Contains(string(out[:]), "Provision complete! Your device is ready to go.") {
t.Error("expected output should include Queued for provisioning in output string")
}
err = helper.CleanTestDevice(deviceId)
if err != nil {
t.Error(err)
}
err = helper.CleanTestProject(projectId)
if err != nil {
t.Error(err)
}
},
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
rootCmd := rootClient.NewCommand()
rootCmd.AddCommand(tt.fields.MainCmd)
tt.cmdFunc(t, tt.fields.MainCmd)
})
}
}
76 changes: 76 additions & 0 deletions test/e2e/events/projecteventstest/project_events_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
package eventsprojtest

import (
"io"
"os"
"strings"
"testing"

root "github.com/equinix/metal-cli/internal/cli"
"github.com/equinix/metal-cli/internal/events"
outputPkg "github.com/equinix/metal-cli/internal/outputs"
"github.com/equinix/metal-cli/test/helper"
"github.com/spf13/cobra"
)

func TestCli_Events_Get(t *testing.T) {
var projectId string
var err error
subCommand := "event"
consumerToken := ""
apiURL := ""
Version := "metal"
rootClient := root.NewClient(consumerToken, apiURL, Version)
type fields struct {
MainCmd *cobra.Command
Outputer outputPkg.Outputer
}
tests := []struct {
name string
fields fields
want *cobra.Command
cmdFunc func(*testing.T, *cobra.Command)
}{
{
name: "get_events_by_proj_id",
fields: fields{
MainCmd: events.NewClient(rootClient, outputPkg.Outputer(&outputPkg.Standard{})).NewCommand(),
Outputer: outputPkg.Outputer(&outputPkg.Standard{}),
},
want: &cobra.Command{},
cmdFunc: func(t *testing.T, c *cobra.Command) {
root := c.Root()

projectId, err = helper.CreateTestProject("metal-cli-events-pro")
if err != nil {
t.Error(err)
}
root.SetArgs([]string{subCommand, "get", "-p", projectId})
rescueStdout := os.Stdout
r, w, _ := os.Pipe()
os.Stdout = w
if err := root.Execute(); err != nil {
t.Error(err)
}
w.Close()
out, _ := io.ReadAll(r)
os.Stdout = rescueStdout
if !strings.Contains(string(out[:]), "metal-cli-events-pro") {
t.Error("expected output should include metal-cli-events-pro in output string")
}
err = helper.CleanTestProject(projectId)
if err != nil {
t.Error(err)
}
},
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
rootCmd := rootClient.NewCommand()
rootCmd.AddCommand(tt.fields.MainCmd)
tt.cmdFunc(t, tt.fields.MainCmd)
})
}
}