Skip to content

Commit

Permalink
Merge pull request containers#3824 from baude/varlinkendpointtest
Browse files Browse the repository at this point in the history
Create framework for varlink endpoint integration tests
  • Loading branch information
openshift-merge-robot authored Aug 26, 2019
2 parents 6240bd4 + 04f2f95 commit 67926d8
Show file tree
Hide file tree
Showing 12 changed files with 718 additions and 1 deletion.
24 changes: 24 additions & 0 deletions .cirrus.yml
Original file line number Diff line number Diff line change
Expand Up @@ -502,6 +502,28 @@ special_testing_cgroupv2_task:
always:
<<: *standardlogs

special_testing_endpoint_task:

depends_on:
- "gating"
- "varlink_api"
- "vendor"

only_if: $CIRRUS_CHANGE_MESSAGE !=~ '.*\*\*\*\s*CIRRUS:\s*TEST\s*IMAGES\s*\*\*\*.*'

env:
SPECIALMODE: 'endpoint' # See docs

timeout_in: 20m

setup_environment_script: '$SCRIPT_BASE/setup_environment.sh |& ${TIMESTAMP}'
integration_test_script: '$SCRIPT_BASE/integration_test.sh |& ${TIMESTAMP}'

on_failure:
failed_branch_script: '$CIRRUS_WORKING_DIR/$SCRIPT_BASE/notice_branch_failure.sh'

always:
<<: *standardlogs

# Test building of new cache-images for future PR testing, in this PR.
test_build_cache_images_task:
Expand Down Expand Up @@ -609,6 +631,7 @@ success_task:
- "special_testing_in_podman"
- "special_testing_cgroupv2"
- "special_testing_cross"
- "special_testing_endpoint"
- "test_build_cache_images"
- "verify_test_built_images"

Expand Down Expand Up @@ -649,6 +672,7 @@ release_task:
- "special_testing_in_podman"
- "special_testing_cgroupv2"
- "special_testing_cross"
- "special_testing_endpoint"
- "test_build_cache_images"
- "verify_test_built_images"
- "success"
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,4 @@ __pycache__
test/e2e/e2e.coverprofile
/podman*zip
podman*.tar.gz
.idea*
5 changes: 4 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ testunit: libpodimage ## Run unittest on the built image
localunit: test/goecho/goecho varlink_generate
ginkgo \
-r \
--skipPackage test/e2e,pkg/apparmor \
--skipPackage test/e2e,pkg/apparmor,test/endpoint \
--cover \
--covermode atomic \
--tags "$(BUILDTAGS)" \
Expand All @@ -247,6 +247,9 @@ ginkgo:
ginkgo-remote:
ginkgo -v -tags "$(BUILDTAGS) remoteclient" $(GINKGOTIMEOUT) -cover -flakeAttempts 3 -progress -trace -noColor test/e2e/.

endpoint:
ginkgo -v -tags "$(BUILDTAGS)" $(GINKGOTIMEOUT) -cover -flakeAttempts 3 -progress -trace -noColor -debug test/endpoint/.

localintegration: varlink_generate test-binaries ginkgo

remoteintegration: varlink_generate test-binaries ginkgo-remote
Expand Down
6 changes: 6 additions & 0 deletions contrib/cirrus/integration_test.sh
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,12 @@ case "$SPECIALMODE" in
make test-binaries
make local${TESTSUITE}
;;
endpoint)
make
make install PREFIX=/usr ETCDIR=/etc
make test-binaries
make endpoint
;;
none)
make
make install PREFIX=/usr ETCDIR=/etc
Expand Down
3 changes: 3 additions & 0 deletions contrib/cirrus/setup_environment.sh
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,9 @@ case "$SPECIALMODE" in
none)
remove_packaged_podman_files
;;
endpoint)
remove_packaged_podman_files
;;
rootless)
# Only do this once, even if ROOTLESS_USER (somehow) changes
if ! grep -q 'ROOTLESS_USER' /etc/environment
Expand Down
22 changes: 22 additions & 0 deletions test/endpoint/config.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
package endpoint

import "encoding/json"

var (
STORAGE_FS = "vfs"
STORAGE_OPTIONS = "--storage-driver vfs"
ROOTLESS_STORAGE_FS = "vfs"
ROOTLESS_STORAGE_OPTIONS = "--storage-driver vfs"
CACHE_IMAGES = []string{ALPINE, BB, fedoraMinimal, nginx, redis, registry, infra, labels}
nginx = "quay.io/libpod/alpine_nginx:latest"
BB_GLIBC = "docker.io/library/busybox:glibc"
registry = "docker.io/library/registry:2"
labels = "quay.io/libpod/alpine_labels:latest"
)

func makeNameMessage(name string) string {
n := make(map[string]string)
n["name"] = name
b, _ := json.Marshal(n)
return string(b)
}
218 changes: 218 additions & 0 deletions test/endpoint/endpoint.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,218 @@
package endpoint

import (
"bytes"
"encoding/json"
"fmt"
"os"
"os/exec"
"strconv"
"strings"
"syscall"
"time"

iopodman "github.com/containers/libpod/cmd/podman/varlink"
"github.com/containers/libpod/pkg/rootless"
. "github.com/onsi/ginkgo"
"github.com/onsi/gomega/gexec"
)

var (
ARTIFACT_DIR = "/tmp/.artifacts"
CGROUP_MANAGER = "systemd"
defaultWaitTimeout = 90
//RESTORE_IMAGES = []string{ALPINE, BB}
INTEGRATION_ROOT string
ImageCacheDir = "/tmp/podman/imagecachedir"
VarlinkBinary = "/usr/bin/varlink"
ALPINE = "docker.io/library/alpine:latest"
infra = "k8s.gcr.io/pause:3.1"
BB = "docker.io/library/busybox:latest"
redis = "docker.io/library/redis:alpine"
fedoraMinimal = "registry.fedoraproject.org/fedora-minimal:latest"
)

type EndpointTestIntegration struct {
ArtifactPath string
CNIConfigDir string
CgroupManager string
ConmonBinary string
CrioRoot string
//Host HostOS
ImageCacheDir string
ImageCacheFS string
OCIRuntime string
PodmanBinary string
RemoteTest bool
RunRoot string
SignaturePolicyPath string
StorageOptions string
TmpDir string
Timings []string
VarlinkBinary string
VarlinkCommand *exec.Cmd
VarlinkEndpoint string
VarlinkSession *os.Process
}

func (p *EndpointTestIntegration) StartVarlink() {
p.startVarlink(false)
}

func (p *EndpointTestIntegration) StartVarlinkWithCache() {
p.startVarlink(true)
}

func (p *EndpointTestIntegration) startVarlink(useImageCache bool) {
var (
counter int
)
if os.Geteuid() == 0 {
os.MkdirAll("/run/podman", 0755)
}
varlinkEndpoint := p.VarlinkEndpoint
//p.SetVarlinkAddress(p.VarlinkEndpoint)

args := []string{"varlink", "--timeout", "0", varlinkEndpoint}
podmanOptions := getVarlinkOptions(p, args)
if useImageCache {
cacheOptions := []string{"--storage-opt", fmt.Sprintf("%s.imagestore=%s", p.ImageCacheFS, p.ImageCacheDir)}
podmanOptions = append(cacheOptions, podmanOptions...)
}
command := exec.Command(p.PodmanBinary, podmanOptions...)
fmt.Printf("Running: %s %s\n", p.PodmanBinary, strings.Join(podmanOptions, " "))
command.Start()
command.SysProcAttr = &syscall.SysProcAttr{Setpgid: true}
p.VarlinkCommand = command
p.VarlinkSession = command.Process
for {
if result := p.endpointReady(); result == 0 {
break
}
fmt.Println("Waiting for varlink connection to become active", counter)
time.Sleep(250 * time.Millisecond)
counter++
if counter > 40 {
Fail("varlink endpoint never became ready")
}
}
}

func (p *EndpointTestIntegration) endpointReady() int {
session := p.Varlink("GetVersion", "", false)
return session.ExitCode()
}

func (p *EndpointTestIntegration) StopVarlink() {
var out bytes.Buffer
var pids []int
varlinkSession := p.VarlinkSession

if !rootless.IsRootless() {
if err := varlinkSession.Kill(); err != nil {
fmt.Fprintf(os.Stderr, "error on varlink stop-kill %q", err)
}
if _, err := varlinkSession.Wait(); err != nil {
fmt.Fprintf(os.Stderr, "error on varlink stop-wait %q", err)
}

} else {
//p.ResetVarlinkAddress()
parentPid := fmt.Sprintf("%d", p.VarlinkSession.Pid)
pgrep := exec.Command("pgrep", "-P", parentPid)
fmt.Printf("running: pgrep %s\n", parentPid)
pgrep.Stdout = &out
err := pgrep.Run()
if err != nil {
fmt.Fprint(os.Stderr, "unable to find varlink pid")
}

for _, s := range strings.Split(out.String(), "\n") {
if len(s) == 0 {
continue
}
p, err := strconv.Atoi(s)
if err != nil {
fmt.Fprintf(os.Stderr, "unable to convert %s to int", s)
}
if p != 0 {
pids = append(pids, p)
}
}

pids = append(pids, p.VarlinkSession.Pid)
for _, pid := range pids {
syscall.Kill(pid, syscall.SIGKILL)
}
}
socket := strings.Split(p.VarlinkEndpoint, ":")[1]
if err := os.Remove(socket); err != nil {
fmt.Println(err)
}
}

type EndpointSession struct {
*gexec.Session
}

func getVarlinkOptions(p *EndpointTestIntegration, args []string) []string {
podmanOptions := strings.Split(fmt.Sprintf("--root %s --runroot %s --runtime %s --conmon %s --cni-config-dir %s --cgroup-manager %s",
p.CrioRoot, p.RunRoot, p.OCIRuntime, p.ConmonBinary, p.CNIConfigDir, p.CgroupManager), " ")
if os.Getenv("HOOK_OPTION") != "" {
podmanOptions = append(podmanOptions, os.Getenv("HOOK_OPTION"))
}
podmanOptions = append(podmanOptions, strings.Split(p.StorageOptions, " ")...)
podmanOptions = append(podmanOptions, args...)
return podmanOptions
}

func (p *EndpointTestIntegration) Varlink(endpoint, message string, more bool) *EndpointSession {
//call unix:/run/user/1000/podman/io.podman/io.podman.GetContainerStats '{"name": "foobar" }'
var (
command *exec.Cmd
)

args := []string{"call"}
if more {
args = append(args, "-m")
}
args = append(args, []string{fmt.Sprintf("%s/io.podman.%s", p.VarlinkEndpoint, endpoint)}...)
if len(message) > 0 {
args = append(args, message)
}
command = exec.Command(p.VarlinkBinary, args...)
session, err := gexec.Start(command, GinkgoWriter, GinkgoWriter)
if err != nil {
Fail(fmt.Sprintf("unable to run varlink command: %s\n%v", strings.Join(args, " "), err))
}
session.Wait(defaultWaitTimeout)
return &EndpointSession{session}
}

func (s *EndpointSession) OutputToString() string {
fields := strings.Fields(fmt.Sprintf("%s", s.Out.Contents()))
return strings.Join(fields, " ")
}

func (s *EndpointSession) OutputToBytes() []byte {
out := s.OutputToString()
return []byte(out)
}

func (s *EndpointSession) OutputToStringMap() map[string]string {
var out map[string]string
json.Unmarshal(s.OutputToBytes(), &out)
return out
}

func (s *EndpointSession) OutputToMapToInt() map[string]int {
var out map[string]int
json.Unmarshal(s.OutputToBytes(), &out)
return out
}

func (s *EndpointSession) OutputToMoreResponse() iopodman.MoreResponse {
out := make(map[string]iopodman.MoreResponse)
json.Unmarshal(s.OutputToBytes(), &out)
return out["reply"]
}
Loading

0 comments on commit 67926d8

Please sign in to comment.