-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
integration_test.go
2235 lines (2028 loc) · 62.7 KB
/
integration_test.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2014 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.
package pubsub
import (
"bufio"
"bytes"
"context"
"errors"
"fmt"
"io/ioutil"
"os"
"strings"
"sync"
"sync/atomic"
"testing"
"time"
"cloud.google.com/go/iam"
"cloud.google.com/go/internal"
"cloud.google.com/go/internal/testutil"
"cloud.google.com/go/internal/uid"
"cloud.google.com/go/internal/version"
kms "cloud.google.com/go/kms/apiv1"
"cloud.google.com/go/kms/apiv1/kmspb"
pb "cloud.google.com/go/pubsub/apiv1/pubsubpb"
testutil2 "cloud.google.com/go/pubsub/internal/testutil"
"github.com/google/go-cmp/cmp"
"github.com/google/go-cmp/cmp/cmpopts"
gax "github.com/googleapis/gax-go/v2"
"golang.org/x/oauth2/google"
"google.golang.org/api/iterator"
"google.golang.org/api/option"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/metadata"
"google.golang.org/grpc/status"
"google.golang.org/protobuf/encoding/protowire"
"google.golang.org/protobuf/proto"
)
var (
topicIDs = uid.NewSpace("topic", nil)
subIDs = uid.NewSpace("sub", nil)
schemaIDs = uid.NewSpace("schema", nil)
)
// messageData is used to hold the contents of a message so that it can be compared against the contents
// of another message without regard to irrelevant fields.
type messageData struct {
ID string
Data string
Attributes map[string]string
}
func extractMessageData(m *Message) messageData {
return messageData{
ID: m.ID,
Data: string(m.Data),
Attributes: m.Attributes,
}
}
func withGRPCHeadersAssertion(t *testing.T, opts ...option.ClientOption) []option.ClientOption {
grpcHeadersEnforcer := &testutil.HeadersEnforcer{
OnFailure: t.Errorf,
Checkers: []*testutil.HeaderChecker{
testutil.XGoogClientHeaderChecker,
},
}
return append(grpcHeadersEnforcer.CallOptions(), opts...)
}
func integrationTestClient(ctx context.Context, t *testing.T, opts ...option.ClientOption) *Client {
if testing.Short() {
t.Skip("Integration tests skipped in short mode")
}
projID := testutil.ProjID()
if projID == "" {
t.Skip("Integration tests skipped. See CONTRIBUTING.md for details")
}
ts := testutil.TokenSource(ctx, ScopePubSub, ScopeCloudPlatform)
if ts == nil {
t.Skip("Integration tests skipped. See CONTRIBUTING.md for details")
}
opts = append(withGRPCHeadersAssertion(t, option.WithTokenSource(ts)), opts...)
client, err := NewClient(ctx, projID, opts...)
if err != nil {
t.Fatalf("Creating client error: %v", err)
}
return client
}
func integrationTestSchemaClient(ctx context.Context, t *testing.T, opts ...option.ClientOption) *SchemaClient {
if testing.Short() {
t.Skip("Integration tests skipped in short mode")
}
projID := testutil.ProjID()
if projID == "" {
t.Skip("Integration tests skipped. See CONTRIBUTING.md for details")
}
ts := testutil.TokenSource(ctx, ScopePubSub, ScopeCloudPlatform)
if ts == nil {
t.Skip("Integration tests skipped. See CONTRIBUTING.md for details")
}
opts = append(withGRPCHeadersAssertion(t, option.WithTokenSource(ts)), opts...)
sc, err := NewSchemaClient(ctx, projID, opts...)
if err != nil {
t.Fatalf("Creating client error: %v", err)
}
return sc
}
func TestIntegration_Admin(t *testing.T) {
t.Parallel()
ctx := context.Background()
client := integrationTestClient(ctx, t)
defer client.Close()
topic, err := createTopicWithRetry(ctx, t, client, topicIDs.New(), nil)
if err != nil {
t.Errorf("CreateTopic error: %v", err)
}
defer topic.Stop()
exists, err := topic.Exists(ctx)
if err != nil {
t.Fatalf("TopicExists error: %v", err)
}
if !exists {
t.Errorf("topic %v should exist, but it doesn't", topic)
}
var sub *Subscription
if sub, err = createSubWithRetry(ctx, t, client, subIDs.New(), SubscriptionConfig{Topic: topic}); err != nil {
t.Errorf("CreateSub error: %v", err)
}
exists, err = sub.Exists(ctx)
if err != nil {
t.Fatalf("SubExists error: %v", err)
}
if !exists {
t.Errorf("subscription %s should exist, but it doesn't", sub.ID())
}
if msg, ok := testIAM(ctx, topic.IAM(), "pubsub.topics.get"); !ok {
t.Errorf("topic IAM: %s", msg)
}
if msg, ok := testIAM(ctx, sub.IAM(), "pubsub.subscriptions.get"); !ok {
t.Errorf("sub IAM: %s", msg)
}
snap, err := sub.CreateSnapshot(ctx, "")
if err != nil {
t.Fatalf("CreateSnapshot error: %v", err)
}
labels := map[string]string{"foo": "bar"}
sc, err := snap.SetLabels(ctx, labels)
if err != nil {
t.Fatalf("Snapshot.SetLabels error: %v", err)
}
if diff := testutil.Diff(sc.Labels, labels); diff != "" {
t.Fatalf("\ngot: - want: +\n%s", diff)
}
timeoutCtx, cancel := context.WithTimeout(ctx, time.Minute)
defer cancel()
err = internal.Retry(timeoutCtx, gax.Backoff{}, func() (bool, error) {
snapIt := client.Snapshots(timeoutCtx)
for {
s, err := snapIt.Next()
if err == nil && s.name == snap.name {
return true, nil
}
if errors.Is(err, iterator.Done) {
return false, fmt.Errorf("cannot find snapshot: %q", snap.name)
}
if err != nil {
return false, err
}
}
})
if err != nil {
t.Error(err)
}
err = internal.Retry(timeoutCtx, gax.Backoff{}, func() (bool, error) {
err := sub.SeekToSnapshot(timeoutCtx, snap.Snapshot)
return err == nil, err
})
if err != nil {
t.Error(err)
}
err = internal.Retry(timeoutCtx, gax.Backoff{}, func() (bool, error) {
err := sub.SeekToTime(timeoutCtx, time.Now())
return err == nil, err
})
if err != nil {
t.Error(err)
}
err = internal.Retry(timeoutCtx, gax.Backoff{}, func() (bool, error) {
snapHandle := client.Snapshot(snap.ID())
err := snapHandle.Delete(timeoutCtx)
return err == nil, err
})
if err != nil {
t.Error(err)
}
if err := sub.Delete(ctx); err != nil {
t.Errorf("DeleteSub error: %v", err)
}
if err := topic.Delete(ctx); err != nil {
t.Errorf("DeleteTopic error: %v", err)
}
}
func TestIntegration_PublishReceive(t *testing.T) {
ctx := context.Background()
client := integrationTestClient(ctx, t)
for _, sync := range []bool{false, true} {
for _, maxMsgs := range []int{0, 3, -1} { // MaxOutstandingMessages = default, 3, unlimited
testPublishAndReceive(t, client, maxMsgs, sync, false, 10, 0)
}
// Tests for large messages (larger than the 4MB gRPC limit).
testPublishAndReceive(t, client, 0, sync, false, 1, 5*1024*1024)
}
}
// withGoogleClientInfo sets the name and version of the application in
// the `x-goog-api-client` header passed on each request and returns the
// updated context.
func withGoogleClientInfo(ctx context.Context) context.Context {
ctxMD, _ := metadata.FromOutgoingContext(ctx)
kv := []string{
"gl-go",
version.Go(),
"gax",
gax.Version,
"grpc",
grpc.Version,
}
allMDs := append([]metadata.MD{ctxMD}, metadata.Pairs("x-goog-api-client", gax.XGoogHeader(kv...)))
return metadata.NewOutgoingContext(ctx, metadata.Join(allMDs...))
}
func testPublishAndReceive(t *testing.T, client *Client, maxMsgs int, synchronous, exactlyOnceDelivery bool, numMsgs, extraBytes int) {
t.Run(fmt.Sprintf("maxMsgs:%d,synchronous:%t,exactlyOnceDelivery:%t,numMsgs:%d", maxMsgs, synchronous, exactlyOnceDelivery, numMsgs), func(t *testing.T) {
t.Parallel()
testutil.Retry(t, 3, 10*time.Second, func(r *testutil.R) {
ctx := context.Background()
topic, err := createTopicWithRetry(ctx, t, client, topicIDs.New(), nil)
if err != nil {
r.Errorf("CreateTopic error: %v", err)
}
defer topic.Delete(ctx)
defer topic.Stop()
exists, err := topic.Exists(ctx)
if err != nil {
r.Errorf("TopicExists error: %v", err)
}
if !exists {
r.Errorf("topic %v should exist, but it doesn't", topic)
}
sub, err := createSubWithRetry(ctx, t, client, subIDs.New(), SubscriptionConfig{
Topic: topic,
EnableExactlyOnceDelivery: exactlyOnceDelivery,
})
if err != nil {
r.Errorf("CreateSub error: %v", err)
}
defer sub.Delete(ctx)
exists, err = sub.Exists(ctx)
if err != nil {
r.Errorf("SubExists error: %v", err)
}
if !exists {
r.Errorf("subscription %s should exist, but it doesn't", sub.ID())
}
var msgs []*Message
for i := 0; i < numMsgs; i++ {
text := fmt.Sprintf("a message with an index %d - %s", i, strings.Repeat(".", extraBytes))
attrs := make(map[string]string)
attrs["foo"] = "bar"
msgs = append(msgs, &Message{
Data: []byte(text),
Attributes: attrs,
})
}
// Publish some messages.
type pubResult struct {
m *Message
r *PublishResult
}
var rs []pubResult
for _, m := range msgs {
r := topic.Publish(ctx, m)
rs = append(rs, pubResult{m, r})
}
want := make(map[string]messageData)
for _, res := range rs {
id, err := res.r.Get(ctx)
if err != nil {
r.Errorf("r.Get: %v", err)
}
md := extractMessageData(res.m)
md.ID = id
want[md.ID] = md
}
sub.ReceiveSettings.MaxOutstandingMessages = maxMsgs
sub.ReceiveSettings.Synchronous = synchronous
// Use a timeout to ensure that Pull does not block indefinitely if there are
// unexpectedly few messages available.
now := time.Now()
timeout := 3 * time.Minute
timeoutCtx, cancel := context.WithTimeout(ctx, timeout)
defer cancel()
gotMsgs, err := pullN(timeoutCtx, sub, len(want), 0, func(ctx context.Context, m *Message) {
m.Ack()
})
if err != nil {
if c := status.Convert(err); c.Code() == codes.Canceled {
if time.Since(now) >= timeout {
r.Errorf("pullN took longer than %v", timeout)
}
} else {
r.Errorf("Pull: %v", err)
}
}
got := make(map[string]messageData)
for _, m := range gotMsgs {
md := extractMessageData(m)
got[md.ID] = md
}
if !testutil.Equal(got, want) {
r.Errorf("MaxOutstandingMessages=%d, Synchronous=%t, messages got: %+v, messages want: %+v",
maxMsgs, synchronous, got, want)
}
})
})
}
// IAM tests.
// NOTE: for these to succeed, the test runner identity must have the Pub/Sub Admin or Owner roles.
// To set, visit https://console.developers.google.com, select "IAM & Admin" from the top-left
// menu, choose the account, click the Roles dropdown, and select "Pub/Sub > Pub/Sub Admin".
// TODO(jba): move this to a testing package within cloud.google.com/iam, so we can re-use it.
func testIAM(ctx context.Context, h *iam.Handle, permission string) (msg string, ok bool) {
// Manually adding withGoogleClientInfo here because this code only takes
// a handle with a grpc.ClientConn that has the "x-goog-api-client" header enforcer,
// but unfortunately not the underlying infrastructure that takes pre-set headers.
ctx = withGoogleClientInfo(ctx)
// Attempting to add an non-existent identity (e.g. "alice@example.com") causes the service
// to return an internal error, so use a real identity.
const member = "domain:google.com"
var policy *iam.Policy
var err error
if policy, err = h.Policy(ctx); err != nil {
return fmt.Sprintf("Policy: %v", err), false
}
// The resource is new, so the policy should be empty.
if got := policy.Roles(); len(got) > 0 {
return fmt.Sprintf("initially: got roles %v, want none", got), false
}
// Add a member, set the policy, then check that the member is present.
policy.Add(member, iam.Viewer)
if err := h.SetPolicy(ctx, policy); err != nil {
return fmt.Sprintf("SetPolicy: %v", err), false
}
if policy, err = h.Policy(ctx); err != nil {
return fmt.Sprintf("Policy: %v", err), false
}
if got, want := policy.Members(iam.Viewer), []string{member}; !testutil.Equal(got, want) {
return fmt.Sprintf("after Add: got %v, want %v", got, want), false
}
// Now remove that member, set the policy, and check that it's empty again.
policy.Remove(member, iam.Viewer)
if err := h.SetPolicy(ctx, policy); err != nil {
return fmt.Sprintf("SetPolicy: %v", err), false
}
if policy, err = h.Policy(ctx); err != nil {
return fmt.Sprintf("Policy: %v", err), false
}
if got := policy.Roles(); len(got) > 0 {
return fmt.Sprintf("after Remove: got roles %v, want none", got), false
}
// Call TestPermissions.
// Because this user is an admin, it has all the permissions on the
// resource type. Note: the service fails if we ask for inapplicable
// permissions (e.g. a subscription permission on a topic, or a topic
// create permission on a topic rather than its parent).
wantPerms := []string{permission}
gotPerms, err := h.TestPermissions(ctx, wantPerms)
if err != nil {
return fmt.Sprintf("TestPermissions: %v", err), false
}
if !testutil.Equal(gotPerms, wantPerms) {
return fmt.Sprintf("TestPermissions: got %v, want %v", gotPerms, wantPerms), false
}
return "", true
}
func TestIntegration_LargePublishSize(t *testing.T) {
ctx := context.Background()
client := integrationTestClient(ctx, t)
defer client.Close()
topic, err := createTopicWithRetry(ctx, t, client, topicIDs.New(), nil)
if err != nil {
t.Fatalf("CreateTopic error: %v", err)
}
defer topic.Delete(ctx)
defer topic.Stop()
// Calculate the largest possible message length that is still valid.
// First, calculate the max length of the encoded message accounting for the topic name.
length := MaxPublishRequestBytes - calcFieldSizeString(topic.String())
// Next, account for the overhead from encoding an individual PubsubMessage,
// and the inner PubsubMessage.Data field.
pbMsgOverhead := 1 + protowire.SizeVarint(uint64(length))
dataOverhead := 1 + protowire.SizeVarint(uint64(length-pbMsgOverhead))
maxLengthSingleMessage := length - pbMsgOverhead - dataOverhead
publishReq := &pb.PublishRequest{
Topic: topic.String(),
Messages: []*pb.PubsubMessage{
{
Data: bytes.Repeat([]byte{'A'}, maxLengthSingleMessage),
},
},
}
if got := proto.Size(publishReq); got != MaxPublishRequestBytes {
t.Fatalf("Created request size of %d bytes,\nwant %f bytes", got, MaxPublishRequestBytes)
}
// Publishing the max length message by itself should succeed.
msg := &Message{
Data: bytes.Repeat([]byte{'A'}, maxLengthSingleMessage),
}
topic.PublishSettings.FlowControlSettings.LimitExceededBehavior = FlowControlSignalError
r := topic.Publish(ctx, msg)
if _, err := r.Get(ctx); err != nil {
t.Fatalf("Failed to publish max length message: %v", err)
}
// Publish a small message first and make sure the max length message
// is added to its own bundle.
smallMsg := &Message{
Data: []byte{'A'},
}
topic.Publish(ctx, smallMsg)
r = topic.Publish(ctx, msg)
if _, err := r.Get(ctx); err != nil {
t.Fatalf("Failed to publish max length message after a small message: %v", err)
}
// Increase the data byte string by 1 byte, which should cause the request to fail,
// specifically due to exceeding the bundle byte limit.
msg.Data = append(msg.Data, 'A')
r = topic.Publish(ctx, msg)
if _, err := r.Get(ctx); err != ErrOversizedMessage {
t.Fatalf("Should throw item size too large error, got %v", err)
}
}
func TestIntegration_CancelReceive(t *testing.T) {
t.Parallel()
ctx := context.Background()
client := integrationTestClient(ctx, t)
defer client.Close()
topic, err := createTopicWithRetry(ctx, t, client, topicIDs.New(), nil)
if err != nil {
t.Errorf("failed to create topic: %v", err)
}
defer topic.Delete(ctx)
defer topic.Stop()
var sub *Subscription
if sub, err = createSubWithRetry(ctx, t, client, subIDs.New(), SubscriptionConfig{Topic: topic}); err != nil {
t.Fatalf("failed to create subscription: %v", err)
}
defer sub.Delete(ctx)
ctx, cancel := context.WithCancel(context.Background())
sub.ReceiveSettings.MaxOutstandingMessages = -1
sub.ReceiveSettings.MaxOutstandingBytes = -1
sub.ReceiveSettings.NumGoroutines = 1
doneReceiving := make(chan struct{})
// Publish the messages.
go func() {
for {
select {
case <-doneReceiving:
return
default:
topic.Publish(ctx, &Message{Data: []byte("some msg")})
time.Sleep(time.Second)
}
}
}()
go func() {
err = sub.Receive(ctx, func(_ context.Context, msg *Message) {
cancel()
time.AfterFunc(5*time.Second, msg.Ack)
})
close(doneReceiving)
}()
select {
case <-time.After(60 * time.Second):
t.Fatalf("Waited 60 seconds for Receive to finish, should have finished sooner")
case <-doneReceiving:
}
}
func TestIntegration_CreateSubscription_NeverExpire(t *testing.T) {
t.Parallel()
ctx := context.Background()
client := integrationTestClient(ctx, t)
defer client.Close()
topic, err := createTopicWithRetry(ctx, t, client, topicIDs.New(), nil)
if err != nil {
t.Fatalf("CreateTopic error: %v", err)
}
defer topic.Delete(ctx)
defer topic.Stop()
cfg := SubscriptionConfig{
Topic: topic,
ExpirationPolicy: time.Duration(0),
}
var sub *Subscription
if sub, err = createSubWithRetry(ctx, t, client, subIDs.New(), cfg); err != nil {
t.Fatalf("CreateSub error: %v", err)
}
defer sub.Delete(ctx)
got, err := sub.Config(ctx)
if err != nil {
t.Fatal(err)
}
want := time.Duration(0)
if got.ExpirationPolicy != want {
t.Fatalf("config.ExpirationPolicy mismatch, got: %v, want: %v\n", got.ExpirationPolicy, want)
}
}
// findServiceAccountEmail tries to find the service account using testutil
// JWTConfig as well as the ADC credentials. It will only invoke t.Skip if
// it successfully retrieves credentials but finds a blank JWTConfig JSON blob.
// For all other errors, it will invoke t.Fatal.
func findServiceAccountEmail(ctx context.Context, t *testing.T) string {
jwtConf, err := testutil.JWTConfig()
if err == nil && jwtConf != nil {
return jwtConf.Email
}
creds := testutil.Credentials(ctx, ScopePubSub, ScopeCloudPlatform)
if creds == nil {
t.Fatal("Failed to retrieve credentials")
}
if len(creds.JSON) == 0 {
t.Skip("No JWTConfig JSON was present so can't get serviceAccountEmail")
}
jwtConf, err = google.JWTConfigFromJSON(creds.JSON)
if err != nil {
if strings.Contains(err.Error(), "authorized_user") {
t.Skip("Found ADC user so can't get serviceAccountEmail")
}
t.Fatalf("Failed to parse Google JWTConfig from JSON: %v", err)
}
return jwtConf.Email
}
func TestIntegration_UpdateSubscription(t *testing.T) {
t.Parallel()
ctx := context.Background()
client := integrationTestClient(ctx, t)
defer client.Close()
serviceAccountEmail := findServiceAccountEmail(ctx, t)
topic, err := createTopicWithRetry(ctx, t, client, topicIDs.New(), nil)
if err != nil {
t.Fatalf("CreateTopic error: %v", err)
}
defer topic.Delete(ctx)
defer topic.Stop()
var sub *Subscription
projID := testutil.ProjID()
sCfg := SubscriptionConfig{
Topic: topic,
PushConfig: PushConfig{
Endpoint: "https://" + projID + ".appspot.com/_ah/push-handlers/push",
AuthenticationMethod: &OIDCToken{
Audience: "client-12345",
ServiceAccountEmail: serviceAccountEmail,
},
},
}
if sub, err = createSubWithRetry(ctx, t, client, subIDs.New(), sCfg); err != nil {
t.Fatalf("CreateSub error: %v", err)
}
defer sub.Delete(ctx)
got, err := sub.Config(ctx)
if err != nil {
t.Fatal(err)
}
want := SubscriptionConfig{
Topic: topic,
AckDeadline: 10 * time.Second,
RetainAckedMessages: false,
RetentionDuration: defaultRetentionDuration,
ExpirationPolicy: defaultExpirationPolicy,
PushConfig: PushConfig{
Endpoint: "https://" + projID + ".appspot.com/_ah/push-handlers/push",
AuthenticationMethod: &OIDCToken{
Audience: "client-12345",
ServiceAccountEmail: serviceAccountEmail,
},
},
State: SubscriptionStateActive,
}
opt := cmpopts.IgnoreUnexported(SubscriptionConfig{})
if diff := testutil.Diff(got, want, opt); diff != "" {
t.Fatalf("\ngot: - want: +\n%s", diff)
}
// Add a PushConfig and change other fields.
pc := PushConfig{
Endpoint: "https://" + projID + ".appspot.com/_ah/push-handlers/push",
Attributes: map[string]string{"x-goog-version": "v1"},
AuthenticationMethod: &OIDCToken{
Audience: "client-updated-54321",
ServiceAccountEmail: serviceAccountEmail,
},
}
got, err = sub.Update(ctx, SubscriptionConfigToUpdate{
PushConfig: &pc,
AckDeadline: 2 * time.Minute,
RetainAckedMessages: true,
RetentionDuration: 2 * time.Hour,
Labels: map[string]string{"label": "value"},
ExpirationPolicy: 25 * time.Hour,
})
if err != nil {
t.Fatal(err)
}
want = SubscriptionConfig{
Topic: topic,
PushConfig: pc,
AckDeadline: 2 * time.Minute,
RetainAckedMessages: true,
RetentionDuration: 2 * time.Hour,
Labels: map[string]string{"label": "value"},
ExpirationPolicy: 25 * time.Hour,
State: SubscriptionStateActive,
}
if !testutil.Equal(got, want, opt) {
t.Fatalf("\ngot %+v\nwant %+v", got, want)
}
// Update ExpirationPolicy to never expire.
got, err = sub.Update(ctx, SubscriptionConfigToUpdate{
ExpirationPolicy: time.Duration(0),
})
if err != nil {
t.Fatal(err)
}
want.ExpirationPolicy = time.Duration(0)
if !testutil.Equal(got, want, opt) {
t.Fatalf("\ngot %+v\nwant %+v", got, want)
}
// Remove the PushConfig, turning the subscription back into pull mode.
// Change AckDeadline, remove labels.
pc = PushConfig{}
got, err = sub.Update(ctx, SubscriptionConfigToUpdate{
PushConfig: &pc,
AckDeadline: 30 * time.Second,
Labels: map[string]string{},
})
if err != nil {
t.Fatal(err)
}
want.PushConfig = pc
want.AckDeadline = 30 * time.Second
want.Labels = nil
// service issue: PushConfig attributes are not removed.
// TODO(jba): remove when issue resolved.
want.PushConfig.Attributes = map[string]string{"x-goog-version": "v1"}
if !testutil.Equal(got, want, opt) {
t.Fatalf("\ngot %+v\nwant %+v", got, want)
}
// If nothing changes, our client returns an error.
_, err = sub.Update(ctx, SubscriptionConfigToUpdate{})
if err == nil {
t.Fatal("got nil, wanted error")
}
}
// publishSync is a utility function for publishing a message and
// blocking until the message has been confirmed.
func publishSync(ctx context.Context, t *testing.T, topic *Topic, msg *Message) {
res := topic.Publish(ctx, msg)
_, err := res.Get(ctx)
if err != nil {
t.Fatalf("publishSync err: %v", err)
}
}
func TestIntegration_UpdateSubscription_ExpirationPolicy(t *testing.T) {
t.Parallel()
ctx := context.Background()
client := integrationTestClient(ctx, t)
defer client.Close()
topic, err := createTopicWithRetry(ctx, t, client, topicIDs.New(), nil)
if err != nil {
t.Fatalf("CreateTopic error: %v", err)
}
defer topic.Delete(ctx)
defer topic.Stop()
var sub *Subscription
if sub, err = createSubWithRetry(ctx, t, client, subIDs.New(), SubscriptionConfig{Topic: topic}); err != nil {
t.Fatalf("CreateSub error: %v", err)
}
defer sub.Delete(ctx)
// Set ExpirationPolicy within the valid range.
got, err := sub.Update(ctx, SubscriptionConfigToUpdate{
RetentionDuration: 2 * time.Hour,
ExpirationPolicy: 25 * time.Hour,
AckDeadline: 2 * time.Minute,
})
if err != nil {
t.Fatal(err)
}
want := 25 * time.Hour
if got.ExpirationPolicy != want {
t.Fatalf("config.ExpirationPolicy mismatch; got: %v, want: %v", got.ExpirationPolicy, want)
}
// ExpirationPolicy to never expire.
got, err = sub.Update(ctx, SubscriptionConfigToUpdate{
ExpirationPolicy: time.Duration(0),
})
if err != nil {
t.Fatalf("Unexpected error: %v\n", err)
}
want = time.Duration(0)
if diff := testutil.Diff(got.ExpirationPolicy, want); diff != "" {
t.Fatalf("\ngot: - want: +\n%s", diff)
}
// ExpirationPolicy when nil is passed in, should not cause any updates.
got, err = sub.Update(ctx, SubscriptionConfigToUpdate{
ExpirationPolicy: nil,
})
if err == nil || err.Error() != "pubsub: UpdateSubscription call with nothing to update" {
t.Fatalf("Expected no attributes to be updated, error: %v", err)
}
// ExpirationPolicy of nil, with the previous value having been a non-zero value.
_, err = sub.Update(ctx, SubscriptionConfigToUpdate{
ExpirationPolicy: 26 * time.Hour,
})
if err != nil {
t.Fatal(err)
}
// Now examine what setting it to nil produces.
_, err = sub.Update(ctx, SubscriptionConfigToUpdate{
ExpirationPolicy: nil,
})
if err == nil || err.Error() != "pubsub: UpdateSubscription call with nothing to update" {
t.Fatalf("Expected no attributes to be updated, error: %v", err)
}
}
// NOTE: This test should be skipped by open source contributors. It requires
// allowlisting, a (gsuite) organization project, and specific permissions.
func TestIntegration_UpdateTopicLabels(t *testing.T) {
t.Parallel()
ctx := context.Background()
client := integrationTestClient(ctx, t)
defer client.Close()
compareConfig := func(got TopicConfig, wantLabels map[string]string) bool {
return testutil.Equal(got.Labels, wantLabels)
}
topic, err := createTopicWithRetry(ctx, t, client, topicIDs.New(), nil)
if err != nil {
t.Fatalf("CreateTopic error: %v", err)
}
defer topic.Delete(ctx)
defer topic.Stop()
got, err := topic.Config(ctx)
if err != nil {
t.Fatal(err)
}
if !compareConfig(got, nil) {
t.Fatalf("\ngot %+v\nwant no labels", got)
}
labels := map[string]string{"label": "value"}
got, err = topic.Update(ctx, TopicConfigToUpdate{Labels: labels})
if err != nil {
t.Fatal(err)
}
if !compareConfig(got, labels) {
t.Fatalf("\ngot %+v\nwant labels %+v", got, labels)
}
// Remove all labels.
got, err = topic.Update(ctx, TopicConfigToUpdate{Labels: map[string]string{}})
if err != nil {
t.Fatal(err)
}
if !compareConfig(got, nil) {
t.Fatalf("\ngot %+v\nwant no labels", got)
}
}
func TestIntegration_PublicTopic(t *testing.T) {
t.Parallel()
ctx := context.Background()
client := integrationTestClient(ctx, t)
defer client.Close()
sub, err := createSubWithRetry(ctx, t, client, subIDs.New(), SubscriptionConfig{
Topic: client.TopicInProject("taxirides-realtime", "pubsub-public-data"),
})
if err != nil {
t.Fatal(err)
}
sub.Delete(ctx)
}
func TestIntegration_Errors(t *testing.T) {
// Test various edge conditions.
t.Parallel()
ctx := context.Background()
client := integrationTestClient(ctx, t)
defer client.Close()
topic, err := createTopicWithRetry(ctx, t, client, topicIDs.New(), nil)
if err != nil {
t.Fatalf("CreateTopic error: %v", err)
}
defer topic.Delete(ctx)
defer topic.Stop()
// Out-of-range retention duration.
sub, err := client.CreateSubscription(ctx, subIDs.New(), SubscriptionConfig{
Topic: topic,
RetentionDuration: 1 * time.Second,
})
if want := codes.InvalidArgument; status.Code(err) != want {
t.Errorf("got <%v>, want %s", err, want)
}
if err == nil {
sub.Delete(ctx)
}
// Ack deadline less than minimum.
sub, err = client.CreateSubscription(ctx, subIDs.New(), SubscriptionConfig{
Topic: topic,
AckDeadline: 5 * time.Second,
})
if want := codes.Unknown; status.Code(err) != want {
t.Errorf("got <%v>, want %s", err, want)
}
if err == nil {
sub.Delete(ctx)
}
// Updating a non-existent subscription.
sub = client.Subscription(subIDs.New())
_, err = sub.Update(ctx, SubscriptionConfigToUpdate{AckDeadline: 20 * time.Second})
if want := codes.NotFound; status.Code(err) != want {
t.Errorf("got <%v>, want %s", err, want)
}
// Deleting a non-existent subscription.
err = sub.Delete(ctx)
if want := codes.NotFound; status.Code(err) != want {
t.Errorf("got <%v>, want %s", err, want)
}
// Updating out-of-range retention duration.
sub, err = createSubWithRetry(ctx, t, client, subIDs.New(), SubscriptionConfig{Topic: topic})
if err != nil {
t.Fatal(err)
}
defer sub.Delete(ctx)
_, err = sub.Update(ctx, SubscriptionConfigToUpdate{RetentionDuration: 1000 * time.Hour})
if want := codes.InvalidArgument; status.Code(err) != want {
t.Errorf("got <%v>, want %s", err, want)
}
}
func TestIntegration_MessageStoragePolicy_TopicLevel(t *testing.T) {
t.Parallel()
ctx := context.Background()
client := integrationTestClient(ctx, t)
defer client.Close()
topic, err := createTopicWithRetry(ctx, t, client, topicIDs.New(), nil)
if err != nil {
t.Fatalf("CreateTopic error: %v", err)
}
defer topic.Delete(ctx)
defer topic.Stop()
// Specify some regions to set.
regions := []string{"asia-east1", "us-east1"}
cfg, err := topic.Update(ctx, TopicConfigToUpdate{
MessageStoragePolicy: &MessageStoragePolicy{
AllowedPersistenceRegions: regions,
},
})
if err != nil {
t.Fatal(err)
}
got := cfg.MessageStoragePolicy.AllowedPersistenceRegions
want := regions
if !testutil.Equal(got, want) {
t.Fatalf("\ngot %+v\nwant regions%+v", got, want)
}
// Removing all regions should fail
updateCfg := TopicConfigToUpdate{
MessageStoragePolicy: &MessageStoragePolicy{
AllowedPersistenceRegions: []string{},
},
}
if _, err = topic.Update(ctx, updateCfg); err == nil {
t.Fatalf("Unexpected succeeded in removing all regions\n%+v\n", got)
}
}
// NOTE: This test should be skipped by open source contributors. It requires
// a (gsuite) organization project, and specific permissions. The test for MessageStoragePolicy
// on a topic level can be run on any topic and is covered by the previous test.
//
// Googlers, see internal bug 77920644. Furthermore, be sure to add your
// service account as an owner of ps-geofencing-test.
func TestIntegration_MessageStoragePolicy_ProjectLevel(t *testing.T) {
// Verify that the message storage policy is populated.
if testing.Short() {
t.Skip("Integration tests skipped in short mode")
}
t.Parallel()
ctx := context.Background()
// If a message storage policy is not set on a topic, the policy depends on the Resource Location
// Restriction which is specified on an organization level. The usual testing project is in the
// google.com org, which has no resource location restrictions. Use a project in another org that
// does have a restriction set ("us-east1").
projID := "ps-geofencing-test"
// We can use the same creds as always because the service account of the default testing project
// has permission to use the above project. This test will fail if a different service account
// is used for testing.
ts := testutil.TokenSource(ctx, ScopePubSub, ScopeCloudPlatform)
if ts == nil {
t.Skip("Integration tests skipped. See CONTRIBUTING.md for details")