-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
21 changed files
with
716 additions
and
253 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| name: coverage | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| workflow_call: | ||
| inputs: | ||
| go_version: | ||
| required: false | ||
| type: string | ||
| default: "1.20.0" | ||
|
|
||
| permissions: | ||
| contents: write | ||
| pull-requests: write | ||
|
|
||
| jobs: | ||
| coverage: | ||
| runs-on: ubuntu-latest | ||
| strategy: | ||
| matrix: | ||
| module: | ||
| - "fxgcppubsub" | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| fetch-depth: 1 | ||
| - name: Install Go | ||
| uses: actions/setup-go@v4 | ||
| with: | ||
| go-version: ${{ inputs.go_version }} | ||
| - name: Install dependencies for module ${{ matrix.module }} | ||
| working-directory: ${{ matrix.module }} | ||
| run: go mod download | ||
| - name: Run tests for module ${{ matrix.module }} | ||
| working-directory: ${{ matrix.module }} | ||
| run: go test -v -race -failfast -coverpkg=./... -covermode=atomic -coverprofile=coverage.tmp.out ./... | ||
| - name: Exclude testdata | ||
| working-directory: ${{ matrix.module}} | ||
| run: cat coverage.tmp.out | grep -v "testdata" > coverage.out | ||
| - name: Clean temp coverage | ||
| working-directory: ${{ matrix.module }} | ||
| run: rm coverage.tmp.out | ||
| - name: Codecov for module ${{ matrix.module }} | ||
| uses: codecov/codecov-action@v3 | ||
| with: | ||
| fail_ci_if_error: false | ||
| flags: ${{ matrix.module }} | ||
| env: | ||
| CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| name: "fxgcppubsub-ci" | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - "feat**" | ||
| - "fix**" | ||
| - "hotfix**" | ||
| - "chore**" | ||
| paths: | ||
| - "fxgcppubsub/**.go" | ||
| - "fxgcppubsub/go.mod" | ||
| - "fxgcppubsub/go.sum" | ||
| pull_request: | ||
| types: | ||
| - opened | ||
| - synchronize | ||
| - reopened | ||
| branches: | ||
| - main | ||
| paths: | ||
| - "fxgcppubsub/**.go" | ||
| - "fxgcppubsub/go.mod" | ||
| - "fxgcppubsub/go.sum" | ||
|
|
||
| jobs: | ||
| ci: | ||
| uses: ./.github/workflows/common-ci.yml | ||
| secrets: inherit | ||
| with: | ||
| module: "fxgcppubsub" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| # Fx Google Pub/Sub Module | ||
|
|
||
| [](https://github.com/ankorstore/yokai/actions/workflows/fxgcppubsub-ci.yml) | ||
| [](https://goreportcard.com/report/github.com/ankorstore/yokai/fxgcppubsub) | ||
| [](https://app.codecov.io/gh/ankorstore/yokai/tree/main/fxgcppubsub) | ||
| [](https://deps.dev/go/github.com%2Fankorstore%2Fyokai%2Ffxgcppubsub) | ||
| [](https://pkg.go.dev/github.com/ankorstore/yokai/fxgcppubsub) | ||
|
|
||
| > [Fx](https://uber-go.github.io/fx/) module for [Google Pub/Sub](https://cloud.google.com/pubsub). | ||
| <!-- TOC --> | ||
| * [Overview](#overview) | ||
| * [Installation](#installation) | ||
| * [Configuration](#configuration) | ||
| * [Health Check](#health-check) | ||
| * [Testing](#testing) | ||
| <!-- TOC --> | ||
|
|
||
| ## Overview | ||
|
|
||
| This module provides to your Fx application a [pubsub.Client](https://pkg.go.dev/cloud.google.com/go/pubsub#Client), | ||
| that you can `inject` anywhere to `publish` or `subscribe` on a `Pub/Sub` instance. | ||
|
|
||
| ## Installation | ||
|
|
||
| First install the module: | ||
|
|
||
| ```shell | ||
| go get github.com/ankorstore/yokai-contrib/fxgcppubsub | ||
| ``` | ||
|
|
||
| Then activate it in your application bootstrapper: | ||
|
|
||
| ```go | ||
| // internal/bootstrap.go | ||
| package internal | ||
|
|
||
| import ( | ||
| "github.com/ankorstore/yokai/fxcore" | ||
| "github.com/ankorstore/yokai-contrib/fxgcppubsub" | ||
| ) | ||
|
|
||
| var Bootstrapper = fxcore.NewBootstrapper().WithOptions( | ||
| // load fxgcppubsub module | ||
| fxgcppubsub.FxGcpPubSubModule, | ||
| // ... | ||
| ) | ||
| ``` | ||
|
|
||
| ## Configuration | ||
|
|
||
| Configuration reference: | ||
|
|
||
| ```yaml | ||
| # ./configs/config.yaml | ||
| app: | ||
| name: app | ||
| env: dev | ||
| version: 0.1.0 | ||
| debug: true | ||
| modules: | ||
| gcppubsub: | ||
| project: | ||
| id: ${GCP_PROJECT_ID} # GCP project id | ||
| healthcheck: | ||
| topics: # list of topics to check for the topics probe | ||
| - topic1 | ||
| - topic2 | ||
| subscriptions: # list of subscriptions to check for the subscriptions probe | ||
| - subscription1 | ||
| - subscription2 | ||
| ``` | ||
| ## Health Check | ||
| This module provides ready to use health check probes, to be used by | ||
| the [fxhealthcheck](https://ankorstore.github.io/yokai/modules/fxhealthcheck/) module: | ||
| - [GcpPubSubTopicsProbe](healthcheck/topic.go): to check existence of the topics in `modules.gcppubsub.healthcheck.topics` | ||
| - [GcpPubSubSubscriptionsProbe](healthcheck/subscription.go): to check existence of topics in `modules.gcppubsub.healthcheck.subscriptions` | ||
|
|
||
| To activate those probes, you just need to register them: | ||
|
|
||
| ```go | ||
| // internal/services.go | ||
| package internal | ||
| import ( | ||
| "github.com/ankorstore/yokai/fxhealthcheck" | ||
| "github.com/ankorstore/yokai-contrib/fxgcppubsub/healthcheck" | ||
| "go.uber.org/fx" | ||
| ) | ||
| func ProvideServices() fx.Option { | ||
| return fx.Options( | ||
| // register the GcpPubSubTopicsProbe | ||
| fxhealthcheck.AsCheckerProbe(healthcheck.NewGcpPubSubTopicsProbe), | ||
| // register the GcpPubSubSubscriptionsProbe | ||
| fxhealthcheck.AsCheckerProbe(healthcheck.NewGcpPubSubSubscriptionsProbe), | ||
| // ... | ||
| ) | ||
| } | ||
| ``` | ||
|
|
||
| If your application is interested only in `publishing`, activate the `GcpPubSubTopicsProbe` only. | ||
|
|
||
| If it is interested only in `subscribing`, activate the `GcpPubSubSubscriptionsProbe` only. | ||
|
|
||
| ## Testing | ||
|
|
||
| In `test` mode, this client is configured to [work with | ||
| a ptest.Server](module.go), avoiding the need to run any `Pub/Sub` | ||
| instance, for better tests portability. | ||
|
|
||
| ```go | ||
| // internal/example/example_test.go | ||
| package example_test | ||
| import ( | ||
| "context" | ||
| "testing" | ||
| "cloud.google.com/go/pubsub" | ||
| "github.com/foo/bar/internal" | ||
| "github.com/stretchr/testify/assert" | ||
| "go.uber.org/fx" | ||
| ) | ||
| func TestExample(t *testing.T) { | ||
| var client *pubsub.Client | ||
| internal.RunTest(t, fx.Populate(&client)) | ||
| ctx := context.Background() | ||
| // prepare test topic on test server | ||
| topic, err := client.CreateTopic(ctx, "test-topic") | ||
| assert.NoError(t, err) | ||
| // public on test topic | ||
| topic.Publish(ctx, &pubsub.Message{Data: []byte("test message")}) | ||
| // ... | ||
| } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.