sdk

README

assay.it SDK for Go

assay.it is the service to confirm quality and eliminate production risks in Serverless, Microservices and other applications. assay-it/sdk-go is the official SDK for the Go programming language.

Use this SDK to develop pure functional and typesafe Behavior as a Code to validate applications. assay.it automates the validation process along CI/CD pipelines. Continuous proofs of the quality helps to eliminate defects at earlier phases of loosely coupled topologies such as serverless applications, microservices and other systems that rely on interface syntaxes and its behaviors.

Getting Started

Installing

Use go get to retrieve the SDK to add it to your GOPATH workspace.

go get github.com/assay-it/sdk-go

Use go get -u to update SDK with latest version

go get -u github.com/assay-it/sdk-go

Quick Example

This example shows a minimal Behavior as a Code suite, which pings the website and ensures the response is correct.

package main

import (
  "github.com/assay-it/sdk-go/assay"
  "github.com/assay-it/sdk-go/http"
  ƒ "github.com/assay-it/sdk-go/http/recv"
  ø "github.com/assay-it/sdk-go/http/send"
)

func TestOk() assay.Arrow {
  return http.Join(
    ø.GET("https://assay.it"),
    ƒ.Code(http.StatusOK),
    ƒ.Header("Content-Type").Is("text/html"),
  )
}

func main() {
  cat := assay.IO(
    http.Default(),
    assay.Logging(assay.LogLevelDebug),
  )
  TestOk()(cat)
}

Further Reading

Minimal example - an annotated walk-through and a minimal Behavior as a Code suite. Use it as getting started tutorial.

Advanced example - an annotated walk-through about CI/CD workflows, shows advanced usage of Behavior as a Code paradigm.

Developer Guide - The documentation is a general introduction on how to configure and use the SDK.

How To Contribute

SDK is MIT licensed and accepts contributions via GitHub pull requests:

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Added some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

bugs

If you experience any issues with SDK, please let us know via GitHub issues. We appreciate detailed and accurate reports that help us to identity and replicate the issue.

License

Documentation

Overview

Package sdk is used to develop **pure functional** and **typesafe** Behavior as a Code to construct automated quality assessment pipelines for your applications across deployments and environments. Use this SDK to develop CI/CD suites for https://assay.it. Continuous proofs of the quality helps developers to eliminate defects at earlier phases of loosely coupled topologies such as serverless applications, microservices and other systems that rely on interface syntaxes and its behaviors.

Further Reading

https://github.com/assay-it/sdk-go SDK Source Code

https://github.com/assay-it/sample.assay.it Minimal example is an annotated walk-through and a minimal Behavior as a Code suite. Use it as getting started tutorial.

https://github.com/assay-it/example.assay.it Advanced example os an annotated walk-through about CI/CD workflows, shows advanced usage of Behavior as a Code paradigm.

https://assay.it/doc/core The documentation is a general introduction on how to configure and use the SDK.