weldpua2008/supraworker repository overview

⁠Supraworker

The abstraction layer around jobs, allows pull a job from your API periodically, call-back your API, observe execution time and to control concurrent execution.

It's responsible for getting the commands from your API, running commands, and streaming the logs back to your API. It also sends state updates to your API.

⁠Getting started

Find the version you wish to install on the GitHub Releases page⁠ and download either the darwin-amd64 binary for MacOS or the linux-amd64 binary for Linux. No other operating systems or architectures have pre-built binaries at this time.

$ xattr -d com.apple.quarantine /Users/weldpua2008/Downloads/supraworker_darwin_amd64/supraworker
$ /Users/weldpua2008/Downloads/supraworker_darwin_amd64/supraworker

• MacOs X Homebrew is a free and open-source package management system for Mac OS X.

 brew tap weldpua2008/tap
 brew install weldpua2008/tap/supraworker

To update to the latest, run

brew upgrade weldpua2008/tap/supraworker

⁠Configuring

Define config at $HOME/supraworker.yaml:

# ClientId in case you need to identify the worker
clientId: "my_uniq_client_id"
# how ofen call your API
api_delay_sec: 10
# jobs related operations
jobs:
  get:
    url: "http://localhost:80/get/new/job"
    method: POST
    headers:
      "Content-type": "application/json"
      params:
        "clientid": "{{ .ClientId}}"

⁠Installing

⁠Download automation

• Download for Linux latest release

curl --silent -L  "https://api.github.com/repos/weldpua2008/supraworker/releases/latest"  \
| jq --arg PLATFORM_ARCH "$(echo `uname -s`_amd| tr '[:upper:]' '[:lower:]')" -r '.assets[] | select(.name | contains($PLATFORM_ARCH)).browser_download_url' \
| xargs -I % curl -sSL  % \
| sudo tar --strip-components=1  -xzf  -

⁠Installing from source

1. install Go⁠ v1.13+
2. clone this down into your $GOPATH

• mkdir -p $GOPATH/src/github.com/weldpua2008
• git clone https://github.com/weldpua2008/supraworker $GOPATH/src/github.com/weldpua2008/supraworker
• cd $GOPATH/src/github.com/weldpua2008/supraworker

1. install golangci-lint⁠ for linting + static analysis

• Lint: docker run --rm -v $(pwd):/app -w /app golangci/golangci-lint:v1.24.0 golangci-lint run -v

⁠Running tests

• expires all test results

$ go clean -testcache

• run all tests

$ go test -bench= -test.v  ./...