kiwi-stackbuild-plugin 1.0.7__tar.gz → 1.0.10__tar.gz

{kiwi_stackbuild_plugin-1.0.7 → kiwi_stackbuild_plugin-1.0.10}/.bumpversion.cfg

@@ -1,9 +1,8 @@
 [bumpversion]
-current_version = 1.0.7
+current_version = 1.0.10
 commit = True
 tag = True
 
 [bumpversion:file:kiwi_stackbuild_plugin/version.py]
 
 [bumpversion:file:doc/source/conf.py]
-

{kiwi_stackbuild_plugin-1.0.7 → kiwi_stackbuild_plugin-1.0.10}/Makefile

@@ -10,7 +10,7 @@ version := $(shell \
 )
 
 tox:
-	tox "-n 5"
+	tox
 
 install:
 	# install plugin manual page and license/readme

{kiwi_stackbuild_plugin-1.0.7 → kiwi_stackbuild_plugin-1.0.10}/PKG-INFO

@@ -1,13 +1,12 @@
 Metadata-Version: 2.1
 Name: kiwi_stackbuild_plugin
-Version: 1.0.7
+Version: 1.0.10
 Summary: KIWI - Stack Build Plugin
 Home-page: https://github.com/OSInside/kiwi-stackbuild-plugin
+Download-URL: https://download.opensuse.org/repositories/Virtualization:/Appliances:/Builder
 Author: Marcus Schaefer
 Author-email: ms@suse.com
 License: GPLv3+
-Download-URL: https://download.opensuse.org/repositories/Virtualization:/Appliances:/Builder
-Platform: UNKNOWN
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
@@ -16,6 +15,9 @@ Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Topic :: System :: Operating System
 License-File: LICENSE
+Requires-Dist: docopt
+Requires-Dist: mock
+Requires-Dist: kiwi>=9.23.0
 
 KIWI - Stack Build Plugin
 =========================
@@ -29,5 +31,3 @@ This [KIWI](https://osinside.github.io/kiwi/) plugin allows to store
 and reuse KIWI built root-trees as OCI containers. The idea is using OCI images
 as portable format to store and distribute a root-tree, so they can be pushed
 and pulled from OCI registries.
-
-

kiwi_stackbuild_plugin-1.0.10/doc/build/man/kiwi::system::stackbuild.8

@@ -0,0 +1,160 @@
+.\" Man page generated from reStructuredText.
+.
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.TH "KIWI::SYSTEM::STACKBUILD" "8" "May 13, 2024" "1.0.10" "KIWI - Stack Build Plugin"
+.SH NAME
+kiwi::system::stackbuild \- Stack Build Plugin
+.SH SYNOPSIS
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+kiwi\-ng system stackbuild \-h | \-\-help
+kiwi\-ng system stackbuild \-\-stash=<name>... \-\-description=<directory> \-\-target\-dir=<directory>
+    [\-\-from\-registry=<URI>]
+    [\-\- <kiwi_build_command_args>...]
+kiwi\-ng system stackbuild \-\-stash=<name>... \-\-target\-dir=<directory>
+    [\-\-from\-registry=<URI>]
+    [\-\- <kiwi_create_command_args>...]
+kiwi\-ng system stackbuild help
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SH DESCRIPTION
+.sp
+This [KIWI](\X'tty: link https://osinside.github.io/kiwi/'\fI\%https://osinside.github.io/kiwi/\fP\X'tty: link') plugin allows to store
+and reuse KIWI built root\-trees as OCI containers. The idea is using OCI images
+as portable format to store and distribute a root\-tree, so they can be pushed
+and pulled from OCI registries.
+.sp
+This plugin allows the user to operate in two modes
+.INDENT 0.0
+.IP 1. 3
+Rebuild an image from a stash
+.sp
+In this mode \fBstackbuild\fP takes a stash, makes it available to the
+local registry and builds the image using the stash rootfs and
+in stash stored image description.
+.INDENT 3.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+$ kiwi\-ng system stackbuild \-\-stash NAME \e
+    \-\-target\-dir /target/rebuild
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.IP 2. 3
+Build an image based on a stash
+.sp
+In this mode \fBstackbuild\fP takes a stash, makes it available to the
+local registry and uses the stash rootfs as the base for an image
+build of another image description.
+.INDENT 3.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+$ kiwi\-ng system stackbuild \-\-stash NAME \e
+    \-\-description=/some/image\-description \-\-target\-dir /target/rebuild
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+\fBNOTE:\fP
+.INDENT 3.0
+.INDENT 3.5
+The stackbuild plugin does not perform any consistency check
+if the used stash rootfs is compatible with the provided image
+description. With that in mind there is nothing which would
+prevent you from using a Leap stash and try to build a Fedora
+image on top of it. That an attempt like this will not produce
+anything useful should be clear to the user and is in the
+users responsibility to prevent combining apples with pears
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SH OPTIONS
+.INDENT 0.0
+.TP
+.BI \-\-stash\fB= <name>
+Name of the stash. See \fBsystem stash \-\-list\fP for available stashes.
+Multiple stashes will be stacked together in the given order
+.TP
+.BI \-\-from\-registry\fB= <URI>
+Pull given stash container name from the provided
+registry URI
+.TP
+.BI \-\-description\fB= <directory>
+Path to the XML description. This is a directory containing at least
+one _config.xml_ or _*.kiwi_ XML file.
+.TP
+.BI \-\-target\-dir\fB= <directory>
+Path to store the build results.
+.UNINDENT
+.sp
+\-\- <kiwi_build_command_args>...
+.INDENT 0.0
+.INDENT 3.5
+List of command parameters as supported by the kiwi\-ng
+build command. The information given here is passed
+along to the \fBkiwi\-ng system build\fP command.
+.UNINDENT
+.UNINDENT
+.sp
+\-\- <kiwi_create_command_args>...
+.INDENT 0.0
+.INDENT 3.5
+List of command parameters as supported by the kiwi\-ng
+build command. The information given here is passed
+along to the \fBkiwi\-ng system create\fP command.
+.UNINDENT
+.UNINDENT
+.SH EXAMPLE
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+$ kiwi\-ng system stackbuild \-\-stash NAME \-\-target\-dir /target/rebuild
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SH AUTHOR
+Marcus Schäfer
+.SH COPYRIGHT
+2021, Marcus Schäfer
+.\" Generated by docutils manpage writer.
+.

kiwi_stackbuild_plugin-1.0.10/doc/build/man/kiwi::system::stash.8

@@ -0,0 +1,90 @@
+.\" Man page generated from reStructuredText.
+.
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.TH "KIWI::SYSTEM::STASH" "8" "May 13, 2024" "1.0.10" "KIWI - Stack Build Plugin"
+.SH NAME
+kiwi::system::stash \- Stack Build Plugin
+.SH SYNOPSIS
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+kiwi\-ng [global options] service <command> [<args>]
+
+kiwi\-ng system stash \-h | \-\-help
+kiwi\-ng system stash \-\-root=<directory>
+    [\-\-tag=<name>]
+    [\-\-container\-name=<name>]
+kiwi\-ng system stash \-\-list
+kiwi\-ng system stash help
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SH DESCRIPTION
+.sp
+Create a container from the given root directory. The command
+takes the contents of the given root directory at call time
+and creates a container from it.
+.SH OPTIONS
+.INDENT 0.0
+.TP
+.BI \-\-root\fB= <directory>
+The path to the root directory, usually the result of
+a former system prepare or build call
+.TP
+.BI \-\-tag\fB= <name>
+The tag name for the container. By default \(aqlatest\(aq
+is used
+.TP
+.BI \-\-container\-name\fB= <name>
+The name of the container. By default
+set to the image name of the stash
+.TP
+.B  \-\-list
+list the available stashes
+.UNINDENT
+.SH EXAMPLE
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+$ kiwi\-ng system stash \-\-root /tmp/mytest/build/image\-root
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SH AUTHOR
+Marcus Schäfer
+.SH COPYRIGHT
+2021, Marcus Schäfer
+.\" Generated by docutils manpage writer.
+.

{kiwi_stackbuild_plugin-1.0.7 → kiwi_stackbuild_plugin-1.0.10}/kiwi_stackbuild_plugin/tasks/system_stackbuild.py

@@ -196,7 +196,7 @@ class SystemStackbuildTask(CliTask):
             )
         )
         validated_create_command = docopt(
-            doc=kiwi.tasks.system_create.__doc__,
+            kiwi.tasks.system_create.__doc__,
             argv=kiwi_create_command
         )
         # rebuild kiwi create command from validated docopt parser result
@@ -221,7 +221,7 @@ class SystemStackbuildTask(CliTask):
             )
         )
         validated_build_command = docopt(
-            doc=kiwi.tasks.system_build.__doc__,
+            kiwi.tasks.system_build.__doc__,
             argv=kiwi_build_command
         )
         # rebuild kiwi build command from validated docopt parser result

{kiwi_stackbuild_plugin-1.0.7 → kiwi_stackbuild_plugin-1.0.10}/kiwi_stackbuild_plugin/version.py

@@ -18,5 +18,5 @@
 """
 Global version information used in kiwi-rebuild-plugin and the package
 """
-__version__ = '1.0.7'
+__version__ = '1.0.10'
 __githash__ = '$Format:%H$'

{kiwi_stackbuild_plugin-1.0.7 → kiwi_stackbuild_plugin-1.0.10}/kiwi_stackbuild_plugin.egg-info/PKG-INFO

@@ -1,13 +1,12 @@
 Metadata-Version: 2.1
-Name: kiwi-stackbuild-plugin
-Version: 1.0.7
+Name: kiwi_stackbuild_plugin
+Version: 1.0.10
 Summary: KIWI - Stack Build Plugin
 Home-page: https://github.com/OSInside/kiwi-stackbuild-plugin
+Download-URL: https://download.opensuse.org/repositories/Virtualization:/Appliances:/Builder
 Author: Marcus Schaefer
 Author-email: ms@suse.com
 License: GPLv3+
-Download-URL: https://download.opensuse.org/repositories/Virtualization:/Appliances:/Builder
-Platform: UNKNOWN
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
@@ -16,6 +15,9 @@ Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Topic :: System :: Operating System
 License-File: LICENSE
+Requires-Dist: docopt
+Requires-Dist: mock
+Requires-Dist: kiwi>=9.23.0
 
 KIWI - Stack Build Plugin
 =========================
@@ -29,5 +31,3 @@ This [KIWI](https://osinside.github.io/kiwi/) plugin allows to store
 and reuse KIWI built root-trees as OCI containers. The idea is using OCI images
 as portable format to store and distribute a root-tree, so they can be pushed
 and pulled from OCI registries.
-
-

{kiwi_stackbuild_plugin-1.0.7 → kiwi_stackbuild_plugin-1.0.10}/kiwi_stackbuild_plugin.egg-info/SOURCES.txt

@@ -8,6 +8,8 @@ README.rst
 setup.cfg
 setup.py
 tox.ini
+doc/build/man/kiwi::system::stackbuild.8
+doc/build/man/kiwi::system::stash.8
 kiwi_stackbuild_plugin/__init__.py
 kiwi_stackbuild_plugin/defaults.py
 kiwi_stackbuild_plugin/exceptions.py

{kiwi_stackbuild_plugin-1.0.7 → kiwi_stackbuild_plugin-1.0.10}/kiwi_stackbuild_plugin.egg-info/entry_points.txt

@@ -1,4 +1,3 @@
 [kiwi.tasks]
 system_stackbuild = kiwi_stackbuild_plugin.tasks.system_stackbuild
 system_stash = kiwi_stackbuild_plugin.tasks.system_stash
-

{kiwi_stackbuild_plugin-1.0.7 → kiwi_stackbuild_plugin-1.0.10}/tox.ini

@@ -10,26 +10,35 @@
 #    $ tox -e doc
 #
 [tox]
+minversion = 3.3.0
+isolated_build = True
 skip_missing_interpreters = True
 skipsdist = True
 envlist =
     check,
-    unit_py3_8,
-    unit_py3_6,
+    unit_py3_11,
+    unit_py3_10,
     doc
 
+
 [testenv]
-whitelist_externals = *
+description =
+    {unit_py3_10,unit_py3_11}: Unit Test run with basepython set to {basepython}
+allowlist_externals =
+    bash
+    travis-sphinx
+    cp
+    make
+    rm
+    mv
+    flake8
+    python
+    pytest
 basepython =
     {check,devel,doc}: python3
-    unit_py3_8: python3.8
-    unit_py3_6: python3.6
-    release: python3.6
-envdir =
-    {check,devel,doc}: {toxworkdir}/3
-    unit_py3_8: {toxworkdir}/3.8
-    unit_py3_6: {toxworkdir}/3.6
-    release: {toxworkdir}/3.6
+    unit_py3_11: python3.11
+    unit_py3_10: python3.10
+    release: python3.10
 passenv =
     *
 usedevelop = True
@@ -37,32 +46,29 @@ deps =
     -r.virtualenv.dev-requirements.txt
 
 
-# Unit Test run with basepython set to 3.6
-[testenv:unit_py3_6]
-skip_install = True
-usedevelop = True
+# Unit Test run with basepython set to 3.10
+[testenv:unit_py3_10]
 setenv =
     PYTHONPATH={toxinidir}/test
-    PYTHONUNBUFFERED=yes
-    WITH_COVERAGE=yes
-passenv =
-    *
-deps = {[testenv]deps}
 changedir=test/unit
 commands =
-    bash -c 'cd ../../ && ./setup.py develop'
-    bash -c 'cd ../../ && mypy kiwi_stackbuild_plugin test/unit'
-    pytest --no-cov-on-fail --cov=kiwi_stackbuild_plugin \
-        --cov-report=term-missing \
-        --cov-fail-under=100 {posargs}
+    {[testenv:unit]commands}
 
 
-# Unit Test run with basepython set to 3.8
-[testenv:unit_py3_8]
+# Unit Test run with basepython set to 3.11
+[testenv:unit_py3_11]
+setenv =
+    PYTHONPATH={toxinidir}/test
+changedir=test/unit
+commands =
+    {[testenv:unit]commands}
+
+
+[testenv:unit]
+description = Unit Test Base
 skip_install = True
 usedevelop = True
 setenv =
-    PYTHONPATH={toxinidir}/test
     PYTHONUNBUFFERED=yes
     WITH_COVERAGE=yes
 passenv =
@@ -71,10 +77,11 @@ deps = {[testenv]deps}
 changedir=test/unit
 commands =
     bash -c 'cd ../../ && ./setup.py develop'
-    bash -c 'cd ../../ && mypy kiwi_stackbuild_plugin test/unit'
+    bash -c 'cd ../../ && mypy --install-types --non-interactive kiwi_stackbuild_plugin'
     pytest --doctest-modules --no-cov-on-fail --cov=kiwi_stackbuild_plugin \
-        --cov-report=term-missing \
-        --cov-fail-under=100 {posargs}
+        --cov-report=term-missing --cov-fail-under=100 \
+        --cov-config .coveragerc {posargs}
+
 
 # Documentation build suitable for local review
 [testenv:doc]
@@ -85,6 +92,7 @@ changedir=doc
 commands =
     {[testenv:doc.man]commands}
 
+
 # Documentation build man pages
 [testenv:doc.man]
 skip_install = True
@@ -104,7 +112,7 @@ commands =
     flake8 --statistics -j auto --count {toxinidir}/test/unit
 
 
-# PyPi prepare for upload
+# PyPi upload
 [testenv:release]
 deps = {[testenv]deps}
 skip_install = True