taskrunner

Taskrunner

Handling CI-related tasks such as building, testing, and deploying can be automated using bash scripts, but these can quickly get messy. Managing multiple processes, handling cleanup, aborting on failure, adding pretty colored output, and more can lead to complex bash code. That's why Taskrunner was created: a simple, open source library to replace bash scripts with cleaner, more maintainable code written in Go.

Installation

go get github.com/quollix/taskrunner

Usage Example

var ( 
    backendDir = "../backend"
    frontendDir = "../frontend"
    acceptanceTestsDir = "../acceptance"
)

func TestFrontend() {
    tr := taskrunner.GetTaskRunner()
	
    tr.Log.Info("Testing Integrated Components")
    defer tr.Cleanup() // shuts down the daemon processes at the end
    tr.Cmd().Dir(backendDir).Run("go build")
    tr.Cmd().Dir(backendDir).AsDaemon("backend").Run("./backend")
    tr.WaitUntilPortIsReady("8080")

    tr.Cmd().Dir(frontendDir).Run("npm install")
    tr.Cmd().Dir(frontendDir).Env("VITE_APP_PROFILE", "TEST").AsDaemon("frontend").Run("npm run serve")
    tr.WaitForWebPageToBeReady("http://localhost:8081/")
    tr.Cmd().Dir(acceptanceTestsDir).Env("CYPRESS_PROFILE", "TEST").Run(cypressCommand)

    output := tr.Cmd().AllowFail().Run("go test ./...").Output()
    tr.Log.Info("test output:\n%s", output)
}

The idea is to write simple functions like this and build a CLI tool, e.g., by using cobra, to call these functions. The final use of the CLI tool might look like this:

go build
./my-task-runner test frontend

This approach helps you create a modern and scalable CI infrastructure.

It is good practice for your CLI program to print a final success line after the root command has completed successfully:

tr.Log.Info("final exit code: 0")

CI logs can become large, and a predictable final line makes it easy for developers to see whether the overall run succeeded. Taskrunner itself prints the matching non-zero final exit code line when it exits through ExitWithError(), so the failure case is already covered by taskrunner.

Contributing

Please read the Community articles for more information on how to contribute to the project and interact with others.

License

This project is licensed under the Apache License 2.0. See LICENSE for details.