kafka

depo-kafka - Factory wrappers for Shopify/sarama

• depo-kafka - Factory wrappers for Shopify/sarama
  • Overview
  • How To Use
  • Developing
    • Make targets
  • License

Overview

This project contains wrappers for Shopify/sarama that make it easier to integrate with projects using our application framework stackopsd/app or other systems built on our dependency orchestration library stackopsd/depo.

How To Use

This project includes three factories:

• ConsumgerGroupFactory
• SyncProducerFactory
• AsyncProducerFactory

that each create their respectively named sarama components. All factories require a *tls.Config but this value may be set to nil so long as TLS is disabled via configuration. We recommend using stackopsd/depo-tls for satisfying this dependency.

reg := app.NewRegistry()
req.Add(app.TypeDriver, new(kafka.SyncProducerFactory))
req.Add(app.TypeDriver, new(kafka.AsyncProducerFactory))
req.Add(app.TypeDriver, new(kafka.ConsumerGroupFactory))
req.Add(app.TypeDriver, new(tls.Factory)) // depo-tls integration

Developing

Make targets

This project includes a Makefile that makes it easier to develop on the project. The following are the included targets:

• fmt

  Format all Go code using goimports.

• generate

  Regenerate any generated code. See gen.go for code generation commands.

• lint

  Run golangci-lint using the included linter configurations.

• test

  Run all unit tests for the project and generate a coverage report.

• integration

  Run all integration tests for the project and generate a coverage report.

• coverage

  Generate a combined coverage report from the test and integration target outputs.

• update

  Update all project dependencies to their latest versions.

• tools

  Generate a local bin/ directory that contains all of the tools used to lint, test, and format, etc.

• updatetools

  Update all project ools to their latest versions.

• vendor

  Generate a vendor directory.

• clean/cleancoverage/cleantools/cleanvendor

  Remove files created by the Makefile. This does not affect any code changes you may have made.

License

Copyright 2019 Kevin Conway

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.