tobiko/tobiko/podman/_client.py
Federico Ressi d65d80efdc Add podman 1.6.0 source files and update requirements
New requirements:
 - podman
 - python-dateutil>=2.8.0
 - varlink

Change-Id: I7c5ec418fd8f9c7d0d36fce033fe588a59e36f5d
2021-10-27 16:34:09 +02:00

179 lines
6.3 KiB
Python

# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
from __future__ import absolute_import
import subprocess
import os
from oslo_log import log
import podman
import tobiko
from tobiko.podman import _exception
from tobiko.podman import _podman1
from tobiko.podman import _shell
from tobiko.shell import ssh
from tobiko.shell import sh
LOG = log.getLogger(__name__)
def get_podman_client(ssh_client=None):
return PodmanClientFixture(ssh_client=ssh_client)
def list_podman_containers(client=None, **kwargs):
try:
containers = podman_client(client).containers.list(**kwargs)
except _exception.PodmanSocketNotFoundError:
return tobiko.Selection()
else:
return tobiko.select(containers)
PODMAN_CLIENT_CLASSES = \
_podman1.Client, podman.PodmanClient # pylint: disable=E1101
def podman_client(obj=None):
if obj is None:
obj = get_podman_client()
if tobiko.is_fixture(obj):
obj = tobiko.setup_fixture(obj).client
if isinstance(obj, PODMAN_CLIENT_CLASSES):
return obj
raise TypeError('Cannot obtain a Podman client from {!r}'.format(obj))
def podman_version_3():
try:
stdout = sh.execute('rpm -q podman').stdout
except sh.ShellCommandFailed:
return False
podman_ver = stdout.split('-')[1].split('.')[0]
if int(podman_ver) >= 3:
return True
else:
return False
class PodmanClientFixture(tobiko.SharedFixture):
client = None
ssh_client = None
def __init__(self, ssh_client=None):
super(PodmanClientFixture, self).__init__()
if ssh_client:
self.ssh_client = ssh_client
def setup_fixture(self):
self.setup_ssh_client()
self.setup_client()
def setup_ssh_client(self):
ssh_client = self.ssh_client
if ssh_client is None:
self.ssh_client = ssh_client = ssh.ssh_proxy_client() or False
if ssh_client:
tobiko.setup_fixture(ssh_client)
return ssh_client
def setup_client(self):
# podman ver3 (osp>=16.2) has different service / socket paths
if podman_version_3():
podman_service = 'podman.socket'
podman_socket_file = '/run/podman/podman.sock'
else:
podman_service = 'io.podman.socket'
podman_socket_file = '/run/podman/io.podman'
podman_client_setup_cmds = \
f"""sudo test -f /var/podman_client_access_setup || \
(sudo groupadd -f podman && \
sudo usermod -a -G podman heat-admin && \
sudo chmod -R o=wxr /etc/tmpfiles.d && \
sudo echo 'd /run/podman 0770 root heat-admin' > \
/etc/tmpfiles.d/podman.conf && \
sudo cp /lib/systemd/system/{podman_service} \
/etc/systemd/system/{podman_service} && \
sudo crudini --set /etc/systemd/system/{podman_service} Socket \
SocketMode 0660 && \
sudo crudini --set /etc/systemd/system/{podman_service} Socket \
SocketGroup podman && \
sudo systemctl daemon-reload && \
sudo systemd-tmpfiles --create && \
sudo systemctl enable --now {podman_service} && \
sudo chmod 777 /run/podman && \
sudo chown -R root: /run/podman && \
sudo chmod g+rw {podman_socket_file} && \
sudo chmod 777 {podman_socket_file} && \
sudo setenforce 0 && \
sudo systemctl start {podman_service} && \
sudo touch /var/podman_client_access_setup)"""
sh.execute(podman_client_setup_cmds, ssh_client=self.ssh_client)
client = self.client
if client is None:
self.client = client = self.create_client()
return client
def create_client(self): # noqa: C901
for _ in tobiko.retry(timeout=60., interval=5.):
try:
podman_remote_socket = self.discover_podman_socket()
username = self.ssh_client.connect_parameters['username']
host = self.ssh_client.connect_parameters["hostname"]
socket = podman_remote_socket
podman_remote_socket_uri = f'unix:/tmp/podman.sock_{host}'
remote_uri = f'ssh://{username}@{host}{socket}'
if podman_version_3():
# check if a ssh tunnel exists, if not create one
psall = str(subprocess.check_output(('ps', '-ef')))
if f'ssh -L /tmp/podman.sock_{host}' not in psall:
if os.path.exists(f"/tmp/podman.sock_{host}"):
subprocess.call(
['rm', '-f', f'/tmp/podman.sock_{host}'])
# start a background ssh tunnel with the remote host
subprocess.call(['ssh', '-L',
f'/tmp/podman.sock_{host}:'
f'/run/podman/podman.sock',
host, '-N', '-f'])
for _ in tobiko.retry(timeout=60., interval=1.):
if os.path.exists(f'/tmp/podman.sock_{host}'):
break
client = podman.PodmanClient(
base_url=podman_remote_socket_uri)
if client.ping():
LOG.info('container_client is online')
else:
client = _podman1.Client( # pylint: disable=E1101
uri=podman_remote_socket_uri,
remote_uri=remote_uri,
identity_file='~/.ssh/id_rsa')
if client.system.ping():
LOG.info('container_client is online')
return client
except (ConnectionRefusedError, ConnectionResetError):
# retry
self.create_client()
def connect(self):
return tobiko.setup_fixture(self).client
def discover_podman_socket(self):
return _shell.discover_podman_socket(ssh_client=self.ssh_client)