Merge pull request #73 from LabNConsulting/chopps/use-uv

Cleanup unshare inline and new pid namespace, and use uv

Author: choppsv1

.github/workflows/ci.yml

@@ -15,26 +15,27 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4
 
-      - name: Setup python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v6
         with:
           python-version: ${{ matrix.python-version }}
+          enable-cache: true   # caches uv’s package cache between runs
 
-      - name: Install Poetry
-        uses: snok/install-poetry@v1
-        with:
-          virtualenvs-create: true
-          virtualenvs-in-project: true
+      - name: Fix sudoers and verify uv available
+        run: |
+          sudo sed -i -e '/secure_path/d' /etc/sudoers
+          sudo -E uv --version
+
+      - name: Install munet project
+        run: |
+          uv sync --locked --all-extras --dev
 
       - name: install Qemu
         run: |
           uname -a
           sudo apt-get update -y
           sudo apt-get install -y cloud-utils qemu-system-x86
 
-      - name: Install munet project
-        run: poetry install --all-extras --no-interaction
-
       - name: Lint the project
         run: make ci-lint
 

.github/workflows/publish.yml

@@ -8,11 +8,15 @@ jobs:
   publish:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/setup-python@v5
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
         with:
-          python-version: 3.9
-      - uses: snok/install-poetry@v1
-      - uses: actions/checkout@v2
-      - run: poetry config pypi-token.pypi "${{ secrets.PYPI_API_KEY }}"
-      - name: Publish package
-        run: poetry publish --build
+          python-version: 3.12
+
+      - uses: actions/checkout@v4
+
+      - name: Build Munet package
+        run: uv build
+
+      - name: Publish package to pypi
+        run: uv publish --token  "${{ secrets.PYPI_API_KEY }}"

.github/workflows/testpub.yml

@@ -8,12 +8,15 @@ jobs:
     runs-on: ubuntu-latest
     if: github.event.pull_request.merged == true
     steps:
-      - uses: actions/setup-python@v5
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
         with:
-          python-version: 3.9
-      - uses: snok/install-poetry@v1
+          python-version: 3.12
+
       - uses: actions/checkout@v4
-      - run: poetry config repositories.testpypi https://test.pypi.org/legacy/
-      - run: poetry config pypi-token.testpypi "${{ secrets.TEST_PYPI_API_KEY }}"
-      - name: publish package (test)
-        run: poetry publish --dry-run -vvv --no-interaction --build -r testpypi
+
+      - name: Build Munet Package
+        run: uv build
+
+      - name: Test publishing package to pypi
+        run: uv publish --token  "${{ secrets.TEST_PYPI_API_KEY }}" --repository-url https://test.pypi.org/legacy/

Makefile

@@ -6,18 +6,20 @@ SCHEMA := test-schema.json
 LOG_CLI := # --log-cli
 TMP := .testtmp
 
-unexport VIRTUAL_ENV
-
-POETRY := env -u VIRTUAL_ENV PATH="$(PATH)" poetry
-POETRYRUN := $(POETRY) run
+UV := uv
+UVRUN := $(UV) run
+UVSYNC := $(UV) sync
+# PYANG_PLUGIN_BASE := .venv/pyang-json-schema-plugin
+PYANG_PLUGIN_DIR := $(PYANG_PLUGIN_BASE)/jsonschema
+PYANG_PLUGIN := $(PYANG_PLUGIN_DIR)/jsonschema.py
 
 MAKE_DIR:=$(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))
 
 all: $(TMP) $(YANG) $(YANG_SCHEMA) doc ci-lint test yang-test
 
 .PHONY: doc
 doc:
-	$(POETRYRUN) $(MAKE) -C doc html
+	$(UVRUN) $(MAKE) -C doc html
 
 doc-start:
 	sudo podman run -it --rm -p 8088:80 -d --volume $(MAKE_DIR)/doc/build/html:/usr/share/nginx/html --name sphinx docker.io/nginx
@@ -27,31 +29,32 @@ doc-stop:
 
 # We hand craft this to keep things cleaner
 doc-apidoc:
-	$(POETRYRUN) sphinx-apidoc -f --module-first --ext-doctest --extensions sphinx-prompt -o doc/source/apidoc munet
+	$(UVRUN) sphinx-apidoc -f --module-first --ext-doctest --extensions sphinx-prompt -o doc/source/apidoc munet
 
 prepare-publish: $(YANG_SCHEMA)
 
 lint:
-	$(POETRYRUN) pydocstyle ./munet
-	$(POETRYRUN) pylint ./munet $(shell find ./tests/*/* -name '*.py')
+	$(UVRUN) pydocstyle ./munet
+	$(UVRUN) pylint ./munet $(shell find ./tests/*/* -name '*.py')
 
 ci-lint:
-	$(POETRYRUN) pydocstyle ./munet
-	$(POETRYRUN) pylint --disable="fixme" ./munet ./tests
+	$(UVRUN) pydocstyle ./munet
+	$(UVRUN) pylint --disable="fixme" ./munet ./tests
 
 test: test-validate ci-lint
-	sudo -E $(POETRYRUN) mutest tests
-	sudo -E $(POETRYRUN) pytest -s -v --cov=munet --cov-report=xml tests
+	$(UVRUN) sudo -E mutest tests
+	$(UVRUN) sudo -E pytest -s -v --cov=munet --cov-report=xml tests
 
 clean:
 	rm -f *.yang coverage.xml err.out ox-rfc.el
 	rm -rf .testtmp/schema
+	rm -rf $(PYANG_PLUGIN_BASE)
 
 run:
-	sudo -E $(POETRYRUN) python3 -m munet
+	$(UVRUN) sudo -E python3 -m munet
 
 install:
-	$(POETRY) install --all-extras
+	$(UVSYNC) --all-groups
 
 # ====
 # YANG
@@ -62,7 +65,7 @@ install:
 # -------------------------
 
 ajv = $(or $(and $(shell which ajv),ajv $(1)),)
-y2j = $(POETRYRUN) python -c 'import sys; import json; import yaml; json.dump(yaml.safe_load(sys.stdin), sys.stdout, indent=2)' < $(1) > $(2)
+y2j = $(UVRUN) python -c 'import sys; import json; import yaml; json.dump(yaml.safe_load(sys.stdin), sys.stdout, indent=2)' < $(1) > $(2)
 
 $(YANG): $(ORG)
 	sed -n '/#+begin_src yang :exports code/,/^#+end_src/p' $< | sed '/^#/d' >$@
@@ -94,8 +97,11 @@ ox-rfc.el:
 # YANG data validation
 # --------------------
 
-$(YANG_SCHEMA): $(YANG)
-	$(POETRYRUN) pyang --plugindir .venv/src/pyang-json-schema-plugin/jsonschema/jsonschema.py --format jsonschema  -o $@ $<
+#$(PYANG_PLUGIN):
+#	$(UV) pip install --no-deps --target $(PYANG_PLUGIN_BASE) git+https://github.com/LabNConsulting/pyang-json-schema-plugin.git@labn-master
+
+$(YANG_SCHEMA): $(YANG) # $(PYANG_PLUGIN)
+	$(UVRUN) pyang --format jsonschema -o $@ $<
 
 $(TMP):
 	mkdir -p .testtmp
@@ -111,8 +117,8 @@ KINDS_DATA := .testtmp/kinds.json
 test-validate: $(YANG_SCHEMA) $(KINDS_DATA) .testtmp/basic.json $(TMP)
 	@echo "testing basic with yang generated schema"
 	$(call ajv,--spec=draft2020 -d .testtmp/basic.json -s $(YANG_SCHEMA))
-	$(POETRYRUN) jsonschema --instance .testtmp/basic.json $(YANG_SCHEMA)
+	$(UVRUN) jsonschema --instance .testtmp/basic.json $(YANG_SCHEMA)
 
 	@echo "testing kinds with yang generated schema"
 	$(call ajv,--spec=draft2020 -d .testtmp/kinds.json -s $(YANG_SCHEMA))
-	$(POETRYRUN) jsonschema --instance .testtmp/kinds.json $(YANG_SCHEMA)
+	$(UVRUN) jsonschema --instance .testtmp/kinds.json $(YANG_SCHEMA)

README.org

@@ -324,41 +324,36 @@ For most users, it is recommended to install munet through pip (see:
 https://munet.readthedocs.io/en/latest/usage.html). However, if you want to run
 the unit tests, then you will need to set up your local enviornment:
 
-*** Dependencies
-
-μNET requires the following packages:
+*** `sudo -E` configuration
 
-  python3 python3-venv
+To allow munet to be found when running with `sudo -E` the `secure_path` config
+should be disabled in /etc/sudoers:
 
-Automate tests require the following system packages:
+#+begin_src shell
+   $ sudo sed -i -e '/secure_path/s/^/# /' /etc/sudoers
+#+end_src
 
-  podman
+*** Dependencies
 
-Ensure you have poetry setup, the following instructions work around some bugs
-with poetry:
+Install the [[https://docs.astral.sh/uv/][uv]] python project
+manager (either through your system's package manager or directly via the
+official installer):
 
 #+begin_src shell
-  python3 -m venv ~/.poetrybin
-  source ~/.poetrybin/bin/activate
-  pip install poetry
-  pip uninstall keyring
-  deactivate
+  curl -LsSf https://astral.sh/uv/install.sh | sh
 #+end_src
 
-NOTE: add "~/.poetrybin/bin" to your $PATH
+Some of the munet unit tests will require the following system packages which
+you should install according to your OS procedures:
+
+  podman
 
 Install μNET with dependencies:
 
 #+begin_src shell
   make install
 #+end_src
 
-NOTE: To run munet or mutest locally, you need to enter the poetry virtual enviornment:
-
-#+begin_src shell
-  $(poetry env activate)
-#+end_src
-
 *** Check your install
 
  make
@@ -367,11 +362,11 @@ NOTE: To run munet or mutest locally, you need to enter the poetry virtual envio
 
 The following uses FRR (see https://frrouting.org)
 
-   sudo poetry run munet -c examples/frr/ospf/ospf/munet.yaml
+   uv run sudo -E munet -c examples/frr/ospf/ospf/munet.yaml
 
 For example:
 #+begin_src shell
-munet$ sudo poetry run munet -c examples/frr/ospf/ospf/munet.yaml
+munet$ uv run sudo -E munet -c examples/frr/ospf/ospf/munet.yaml
 2022-09-16 13:37:05,603: INFO: Loaded logging config /home/lberger/Code/github/labn/munet/munet/logconf.yaml
 2022-09-16 13:37:05,609: INFO: Loaded config from /home/lberger/Code/github/labn/munet/examples/frr/ospf/ospf/munet.yaml
 2022-09-16 13:37:05,623: INFO: Loaded kinds config /home/lberger/Code/github/labn/munet/munet/kinds.yaml

doc/source/api/unshare.rst

@@ -23,6 +23,23 @@ Or if you need the latest changes from master:
 
    $ pip install git+https://github.com/LabNConsulting/munet.git#egg=munet
 
+`sudo -E` configuration
+-----------------------
+
+sudo/root is required for most uses of munet and mutest; however, when you
+install munet as a non-root user (typical) either in your default
+environment or in a virtual environment, it may not be found when you `sudo`.
+
+First you should always run with `sudo -E` which carries the user environment
+over into the new process running as root. However, it is also common for sudo
+to be configured to override the user's `$PATH` even when the `-E` flag is
+specified. To make sure this isn't the case you should disable the `Default
+secure_path` configuration if present. One way to do that is:
+
+.. code-block:: console
+
+   $ sudo sed -i -e '/secure_path/s/^/#/' /etc/sudoers
+
 Running
 -------
 

doc/source/usage.rst

@@ -17,7 +17,6 @@
 from . import cli
 from . import parser
 from .args import add_launch_args
-from .base import get_event_loop
 from .cleanup import cleanup_previous
 from .cleanup import is_running_in_rundir
 from .compat import PytestConfig
@@ -200,22 +199,16 @@ def main(*args):
         logger.critical("No nodes defined in config file")
         return 1
 
-    loop = None
     status = 4
     try:
         parser.validate_config(config, logger, args)
         if args.validate_only:
             return 0
-        # Executes the cmd for each node.
-        loop = get_event_loop()
-        status = loop.run_until_complete(async_main(args, config))
+        status = asyncio.get_event_loop().run_until_complete(async_main(args, config))
     except KeyboardInterrupt:
         logger.info("Exiting, received KeyboardInterrupt in main")
     except Exception as error:
         logger.info("Exiting, unexpected exception %s", error, exc_info=True)
-    finally:
-        if loop:
-            loop.close()
 
     return status