sysl-go

README

Sysl-go

Communication library used by SYSL-generated code written in Go.

• Getting Started
  • Code
  • Docker
  • Local Development
  • Development
  • Logging

Getting Started

Code

go get github.com/anz-bank/sysl-go

Docker

docker pull anzbank/sysl-go:latest

docker run --rm -v $(pwd):/mount:ro anzbank/sysl-go /sysl-go/codegen/arrai/service.arrai github.com/anz-bank/sysl-template/gen /mount/api/project.json simple rest-app | tar xf - -C gen/simple

See sysl-template for more examples

Local Development

Ensure your environment provides:

• go 1.20
• golangci-lint 1.56.2
• protobuf 3.11.4
• make
• proto3 and gRPC
  • https://github.com/protocolbuffers/protobuf/releases
  • https://github.com/golang/protobuf
  • https://github.com/grpc/grpc
• sysl tool available on PATH
• arrai tool available on PATH
• go-bindata tool available on PATH
• goimports tool available on PATH

On OSX, after installing go 1.20 run

brew install golangci/tap/golangci-lint make curl protoc-gen-go grpc

Development

Test and lint everything with

make

View all relevant make targets with

make help

View test coverage in the browser with

make coverage

Logging

Sysl-go comes equipped with flexible, out-of-the-box logging support.

For complete information see Logging.