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

     1  package logshuttle_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 TestLogshuttleCreate(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 logshuttle create --service-id 123 --version 1 --name log --url example.com --auth-token abc --autoclone"),
    28  			api: mock.API{
    29  				ListVersionsFn:     testutil.ListVersions,
    30  				CloneVersionFn:     testutil.CloneVersionResult(4),
    31  				CreateLogshuttleFn: createLogshuttleOK,
    32  			},
    33  			wantOutput: "Created Logshuttle logging endpoint log (service 123 version 4)",
    34  		},
    35  		{
    36  			args: args("logging logshuttle create --service-id 123 --version 1 --name log --url example.com --auth-token abc --autoclone"),
    37  			api: mock.API{
    38  				ListVersionsFn:     testutil.ListVersions,
    39  				CloneVersionFn:     testutil.CloneVersionResult(4),
    40  				CreateLogshuttleFn: createLogshuttleError,
    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 TestLogshuttleList(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 logshuttle list --service-id 123 --version 1"),
    71  			api: mock.API{
    72  				ListVersionsFn:    testutil.ListVersions,
    73  				ListLogshuttlesFn: listLogshuttlesOK,
    74  			},
    75  			wantOutput: listLogshuttlesShortOutput,
    76  		},
    77  		{
    78  			args: args("logging logshuttle list --service-id 123 --version 1 --verbose"),
    79  			api: mock.API{
    80  				ListVersionsFn:    testutil.ListVersions,
    81  				ListLogshuttlesFn: listLogshuttlesOK,
    82  			},
    83  			wantOutput: listLogshuttlesVerboseOutput,
    84  		},
    85  		{
    86  			args: args("logging logshuttle list --service-id 123 --version 1 -v"),
    87  			api: mock.API{
    88  				ListVersionsFn:    testutil.ListVersions,
    89  				ListLogshuttlesFn: listLogshuttlesOK,
    90  			},
    91  			wantOutput: listLogshuttlesVerboseOutput,
    92  		},
    93  		{
    94  			args: args("logging logshuttle --verbose list --service-id 123 --version 1"),
    95  			api: mock.API{
    96  				ListVersionsFn:    testutil.ListVersions,
    97  				ListLogshuttlesFn: listLogshuttlesOK,
    98  			},
    99  			wantOutput: listLogshuttlesVerboseOutput,
   100  		},
   101  		{
   102  			args: args("logging -v logshuttle list --service-id 123 --version 1"),
   103  			api: mock.API{
   104  				ListVersionsFn:    testutil.ListVersions,
   105  				ListLogshuttlesFn: listLogshuttlesOK,
   106  			},
   107  			wantOutput: listLogshuttlesVerboseOutput,
   108  		},
   109  		{
   110  			args: args("logging logshuttle list --service-id 123 --version 1"),
   111  			api: mock.API{
   112  				ListVersionsFn:    testutil.ListVersions,
   113  				ListLogshuttlesFn: listLogshuttlesError,
   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 TestLogshuttleDescribe(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 logshuttle describe --service-id 123 --version 1"),
   144  			wantError: "error parsing arguments: required flag --name not provided",
   145  		},
   146  		{
   147  			args: args("logging logshuttle describe --service-id 123 --version 1 --name logs"),
   148  			api: mock.API{
   149  				ListVersionsFn:  testutil.ListVersions,
   150  				GetLogshuttleFn: getLogshuttleError,
   151  			},
   152  			wantError: errTest.Error(),
   153  		},
   154  		{
   155  			args: args("logging logshuttle describe --service-id 123 --version 1 --name logs"),
   156  			api: mock.API{
   157  				ListVersionsFn:  testutil.ListVersions,
   158  				GetLogshuttleFn: getLogshuttleOK,
   159  			},
   160  			wantOutput: describeLogshuttleOutput,
   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 TestLogshuttleUpdate(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 logshuttle 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 logshuttle 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  				UpdateLogshuttleFn: updateLogshuttleError,
   197  			},
   198  			wantError: errTest.Error(),
   199  		},
   200  		{
   201  			args: args("logging logshuttle 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  				UpdateLogshuttleFn: updateLogshuttleOK,
   206  			},
   207  			wantOutput: "Updated Logshuttle 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 TestLogshuttleDelete(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 logshuttle delete --service-id 123 --version 1"),
   236  			wantError: "error parsing arguments: required flag --name not provided",
   237  		},
   238  		{
   239  			args: args("logging logshuttle delete --service-id 123 --version 1 --name logs --autoclone"),
   240  			api: mock.API{
   241  				ListVersionsFn:     testutil.ListVersions,
   242  				CloneVersionFn:     testutil.CloneVersionResult(4),
   243  				DeleteLogshuttleFn: deleteLogshuttleError,
   244  			},
   245  			wantError: errTest.Error(),
   246  		},
   247  		{
   248  			args: args("logging logshuttle delete --service-id 123 --version 1 --name logs --autoclone"),
   249  			api: mock.API{
   250  				ListVersionsFn:     testutil.ListVersions,
   251  				CloneVersionFn:     testutil.CloneVersionResult(4),
   252  				DeleteLogshuttleFn: deleteLogshuttleOK,
   253  			},
   254  			wantOutput: "Deleted Logshuttle 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 createLogshuttleOK(i *fastly.CreateLogshuttleInput) (*fastly.Logshuttle, error) {
   276  	s := fastly.Logshuttle{
   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 createLogshuttleError(_ *fastly.CreateLogshuttleInput) (*fastly.Logshuttle, error) {
   289  	return nil, errTest
   290  }
   291  
   292  func listLogshuttlesOK(i *fastly.ListLogshuttlesInput) ([]*fastly.Logshuttle, error) {
   293  	return []*fastly.Logshuttle{
   294  		{
   295  			ServiceID:         fastly.ToPointer(i.ServiceID),
   296  			ServiceVersion:    fastly.ToPointer(i.ServiceVersion),
   297  			Name:              fastly.ToPointer("logs"),
   298  			Format:            fastly.ToPointer(`%h %l %u %t "%r" %>s %b`),
   299  			FormatVersion:     fastly.ToPointer(2),
   300  			URL:               fastly.ToPointer("example.com"),
   301  			Token:             fastly.ToPointer("abc"),
   302  			ResponseCondition: fastly.ToPointer("Prevent default logging"),
   303  			Placement:         fastly.ToPointer("none"),
   304  		},
   305  		{
   306  			ServiceID:         fastly.ToPointer(i.ServiceID),
   307  			ServiceVersion:    fastly.ToPointer(i.ServiceVersion),
   308  			Name:              fastly.ToPointer("analytics"),
   309  			Format:            fastly.ToPointer(`%h %l %u %t "%r" %>s %b`),
   310  			FormatVersion:     fastly.ToPointer(2),
   311  			URL:               fastly.ToPointer("example.com"),
   312  			Token:             fastly.ToPointer("abc"),
   313  			ResponseCondition: fastly.ToPointer("Prevent default logging"),
   314  			Placement:         fastly.ToPointer("none"),
   315  		},
   316  	}, nil
   317  }
   318  
   319  func listLogshuttlesError(_ *fastly.ListLogshuttlesInput) ([]*fastly.Logshuttle, error) {
   320  	return nil, errTest
   321  }
   322  
   323  var listLogshuttlesShortOutput = strings.TrimSpace(`
   324  SERVICE  VERSION  NAME
   325  123      1        logs
   326  123      1        analytics
   327  `) + "\n"
   328  
   329  var listLogshuttlesVerboseOutput = strings.TrimSpace(`
   330  Fastly API endpoint: https://api.fastly.com
   331  Fastly API token provided via config file (profile: user)
   332  
   333  Service ID (via --service-id): 123
   334  
   335  Version: 1
   336  	Logshuttle 1/2
   337  		Service ID: 123
   338  		Version: 1
   339  		Name: logs
   340  		URL: example.com
   341  		Token: abc
   342  		Format: %h %l %u %t "%r" %>s %b
   343  		Format version: 2
   344  		Response condition: Prevent default logging
   345  		Placement: none
   346  	Logshuttle 2/2
   347  		Service ID: 123
   348  		Version: 1
   349  		Name: analytics
   350  		URL: example.com
   351  		Token: abc
   352  		Format: %h %l %u %t "%r" %>s %b
   353  		Format version: 2
   354  		Response condition: Prevent default logging
   355  		Placement: none
   356  `) + "\n\n"
   357  
   358  func getLogshuttleOK(i *fastly.GetLogshuttleInput) (*fastly.Logshuttle, error) {
   359  	return &fastly.Logshuttle{
   360  		ServiceID:         fastly.ToPointer(i.ServiceID),
   361  		ServiceVersion:    fastly.ToPointer(i.ServiceVersion),
   362  		Name:              fastly.ToPointer("logs"),
   363  		URL:               fastly.ToPointer("example.com"),
   364  		Token:             fastly.ToPointer("abc"),
   365  		Format:            fastly.ToPointer(`%h %l %u %t "%r" %>s %b`),
   366  		FormatVersion:     fastly.ToPointer(2),
   367  		ResponseCondition: fastly.ToPointer("Prevent default logging"),
   368  		Placement:         fastly.ToPointer("none"),
   369  	}, nil
   370  }
   371  
   372  func getLogshuttleError(_ *fastly.GetLogshuttleInput) (*fastly.Logshuttle, error) {
   373  	return nil, errTest
   374  }
   375  
   376  var describeLogshuttleOutput = "\n" + strings.TrimSpace(`
   377  Format: %h %l %u %t "%r" %>s %b
   378  Format version: 2
   379  Name: logs
   380  Placement: none
   381  Response condition: Prevent default logging
   382  Service ID: 123
   383  Token: abc
   384  URL: example.com
   385  Version: 1
   386  `) + "\n"
   387  
   388  func updateLogshuttleOK(i *fastly.UpdateLogshuttleInput) (*fastly.Logshuttle, error) {
   389  	return &fastly.Logshuttle{
   390  		ServiceID:         fastly.ToPointer(i.ServiceID),
   391  		ServiceVersion:    fastly.ToPointer(i.ServiceVersion),
   392  		Name:              fastly.ToPointer("log"),
   393  		URL:               fastly.ToPointer("example.com"),
   394  		Token:             fastly.ToPointer("abc"),
   395  		Format:            fastly.ToPointer(`%h %l %u %t "%r" %>s %b`),
   396  		FormatVersion:     fastly.ToPointer(2),
   397  		ResponseCondition: fastly.ToPointer("Prevent default logging"),
   398  		Placement:         fastly.ToPointer("none"),
   399  	}, nil
   400  }
   401  
   402  func updateLogshuttleError(_ *fastly.UpdateLogshuttleInput) (*fastly.Logshuttle, error) {
   403  	return nil, errTest
   404  }
   405  
   406  func deleteLogshuttleOK(_ *fastly.DeleteLogshuttleInput) error {
   407  	return nil
   408  }
   409  
   410  func deleteLogshuttleError(_ *fastly.DeleteLogshuttleInput) error {
   411  	return errTest
   412  }