|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284 |
- // Copyright 2016 Google LLC
- //
- // Licensed under the Apache License, Version 2.0 (the "License");
- // you may not use this file except in compliance with the License.
- // You may obtain a copy of the License at
- //
- // http://www.apache.org/licenses/LICENSE-2.0
- //
- // Unless required by applicable law or agreed to in writing, software
- // distributed under the License is distributed on an "AS IS" BASIS,
- // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- // See the License for the specific language governing permissions and
- // limitations under the License.
-
- // TODO(jba): document in CONTRIBUTING.md that service account must be given "Logs Configuration Writer" IAM role for sink tests to pass.
- // TODO(jba): [cont] (1) From top left menu, go to IAM & Admin. (2) In Roles dropdown for acct, select Logging > Logs Configuration Writer. (3) Save.
- // TODO(jba): Also, cloud-logs@google.com must have Owner permission on the GCS bucket named for the test project.
-
- package logadmin
-
- import (
- "context"
- "log"
- "testing"
- "time"
-
- "cloud.google.com/go/internal/testutil"
- "cloud.google.com/go/internal/uid"
- ltest "cloud.google.com/go/logging/internal/testing"
- "cloud.google.com/go/storage"
- "google.golang.org/api/iterator"
- "google.golang.org/api/option"
- )
-
- var sinkIDs = uid.NewSpace("GO-CLIENT-TEST-SINK", nil)
-
- const testFilter = ""
-
- var testSinkDestination string
-
- // Called just before TestMain calls m.Run.
- // Returns a cleanup function to be called after the tests finish.
- func initSinks(ctx context.Context) func() {
- // Create a unique GCS bucket so concurrent tests don't interfere with each other.
- bucketIDs := uid.NewSpace(testProjectID+"-log-sink", nil)
- testBucket := bucketIDs.New()
- testSinkDestination = "storage.googleapis.com/" + testBucket
- var storageClient *storage.Client
- if integrationTest {
- // Create a unique bucket as a sink destination, and give the cloud logging account
- // owner right.
- ts := testutil.TokenSource(ctx, storage.ScopeFullControl)
- var err error
- storageClient, err = storage.NewClient(ctx, option.WithTokenSource(ts))
- if err != nil {
- log.Fatalf("new storage client: %v", err)
- }
- bucket := storageClient.Bucket(testBucket)
- if err := bucket.Create(ctx, testProjectID, nil); err != nil {
- log.Fatalf("creating storage bucket %q: %v", testBucket, err)
- }
- log.Printf("successfully created bucket %s", testBucket)
- if err := bucket.ACL().Set(ctx, "group-cloud-logs@google.com", storage.RoleOwner); err != nil {
- log.Fatalf("setting owner role: %v", err)
- }
- }
- // Clean up from aborted tests.
- it := client.Sinks(ctx)
- for {
- s, err := it.Next()
- if err == iterator.Done {
- break
- }
- if err != nil {
- log.Printf("listing sinks: %v", err)
- break
- }
- if sinkIDs.Older(s.ID, time.Hour) {
- client.DeleteSink(ctx, s.ID) // ignore error
- }
- }
- if integrationTest {
- for _, bn := range bucketNames(ctx, storageClient) {
- if bucketIDs.Older(bn, 24*time.Hour) {
- storageClient.Bucket(bn).Delete(ctx) // ignore error
- }
- }
- return func() {
- storageClient.Close()
- }
- }
- return func() {}
- }
-
- // Collect the name of all buckets for the test project.
- func bucketNames(ctx context.Context, client *storage.Client) []string {
- var names []string
- it := client.Buckets(ctx, testProjectID)
- loop:
- for {
- b, err := it.Next()
- switch err {
- case nil:
- names = append(names, b.Name)
- case iterator.Done:
- break loop
- default:
- log.Printf("listing buckets: %v", err)
- break loop
- }
- }
- return names
- }
-
- func TestCreateSink(t *testing.T) {
- ctx := context.Background()
- sink := &Sink{
- ID: sinkIDs.New(),
- Destination: testSinkDestination,
- Filter: testFilter,
- IncludeChildren: true,
- }
- got, err := client.CreateSink(ctx, sink)
- if err != nil {
- t.Fatal(err)
- }
- sink.WriterIdentity = ltest.SharedServiceAccount
- if want := sink; !testutil.Equal(got, want) {
- t.Errorf("got %+v, want %+v", got, want)
- }
- got, err = client.Sink(ctx, sink.ID)
- if err != nil {
- t.Fatal(err)
- }
- if want := sink; !testutil.Equal(got, want) {
- t.Errorf("got %+v, want %+v", got, want)
- }
-
- // UniqueWriterIdentity
- sink.ID = sinkIDs.New()
- got, err = client.CreateSinkOpt(ctx, sink, SinkOptions{UniqueWriterIdentity: true})
- if err != nil {
- t.Fatal(err)
- }
- // The WriterIdentity should be different.
- if got.WriterIdentity == sink.WriterIdentity {
- t.Errorf("got %s, want something different", got.WriterIdentity)
- }
- }
-
- func TestUpdateSink(t *testing.T) {
- ctx := context.Background()
- sink := &Sink{
- ID: sinkIDs.New(),
- Destination: testSinkDestination,
- Filter: testFilter,
- IncludeChildren: true,
- WriterIdentity: ltest.SharedServiceAccount,
- }
-
- if _, err := client.CreateSink(ctx, sink); err != nil {
- t.Fatal(err)
- }
- got, err := client.UpdateSink(ctx, sink)
- if err != nil {
- t.Fatal(err)
- }
- if want := sink; !testutil.Equal(got, want) {
- t.Errorf("got\n%+v\nwant\n%+v", got, want)
- }
- got, err = client.Sink(ctx, sink.ID)
- if err != nil {
- t.Fatal(err)
- }
- if want := sink; !testutil.Equal(got, want) {
- t.Errorf("got\n%+v\nwant\n%+v", got, want)
- }
-
- // Updating an existing sink changes it.
- sink.Filter = ""
- sink.IncludeChildren = false
- if _, err := client.UpdateSink(ctx, sink); err != nil {
- t.Fatal(err)
- }
- got, err = client.Sink(ctx, sink.ID)
- if err != nil {
- t.Fatal(err)
- }
- if want := sink; !testutil.Equal(got, want) {
- t.Errorf("got\n%+v\nwant\n%+v", got, want)
- }
- }
-
- func TestUpdateSinkOpt(t *testing.T) {
- ctx := context.Background()
- id := sinkIDs.New()
- origSink := &Sink{
- ID: id,
- Destination: testSinkDestination,
- Filter: testFilter,
- IncludeChildren: true,
- WriterIdentity: ltest.SharedServiceAccount,
- }
-
- if _, err := client.CreateSink(ctx, origSink); err != nil {
- t.Fatal(err)
- }
-
- // Updating with empty options is an error.
- _, err := client.UpdateSinkOpt(ctx, &Sink{ID: id, Destination: testSinkDestination}, SinkOptions{})
- if err == nil {
- t.Errorf("got %v, want nil", err)
- }
-
- // Update selected fields.
- got, err := client.UpdateSinkOpt(ctx, &Sink{ID: id}, SinkOptions{
- UpdateFilter: true,
- UpdateIncludeChildren: true,
- })
- if err != nil {
- t.Fatal(err)
- }
- want := *origSink
- want.Filter = ""
- want.IncludeChildren = false
- if !testutil.Equal(got, &want) {
- t.Errorf("got\n%+v\nwant\n%+v", got, want)
- }
-
- // Update writer identity.
- got, err = client.UpdateSinkOpt(ctx, &Sink{ID: id, Filter: "foo"},
- SinkOptions{UniqueWriterIdentity: true})
- if err != nil {
- t.Fatal(err)
- }
- if got.WriterIdentity == want.WriterIdentity {
- t.Errorf("got %s, want something different", got.WriterIdentity)
- }
- want.WriterIdentity = got.WriterIdentity
- if !testutil.Equal(got, &want) {
- t.Errorf("got\n%+v\nwant\n%+v", got, want)
- }
- }
-
- func TestListSinks(t *testing.T) {
- ctx := context.Background()
- var sinks []*Sink
- want := map[string]*Sink{}
- for i := 0; i < 4; i++ {
- s := &Sink{
- ID: sinkIDs.New(),
- Destination: testSinkDestination,
- Filter: testFilter,
- WriterIdentity: "serviceAccount:cloud-logs@system.gserviceaccount.com",
- }
- sinks = append(sinks, s)
- want[s.ID] = s
- }
- for _, s := range sinks {
- if _, err := client.CreateSink(ctx, s); err != nil {
- t.Fatalf("Create(%q): %v", s.ID, err)
- }
- }
-
- got := map[string]*Sink{}
- it := client.Sinks(ctx)
- for {
- s, err := it.Next()
- if err == iterator.Done {
- break
- }
- if err != nil {
- t.Fatal(err)
- }
- // If tests run simultaneously, we may have more sinks than we
- // created. So only check for our own.
- if _, ok := want[s.ID]; ok {
- got[s.ID] = s
- }
- }
- if !testutil.Equal(got, want) {
- t.Errorf("got %+v, want %+v", got, want)
- }
- }
|