docs-wip

next-actions · Sep 13, 2024 · fb4837f · fb4837f
1 parent 0a1791f
commit fb4837f
Show file tree

Hide file tree

Showing 196 changed files with 22,596 additions and 674 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -19,8 +19,8 @@ jobs:
     permissions:
       contents: read
     steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-python@v4
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
@@ -39,18 +39,50 @@ jobs:
     permissions:
       contents: read
     steps:
-    - uses: actions/setup-python@v4
+    - uses: actions/setup-python@v5
       with:
         python-version: 3.11
 
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
-    - name: Setup containers
-      uses: SSSD/sssd-ci-containers/actions/setup@master
-      with:
-        path: sssd-ci-containers
-        limit: dns client kdc
+    - name: Install dependencies
+      shell: bash
+      run: |
+        set -ex
+        sudo apt-get update
+        sudo apt-get install -y podman docker-compose
+
+    - name: Workaround https://github.com/actions/runner-images/issues/7753
+      shell: bash
+      run: |
+        curl -O http://archive.ubuntu.com/ubuntu/pool/universe/g/golang-github-containernetworking-plugins/containernetworking-plugins_1.1.1+ds1-3_amd64.deb
+        sudo dpkg -i containernetworking-plugins_1.1.1+ds1-3_amd64.deb
+        rm --force containernetworking-plugins_1.1.1+ds1-3_amd64.deb
+
+    - name: Workaround https://github.com/containers/crun/issues/1308
+      shell: bash
+      run: |
+        CRUN_VER='1.11.2'
+        sudo curl -L "https://github.com/containers/crun/releases/download/${CRUN_VER}/crun-${CRUN_VER}-linux-amd64" -o "/usr/bin/crun"
+        sudo chmod +x "/usr/bin/crun"
+        crun --version
+
+    - name: Start podman socket
+      shell: bash
+      run: |
+        sudo systemctl enable podman.socket
+        sudo systemctl restart podman.socket
+
+    - name: Build containers
+      working-directory: example/containers
+      run: |
+        sudo docker-compose -H unix:///run/podman/podman.sock build
+
+    - name: Start containers
+      working-directory: example/containers
+      run: |
+        sudo docker-compose -H unix:///run/podman/podman.sock up --detach
 
     - name: Install packages
       run: |
@@ -60,9 +92,11 @@ jobs:
         pip3 install virtualenv
         python3 -m venv .venv
         source .venv/bin/activate
+        pip3 install -e .
         pip3 install -r ./requirements.txt
+        pip3 install -r ./example/requirements.txt
 
     - name: Run example tests
       run: |
         source .venv/bin/activate
-        pytest --color=yes --mh-config=./example/mhc.yaml -vv ./example
+        pytest --color=yes --mh-config=./example/mhc.yaml -vvv ./example
diff --git a/docs.bak/Makefile b/docs.bak/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs.bak/_build/doctrees/api.doctree b/docs.bak/_build/doctrees/api.doctree
diff --git a/docs.bak/_build/doctrees/api/pytest_mh.cli.doctree b/docs.bak/_build/doctrees/api/pytest_mh.cli.doctree
diff --git a/docs.bak/_build/doctrees/api/pytest_mh.doctree b/docs.bak/_build/doctrees/api/pytest_mh.doctree
diff --git a/docs.bak/_build/doctrees/api/pytest_mh.ssh.doctree b/docs.bak/_build/doctrees/api/pytest_mh.ssh.doctree
diff --git a/docs.bak/_build/doctrees/api/pytest_mh.utils.doctree b/docs.bak/_build/doctrees/api/pytest_mh.utils.doctree
diff --git a/docs.bak/_build/doctrees/api/pytest_mh.utils.firewall.doctree b/docs.bak/_build/doctrees/api/pytest_mh.utils.firewall.doctree
diff --git a/docs.bak/_build/doctrees/api/pytest_mh.utils.fs.doctree b/docs.bak/_build/doctrees/api/pytest_mh.utils.fs.doctree
diff --git a/docs.bak/_build/doctrees/api/pytest_mh.utils.journald.doctree b/docs.bak/_build/doctrees/api/pytest_mh.utils.journald.doctree
diff --git a/docs.bak/_build/doctrees/api/pytest_mh.utils.services.doctree b/docs.bak/_build/doctrees/api/pytest_mh.utils.services.doctree
diff --git a/docs.bak/_build/doctrees/api/pytest_mh.utils.tc.doctree b/docs.bak/_build/doctrees/api/pytest_mh.utils.tc.doctree
diff --git a/docs.bak/_build/doctrees/classes.doctree b/docs.bak/_build/doctrees/classes.doctree
diff --git a/docs.bak/_build/doctrees/config.doctree b/docs.bak/_build/doctrees/config.doctree
diff --git a/docs.bak/_build/doctrees/environment.pickle b/docs.bak/_build/doctrees/environment.pickle
diff --git a/docs.bak/_build/doctrees/index.doctree b/docs.bak/_build/doctrees/index.doctree
diff --git a/docs.bak/_build/doctrees/pytest.doctree b/docs.bak/_build/doctrees/pytest.doctree
diff --git a/docs.bak/_build/doctrees/quick-start.doctree b/docs.bak/_build/doctrees/quick-start.doctree
diff --git a/docs.bak/_build/doctrees/runtime-requirements.doctree b/docs.bak/_build/doctrees/runtime-requirements.doctree
diff --git a/docs.bak/_build/doctrees/topology.doctree b/docs.bak/_build/doctrees/topology.doctree
diff --git a/docs.bak/_build/html/.buildinfo b/docs.bak/_build/html/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 2ee3f1b99120090e966b0df365817b0a
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs.bak/_build/html/_sources/api.rst.txt b/docs.bak/_build/html/_sources/api.rst.txt
@@ -0,0 +1,12 @@
+API Reference
+=============
+
+.. autosummary::
+   :toctree: api
+   :nosignatures:
+   :recursive:
+
+   pytest_mh
+   pytest_mh.cli
+   pytest_mh.ssh
+   pytest_mh.utils
diff --git a/docs.bak/_build/html/_sources/api/pytest_mh.cli.rst.txt b/docs.bak/_build/html/_sources/api/pytest_mh.cli.rst.txt
@@ -0,0 +1,41 @@
+pytest\_mh.cli
+==============
+
+.. automodule:: pytest_mh.cli
+
+
+
+   .. rubric:: Module Attributes
+
+   .. autosummary::
+
+      CLIBuilderArgs
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Any
+      CLIBuilder
+      Enum
+      SSHClient
+      SSHPowerShellProcess
+      SSHProcess
+      auto
+
+
+
+
+
+
+
+
+
diff --git a/docs.bak/_build/html/_sources/api/pytest_mh.rst.txt b/docs.bak/_build/html/_sources/api/pytest_mh.rst.txt
@@ -0,0 +1,53 @@
+pytest\_mh
+==========
+
+.. automodule:: pytest_mh
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      mh
+      pytest_addoption
+      pytest_configure
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      KnownTopologyBase
+      KnownTopologyGroupBase
+      MultihostConfig
+      MultihostDomain
+      MultihostFixture
+      MultihostHost
+      MultihostHostArtifacts
+      MultihostItemData
+      MultihostOSFamily
+      MultihostPlugin
+      MultihostRole
+      MultihostTopologyControllerArtifacts
+      MultihostUtility
+      Topology
+      TopologyController
+      TopologyDomain
+      TopologyMark
+
+
+
+
+
+
+
+
+
diff --git a/docs.bak/_build/html/_sources/api/pytest_mh.ssh.rst.txt b/docs.bak/_build/html/_sources/api/pytest_mh.ssh.rst.txt
@@ -0,0 +1,45 @@
+pytest\_mh.ssh
+==============
+
+.. automodule:: pytest_mh.ssh
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Any
+      Enum
+      MultihostLogger
+      SSHBashProcess
+      SSHClient
+      SSHLog
+      SSHPowerShellProcess
+      SSHProcess
+      SSHProcessResult
+      auto
+
+
+
+
+
+   .. rubric:: Exceptions
+
+   .. autosummary::
+
+      SSHAuthenticationError
+      SSHProcessError
+
+
+
+
+
diff --git a/docs.bak/_build/html/_sources/api/pytest_mh.utils.firewall.rst.txt b/docs.bak/_build/html/_sources/api/pytest_mh.utils.firewall.rst.txt
@@ -0,0 +1,29 @@
+pytest\_mh.utils.firewall
+=========================
+
+.. automodule:: pytest_mh.utils.firewall
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      Firewalld
+
+
+
+
+
+
+
+
+
diff --git a/docs.bak/_build/html/_sources/api/pytest_mh.utils.fs.rst.txt b/docs.bak/_build/html/_sources/api/pytest_mh.utils.fs.rst.txt
@@ -0,0 +1,29 @@
+pytest\_mh.utils.fs
+===================
+
+.. automodule:: pytest_mh.utils.fs
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      LinuxFileSystem
+
+
+
+
+
+
+
+
+
diff --git a/docs.bak/_build/html/_sources/api/pytest_mh.utils.journald.rst.txt b/docs.bak/_build/html/_sources/api/pytest_mh.utils.journald.rst.txt
@@ -0,0 +1,29 @@
+pytest\_mh.utils.journald
+=========================
+
+.. automodule:: pytest_mh.utils.journald
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      JournaldUtils
+
+
+
+
+
+
+
+
+
diff --git a/docs.bak/_build/html/_sources/api/pytest_mh.utils.rst.txt b/docs.bak/_build/html/_sources/api/pytest_mh.utils.rst.txt
@@ -0,0 +1,35 @@
+pytest\_mh.utils
+================
+
+.. automodule:: pytest_mh.utils
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :recursive:
+
+   pytest_mh.utils.firewall
+   pytest_mh.utils.fs
+   pytest_mh.utils.journald
+   pytest_mh.utils.services
+   pytest_mh.utils.tc
+