Skip to content
This repository was archived by the owner on Dec 21, 2018. It is now read-only.

Repository files navigation

Libkermit

GoDocBuild StatusGo Report CardLicensecodecov

When green is all there is to be
It could make you wonder why
But why wonder why wonder
I am green, and it'll do fine
It's beautiful,
and I think it's what I want to be.
-- Kermit the Frog

When Docker meets with integration/acceptance tests to make you see everything in green. Libkermit is a Go(lang) library that aims to ease the writing of integration tests (any non unit tests actually) with the helps of Docker and it's ecosystem (mainly libcompose).

The goals are :

  • Easy docker manipulation, from managing a simple container to boot up a whole stack.
    • create, delete, pause, … containers
    • check for a certain state containers (inspect them)
    • support compose files to allow starting a whole stack
  • Testing suite and functions, in a simple fashion.
  • Works seamlessly with the Go(lang) testing framework.
  • Try to not force any testing framework but also tries to integrate with them (go-check, testify, …).

Note: This is experimental and not even implemented yet. You are on your own right now

Package docker

This package holds functions and structs to ease docker uses.

package yours
import (
"testing""github.com/libkermit/docker"
)
funcTestItMyFriend(t*testing.T) {
project, err:=docker.NewProjectFromEnv()
iferr!=nil {
t.Fatal(err)
}
container, err:=project.Start("vdemeester/myawesomeimage")
iferr!=nil {
t.Fatal(err)
}
// Do your stuff// […]// Clean the containers managed by libkermiterr=project.Clean()
iferr!=nil {
t.Fatal(err)
}
}

Package docker/testing

This package map the docker package but takes a *testing.T struct on all methods. The idea is to write even less. Let's write the same example as above.

package yours
import (
"testing"
docker "github.com/libkermit/docker/testing"
)
funcTestItMyFriend(t*testing.T) {
project:=docker.NewProjectFromEnv(t)
container:=project.Start(t, "vdemeester/myawesomeimage")
// Do your stuff// […]// Clean the containers managed by libkermitproject.Clean(t)
}

Other packages to come

  • suite : functions and structs to setup tests suites.

About

🐳 🐸 When Docker meets with integration/acceptance tests to make you see everything in green

Resources

Stars

17 stars

Watchers

5 watching

Forks

Releases

Packages

Used by

Contributors

Languages