summaryrefslogtreecommitdiff
path: root/contrib/python/podman
diff options
context:
space:
mode:
authorJhon Honce <jhonce@redhat.com>2018-09-25 10:09:16 -0700
committerJhon Honce <jhonce@redhat.com>2018-10-01 07:24:50 -0700
commit9074565f4e623124f17ce02657e35d658abafae5 (patch)
tree6177fa9a72650f6d5ce4cdc2dca0b86dc17c69cd /contrib/python/podman
parentdf978a264d7944351e7cded0a9506cab8a7bb0db (diff)
downloadpodman-9074565f4e623124f17ce02657e35d658abafae5.tar.gz
podman-9074565f4e623124f17ce02657e35d658abafae5.tar.bz2
podman-9074565f4e623124f17ce02657e35d658abafae5.zip
Implement pod varlink bindings
* Update varlink document * Add NoContainersInPod error in go and python * Add support for varlink pod interface * New code passes pylint * Fix bug in test_runner.sh * Update integration tests for race condition on status check * Add missing port config file support Signed-off-by: Jhon Honce <jhonce@redhat.com>
Diffstat (limited to 'contrib/python/podman')
-rw-r--r--contrib/python/podman/.pylintrc564
-rw-r--r--contrib/python/podman/podman/__init__.py11
-rw-r--r--contrib/python/podman/podman/client.py6
-rw-r--r--contrib/python/podman/podman/libs/__init__.py26
-rw-r--r--contrib/python/podman/podman/libs/errors.py26
-rw-r--r--contrib/python/podman/podman/libs/images.py6
-rw-r--r--contrib/python/podman/podman/libs/pods.py164
-rw-r--r--contrib/python/podman/test/test_pods_ctnrs.py65
-rw-r--r--contrib/python/podman/test/test_pods_no_ctnrs.py94
-rwxr-xr-xcontrib/python/podman/test/test_runner.sh2
10 files changed, 948 insertions, 16 deletions
diff --git a/contrib/python/podman/.pylintrc b/contrib/python/podman/.pylintrc
new file mode 100644
index 000000000..a5628a6cf
--- /dev/null
+++ b/contrib/python/podman/.pylintrc
@@ -0,0 +1,564 @@
+[MASTER]
+
+# A comma-separated list of package or module names from where C extensions may
+# be loaded. Extensions are loading into the active Python interpreter and may
+# run arbitrary code.
+extension-pkg-whitelist=
+
+# Add files or directories to the blacklist. They should be base names, not
+# paths.
+ignore=CVS
+
+# Add files or directories matching the regex patterns to the blacklist. The
+# regex matches against base names, not paths.
+ignore-patterns=
+
+# Python code to execute, usually for sys.path manipulation such as
+# pygtk.require().
+#init-hook=
+
+# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the
+# number of processors available to use.
+jobs=0
+
+# Control the amount of potential inferred values when inferring a single
+# object. This can help the performance when dealing with large functions or
+# complex, nested conditions.
+limit-inference-results=100
+
+# List of plugins (as comma separated values of python modules names) to load,
+# usually to register additional checkers.
+load-plugins=
+
+# Pickle collected data for later comparisons.
+persistent=yes
+
+# Specify a configuration file.
+#rcfile=
+
+# When enabled, pylint would attempt to guess common misconfiguration and emit
+# user-friendly hints instead of false-positive error messages.
+suggestion-mode=yes
+
+# Allow loading of arbitrary C extensions. Extensions are imported into the
+# active Python interpreter and may run arbitrary code.
+unsafe-load-any-extension=no
+
+
+[MESSAGES CONTROL]
+
+# Only show warnings with the listed confidence levels. Leave empty to show
+# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED.
+confidence=
+
+# Disable the message, report, category or checker with the given id(s). You
+# can either give multiple identifiers separated by comma (,) or put this
+# option multiple times (only on the command line, not in the configuration
+# file where it should appear only once). You can also use "--disable=all" to
+# disable everything first and then reenable specific checks. For example, if
+# you want to run only the similarities checker, you can use "--disable=all
+# --enable=similarities". If you want to run only the classes checker, but have
+# no Warning level messages displayed, use "--disable=all --enable=classes
+# --disable=W".
+disable=print-statement,
+ parameter-unpacking,
+ unpacking-in-except,
+ old-raise-syntax,
+ backtick,
+ long-suffix,
+ old-ne-operator,
+ old-octal-literal,
+ import-star-module-level,
+ non-ascii-bytes-literal,
+ raw-checker-failed,
+ bad-inline-option,
+ locally-disabled,
+ locally-enabled,
+ file-ignored,
+ suppressed-message,
+ useless-suppression,
+ deprecated-pragma,
+ use-symbolic-message-instead,
+ apply-builtin,
+ basestring-builtin,
+ buffer-builtin,
+ cmp-builtin,
+ coerce-builtin,
+ execfile-builtin,
+ file-builtin,
+ long-builtin,
+ raw_input-builtin,
+ reduce-builtin,
+ standarderror-builtin,
+ unicode-builtin,
+ xrange-builtin,
+ coerce-method,
+ delslice-method,
+ getslice-method,
+ setslice-method,
+ no-absolute-import,
+ old-division,
+ dict-iter-method,
+ dict-view-method,
+ next-method-called,
+ metaclass-assignment,
+ indexing-exception,
+ raising-string,
+ reload-builtin,
+ oct-method,
+ hex-method,
+ nonzero-method,
+ cmp-method,
+ input-builtin,
+ round-builtin,
+ intern-builtin,
+ unichr-builtin,
+ map-builtin-not-iterating,
+ zip-builtin-not-iterating,
+ range-builtin-not-iterating,
+ filter-builtin-not-iterating,
+ using-cmp-argument,
+ eq-without-hash,
+ div-method,
+ idiv-method,
+ rdiv-method,
+ exception-message-attribute,
+ invalid-str-codec,
+ sys-max-int,
+ bad-python3-import,
+ deprecated-string-function,
+ deprecated-str-translate-call,
+ deprecated-itertools-function,
+ deprecated-types-field,
+ next-method-defined,
+ dict-items-not-iterating,
+ dict-keys-not-iterating,
+ dict-values-not-iterating,
+ deprecated-operator-function,
+ deprecated-urllib-function,
+ xreadlines-attribute,
+ deprecated-sys-function,
+ exception-escape,
+ comprehension-escape
+
+# Enable the message, report, category or checker with the given id(s). You can
+# either give multiple identifier separated by comma (,) or put this option
+# multiple time (only on the command line, not in the configuration file where
+# it should appear only once). See also the "--disable" option for examples.
+enable=c-extension-no-member
+
+
+[REPORTS]
+
+# Python expression which should return a note less than 10 (10 is the highest
+# note). You have access to the variables errors warning, statement which
+# respectively contain the number of errors / warnings messages and the total
+# number of statements analyzed. This is used by the global evaluation report
+# (RP0004).
+evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
+
+# Template used to display messages. This is a python new-style format string
+# used to format the message information. See doc for all details.
+#msg-template=
+
+# Set the output format. Available formats are text, parseable, colorized, json
+# and msvs (visual studio). You can also give a reporter class, e.g.
+# mypackage.mymodule.MyReporterClass.
+output-format=text
+
+# Tells whether to display a full report or only the messages.
+reports=no
+
+# Activate the evaluation score.
+score=yes
+
+
+[REFACTORING]
+
+# Maximum number of nested blocks for function / method body
+max-nested-blocks=5
+
+# Complete name of functions that never returns. When checking for
+# inconsistent-return-statements if a never returning function is called then
+# it will be considered as an explicit return statement and no message will be
+# printed.
+never-returning-functions=sys.exit
+
+
+[TYPECHECK]
+
+# List of decorators that produce context managers, such as
+# contextlib.contextmanager. Add to this list to register other decorators that
+# produce valid context managers.
+contextmanager-decorators=contextlib.contextmanager
+
+# List of members which are set dynamically and missed by pylint inference
+# system, and so shouldn't trigger E1101 when accessed. Python regular
+# expressions are accepted.
+generated-members=
+
+# Tells whether missing members accessed in mixin class should be ignored. A
+# mixin class is detected if its name ends with "mixin" (case insensitive).
+ignore-mixin-members=yes
+
+# Tells whether to warn about missing members when the owner of the attribute
+# is inferred to be None.
+ignore-none=yes
+
+# This flag controls whether pylint should warn about no-member and similar
+# checks whenever an opaque object is returned when inferring. The inference
+# can return multiple potential results while evaluating a Python object, but
+# some branches might not be evaluated, which results in partial inference. In
+# that case, it might be useful to still emit no-member and other checks for
+# the rest of the inferred objects.
+ignore-on-opaque-inference=yes
+
+# List of class names for which member attributes should not be checked (useful
+# for classes with dynamically set attributes). This supports the use of
+# qualified names.
+ignored-classes=optparse.Values,thread._local,_thread._local
+
+# List of module names for which member attributes should not be checked
+# (useful for modules/projects where namespaces are manipulated during runtime
+# and thus existing member attributes cannot be deduced by static analysis. It
+# supports qualified module names, as well as Unix pattern matching.
+ignored-modules=
+
+# Show a hint with possible names when a member name was not found. The aspect
+# of finding the hint is based on edit distance.
+missing-member-hint=yes
+
+# The minimum edit distance a name should have in order to be considered a
+# similar match for a missing member name.
+missing-member-hint-distance=1
+
+# The total number of similar names that should be taken in consideration when
+# showing a hint for a missing member.
+missing-member-max-choices=1
+
+
+[SPELLING]
+
+# Limits count of emitted suggestions for spelling mistakes.
+max-spelling-suggestions=4
+
+# Spelling dictionary name. Available dictionaries: none. To make it working
+# install python-enchant package..
+spelling-dict=
+
+# List of comma separated words that should not be checked.
+spelling-ignore-words=
+
+# A path to a file that contains private dictionary; one word per line.
+spelling-private-dict-file=
+
+# Tells whether to store unknown words to indicated private dictionary in
+# --spelling-private-dict-file option instead of raising a message.
+spelling-store-unknown-words=no
+
+
+[MISCELLANEOUS]
+
+# List of note tags to take in consideration, separated by a comma.
+notes=FIXME,
+ XXX,
+ TODO
+
+
+[FORMAT]
+
+# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
+expected-line-ending-format=
+
+# Regexp for a line that is allowed to be longer than the limit.
+ignore-long-lines=^\s*(# )?<?https?://\S+>?$
+
+# Number of spaces of indent required inside a hanging or continued line.
+indent-after-paren=4
+
+# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
+# tab).
+indent-string=' '
+
+# Maximum number of characters on a single line.
+max-line-length=100
+
+# Maximum number of lines in a module.
+max-module-lines=1000
+
+# List of optional constructs for which whitespace checking is disabled. `dict-
+# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}.
+# `trailing-comma` allows a space between comma and closing bracket: (a, ).
+# `empty-line` allows space-only lines.
+no-space-check=trailing-comma,
+ dict-separator
+
+# Allow the body of a class to be on the same line as the declaration if body
+# contains single statement.
+single-line-class-stmt=no
+
+# Allow the body of an if to be on the same line as the test if there is no
+# else.
+single-line-if-stmt=no
+
+
+[BASIC]
+
+# Naming style matching correct argument names.
+#argument-naming-style=snake_case
+
+# Regular expression matching correct argument names. Overrides argument-
+# naming-style.
+argument-rgx=[a-z_][a-z0-9_]{1,30}$
+argument-name-hint=[a-z_][a-z0-9_]{1,30}$
+
+# Naming style matching correct attribute names.
+attr-naming-style=snake_case
+
+# Regular expression matching correct attribute names. Overrides attr-naming-
+# style.
+#attr-rgx=
+
+# Bad variable names which should always be refused, separated by a comma.
+bad-names=foo,
+ bar,
+ baz,
+ toto,
+ tutu,
+ tata
+
+# Naming style matching correct class attribute names.
+class-attribute-naming-style=any
+
+# Regular expression matching correct class attribute names. Overrides class-
+# attribute-naming-style.
+#class-attribute-rgx=
+
+# Naming style matching correct class names.
+class-naming-style=PascalCase
+
+# Regular expression matching correct class names. Overrides class-naming-
+# style.
+#class-rgx=
+
+# Naming style matching correct constant names.
+const-naming-style=UPPER_CASE
+
+# Regular expression matching correct constant names. Overrides const-naming-
+# style.
+#const-rgx=
+
+# Minimum line length for functions/classes that require docstrings, shorter
+# ones are exempt.
+docstring-min-length=-1
+
+# Naming style matching correct function names.
+function-naming-style=snake_case
+
+# Regular expression matching correct function names. Overrides function-
+# naming-style.
+#function-rgx=
+
+# Good variable names which should always be accepted, separated by a comma.
+good-names=c,
+ e,
+ i,
+ j,
+ k,
+ r,
+ v,
+ ex,
+ Run,
+ _
+
+# Include a hint for the correct naming format with invalid-name.
+include-naming-hint=no
+
+# Naming style matching correct inline iteration names.
+inlinevar-naming-style=any
+
+# Regular expression matching correct inline iteration names. Overrides
+# inlinevar-naming-style.
+#inlinevar-rgx=
+
+# Naming style matching correct method names.
+method-naming-style=snake_case
+
+# Regular expression matching correct method names. Overrides method-naming-
+# style.
+#method-rgx=
+
+# Naming style matching correct module names.
+module-naming-style=snake_case
+
+# Regular expression matching correct module names. Overrides module-naming-
+# style.
+#module-rgx=
+
+# Colon-delimited sets of names that determine each other's naming style when
+# the name regexes allow several styles.
+name-group=
+
+# Regular expression which should only match function or class names that do
+# not require a docstring.
+no-docstring-rgx=^_
+
+# List of decorators that produce properties, such as abc.abstractproperty. Add
+# to this list to register other decorators that produce valid properties.
+# These decorators are taken in consideration only for invalid-name.
+property-classes=abc.abstractproperty
+
+# Naming style matching correct variable names.
+#variable-naming-style=snake_case
+
+# Regular expression matching correct variable names. Overrides variable-
+# naming-style.
+variable-rgx=[a-z_][a-z0-9_]{2,30}$
+variable-name-hint=[a-z_][a-z0-9_]{2,30}$
+
+[SIMILARITIES]
+
+# Ignore comments when computing similarities.
+ignore-comments=yes
+
+# Ignore docstrings when computing similarities.
+ignore-docstrings=yes
+
+# Ignore imports when computing similarities.
+ignore-imports=no
+
+# Minimum lines number of a similarity.
+min-similarity-lines=4
+
+
+[VARIABLES]
+
+# List of additional names supposed to be defined in builtins. Remember that
+# you should avoid to define new builtins when possible.
+additional-builtins=
+
+# Tells whether unused global variables should be treated as a violation.
+allow-global-unused-variables=yes
+
+# List of strings which can identify a callback function by name. A callback
+# name must start or end with one of those strings.
+callbacks=cb_,
+ _cb
+
+# A regular expression matching the name of dummy variables (i.e. expected to
+# not be used).
+dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
+
+# Argument names that match this expression will be ignored. Default to name
+# with leading underscore.
+ignored-argument-names=_.*|^ignored_|^unused_
+
+# Tells whether we should check for unused import in __init__ files.
+init-import=no
+
+# List of qualified module names which can have objects that can redefine
+# builtins.
+redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io
+
+
+[LOGGING]
+
+# Logging modules to check that the string format arguments are in logging
+# function parameter format.
+logging-modules=logging
+
+
+[IMPORTS]
+
+# Allow wildcard imports from modules that define __all__.
+allow-wildcard-with-all=no
+
+# Analyse import fallback blocks. This can be used to support both Python 2 and
+# 3 compatible code, which means that the block might have code that exists
+# only in one or another interpreter, leading to false positives when analysed.
+analyse-fallback-blocks=no
+
+# Deprecated modules which should not be used, separated by a comma.
+deprecated-modules=optparse,tkinter.tix
+
+# Create a graph of external dependencies in the given file (report RP0402 must
+# not be disabled).
+ext-import-graph=
+
+# Create a graph of every (i.e. internal and external) dependencies in the
+# given file (report RP0402 must not be disabled).
+import-graph=
+
+# Create a graph of internal dependencies in the given file (report RP0402 must
+# not be disabled).
+int-import-graph=
+
+# Force import order to recognize a module as part of the standard
+# compatibility libraries.
+known-standard-library=
+
+# Force import order to recognize a module as part of a third party library.
+known-third-party=enchant
+
+
+[DESIGN]
+
+# Support argparse.Action constructor API
+# Maximum number of arguments for function / method.
+max-args=12
+
+# Maximum number of attributes for a class (see R0902).
+max-attributes=7
+
+# Maximum number of boolean expressions in an if statement.
+max-bool-expr=5
+
+# Maximum number of branch for function / method body.
+max-branches=12
+
+# Maximum number of locals for function / method body.
+max-locals=15
+
+# Maximum number of parents for a class (see R0901).
+max-parents=10
+
+# Maximum number of public methods for a class (see R0904).
+max-public-methods=20
+
+# Maximum number of return / yield for function / method body.
+max-returns=6
+
+# Maximum number of statements in function / method body.
+max-statements=50
+
+# Minimum number of public methods for a class (see R0903).
+min-public-methods=2
+
+
+[CLASSES]
+
+# List of method names used to declare (i.e. assign) instance attributes.
+defining-attr-methods=__init__,
+ __new__,
+ setUp
+
+# List of member names, which should be excluded from the protected access
+# warning.
+exclude-protected=_asdict,
+ _fields,
+ _replace,
+ _source,
+ _make
+
+# List of valid names for the first argument in a class method.
+valid-classmethod-first-arg=cls
+
+# List of valid names for the first argument in a metaclass class method.
+valid-metaclass-classmethod-first-arg=cls
+
+
+[EXCEPTIONS]
+
+# Exceptions that will emit a warning when being caught. Defaults to
+# "Exception".
+overgeneral-exceptions=Exception
diff --git a/contrib/python/podman/podman/__init__.py b/contrib/python/podman/podman/__init__.py
index 3b083f007..1cdb72773 100644
--- a/contrib/python/podman/podman/__init__.py
+++ b/contrib/python/podman/podman/__init__.py
@@ -2,9 +2,12 @@
import pkg_resources
from .client import Client
-from .libs import datetime_format, datetime_parse
+from .libs import FoldedString, datetime_format, datetime_parse
from .libs.errors import (ContainerNotFound, ErrorOccurred, ImageNotFound,
- PodmanError)
+ NoContainerRunning, NoContainersInPod,
+ PodContainerError, PodmanError, PodNotFound)
+
+assert FoldedString
try:
__version__ = pkg_resources.get_distribution('podman').version
@@ -18,5 +21,9 @@ __all__ = [
'datetime_parse',
'ErrorOccurred',
'ImageNotFound',
+ 'NoContainerRunning',
+ 'NoContainersInPod',
+ 'PodContainerError',
'PodmanError',
+ 'PodNotFound',
]
diff --git a/contrib/python/podman/podman/client.py b/contrib/python/podman/podman/client.py
index 24df65e23..ad603166e 100644
--- a/contrib/python/podman/podman/client.py
+++ b/contrib/python/podman/podman/client.py
@@ -13,6 +13,7 @@ from .libs.errors import error_factory
from .libs.images import Images
from .libs.system import System
from .libs.tunnel import Context, Portal, Tunnel
+from .libs.pods import Pods
class BaseClient():
@@ -204,3 +205,8 @@ class Client():
def containers(self):
"""Manage containers model for libpod."""
return Containers(self._client)
+
+ @cached_property
+ def pods(self):
+ """Manage pods model for libpod."""
+ return Pods(self._client)
diff --git a/contrib/python/podman/podman/libs/__init__.py b/contrib/python/podman/podman/libs/__init__.py
index e9859bee5..5193313ed 100644
--- a/contrib/python/podman/podman/libs/__init__.py
+++ b/contrib/python/podman/podman/libs/__init__.py
@@ -7,8 +7,9 @@ from dateutil.parser import parse as dateutil_parse
__all__ = [
'cached_property',
- 'datetime_parse',
'datetime_format',
+ 'datetime_parse',
+ 'fold_keys',
]
@@ -17,12 +18,12 @@ def cached_property(fn):
return property(functools.lru_cache(maxsize=8)(fn))
-class Config(collections.UserDict):
+class ConfigDict(collections.UserDict):
"""Silently ignore None values, only take key once."""
def __init__(self, **kwargs):
"""Construct dictionary."""
- super(Config, self).__init__(kwargs)
+ super().__init__(kwargs)
def __setitem__(self, key, value):
"""Store unique, not None values."""
@@ -35,6 +36,25 @@ class Config(collections.UserDict):
super().__setitem__(key, value)
+class FoldedString(collections.UserString):
+ """Foldcase sequences value."""
+
+ def __init__(self, seq):
+ super().__init__(seq)
+ self.data.casefold()
+
+
+def fold_keys(): # noqa: D202
+ """Fold case of dictionary keys."""
+
+ @functools.wraps(fold_keys)
+ def wrapped(mapping):
+ """Fold case of dictionary keys."""
+ return {k.casefold(): v for (k, v) in mapping.items()}
+
+ return wrapped
+
+
def datetime_parse(string):
"""Convert timestamps to datetime.
diff --git a/contrib/python/podman/podman/libs/errors.py b/contrib/python/podman/podman/libs/errors.py
index 9d7559c84..1b94344c4 100644
--- a/contrib/python/podman/podman/libs/errors.py
+++ b/contrib/python/podman/podman/libs/errors.py
@@ -25,13 +25,25 @@ class VarlinkErrorProxy(VarlinkError):
class ContainerNotFound(VarlinkErrorProxy):
"""Raised when Client can not find requested container."""
- pass
-
class ImageNotFound(VarlinkErrorProxy):
"""Raised when Client can not find requested image."""
- pass
+
+class PodNotFound(VarlinkErrorProxy):
+ """Raised when Client can not find requested image."""
+
+
+class PodContainerError(VarlinkErrorProxy):
+ """Raised when a container fails requested pod operation."""
+
+
+class NoContainerRunning(VarlinkErrorProxy):
+ """Raised when no container is running in pod."""
+
+
+class NoContainersInPod(VarlinkErrorProxy):
+ """Raised when Client fails to connect to runtime."""
class ErrorOccurred(VarlinkErrorProxy):
@@ -40,19 +52,19 @@ class ErrorOccurred(VarlinkErrorProxy):
See error() to see actual error text.
"""
- pass
-
class PodmanError(VarlinkErrorProxy):
"""Raised when Client fails to connect to runtime."""
- pass
-
ERROR_MAP = {
'io.podman.ContainerNotFound': ContainerNotFound,
'io.podman.ErrorOccurred': ErrorOccurred,
'io.podman.ImageNotFound': ImageNotFound,
+ 'io.podman.NoContainerRunning': NoContainerRunning,
+ 'io.podman.NoContainersInPod': NoContainersInPod,
+ 'io.podman.PodContainerError': PodContainerError,
+ 'io.podman.PodNotFound': PodNotFound,
'io.podman.RuntimeError': PodmanError,
}
diff --git a/contrib/python/podman/podman/libs/images.py b/contrib/python/podman/podman/libs/images.py
index 547994798..325ee46f4 100644
--- a/contrib/python/podman/podman/libs/images.py
+++ b/contrib/python/podman/podman/libs/images.py
@@ -5,7 +5,7 @@ import functools
import json
import logging
-from . import Config
+from . import ConfigDict
from .containers import Container
@@ -40,7 +40,7 @@ class Image(collections.UserDict):
"""
details = self.inspect()
- config = Config(image_id=self._id, **kwargs)
+ config = ConfigDict(image_id=self._id, **kwargs)
config['command'] = details.containerconfig['cmd']
config['env'] = self._split_token(details.containerconfig['env'])
config['image'] = copy.deepcopy(details.repotags[0])
@@ -134,7 +134,7 @@ class Images():
elif not hasattr(tags, '__iter__'):
raise ValueError('"tags" is required to be an iter.')
- config = Config(dockerfile=dockerfile, tags=tags, **kwargs)
+ config = ConfigDict(dockerfile=dockerfile, tags=tags, **kwargs)
with self._client() as podman:
result = podman.BuildImage(config)
return self.get(result['image']['id']), \
diff --git a/contrib/python/podman/podman/libs/pods.py b/contrib/python/podman/podman/libs/pods.py
new file mode 100644
index 000000000..6aec2c186
--- /dev/null
+++ b/contrib/python/podman/podman/libs/pods.py
@@ -0,0 +1,164 @@
+"""Model for accessing details of Pods from podman service."""
+import collections
+import json
+import signal
+import time
+
+from . import ConfigDict, FoldedString, fold_keys
+
+
+class Pod(collections.UserDict):
+ """Model for a Pod."""
+
+ def __init__(self, client, ident, data):
+ """Construct Pod model."""
+ super().__init__(data)
+
+ self._ident = ident
+ self._client = client
+
+ with client() as podman:
+ self._refresh(podman)
+
+ def _refresh(self, podman):
+ pod = podman.GetPod(self._ident)
+ super().update(pod['pod'])
+
+ for k, v in self.data.items():
+ setattr(self, k, v)
+ return self
+
+ def inspect(self):
+ """Retrieve details about pod."""
+ with self._client() as podman:
+ results = podman.InspectPod(self._ident)
+ obj = json.loads(results['pod'], object_hook=fold_keys())
+ obj['id'] = obj['config']['id']
+ return collections.namedtuple('PodInspect', obj.keys())(**obj)
+
+ def kill(self, signal_=signal.SIGTERM, wait=25):
+ """Send signal to all containers in pod.
+
+ default signal is signal.SIGTERM.
+ wait n of seconds, 0 waits forever.
+ """
+ running = FoldedString(self.status)
+
+ with self._client() as podman:
+ podman.KillPod(self._ident, signal_)
+ timeout = time.time() + wait
+ while True:
+ # pylint: disable=maybe-no-member
+ self._refresh(podman)
+ if running != 'running':
+ return self
+
+ if wait and timeout < time.time():
+ raise TimeoutError()
+
+ time.sleep(0.5)
+ return self
+
+ def pause(self):
+ """Pause all containers in the pod."""
+ with self._client() as podman:
+ podman.PausePod(self._ident)
+ return self._refresh(podman)
+
+ def refresh(self):
+ """Refresh status fields for this pod."""
+ with self._client() as podman:
+ return self._refresh(podman)
+
+ def remove(self, force=False):
+ """Remove all containers in the pod, the pod, return pod ident.
+
+ force=True, stop any running container.
+ """
+ with self._client() as podman:
+ results = podman.RemovePod(self._ident, force)
+ return results['pod']
+
+ def restart(self):
+ """Restart all containers in the pod."""
+ with self._client() as podman:
+ podman.RestartPod(self._ident)
+ return self._refresh(podman)
+
+ def stats(self):
+ """Stats on all containers in the pod."""
+ with self._client() as podman:
+ results = podman.GetPodStats(self._ident)
+ for obj in results['containers']:
+ yield collections.namedtuple('ContainerStats', obj.keys())(**obj)
+
+ def start(self):
+ """Start all containers in the pod."""
+ with self._client() as podman:
+ podman.StartPod(self._ident)
+ return self._refresh(podman)
+
+ def stop(self):
+ """Stop all containers in the pod."""
+ with self._client() as podman:
+ podman.StopPod(self._ident)
+ return self._refresh(podman)
+
+ def top(self):
+ """Display stats for all containers exit."""
+ with self._client() as podman:
+ results = podman.TopPod(self._ident)
+ return results['pod']
+
+ def unpause(self):
+ """Unpause all containers in the pod."""
+ with self._client() as podman:
+ podman.UnpausePod(self._ident)
+ return self._refresh(podman)
+
+ def wait(self):
+ """Wait for all containers to exit."""
+ with self._client() as podman:
+ results = podman.WaitPod(self._ident)
+ return results['pod']
+
+
+class Pods():
+ """Model for accessing pods."""
+
+ def __init__(self, client):
+ """Construct pod model."""
+ self._client = client
+
+ def create(self,
+ ident,
+ cgroupparent=None,
+ labels=None,
+ share=None,
+ infra=False):
+ """Create a new empty pod."""
+ config = ConfigDict(
+ name=ident,
+ cgroupParent=cgroupparent,
+ labels=labels,
+ share=share,
+ infra=infra,
+ )
+
+ with self._client() as podman:
+ result = podman.CreatePod(config)
+ details = podman.GetPod(result['pod'])
+ return Pod(self._client, result['pod'], details['pod'])
+
+ def get(self, ident):
+ """Get Pod from ident."""
+ with self._client() as podman:
+ result = podman.GetPod(ident)
+ return Pod(self._client, result['pod']['id'], result['pod'])
+
+ def list(self):
+ """List all pods."""
+ with self._client() as podman:
+ results = podman.ListPods()
+ for pod in results['pods']:
+ yield Pod(self._client, pod['id'], pod)
diff --git a/contrib/python/podman/test/test_pods_ctnrs.py b/contrib/python/podman/test/test_pods_ctnrs.py
new file mode 100644
index 000000000..c5733091c
--- /dev/null
+++ b/contrib/python/podman/test/test_pods_ctnrs.py
@@ -0,0 +1,65 @@
+import os
+from test.podman_testcase import PodmanTestCase
+
+import podman
+from podman import FoldedString
+
+pod = None
+
+
+class TestPodsCtnrs(PodmanTestCase):
+ @classmethod
+ def setUpClass(cls):
+ # Populate storage
+ super().setUpClass()
+
+ @classmethod
+ def tearDownClass(cls):
+ super().tearDownClass()
+
+ def setUp(self):
+ self.tmpdir = os.environ['TMPDIR']
+ self.host = os.environ['PODMAN_HOST']
+
+ self.pclient = podman.Client(self.host)
+
+ def test_010_populate(self):
+ global pod
+
+ pod = self.pclient.pods.create('pod1')
+ self.assertEqual('pod1', pod.name)
+
+ img = self.pclient.images.get('docker.io/library/alpine:latest')
+ ctnr = img.container(pod=pod.id)
+
+ pod.refresh()
+ self.assertEqual('1', pod.numberofcontainers)
+ self.assertEqual(ctnr.id, pod.containersinfo[0]['id'])
+
+ def test_015_one_shot(self):
+ global pod
+
+ details = pod.inspect()
+ state = FoldedString(details.containers[0]['state'])
+ self.assertEqual(state, 'configured')
+
+ pod = pod.start()
+ status = FoldedString(pod.containersinfo[0]['status'])
+ # Race on whether container is still running or finished
+ self.assertIn(status, ('exited', 'running'))
+
+ pod = pod.restart()
+ status = FoldedString(pod.containersinfo[0]['status'])
+ self.assertIn(status, ('exited', 'running'))
+
+ killed = pod.kill()
+ self.assertEqual(pod, killed)
+
+ def test_999_remove(self):
+ global pod
+
+ ident = pod.remove(force=True)
+ self.assertEqual(ident, pod.id)
+
+ with self.assertRaises(StopIteration):
+ next(self.pclient.pods.list())
diff --git a/contrib/python/podman/test/test_pods_no_ctnrs.py b/contrib/python/podman/test/test_pods_no_ctnrs.py
new file mode 100644
index 000000000..48b4f74e4
--- /dev/null
+++ b/contrib/python/podman/test/test_pods_no_ctnrs.py
@@ -0,0 +1,94 @@
+import os
+import unittest
+
+import podman
+import varlink
+
+ident = None
+pod = None
+
+
+class TestPodsNoCtnrs(unittest.TestCase):
+ def setUp(self):
+ self.tmpdir = os.environ['TMPDIR']
+ self.host = os.environ['PODMAN_HOST']
+
+ self.pclient = podman.Client(self.host)
+
+ def test_010_create(self):
+ global ident
+
+ actual = self.pclient.pods.create('pod0')
+ self.assertIsNotNone(actual)
+ ident = actual.id
+
+ def test_015_list(self):
+ global ident, pod
+
+ actual = next(self.pclient.pods.list())
+ self.assertEqual('pod0', actual.name)
+ self.assertEqual(ident, actual.id)
+ self.assertEqual('Created', actual.status)
+ self.assertEqual('0', actual.numberofcontainers)
+ self.assertFalse(actual.containersinfo)
+ pod = actual
+
+ def test_020_get(self):
+ global ident, pod
+
+ actual = self.pclient.pods.get(pod.id)
+ self.assertEqual('pod0', actual.name)
+ self.assertEqual(ident, actual.id)
+ self.assertEqual('Created', actual.status)
+ self.assertEqual('0', actual.numberofcontainers)
+ self.assertFalse(actual.containersinfo)
+
+ def test_025_inspect(self):
+ global ident, pod
+
+ details = pod.inspect()
+ self.assertEqual(ident, details.id)
+ self.assertEqual('pod0', details.config['name'])
+ self.assertIsNone(details.containers)
+
+ def test_030_ident_no_ctnrs(self):
+ global ident, pod
+
+ actual = pod.kill()
+ self.assertEqual(pod, actual)
+
+ actual = pod.pause()
+ self.assertEqual(pod, actual)
+
+ actual = pod.unpause()
+ self.assertEqual(pod, actual)
+
+ actual = pod.stop()
+ self.assertEqual(pod, actual)
+
+ def test_045_raises_no_ctnrs(self):
+ global ident, pod
+
+ with self.assertRaises(podman.NoContainersInPod):
+ pod.start()
+
+ with self.assertRaises(podman.NoContainersInPod):
+ pod.restart()
+
+ with self.assertRaises(podman.NoContainerRunning):
+ next(pod.stats())
+
+ with self.assertRaises(varlink.error.MethodNotImplemented):
+ pod.top()
+
+ with self.assertRaises(varlink.error.MethodNotImplemented):
+ pod.wait()
+
+ def test_999_remove(self):
+ global ident, pod
+
+ actual = pod.remove()
+ self.assertEqual(ident, actual)
+
+ with self.assertRaises(StopIteration):
+ next(self.pclient.pods.list())
diff --git a/contrib/python/podman/test/test_runner.sh b/contrib/python/podman/test/test_runner.sh
index 76432cf47..ce518e7ed 100755
--- a/contrib/python/podman/test/test_runner.sh
+++ b/contrib/python/podman/test/test_runner.sh
@@ -14,7 +14,7 @@ fi
export PATH=../../../bin:$PATH
function usage {
- echo 1>&2 $0 [-v] [-h] [test.TestCase|test.TestCase.step]
+ echo 1>&2 $0 '[-v] [-h] [test.<TestCase>|test.<TestCase>.<step>]'
}
while getopts "vh" arg; do