bkosm / gompose

Use docker-compose programatically in Go tests. No third-party dependencies.

gompose's Issues

v2 with std `context` instead of options

As an idea, it would make the library even more std lib oriented.

Up should accept options struct

Parameters to the Up function should accept a struct rather than a required param and varargs.

---

Turn this:

err = gompose.Up(
	gompose.ReadyOnLog("database system is ready to accept connections", 2),
	func() { _ = gompose.Down() }, // any action to be taken on system interrupt
)

Into this:

err = gompose.Up(
        gompose.UpOpts {
              WaitOnChannel: gompose.ReadyOnLog("database system is ready to accept connections", 2),
              OnInterrupt: func() { _ = gompose.Down() },
        }
)

Write `godoc`s

Write docs that will be nicely visualized on the pkg go site.

See this repo for examples: https://github.com/sebdah/goldie
Write some example functions too.

Expose `start/stop` functionality

Another useful command of compose is stop which does not remove the containers entirely, allowing for a faster consecutive startup.

A possible flow is:

1. Up
2. Stop
3. Start
4. Down

Implement wrappers for those two in gompose.

Align with `golang-standards`

Reference: https://github.com/golang-standards/project-layout

Wait on multiple conditions

Make WithWait accept arbitrary number of channels.

E.g.:

_ := Up(
  WithWait(ReadyOnLog(...), ReadyOnLog(...), ReadyOnHttp(...))
)

Remove `testify`

Due to the fact that there are no ways of specifying test-only packages, the assertion library is pulled with gompose every time.

To deliver on the promise the library usage should be removed.

Ready on http response wait condition

Allow for a wait condition that expects a successful HTTP response from the container.

E.g.:

err := Up(
	WithWait(
		ReadyOnHttp("5432", http.StatusOk),
	),
)

An option of a callback on request sounds good too.