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

     1  package loggly_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 TestLogglyCreate(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 loggly create --service-id 123 --version 1 --name log --auth-token abc --autoclone"),
    28  			api: mock.API{
    29  				ListVersionsFn: testutil.ListVersions,
    30  				CloneVersionFn: testutil.CloneVersionResult(4),
    31  				CreateLogglyFn: createLogglyOK,
    32  			},
    33  			wantOutput: "Created Loggly logging endpoint log (service 123 version 4)",
    34  		},
    35  		{
    36  			args: args("logging loggly create --service-id 123 --version 1 --name log --auth-token abc --autoclone"),
    37  			api: mock.API{
    38  				ListVersionsFn: testutil.ListVersions,
    39  				CloneVersionFn: testutil.CloneVersionResult(4),
    40  				CreateLogglyFn: createLogglyError,
    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 TestLogglyList(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 loggly list --service-id 123 --version 1"),
    71  			api: mock.API{
    72  				ListVersionsFn: testutil.ListVersions,
    73  				ListLogglyFn:   listLogglysOK,
    74  			},
    75  			wantOutput: listLogglysShortOutput,
    76  		},
    77  		{
    78  			args: args("logging loggly list --service-id 123 --version 1 --verbose"),
    79  			api: mock.API{
    80  				ListVersionsFn: testutil.ListVersions,
    81  				ListLogglyFn:   listLogglysOK,
    82  			},
    83  			wantOutput: listLogglysVerboseOutput,
    84  		},
    85  		{
    86  			args: args("logging loggly list --service-id 123 --version 1 -v"),
    87  			api: mock.API{
    88  				ListVersionsFn: testutil.ListVersions,
    89  				ListLogglyFn:   listLogglysOK,
    90  			},
    91  			wantOutput: listLogglysVerboseOutput,
    92  		},
    93  		{
    94  			args: args("logging loggly --verbose list --service-id 123 --version 1"),
    95  			api: mock.API{
    96  				ListVersionsFn: testutil.ListVersions,
    97  				ListLogglyFn:   listLogglysOK,
    98  			},
    99  			wantOutput: listLogglysVerboseOutput,
   100  		},
   101  		{
   102  			args: args("logging -v loggly list --service-id 123 --version 1"),
   103  			api: mock.API{
   104  				ListVersionsFn: testutil.ListVersions,
   105  				ListLogglyFn:   listLogglysOK,
   106  			},
   107  			wantOutput: listLogglysVerboseOutput,
   108  		},
   109  		{
   110  			args: args("logging loggly list --service-id 123 --version 1"),
   111  			api: mock.API{
   112  				ListVersionsFn: testutil.ListVersions,
   113  				ListLogglyFn:   listLogglysError,
   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 TestLogglyDescribe(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 loggly describe --service-id 123 --version 1"),
   144  			wantError: "error parsing arguments: required flag --name not provided",
   145  		},
   146  		{
   147  			args: args("logging loggly describe --service-id 123 --version 1 --name logs"),
   148  			api: mock.API{
   149  				ListVersionsFn: testutil.ListVersions,
   150  				GetLogglyFn:    getLogglyError,
   151  			},
   152  			wantError: errTest.Error(),
   153  		},
   154  		{
   155  			args: args("logging loggly describe --service-id 123 --version 1 --name logs"),
   156  			api: mock.API{
   157  				ListVersionsFn: testutil.ListVersions,
   158  				GetLogglyFn:    getLogglyOK,
   159  			},
   160  			wantOutput: describeLogglyOutput,
   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 TestLogglyUpdate(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 loggly 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 loggly 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  				UpdateLogglyFn: updateLogglyError,
   197  			},
   198  			wantError: errTest.Error(),
   199  		},
   200  		{
   201  			args: args("logging loggly 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  				UpdateLogglyFn: updateLogglyOK,
   206  			},
   207  			wantOutput: "Updated Loggly 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 TestLogglyDelete(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 loggly delete --service-id 123 --version 1"),
   236  			wantError: "error parsing arguments: required flag --name not provided",
   237  		},
   238  		{
   239  			args: args("logging loggly delete --service-id 123 --version 1 --name logs --autoclone"),
   240  			api: mock.API{
   241  				ListVersionsFn: testutil.ListVersions,
   242  				CloneVersionFn: testutil.CloneVersionResult(4),
   243  				DeleteLogglyFn: deleteLogglyError,
   244  			},
   245  			wantError: errTest.Error(),
   246  		},
   247  		{
   248  			args: args("logging loggly delete --service-id 123 --version 1 --name logs --autoclone"),
   249  			api: mock.API{
   250  				ListVersionsFn: testutil.ListVersions,
   251  				CloneVersionFn: testutil.CloneVersionResult(4),
   252  				DeleteLogglyFn: deleteLogglyOK,
   253  			},
   254  			wantOutput: "Deleted Loggly 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 createLogglyOK(i *fastly.CreateLogglyInput) (*fastly.Loggly, error) {
   276  	s := fastly.Loggly{
   277  		ServiceID:      fastly.ToPointer(i.ServiceID),
   278  		ServiceVersion: fastly.ToPointer(i.ServiceVersion),
   279  	}
   280  
   281  	if i.Name != nil {
   282  		s.Name = i.Name
   283  	}
   284  
   285  	return &s, nil
   286  }
   287  
   288  func createLogglyError(_ *fastly.CreateLogglyInput) (*fastly.Loggly, error) {
   289  	return nil, errTest
   290  }
   291  
   292  func listLogglysOK(i *fastly.ListLogglyInput) ([]*fastly.Loggly, error) {
   293  	return []*fastly.Loggly{
   294  		{
   295  			ServiceID:         fastly.ToPointer(i.ServiceID),
   296  			ServiceVersion:    fastly.ToPointer(i.ServiceVersion),
   297  			Name:              fastly.ToPointer("logs"),
   298  			Token:             fastly.ToPointer("abc"),
   299  			Format:            fastly.ToPointer(`%h %l %u %t "%r" %>s %b`),
   300  			FormatVersion:     fastly.ToPointer(2),
   301  			ResponseCondition: fastly.ToPointer("Prevent default logging"),
   302  			Placement:         fastly.ToPointer("none"),
   303  		},
   304  		{
   305  			ServiceID:         fastly.ToPointer(i.ServiceID),
   306  			ServiceVersion:    fastly.ToPointer(i.ServiceVersion),
   307  			Name:              fastly.ToPointer("analytics"),
   308  			Token:             fastly.ToPointer("abc"),
   309  			Format:            fastly.ToPointer(`%h %l %u %t "%r" %>s %b`),
   310  			FormatVersion:     fastly.ToPointer(2),
   311  			ResponseCondition: fastly.ToPointer("Prevent default logging"),
   312  			Placement:         fastly.ToPointer("none"),
   313  		},
   314  	}, nil
   315  }
   316  
   317  func listLogglysError(_ *fastly.ListLogglyInput) ([]*fastly.Loggly, error) {
   318  	return nil, errTest
   319  }
   320  
   321  var listLogglysShortOutput = strings.TrimSpace(`
   322  SERVICE  VERSION  NAME
   323  123      1        logs
   324  123      1        analytics
   325  `) + "\n"
   326  
   327  var listLogglysVerboseOutput = strings.TrimSpace(`
   328  Fastly API endpoint: https://api.fastly.com
   329  Fastly API token provided via config file (profile: user)
   330  
   331  Service ID (via --service-id): 123
   332  
   333  Version: 1
   334  	Loggly 1/2
   335  		Service ID: 123
   336  		Version: 1
   337  		Name: logs
   338  		Token: abc
   339  		Format: %h %l %u %t "%r" %>s %b
   340  		Format version: 2
   341  		Response condition: Prevent default logging
   342  		Placement: none
   343  	Loggly 2/2
   344  		Service ID: 123
   345  		Version: 1
   346  		Name: analytics
   347  		Token: abc
   348  		Format: %h %l %u %t "%r" %>s %b
   349  		Format version: 2
   350  		Response condition: Prevent default logging
   351  		Placement: none
   352  `) + "\n\n"
   353  
   354  func getLogglyOK(i *fastly.GetLogglyInput) (*fastly.Loggly, error) {
   355  	return &fastly.Loggly{
   356  		ServiceID:         fastly.ToPointer(i.ServiceID),
   357  		ServiceVersion:    fastly.ToPointer(i.ServiceVersion),
   358  		Name:              fastly.ToPointer("logs"),
   359  		Token:             fastly.ToPointer("abc"),
   360  		Format:            fastly.ToPointer(`%h %l %u %t "%r" %>s %b`),
   361  		FormatVersion:     fastly.ToPointer(2),
   362  		ResponseCondition: fastly.ToPointer("Prevent default logging"),
   363  		Placement:         fastly.ToPointer("none"),
   364  	}, nil
   365  }
   366  
   367  func getLogglyError(_ *fastly.GetLogglyInput) (*fastly.Loggly, error) {
   368  	return nil, errTest
   369  }
   370  
   371  var describeLogglyOutput = "\n" + strings.TrimSpace(`
   372  Format: %h %l %u %t "%r" %>s %b
   373  Format version: 2
   374  Name: logs
   375  Placement: none
   376  Response condition: Prevent default logging
   377  Service ID: 123
   378  Token: abc
   379  Version: 1
   380  `) + "\n"
   381  
   382  func updateLogglyOK(i *fastly.UpdateLogglyInput) (*fastly.Loggly, error) {
   383  	return &fastly.Loggly{
   384  		ServiceID:         fastly.ToPointer(i.ServiceID),
   385  		ServiceVersion:    fastly.ToPointer(i.ServiceVersion),
   386  		Name:              fastly.ToPointer("log"),
   387  		Token:             fastly.ToPointer("abc"),
   388  		Format:            fastly.ToPointer(`%h %l %u %t "%r" %>s %b`),
   389  		FormatVersion:     fastly.ToPointer(2),
   390  		ResponseCondition: fastly.ToPointer("Prevent default logging"),
   391  	}, nil
   392  }
   393  
   394  func updateLogglyError(_ *fastly.UpdateLogglyInput) (*fastly.Loggly, error) {
   395  	return nil, errTest
   396  }
   397  
   398  func deleteLogglyOK(_ *fastly.DeleteLogglyInput) error {
   399  	return nil
   400  }
   401  
   402  func deleteLogglyError(_ *fastly.DeleteLogglyInput) error {
   403  	return errTest
   404  }