assay-it

README

assay-it

Test Cloud Apps in Production. Confirm Quality & Eliminate Risk.

---

Construct automated quality check pipelines for your applications, microservices and other endpoints across deployments and environments.

User Guide | Community Support | Golang Suite example | Markdown Suite example

Quick Example

Let's get your start with assay-it. These few simple steps explain how to run a first quality check.

Install It

assay-it is an open source command line utility. The utility is designed for testing of loosely coupled topologies such as serverless applications, microservices and other systems that rely on interfaces, protocols and its behaviors. It does the unit-like testing but in distributed environments.

Easiest way to install the latest version of utility using brew but binaries are also available here.

brew tap assay-it/assay-it https://github.com/assay-it/assay-it
brew install -q assay-it

## use `brew upgrade` to install latest version 

Code It

assay-it checks the correctness and makes the formal proof of quality in loosely coupled topologies such as serverless applications, microservices and other systems that rely on interface syntaxes and its behaviors. Testing suites are type safe and pure functional test specification of protocol endpoints exposed by software components. The command requires the suite development using Golang syntax implemented by ᵍ🆄🆁🅻 library but limited functionality is supported with Markdown documents.

assay-it testspec > suite.go

// suite.go file
package suite

import (
  "github.com/fogfish/gurl/v2/http"
  ƒ "github.com/fogfish/gurl/v2/http/recv"
  ø "github.com/fogfish/gurl/v2/http/send"
)

func TestHttpBinGet() http.Arrow {
  return http.GET(
    ø.URI("http://httpbin.org/get"),

    ƒ.Status.OK,
    ƒ.ContentType.ApplicationJSON,
  )
}

Run It

Run the the quality assessment with assay-it eval suite.go. The utility automatically downloads imported modules, compiles suites and outputs results into console.

assay-it eval suite.go

==> PASS: TestHttpBinGet (325.187959ms)
PASS	main

How To Contribute

The command line utility 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

The build and testing process requires Go version 1.20 or later.

Build and run in your development console.

git clone https://github.com/assay-it/assay-it
cd assay-it
go test

commit message

The commit message helps us to write a good release note, speed-up review process. The message should address two question what changed and why. The project follows the template defined by chapter Contributing to a Project of Git book.

bugs

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

License