Add pubsub test and remove mock_interface from coverage (#366)

Author: aryanmehrotra

.github/workflows/go.yml

@@ -152,7 +152,8 @@ jobs:
         run: |
           export GOFR_ENV=test
           go test gofr.dev/pkg/... -tags migration -v -short -coverprofile packageWithMigration.cov -coverpkg=gofr.dev/pkg/...
-          grep -v 'gofr.dev/pkg/gofr/migration' packageWithMigration.cov > profile.cov
+          grep -v 'gofr.dev/pkg/gofr/migration' packageWithMigration.cov > packageWithoutMigration.cov
+          grep -v 'google/mock_interfaces\.go' packageWithoutMigration.cov > profile.cov
           go tool cover -func profile.cov
 
       - name: Upload Test Coverage
@@ -216,7 +217,6 @@ jobs:
           awk '!/^mode: / && FNR==1{print "mode: set"} {print}' ./Example-Test-Report/profile.cov > merged_profile.cov
           tail -n +2 ./PKG-Coverage-Report/profile.cov >> merged_profile.cov
 
-
       - name: Upload
         uses: paambaati/[email protected]
         env:

pkg/gofr/datasource/pubsub/google/google.go

@@ -24,33 +24,11 @@ type Config struct {
 type googleClient struct {
 	Config
 
-	client  *gcPubSub.Client
+	client  Client
 	logger  pubsub.Logger
 	metrics Metrics
 }
 
-func (g *googleClient) DeleteTopic(ctx context.Context, name string) error {
-	topic := g.client.Topic(name)
-
-	err := topic.Delete(ctx)
-
-	if err != nil && strings.Contains(err.Error(), "Topic not found") {
-		return nil
-	}
-
-	return err
-}
-
-func (g *googleClient) CreateTopic(ctx context.Context, name string) error {
-	_, err := g.client.CreateTopic(ctx, name)
-
-	if err != nil && strings.Contains(err.Error(), "Topic already exists") {
-		return nil
-	}
-
-	return err
-}
-
 //nolint:revive // We do not want anyone using the client without initialization steps.
 func New(conf Config, logger pubsub.Logger, metrics Metrics) *googleClient {
 	err := validateConfigs(&conf)
@@ -192,3 +170,23 @@ func (g *googleClient) getSubscription(ctx context.Context, topic *gcPubSub.Topi
 
 	return subscription, nil
 }
+
+func (g *googleClient) DeleteTopic(ctx context.Context, name string) error {
+	err := g.client.Topic(name).Delete(ctx)
+
+	if err != nil && strings.Contains(err.Error(), "Topic not found") {
+		return nil
+	}
+
+	return err
+}
+
+func (g *googleClient) CreateTopic(ctx context.Context, name string) error {
+	_, err := g.client.CreateTopic(ctx, name)
+
+	if err != nil && strings.Contains(err.Error(), "Topic already exists") {
+		return nil
+	}
+
+	return err
+}

pkg/gofr/datasource/pubsub/google/google_test.go

@@ -169,3 +169,50 @@ func Test_validateConfigs(t *testing.T) {
 		assert.Equal(t, tc.expErr, err)
 	}
 }
+
+func TestGoogleClient_CreateTopicSuccess(t *testing.T) {
+	ctrl := gomock.NewController(t)
+	mock := NewMockClient(ctrl)
+
+	client := googleClient{
+		client: mock,
+	}
+
+	mock.EXPECT().CreateTopic(context.Background(), "test-topic").Return(&gcPubSub.Topic{}, nil)
+
+	err := client.CreateTopic(context.Background(), "test-topic")
+
+	assert.Nil(t, err)
+}
+
+func TestGoogleClient_CreateTopic_AlreadyExist(t *testing.T) {
+	ctrl := gomock.NewController(t)
+	mock := NewMockClient(ctrl)
+
+	client := googleClient{
+		client: mock,
+	}
+
+	mock.EXPECT().CreateTopic(context.Background(), "test-topic").Return(&gcPubSub.Topic{},
+		testutil.CustomError{ErrorMessage: "Topic already exists"})
+
+	err := client.CreateTopic(context.Background(), "test-topic")
+
+	assert.Nil(t, err)
+}
+
+func TestGoogleClient_CreateTopicFailure(t *testing.T) {
+	ctrl := gomock.NewController(t)
+	mock := NewMockClient(ctrl)
+
+	client := googleClient{
+		client: mock,
+	}
+
+	mock.EXPECT().CreateTopic(context.Background(), "test-topic").Return(&gcPubSub.Topic{},
+		testutil.CustomError{ErrorMessage: "Unknown Error"})
+
+	err := client.CreateTopic(context.Background(), "test-topic")
+
+	assert.NotNil(t, err)
+}

pkg/gofr/datasource/pubsub/google/interfaces.go

@@ -0,0 +1,26 @@
+package google
+
+import (
+	"context"
+
+	"cloud.google.com/go/pubsub"
+)
+
+type Client interface {
+	Writer
+	Reader
+
+	Close() error
+	Topics(ctx context.Context) *pubsub.TopicIterator
+	Subscriptions(ctx context.Context) *pubsub.SubscriptionIterator
+}
+
+type Writer interface {
+	Subscription(id string) *pubsub.Subscription
+	CreateSubscription(ctx context.Context, id string, cfg pubsub.SubscriptionConfig) (*pubsub.Subscription, error)
+}
+
+type Reader interface {
+	Topic(id string) *pubsub.Topic
+	CreateTopic(ctx context.Context, topicID string) (*pubsub.Topic, error)
+}