github.com/fastly/cli@v1.7.2-0.20240304164155-9d0f1d77c3bf/pkg/commands/logging/sumologic/sumologic_integration_test.go (about)

     1  package sumologic_test
     2  
     3  import (
     4  	"bytes"
     5  	"errors"
     6  	"io"
     7  	"strings"
     8  	"testing"
     9  
    10  	"github.com/fastly/go-fastly/v9/fastly"
    11  
    12  	"github.com/fastly/cli/pkg/app"
    13  	"github.com/fastly/cli/pkg/global"
    14  	"github.com/fastly/cli/pkg/mock"
    15  	"github.com/fastly/cli/pkg/testutil"
    16  )
    17  
    18  func TestSumologicCreate(t *testing.T) {
    19  	args := testutil.Args
    20  	scenarios := []struct {
    21  		args       []string
    22  		api        mock.API
    23  		wantError  string
    24  		wantOutput string
    25  	}{
    26  		{
    27  			args: args("logging sumologic create --service-id 123 --version 1 --name log --url example.com --autoclone"),
    28  			api: mock.API{
    29  				ListVersionsFn:    testutil.ListVersions,
    30  				CloneVersionFn:    testutil.CloneVersionResult(4),
    31  				CreateSumologicFn: createSumologicOK,
    32  			},
    33  			wantOutput: "Created Sumologic logging endpoint log (service 123 version 4)",
    34  		},
    35  		{
    36  			args: args("logging sumologic create --service-id 123 --version 1 --name log --url example.com --autoclone"),
    37  			api: mock.API{
    38  				ListVersionsFn:    testutil.ListVersions,
    39  				CloneVersionFn:    testutil.CloneVersionResult(4),
    40  				CreateSumologicFn: createSumologicError,
    41  			},
    42  			wantError: errTest.Error(),
    43  		},
    44  	}
    45  	for testcaseIdx := range scenarios {
    46  		testcase := &scenarios[testcaseIdx]
    47  		t.Run(strings.Join(testcase.args, " "), func(t *testing.T) {
    48  			var stdout bytes.Buffer
    49  			app.Init = func(_ []string, _ io.Reader) (*global.Data, error) {
    50  				opts := testutil.MockGlobalData(testcase.args, &stdout)
    51  				opts.APIClientFactory = mock.APIClient(testcase.api)
    52  				return opts, nil
    53  			}
    54  			err := app.Run(testcase.args, nil)
    55  			testutil.AssertErrorContains(t, err, testcase.wantError)
    56  			testutil.AssertStringContains(t, stdout.String(), testcase.wantOutput)
    57  		})
    58  	}
    59  }
    60  
    61  func TestSumologicList(t *testing.T) {
    62  	args := testutil.Args
    63  	scenarios := []struct {
    64  		args       []string
    65  		api        mock.API
    66  		wantError  string
    67  		wantOutput string
    68  	}{
    69  		{
    70  			args: args("logging sumologic list --service-id 123 --version 1"),
    71  			api: mock.API{
    72  				ListVersionsFn:   testutil.ListVersions,
    73  				ListSumologicsFn: listSumologicsOK,
    74  			},
    75  			wantOutput: listSumologicsShortOutput,
    76  		},
    77  		{
    78  			args: args("logging sumologic list --service-id 123 --version 1 --verbose"),
    79  			api: mock.API{
    80  				ListVersionsFn:   testutil.ListVersions,
    81  				ListSumologicsFn: listSumologicsOK,
    82  			},
    83  			wantOutput: listSumologicsVerboseOutput,
    84  		},
    85  		{
    86  			args: args("logging sumologic list --service-id 123 --version 1 -v"),
    87  			api: mock.API{
    88  				ListVersionsFn:   testutil.ListVersions,
    89  				ListSumologicsFn: listSumologicsOK,
    90  			},
    91  			wantOutput: listSumologicsVerboseOutput,
    92  		},
    93  		{
    94  			args: args("logging sumologic --verbose list --service-id 123 --version 1"),
    95  			api: mock.API{
    96  				ListVersionsFn:   testutil.ListVersions,
    97  				ListSumologicsFn: listSumologicsOK,
    98  			},
    99  			wantOutput: listSumologicsVerboseOutput,
   100  		},
   101  		{
   102  			args: args("logging -v sumologic list --service-id 123 --version 1"),
   103  			api: mock.API{
   104  				ListVersionsFn:   testutil.ListVersions,
   105  				ListSumologicsFn: listSumologicsOK,
   106  			},
   107  			wantOutput: listSumologicsVerboseOutput,
   108  		},
   109  		{
   110  			args: args("logging sumologic list --service-id 123 --version 1"),
   111  			api: mock.API{
   112  				ListVersionsFn:   testutil.ListVersions,
   113  				ListSumologicsFn: listSumologicsError,
   114  			},
   115  			wantError: errTest.Error(),
   116  		},
   117  	}
   118  	for testcaseIdx := range scenarios {
   119  		testcase := &scenarios[testcaseIdx]
   120  		t.Run(strings.Join(testcase.args, " "), func(t *testing.T) {
   121  			var stdout bytes.Buffer
   122  			app.Init = func(_ []string, _ io.Reader) (*global.Data, error) {
   123  				opts := testutil.MockGlobalData(testcase.args, &stdout)
   124  				opts.APIClientFactory = mock.APIClient(testcase.api)
   125  				return opts, nil
   126  			}
   127  			err := app.Run(testcase.args, nil)
   128  			testutil.AssertErrorContains(t, err, testcase.wantError)
   129  			testutil.AssertString(t, testcase.wantOutput, stdout.String())
   130  		})
   131  	}
   132  }
   133  
   134  func TestSumologicDescribe(t *testing.T) {
   135  	args := testutil.Args
   136  	scenarios := []struct {
   137  		args       []string
   138  		api        mock.API
   139  		wantError  string
   140  		wantOutput string
   141  	}{
   142  		{
   143  			args:      args("logging sumologic describe --service-id 123 --version 1"),
   144  			wantError: "error parsing arguments: required flag --name not provided",
   145  		},
   146  		{
   147  			args: args("logging sumologic describe --service-id 123 --version 1 --name logs"),
   148  			api: mock.API{
   149  				ListVersionsFn: testutil.ListVersions,
   150  				GetSumologicFn: getSumologicError,
   151  			},
   152  			wantError: errTest.Error(),
   153  		},
   154  		{
   155  			args: args("logging sumologic describe --service-id 123 --version 1 --name logs"),
   156  			api: mock.API{
   157  				ListVersionsFn: testutil.ListVersions,
   158  				GetSumologicFn: getSumologicOK,
   159  			},
   160  			wantOutput: describeSumologicOutput,
   161  		},
   162  	}
   163  	for testcaseIdx := range scenarios {
   164  		testcase := &scenarios[testcaseIdx]
   165  		t.Run(strings.Join(testcase.args, " "), func(t *testing.T) {
   166  			var stdout bytes.Buffer
   167  			app.Init = func(_ []string, _ io.Reader) (*global.Data, error) {
   168  				opts := testutil.MockGlobalData(testcase.args, &stdout)
   169  				opts.APIClientFactory = mock.APIClient(testcase.api)
   170  				return opts, nil
   171  			}
   172  			err := app.Run(testcase.args, nil)
   173  			testutil.AssertErrorContains(t, err, testcase.wantError)
   174  			testutil.AssertString(t, testcase.wantOutput, stdout.String())
   175  		})
   176  	}
   177  }
   178  
   179  func TestSumologicUpdate(t *testing.T) {
   180  	args := testutil.Args
   181  	scenarios := []struct {
   182  		args       []string
   183  		api        mock.API
   184  		wantError  string
   185  		wantOutput string
   186  	}{
   187  		{
   188  			args:      args("logging sumologic update --service-id 123 --version 1 --new-name log"),
   189  			wantError: "error parsing arguments: required flag --name not provided",
   190  		},
   191  		{
   192  			args: args("logging sumologic update --service-id 123 --version 1 --name logs --new-name log --autoclone"),
   193  			api: mock.API{
   194  				ListVersionsFn:    testutil.ListVersions,
   195  				CloneVersionFn:    testutil.CloneVersionResult(4),
   196  				UpdateSumologicFn: updateSumologicError,
   197  			},
   198  			wantError: errTest.Error(),
   199  		},
   200  		{
   201  			args: args("logging sumologic update --service-id 123 --version 1 --name logs --new-name log --autoclone"),
   202  			api: mock.API{
   203  				ListVersionsFn:    testutil.ListVersions,
   204  				CloneVersionFn:    testutil.CloneVersionResult(4),
   205  				UpdateSumologicFn: updateSumologicOK,
   206  			},
   207  			wantOutput: "Updated Sumologic logging endpoint log (service 123 version 4)",
   208  		},
   209  	}
   210  	for testcaseIdx := range scenarios {
   211  		testcase := &scenarios[testcaseIdx]
   212  		t.Run(strings.Join(testcase.args, " "), func(t *testing.T) {
   213  			var stdout bytes.Buffer
   214  			app.Init = func(_ []string, _ io.Reader) (*global.Data, error) {
   215  				opts := testutil.MockGlobalData(testcase.args, &stdout)
   216  				opts.APIClientFactory = mock.APIClient(testcase.api)
   217  				return opts, nil
   218  			}
   219  			err := app.Run(testcase.args, nil)
   220  			testutil.AssertErrorContains(t, err, testcase.wantError)
   221  			testutil.AssertStringContains(t, stdout.String(), testcase.wantOutput)
   222  		})
   223  	}
   224  }
   225  
   226  func TestSumologicDelete(t *testing.T) {
   227  	args := testutil.Args
   228  	scenarios := []struct {
   229  		args       []string
   230  		api        mock.API
   231  		wantError  string
   232  		wantOutput string
   233  	}{
   234  		{
   235  			args:      args("logging sumologic delete --service-id 123 --version 1"),
   236  			wantError: "error parsing arguments: required flag --name not provided",
   237  		},
   238  		{
   239  			args: args("logging sumologic delete --service-id 123 --version 1 --name logs --autoclone"),
   240  			api: mock.API{
   241  				ListVersionsFn:    testutil.ListVersions,
   242  				CloneVersionFn:    testutil.CloneVersionResult(4),
   243  				DeleteSumologicFn: deleteSumologicError,
   244  			},
   245  			wantError: errTest.Error(),
   246  		},
   247  		{
   248  			args: args("logging sumologic delete --service-id 123 --version 1 --name logs --autoclone"),
   249  			api: mock.API{
   250  				ListVersionsFn:    testutil.ListVersions,
   251  				CloneVersionFn:    testutil.CloneVersionResult(4),
   252  				DeleteSumologicFn: deleteSumologicOK,
   253  			},
   254  			wantOutput: "Deleted Sumologic logging endpoint logs (service 123 version 4)",
   255  		},
   256  	}
   257  	for testcaseIdx := range scenarios {
   258  		testcase := &scenarios[testcaseIdx]
   259  		t.Run(strings.Join(testcase.args, " "), func(t *testing.T) {
   260  			var stdout bytes.Buffer
   261  			app.Init = func(_ []string, _ io.Reader) (*global.Data, error) {
   262  				opts := testutil.MockGlobalData(testcase.args, &stdout)
   263  				opts.APIClientFactory = mock.APIClient(testcase.api)
   264  				return opts, nil
   265  			}
   266  			err := app.Run(testcase.args, nil)
   267  			testutil.AssertErrorContains(t, err, testcase.wantError)
   268  			testutil.AssertStringContains(t, stdout.String(), testcase.wantOutput)
   269  		})
   270  	}
   271  }
   272  
   273  var errTest = errors.New("fixture error")
   274  
   275  func createSumologicOK(i *fastly.CreateSumologicInput) (*fastly.Sumologic, error) {
   276  	return &fastly.Sumologic{
   277  		ServiceID:      fastly.ToPointer(i.ServiceID),
   278  		ServiceVersion: fastly.ToPointer(i.ServiceVersion),
   279  		Name:           i.Name,
   280  	}, nil
   281  }
   282  
   283  func createSumologicError(_ *fastly.CreateSumologicInput) (*fastly.Sumologic, error) {
   284  	return nil, errTest
   285  }
   286  
   287  func listSumologicsOK(i *fastly.ListSumologicsInput) ([]*fastly.Sumologic, error) {
   288  	return []*fastly.Sumologic{
   289  		{
   290  			ServiceID:         fastly.ToPointer(i.ServiceID),
   291  			ServiceVersion:    fastly.ToPointer(i.ServiceVersion),
   292  			Name:              fastly.ToPointer("logs"),
   293  			URL:               fastly.ToPointer("example.com"),
   294  			Format:            fastly.ToPointer(`%h %l %u %t "%r" %>s %b`),
   295  			FormatVersion:     fastly.ToPointer(2),
   296  			MessageType:       fastly.ToPointer("classic"),
   297  			ResponseCondition: fastly.ToPointer("Prevent default logging"),
   298  			Placement:         fastly.ToPointer("none"),
   299  		},
   300  		{
   301  			ServiceID:         fastly.ToPointer(i.ServiceID),
   302  			ServiceVersion:    fastly.ToPointer(i.ServiceVersion),
   303  			Name:              fastly.ToPointer("analytics"),
   304  			URL:               fastly.ToPointer("bar.com"),
   305  			Format:            fastly.ToPointer(`%h %l %u %t "%r" %>s %b`),
   306  			ResponseCondition: fastly.ToPointer("Prevent default logging"),
   307  			MessageType:       fastly.ToPointer("classic"),
   308  			FormatVersion:     fastly.ToPointer(2),
   309  			Placement:         fastly.ToPointer("none"),
   310  		},
   311  	}, nil
   312  }
   313  
   314  func listSumologicsError(_ *fastly.ListSumologicsInput) ([]*fastly.Sumologic, error) {
   315  	return nil, errTest
   316  }
   317  
   318  var listSumologicsShortOutput = strings.TrimSpace(`
   319  SERVICE  VERSION  NAME
   320  123      1        logs
   321  123      1        analytics
   322  `) + "\n"
   323  
   324  var listSumologicsVerboseOutput = strings.TrimSpace(`
   325  Fastly API endpoint: https://api.fastly.com
   326  Fastly API token provided via config file (profile: user)
   327  
   328  Service ID (via --service-id): 123
   329  
   330  Version: 1
   331  	Sumologic 1/2
   332  		Service ID: 123
   333  		Version: 1
   334  		Name: logs
   335  		URL: example.com
   336  		Format: %h %l %u %t "%r" %>s %b
   337  		Format version: 2
   338  		Response condition: Prevent default logging
   339  		Message type: classic
   340  		Placement: none
   341  	Sumologic 2/2
   342  		Service ID: 123
   343  		Version: 1
   344  		Name: analytics
   345  		URL: bar.com
   346  		Format: %h %l %u %t "%r" %>s %b
   347  		Format version: 2
   348  		Response condition: Prevent default logging
   349  		Message type: classic
   350  		Placement: none
   351  `) + "\n\n"
   352  
   353  func getSumologicOK(i *fastly.GetSumologicInput) (*fastly.Sumologic, error) {
   354  	return &fastly.Sumologic{
   355  		ServiceID:         fastly.ToPointer(i.ServiceID),
   356  		ServiceVersion:    fastly.ToPointer(i.ServiceVersion),
   357  		Name:              fastly.ToPointer("logs"),
   358  		URL:               fastly.ToPointer("example.com"),
   359  		Format:            fastly.ToPointer(`%h %l %u %t "%r" %>s %b`),
   360  		FormatVersion:     fastly.ToPointer(2),
   361  		MessageType:       fastly.ToPointer("classic"),
   362  		ResponseCondition: fastly.ToPointer("Prevent default logging"),
   363  		Placement:         fastly.ToPointer("none"),
   364  	}, nil
   365  }
   366  
   367  func getSumologicError(_ *fastly.GetSumologicInput) (*fastly.Sumologic, error) {
   368  	return nil, errTest
   369  }
   370  
   371  var describeSumologicOutput = "\n" + strings.TrimSpace(`
   372  Format: %h %l %u %t "%r" %>s %b
   373  Format version: 2
   374  Message type: classic
   375  Name: logs
   376  Placement: none
   377  Response condition: Prevent default logging
   378  Service ID: 123
   379  URL: example.com
   380  Version: 1
   381  `) + "\n"
   382  
   383  func updateSumologicOK(i *fastly.UpdateSumologicInput) (*fastly.Sumologic, error) {
   384  	return &fastly.Sumologic{
   385  		ServiceID:         fastly.ToPointer(i.ServiceID),
   386  		ServiceVersion:    fastly.ToPointer(i.ServiceVersion),
   387  		Name:              fastly.ToPointer("log"),
   388  		URL:               fastly.ToPointer("example.com"),
   389  		Format:            fastly.ToPointer(`%h %l %u %t "%r" %>s %b`),
   390  		FormatVersion:     fastly.ToPointer(2),
   391  		MessageType:       fastly.ToPointer("classic"),
   392  		ResponseCondition: fastly.ToPointer("Prevent default logging"),
   393  		Placement:         fastly.ToPointer("none"),
   394  	}, nil
   395  }
   396  
   397  func updateSumologicError(_ *fastly.UpdateSumologicInput) (*fastly.Sumologic, error) {
   398  	return nil, errTest
   399  }
   400  
   401  func deleteSumologicOK(_ *fastly.DeleteSumologicInput) error {
   402  	return nil
   403  }
   404  
   405  func deleteSumologicError(_ *fastly.DeleteSumologicInput) error {
   406  	return errTest
   407  }