mirror of
https://github.com/containers/podman.git
synced 2025-08-06 19:44:14 +08:00
Refactor docker-py compatibility tests
* Add which python client is being used to run tests, see "python client" below. * Remove redundate code from test classes * Update/Add comments to modules and classes ======================================================= test session starts ======================================================== platform linux -- Python 3.10.0, pytest-6.2.4, py-1.10.0, pluggy-0.13.1 python client -- DockerClient rootdir: /home/jhonce/Projects/go/src/github.com/containers/podman plugins: requests-mock-1.8.0 collected 33 items test/python/docker/compat/test_containers.py ...s.............. [ 54%] test/python/docker/compat/test_images.py ............ [ 90%] test/python/docker/compat/test_system.py ... [100%] Note: Follow-up PRs will verify the test results and expand the tests. Signed-off-by: Jhon Honce <jhonce@redhat.com>
This commit is contained in:
Jhon Honce
@ -1,111 +1,56 @@
|
||||
"""
|
||||
Integration tests for exercising docker-py against Podman Service.
|
||||
"""
|
||||
import io
|
||||
import subprocess
|
||||
import sys
|
||||
import time
|
||||
import unittest
|
||||
from typing import IO, Optional, List
|
||||
import tarfile
|
||||
from typing import IO, List, Optional
|
||||
|
||||
from docker import DockerClient, errors
|
||||
from docker import errors
|
||||
from docker.models.containers import Container
|
||||
from docker.models.images import Image
|
||||
from docker.models.volumes import Volume
|
||||
from docker.types import Mount
|
||||
|
||||
from test.python.docker import Podman
|
||||
# pylint: disable=no-name-in-module,import-error,wrong-import-order
|
||||
from test.python.docker.compat import common, constant
|
||||
|
||||
import tarfile
|
||||
|
||||
|
||||
class TestContainers(unittest.TestCase):
|
||||
podman = None # initialized podman configuration for tests
|
||||
service = None # podman service instance
|
||||
topContainerId = ""
|
||||
|
||||
def setUp(self):
|
||||
super().setUp()
|
||||
self.client = DockerClient(base_url="tcp://127.0.0.1:8080", timeout=15)
|
||||
TestContainers.podman.restore_image_from_cache(self.client)
|
||||
TestContainers.topContainerId = common.run_top_container(self.client)
|
||||
self.assertIsNotNone(TestContainers.topContainerId)
|
||||
|
||||
def tearDown(self):
|
||||
common.remove_all_containers(self.client)
|
||||
common.remove_all_images(self.client)
|
||||
self.client.close()
|
||||
return super().tearDown()
|
||||
|
||||
@classmethod
|
||||
def setUpClass(cls):
|
||||
super().setUpClass()
|
||||
TestContainers.podman = Podman()
|
||||
TestContainers.service = TestContainers.podman.open(
|
||||
"system", "service", "tcp:127.0.0.1:8080", "--time=0"
|
||||
)
|
||||
# give the service some time to be ready...
|
||||
time.sleep(2)
|
||||
|
||||
rc = TestContainers.service.poll()
|
||||
if rc is not None:
|
||||
raise subprocess.CalledProcessError(rc, "podman system service")
|
||||
|
||||
@classmethod
|
||||
def tearDownClass(cls):
|
||||
TestContainers.service.terminate()
|
||||
stdout, stderr = TestContainers.service.communicate(timeout=0.5)
|
||||
if stdout:
|
||||
sys.stdout.write("\nContainers Service Stdout:\n" + stdout.decode("utf-8"))
|
||||
if stderr:
|
||||
sys.stderr.write("\nContainers Service Stderr:\n" + stderr.decode("utf-8"))
|
||||
|
||||
TestContainers.podman.tear_down()
|
||||
return super().tearDownClass()
|
||||
# pylint: disable=missing-function-docstring
|
||||
class TestContainers(common.DockerTestCase):
|
||||
"""TestCase for exercising containers."""
|
||||
|
||||
def test_create_container(self):
|
||||
# Run a container with detach mode
|
||||
self.client.containers.create(image="alpine", detach=True)
|
||||
self.assertEqual(len(self.client.containers.list(all=True)), 2)
|
||||
"""Run a container with detach mode."""
|
||||
self.docker.containers.create(image="alpine", detach=True)
|
||||
self.assertEqual(len(self.docker.containers.list(all=True)), 2)
|
||||
|
||||
def test_create_network(self):
|
||||
net = self.client.networks.create("testNetwork", driver="bridge")
|
||||
ctnr = self.client.containers.create(image="alpine", detach=True)
|
||||
|
||||
# TODO fix when ready
|
||||
# This test will not work until all connect|disconnect
|
||||
# code is fixed.
|
||||
# net.connect(ctnr)
|
||||
|
||||
# nets = self.client.networks.list(greedy=True)
|
||||
# self.assertGreaterEqual(len(nets), 1)
|
||||
|
||||
# TODO fix endpoint to include containers
|
||||
# for n in nets:
|
||||
# if n.id == "testNetwork":
|
||||
# self.assertEqual(ctnr.id, n.containers)
|
||||
# self.assertTrue(False, "testNetwork not found")
|
||||
"""Add network to a container."""
|
||||
self.docker.networks.create("testNetwork", driver="bridge")
|
||||
self.docker.containers.create(image="alpine", detach=True)
|
||||
|
||||
def test_start_container(self):
|
||||
# Podman docs says it should give a 304 but returns with no response
|
||||
# # Start a already started container should return 304
|
||||
# response = self.client.api.start(container=TestContainers.topContainerId)
|
||||
# response = self.docker.api.start(container=self.top_container_id)
|
||||
# self.assertEqual(error.exception.response.status_code, 304)
|
||||
|
||||
# Create a new container and validate the count
|
||||
self.client.containers.create(image=constant.ALPINE, name="container2")
|
||||
containers = self.client.containers.list(all=True)
|
||||
self.docker.containers.create(image=constant.ALPINE, name="container2")
|
||||
containers = self.docker.containers.list(all=True)
|
||||
self.assertEqual(len(containers), 2)
|
||||
|
||||
def test_start_container_with_random_port_bind(self):
|
||||
container = self.client.containers.create(
|
||||
container = self.docker.containers.create(
|
||||
image=constant.ALPINE,
|
||||
name="containerWithRandomBind",
|
||||
ports={"1234/tcp": None},
|
||||
)
|
||||
containers = self.client.containers.list(all=True)
|
||||
containers = self.docker.containers.list(all=True)
|
||||
self.assertTrue(container in containers)
|
||||
|
||||
def test_stop_container(self):
|
||||
top = self.client.containers.get(TestContainers.topContainerId)
|
||||
top = self.docker.containers.get(self.top_container_id)
|
||||
self.assertEqual(top.status, "running")
|
||||
|
||||
# Stop a running container and validate the state
|
||||
@ -114,7 +59,7 @@ class TestContainers(unittest.TestCase):
|
||||
self.assertIn(top.status, ("stopped", "exited"))
|
||||
|
||||
def test_kill_container(self):
|
||||
top = self.client.containers.get(TestContainers.topContainerId)
|
||||
top = self.docker.containers.get(self.top_container_id)
|
||||
self.assertEqual(top.status, "running")
|
||||
|
||||
# Kill a running container and validate the state
|
||||
@ -124,7 +69,7 @@ class TestContainers(unittest.TestCase):
|
||||
|
||||
def test_restart_container(self):
|
||||
# Validate the container state
|
||||
top = self.client.containers.get(TestContainers.topContainerId)
|
||||
top = self.docker.containers.get(self.top_container_id)
|
||||
top.stop()
|
||||
top.reload()
|
||||
self.assertIn(top.status, ("stopped", "exited"))
|
||||
@ -136,16 +81,16 @@ class TestContainers(unittest.TestCase):
|
||||
|
||||
def test_remove_container(self):
|
||||
# Remove container by ID with force
|
||||
top = self.client.containers.get(TestContainers.topContainerId)
|
||||
top = self.docker.containers.get(self.top_container_id)
|
||||
top.remove(force=True)
|
||||
self.assertEqual(len(self.client.containers.list()), 0)
|
||||
self.assertEqual(len(self.docker.containers.list()), 0)
|
||||
|
||||
def test_remove_container_without_force(self):
|
||||
# Validate current container count
|
||||
self.assertEqual(len(self.client.containers.list()), 1)
|
||||
self.assertEqual(len(self.docker.containers.list()), 1)
|
||||
|
||||
# Remove running container should throw error
|
||||
top = self.client.containers.get(TestContainers.topContainerId)
|
||||
top = self.docker.containers.get(self.top_container_id)
|
||||
with self.assertRaises(errors.APIError) as error:
|
||||
top.remove()
|
||||
self.assertEqual(error.exception.response.status_code, 500)
|
||||
@ -153,11 +98,11 @@ class TestContainers(unittest.TestCase):
|
||||
# Remove container by ID without force
|
||||
top.stop()
|
||||
top.remove()
|
||||
self.assertEqual(len(self.client.containers.list()), 0)
|
||||
self.assertEqual(len(self.docker.containers.list()), 0)
|
||||
|
||||
def test_pause_container(self):
|
||||
# Validate the container state
|
||||
top = self.client.containers.get(TestContainers.topContainerId)
|
||||
top = self.docker.containers.get(self.top_container_id)
|
||||
self.assertEqual(top.status, "running")
|
||||
|
||||
# Pause a running container and validate the state
|
||||
@ -167,7 +112,7 @@ class TestContainers(unittest.TestCase):
|
||||
|
||||
def test_pause_stopped_container(self):
|
||||
# Stop the container
|
||||
top = self.client.containers.get(TestContainers.topContainerId)
|
||||
top = self.docker.containers.get(self.top_container_id)
|
||||
top.stop()
|
||||
|
||||
# Pause exited container should throw error
|
||||
@ -176,7 +121,7 @@ class TestContainers(unittest.TestCase):
|
||||
self.assertEqual(error.exception.response.status_code, 500)
|
||||
|
||||
def test_unpause_container(self):
|
||||
top = self.client.containers.get(TestContainers.topContainerId)
|
||||
top = self.docker.containers.get(self.top_container_id)
|
||||
|
||||
# Validate the container state
|
||||
top.pause()
|
||||
@ -190,21 +135,21 @@ class TestContainers(unittest.TestCase):
|
||||
|
||||
def test_list_container(self):
|
||||
# Add container and validate the count
|
||||
self.client.containers.create(image="alpine", detach=True)
|
||||
containers = self.client.containers.list(all=True)
|
||||
self.docker.containers.create(image="alpine", detach=True)
|
||||
containers = self.docker.containers.list(all=True)
|
||||
self.assertEqual(len(containers), 2)
|
||||
|
||||
def test_filters(self):
|
||||
self.skipTest("TODO Endpoint does not yet support filters")
|
||||
|
||||
# List container with filter by id
|
||||
filters = {"id": TestContainers.topContainerId}
|
||||
ctnrs = self.client.containers.list(all=True, filters=filters)
|
||||
filters = {"id": self.top_container_id}
|
||||
ctnrs = self.docker.containers.list(all=True, filters=filters)
|
||||
self.assertEqual(len(ctnrs), 1)
|
||||
|
||||
# List container with filter by name
|
||||
filters = {"name": "top"}
|
||||
ctnrs = self.client.containers.list(all=True, filters=filters)
|
||||
ctnrs = self.docker.containers.list(all=True, filters=filters)
|
||||
self.assertEqual(len(ctnrs), 1)
|
||||
|
||||
def test_copy_to_container(self):
|
||||
@ -212,31 +157,33 @@ class TestContainers(unittest.TestCase):
|
||||
vol: Optional[Volume] = None
|
||||
try:
|
||||
test_file_content = b"Hello World!"
|
||||
vol = self.client.volumes.create("test-volume")
|
||||
ctr = self.client.containers.create(image="alpine",
|
||||
detach=True,
|
||||
command="top",
|
||||
volumes=["test-volume:/test-volume-read-only:ro"])
|
||||
vol = self.docker.volumes.create("test-volume")
|
||||
ctr = self.docker.containers.create(
|
||||
image="alpine",
|
||||
detach=True,
|
||||
command="top",
|
||||
volumes=["test-volume:/test-volume-read-only:ro"],
|
||||
)
|
||||
ctr.start()
|
||||
|
||||
buff: IO[bytes] = io.BytesIO()
|
||||
with tarfile.open(fileobj=buff, mode="w:") as tf:
|
||||
ti: tarfile.TarInfo = tarfile.TarInfo()
|
||||
ti.uid = 1042
|
||||
ti.gid = 1043
|
||||
ti.name = "a.txt"
|
||||
ti.path = "a.txt"
|
||||
ti.mode = 0o644
|
||||
ti.type = tarfile.REGTYPE
|
||||
ti.size = len(test_file_content)
|
||||
tf.addfile(ti, fileobj=io.BytesIO(test_file_content))
|
||||
with tarfile.open(fileobj=buff, mode="w:") as file:
|
||||
info: tarfile.TarInfo = tarfile.TarInfo()
|
||||
info.uid = 1042
|
||||
info.gid = 1043
|
||||
info.name = "a.txt"
|
||||
info.path = "a.txt"
|
||||
info.mode = 0o644
|
||||
info.type = tarfile.REGTYPE
|
||||
info.size = len(test_file_content)
|
||||
file.addfile(info, fileobj=io.BytesIO(test_file_content))
|
||||
|
||||
buff.seek(0)
|
||||
ctr.put_archive("/tmp/", buff)
|
||||
ret, out = ctr.exec_run(["stat", "-c", "%u:%g", "/tmp/a.txt"])
|
||||
|
||||
self.assertEqual(ret, 0)
|
||||
self.assertEqual(out.rstrip(), b'1042:1043', "UID/GID of copied file")
|
||||
self.assertEqual(out.rstrip(), b"1042:1043", "UID/GID of copied file")
|
||||
|
||||
ret, out = ctr.exec_run(["cat", "/tmp/a.txt"])
|
||||
self.assertEqual(ret, 0)
|
||||
@ -253,48 +200,61 @@ class TestContainers(unittest.TestCase):
|
||||
vol.remove(force=True)
|
||||
|
||||
def test_mount_preexisting_dir(self):
|
||||
dockerfile = (B'FROM quay.io/libpod/alpine:latest\n'
|
||||
B'USER root\n'
|
||||
B'RUN mkdir -p /workspace\n'
|
||||
B'RUN chown 1042:1043 /workspace')
|
||||
dockerfile = (
|
||||
b"FROM quay.io/libpod/alpine:latest\n"
|
||||
b"USER root\n"
|
||||
b"RUN mkdir -p /workspace\n"
|
||||
b"RUN chown 1042:1043 /workspace"
|
||||
)
|
||||
img: Image
|
||||
img, out = self.client.images.build(fileobj=io.BytesIO(dockerfile))
|
||||
ctr: Container = self.client.containers.create(image=img.id, detach=True, command="top",
|
||||
volumes=["test_mount_preexisting_dir_vol:/workspace"])
|
||||
img, out = self.docker.images.build(fileobj=io.BytesIO(dockerfile))
|
||||
ctr: Container = self.docker.containers.create(
|
||||
image=img.id,
|
||||
detach=True,
|
||||
command="top",
|
||||
volumes=["test_mount_preexisting_dir_vol:/workspace"],
|
||||
)
|
||||
ctr.start()
|
||||
ret, out = ctr.exec_run(["stat", "-c", "%u:%g", "/workspace"])
|
||||
self.assertEqual(out.rstrip(), b'1042:1043', "UID/GID set in dockerfile")
|
||||
|
||||
_, out = ctr.exec_run(["stat", "-c", "%u:%g", "/workspace"])
|
||||
self.assertEqual(out.rstrip(), b"1042:1043", "UID/GID set in dockerfile")
|
||||
|
||||
def test_non_existant_workdir(self):
|
||||
dockerfile = (B'FROM quay.io/libpod/alpine:latest\n'
|
||||
B'USER root\n'
|
||||
B'WORKDIR /workspace/scratch\n'
|
||||
B'RUN touch test')
|
||||
dockerfile = (
|
||||
b"FROM quay.io/libpod/alpine:latest\n"
|
||||
b"USER root\n"
|
||||
b"WORKDIR /workspace/scratch\n"
|
||||
b"RUN touch test"
|
||||
)
|
||||
img: Image
|
||||
img, out = self.client.images.build(fileobj=io.BytesIO(dockerfile))
|
||||
ctr: Container = self.client.containers.create(image=img.id, detach=True, command="top",
|
||||
volumes=["test_non_existant_workdir:/workspace"])
|
||||
img, _ = self.docker.images.build(fileobj=io.BytesIO(dockerfile))
|
||||
ctr: Container = self.docker.containers.create(
|
||||
image=img.id,
|
||||
detach=True,
|
||||
command="top",
|
||||
volumes=["test_non_existant_workdir:/workspace"],
|
||||
)
|
||||
ctr.start()
|
||||
ret, out = ctr.exec_run(["stat", "/workspace/scratch/test"])
|
||||
ret, _ = ctr.exec_run(["stat", "/workspace/scratch/test"])
|
||||
self.assertEqual(ret, 0, "Working directory created if it doesn't exist")
|
||||
|
||||
def test_mount_rw_by_default(self):
|
||||
ctr: Optional[Container] = None
|
||||
vol: Optional[Volume] = None
|
||||
|
||||
try:
|
||||
vol = self.client.volumes.create("test-volume")
|
||||
ctr = self.client.containers.create(image="alpine",
|
||||
detach=True,
|
||||
command="top",
|
||||
mounts=[Mount(target="/vol-mnt",
|
||||
source="test-volume",
|
||||
type='volume',
|
||||
read_only=False)])
|
||||
ctr_inspect = self.client.api.inspect_container(ctr.id)
|
||||
vol = self.docker.volumes.create("test-volume")
|
||||
ctr = self.docker.containers.create(
|
||||
image="alpine",
|
||||
detach=True,
|
||||
command="top",
|
||||
mounts=[
|
||||
Mount(target="/vol-mnt", source="test-volume", type="volume", read_only=False)
|
||||
],
|
||||
)
|
||||
ctr_inspect = self.docker.api.inspect_container(ctr.id)
|
||||
binds: List[str] = ctr_inspect["HostConfig"]["Binds"]
|
||||
self.assertEqual(len(binds), 1)
|
||||
self.assertEqual(binds[0], 'test-volume:/vol-mnt:rw,rprivate,nosuid,nodev,rbind')
|
||||
self.assertEqual(binds[0], "test-volume:/vol-mnt:rw,rprivate,nosuid,nodev,rbind")
|
||||
finally:
|
||||
if ctr is not None:
|
||||
ctr.remove()
|
||||
|
||||
Reference in New Issue
Block a user