Merge pull request #350 from KatharaFramework/develop

tcaiazzi · web-flow · commit e62577ac80cf · 2025-03-26T15:57:35.000+01:00
Kathará v3.7.9
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -22,7 +22,7 @@ body:
     attributes:
       label: Kathará Version
       description: "Please provide the Kathará version you are using (`kathara -v`)."
-      placeholder: "3.7.8"
+      placeholder: "3.7.9"
     validations:
       required: true
   - type: textarea
diff --git a/SECURITY.md b/SECURITY.md
@@ -6,7 +6,7 @@ We release patches for security vulnerabilities only for the last version:
 
 | Version | Supported Versions |
 |---------|--------------------|
-| 3.7.8   | :white_check_mark: |
+| 3.7.9   | :white_check_mark: |
 
 ## Reporting a Vulnerability
 
diff --git a/docs/kathara-lrestart.1.ronn b/docs/kathara-lrestart.1.ronn
@@ -5,7 +5,7 @@ kathara-lrestart(1) -- Restart a Kathara network scenario
 ## SYNOPSIS
 
 `kathara lrestart` [`-h`] [`-F`] [`-l`]  
-[`--noterminals` | `--terminals` | `--privileged`] [`-d` <DIRECTORY>]  
+[`--noterminals` | `--terminals`] [`--privileged`] [`-d` <DIRECTORY>]  
 [`-o` [<OPTION> [<OPTION> ...]]] [`--xterm` <XTERM>]  
 [`--no-hosthome` \| `--hosthome`] [`--no-shared` \| `--shared`] [`--exclude` <DEVICE_NAME> [<DEVICE_NAME> ...]]  
 [<DEVICE_NAME> [<DEVICE_NAME> ...]]
diff --git a/docs/kathara-lstart.1.ronn b/docs/kathara-lstart.1.ronn
@@ -4,7 +4,7 @@ kathara-lstart(1) -- Start a Kathara network scenario
 
 ## SYNOPSIS
 
-`kathara lstart` [`-h`] [`--noterminals` \| `--terminals` \| `--privileged`]  
+`kathara lstart` [`-h`] [`--noterminals` \| `--terminals`] [`--privileged`]  
 [`-d` <DIRECTORY>] [`-F`] [`-l`] [`-o` [<OPTION> [<OPTION> ...]]] [`--xterm` <XTERM>]  
 [`--print`]  [`--no-hosthome` \| `--hosthome`] [`--no-shared` \| `--shared`] [`--exclude` <DEVICE_NAME> [<DEVICE_NAME> ...]]  
 [<DEVICE_NAME> [<DEVICE_NAME> ...]]
diff --git a/docs/kathara-vstart.1.ronn b/docs/kathara-vstart.1.ronn
@@ -5,7 +5,7 @@ kathara-vstart(1) -- Start a new Kathara device
 ## SYNOPSIS
 
 `kathara vstart` `-n` <DEVICE_NAME>  
-[`-h`] [`--noterminals` | `--terminals` | `--privileged` | `--num_terms` <NUM_TERMS>]  
+[`-h`] [`--noterminals` | `--terminals` | `--num_terms` <NUM_TERMS>] [`--privileged`]  
 [`--eth` <N:CD[/MAC_ADDR]> [<N:CD[/MAC_ADDR]> ...]]  
 [`-e` [<EXEC_COMMANDS> [<EXEC_COMMANDS> ...]]] [`--mem` <MEM>]  
 [`--cpus` <CPUS>] [`-i` <IMAGE>] [`--no-hosthome` \| `--hosthome`]  
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,10 +1,11 @@
 [project]
 name = "kathara"
-version = "3.7.8"
+version = "3.7.9"
 description = "A lightweight container-based network emulation tool."
 readme = "README.md"
 requires-python = ">=3.9"
-license = { file = "LICENSE" }
+license = 'gpl-3.0'
+license-files = ["LICENSE"]
 keywords = ["NETWORK-EMULATION", "CONTAINERS", "NFV"]
 authors = [
     { name = "Kathara Framework", email = "contact@kathara.org" }
@@ -22,7 +23,6 @@ classifiers = [
     "Intended Audience :: Education",
     "Intended Audience :: Telecommunications Industry",
     "Topic :: Software Development :: Build Tools",
-    "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11"
diff --git a/scripts/Linux-Deb/Makefile b/scripts/Linux-Deb/Makefile
@@ -1,6 +1,6 @@
 #!/usr/bin/make -f
 
-VERSION=3.7.8
+VERSION=3.7.9
 DEBIAN_PACKAGE_VERSION=1
 LAUNCHPAD_NAME=user
 NO_BINARY_PACKAGES=pyroute2|pyuv|deepdiff
@@ -59,13 +59,13 @@ download-pip: copy-debian-folder
 	cd Output/kathara-$(VERSION)/debian/pythonLibs_amd64 && /root/py-build-env/bin/pip download --platform manylinux2014_x86_64 --only-binary=:all: zstandard
 	cd Output/kathara-$(VERSION)/debian/pythonLibs_amd64 && /root/py-build-env/bin/pip download --no-binary=:all: -r ../../requirements-no-binary.txt
 	cd Output/kathara-$(VERSION)/debian/pythonLibs_amd64 && /root/py-build-env/bin/pip download --platform manylinux2014_x86_64 --platform x86_64 --only-binary=:all: -r ../../requirements-binary.txt
-	cd Output/kathara-$(VERSION)/debian/pythonLibs_amd64 && /root/py-build-env/bin/pip download --no-binary=:all: nuitka
+	cd Output/kathara-$(VERSION)/debian/pythonLibs_amd64 && /root/py-build-env/bin/pip download --no-binary=:all: nuitka==2.6.7
 	cd Output/kathara-$(VERSION)/debian/pythonLibs_arm64 && /root/py-build-env/bin/pip download --platform manylinux2014_aarch64 --only-binary=:all: flit_core
 	cd Output/kathara-$(VERSION)/debian/pythonLibs_arm64 && /root/py-build-env/bin/pip download --platform manylinux2014_aarch64 --only-binary=:all: wheel
 	cd Output/kathara-$(VERSION)/debian/pythonLibs_arm64 && /root/py-build-env/bin/pip download --platform manylinux2014_aarch64 --only-binary=:all: zstandard
 	cd Output/kathara-$(VERSION)/debian/pythonLibs_arm64 && /root/py-build-env/bin/pip download --no-binary=:all: -r ../../requirements-no-binary.txt
 	cd Output/kathara-$(VERSION)/debian/pythonLibs_arm64 && /root/py-build-env/bin/pip download --platform manylinux2014_aarch64 --platform arm64 --only-binary=:all: -r ../../requirements-binary.txt
-	cd Output/kathara-$(VERSION)/debian/pythonLibs_arm64 && /root/py-build-env/bin/pip download --no-binary=:all: nuitka
+	cd Output/kathara-$(VERSION)/debian/pythonLibs_arm64 && /root/py-build-env/bin/pip download --no-binary=:all: nuitka==2.6.7
 	rm Output/kathara-$(VERSION)/debian/pythonLibs_arm64/zstandard*.tar.gz
 	rm Output/kathara-$(VERSION)/debian/pythonLibs_amd64/zstandard*.tar.gz
 	rm -Rf Output/kathara-$(VERSION)/requirements-binary.txt Output/kathara-$(VERSION)/requirements-no-binary.txt
diff --git a/scripts/Linux-Deb/debian/changelog b/scripts/Linux-Deb/debian/changelog
@@ -1,14 +1,8 @@
 kathara (__VERSION__-__DEBIAN_PACKAGE_VERSION____UBUNTU_VERSION__) __UBUNTU_VERSION__; urgency=low
 
-    * WARNING: "ltest" command is deprecated. It will be removed in the next release! Please use the "kathara-lab-checker" tool as its replacement with enhanced functionalities.
-    * Add "--topology" argument to "kathara linfo" that displays a list of collision domains and the devices connected to each of them
-    * "kathara linfo" now displays a column with the connected interfaces of each device
-    * "kathara exec" now returns the exact exit code of the command
-    * API Improvements in the "Lab" object
-    * (Docker) Fix "rp_filter" sysctl assigment on Docker Engine >= v27.0.0
-    * (Docker) Add the possibility to specify "ulimits" in network scenario metadata (thanks to g4br-i)
-    * (Docker) Fix compatibility with docker-io version numbers
-    * (Kubernetes) Add the support to private image registries through the "docker.json" file (thanks to Giovanni Barbiero)
-    * Minor bug fixes
+    * (Docker) Fix user-defined interface-specific sysctls on Docker Engine >= v27.0.0
+    * Open device terminals when "--privileged" flag is set
+    * Assign device FQDN in "/etc/hosts" (if no "/etc/hosts" is passed by the user)
+    * Fix TMUX issues
 
  -- Kathara Team <contact@kathara.org>  __DATE__
diff --git a/scripts/Linux-Pkg/Makefile b/scripts/Linux-Pkg/Makefile
@@ -1,6 +1,6 @@
 #!/usr/bin/make -f
 
-VERSION=3.7.8
+VERSION=3.7.9
 PACKAGE_VERSION=1
 AUR_NAME=user
 AUR_MAIL=contact@kathara.org
diff --git a/scripts/Linux-Pkg/kathara.spec b/scripts/Linux-Pkg/kathara.spec
@@ -0,0 +1,74 @@
+# -*- mode: python ; coding: utf-8 -*-
+
+block_cipher = None
+
+
+a = Analysis(['kathara.py'],
+             pathex=['../src/'],
+             binaries=[],
+             datas=[],
+             hiddenimports=['Kathara',
+                            'Kathara.cli',
+                            'Kathara.cli.command',
+                            'Kathara.cli.command.CheckCommand',
+                            'Kathara.cli.command.ConnectCommand',
+                            'Kathara.cli.command.ExecCommand',
+                            'Kathara.cli.command.LcleanCommand',
+                            'Kathara.cli.command.LinfoCommand',
+                            'Kathara.cli.command.ListCommand',
+                            'Kathara.cli.command.LrestartCommand',
+                            'Kathara.cli.command.LstartCommand',
+                            'Kathara.cli.command.LtestCommand',
+                            'Kathara.cli.command.LconfigCommand',
+                            'Kathara.cli.command.SettingsCommand',
+                            'Kathara.cli.command.VcleanCommand',
+                            'Kathara.cli.command.VconfigCommand',
+                            'Kathara.cli.command.VstartCommand',
+                            'Kathara.cli.command.WipeCommand',
+                            'Kathara.cli.ui',
+                            'Kathara.cli.ui.setting',
+                            'Kathara.cli.ui.setting.DockerOptionsHandler',
+                            'Kathara.cli.ui.setting.KubernetesOptionsHandler',
+                            'Kathara.manager',
+                            'Kathara.manager.Kathara',
+                            'Kathara.manager.docker',
+                            'Kathara.manager.docker.DockerManager',
+                            'Kathara.manager.kubernetes',
+                            'Kathara.manager.kubernetes.KubernetesManager',
+                            'Kathara.setting',
+                            'Kathara.setting.addon',
+                            'Kathara.setting.addon.DockerSettingsAddon',
+                            'Kathara.setting.addon.KubernetesSettingsAddon'
+                            ],
+             hookspath=[],
+             runtime_hooks=[],
+             excludes=[],
+             win_no_prefer_redirects=False,
+             win_private_assemblies=False,
+             cipher=block_cipher,
+             noarchive=False)
+pyz = PYZ(a.pure, a.zipped_data,
+             cipher=block_cipher)
+exe = EXE(pyz,
+          a.scripts,
+          [],
+          name='kathara',
+          debug=False,
+          bootloader_ignore_signals=False,
+          strip=False,
+          upx=True,
+          upx_exclude=[],
+          exclude_binaries=True,
+          runtime_tmpdir=None,
+          target_arch='x86',
+          console=True)
+
+col = COLLECT(exe,
+              a.binaries,
+              a.zipfiles,
+              a.datas,
+              strip=False,
+              upx=True,
+              upx_exclude=[],
+              name='kathara'
+)
diff --git a/scripts/Linux-Pkg/pkginfo/PKGBUILD b/scripts/Linux-Pkg/pkginfo/PKGBUILD
@@ -10,8 +10,6 @@ changelog="kathara.changelog"
 makedepends=(
 	'python'
     'chrpath'
-    'patchelf'
-    'make'
     'ruby-ronn-ng'
 )
 optdepends=(
@@ -27,15 +25,16 @@ prepare() {
   $srcdir/venv/bin/pip install --upgrade setuptools
   $srcdir/venv/bin/pip install -r $srcdir/Kathara-$pkgver/src/requirements.txt
   $srcdir/venv/bin/pip install -r $srcdir/Kathara-$pkgver/scripts/autocompletion/requirements.txt
-  $srcdir/venv/bin/pip install nuitka==2.3.3
+  $srcdir/venv/bin/pip install pyinstaller
   $srcdir/venv/bin/pip install pytest
 }
 
 build() {
   cd $srcdir/Kathara-$pkgver/docs && make roff-build
   cd $srcdir/Kathara-$pkgver/scripts/autocompletion/ && $srcdir/venv/bin/python generate_autocompletion.py $srcdir/Kathara-$pkgver/scripts/autocompletion/kathara.bash-completion
   cd $srcdir/Kathara-$pkgver/ && $srcdir/venv/bin/python -m pytest tests
-  cd $srcdir/Kathara-$pkgver/src/ && $srcdir/venv/bin/python -m nuitka --lto=yes --plugin-enable=pylint-warnings --plugin-enable=multiprocessing --follow-imports --standalone --include-plugin-directory=Kathara --output-filename=kathara kathara.py
+  cp $srcdir/Kathara-$pkgver/scripts/Linux-Pkg/kathara.spec $srcdir/Kathara-$pkgver/src/
+  cd $srcdir/Kathara-$pkgver/src/ && $srcdir/venv/bin/pyinstaller --distpath=./kathara.dist --workpath=./kathara.build kathara.spec
 }
 
 package() {
@@ -50,19 +49,11 @@ package() {
   install -d -m 755 $pkgdir/etc/bash_completion.d/
   install -p -m 644 $srcdir/Kathara-$pkgver/scripts/autocompletion/kathara.bash-completion $pkgdir/etc/bash_completion.d/
 
-  rm -f $srcdir/Kathara-$pkgver/src/kathara.dist/libbz2.so.1.0
-  rm -f $srcdir/Kathara-$pkgver/src/kathara.dist/libexpat.so.1
-  rm -f $srcdir/Kathara-$pkgver/src/kathara.dist/libtinfo.so.6
-  rm -f $srcdir/Kathara-$pkgver/src/kathara.dist/libz.so.1
-  rm -f $srcdir/Kathara-$pkgver/src/kathara.dist/libtinfo.so.5
-  rm -f $srcdir/Kathara-$pkgver/src/kathara.dist/libcrypto.so.1.1
   install -d $pkgdir/usr/lib/$pkgname
-  install -p -m 644 $srcdir/Kathara-$pkgver/src/kathara.dist/*.so* $pkgdir/usr/lib/$pkgname/
-  install -p -m 755 $srcdir/Kathara-$pkgver/src/kathara.dist/kathara $pkgdir/usr/lib/$pkgname/
-  install -d -m 755 $pkgdir/usr/lib/$pkgname/certifi
-  install -p -m 644 $srcdir/Kathara-$pkgver/src/kathara.dist/certifi/* $pkgdir/usr/lib/$pkgname/certifi/
-  install -d -m 755 $pkgdir/usr/lib/$pkgname/pyuv
-  install -p -m 644 $srcdir/Kathara-$pkgver/src/kathara.dist/pyuv/* $pkgdir/usr/lib/$pkgname/pyuv/
+  cp -r $srcdir/Kathara-$pkgver/src/kathara.dist/kathara/_internal $pkgdir/usr/lib/$pkgname/_internal
+  find $pkgdir/usr/lib/$pkgname/_internal -type f -exec chmod 644 {} \;
+  install -p -m 2755 -g 962 $srcdir/Kathara-$pkgver/src/kathara.dist/kathara/kathara $pkgdir/usr/lib/$pkgname/
   install -d -m 755 $pkgdir/usr/bin
-  ln -sf /usr/lib/$pkgname/kathara "$pkgdir/usr/bin/$pkgname"
+  ln -sf /usr/lib/$pkgname/kathara $pkgdir/usr/bin/$pkgname
 }
+
diff --git a/scripts/Linux-Pkg/pkginfo/kathara.changelog b/scripts/Linux-Pkg/pkginfo/kathara.changelog
@@ -1,13 +1,7 @@
 __DATE__ Kathara Team <******@kathara.org>
 
 * Release v__VERSION__
-    * WARNING: "ltest" command is deprecated. It will be removed in the next release! Please use the "kathara-lab-checker" tool as its replacement with enhanced functionalities.
-    * Add "--topology" argument to "kathara linfo" that displays a list of collision domains and the devices connected to each of them
-    * "kathara linfo" now displays a column with the connected interfaces of each device
-    * "kathara exec" now returns the exact exit code of the command
-    * API Improvements in the "Lab" object
-    * (Docker) Fix "rp_filter" sysctl assigment on Docker Engine >= v27.0.0
-    * (Docker) Add the possibility to specify "ulimits" in network scenario metadata (thanks to g4br-i)
-    * (Docker) Fix compatibility with docker-io version numbers
-    * (Kubernetes) Add the support to private image registries through the "docker.json" file (thanks to Giovanni Barbiero)
-    * Minor bug fixes
+    * (Docker) Fix user-defined interface-specific sysctls on Docker Engine >= v27.0.0
+    * Open device terminals when "--privileged" flag is set
+    * Assign device FQDN in "/etc/hosts" (if no "/etc/hosts" is passed by the user)
+    * Fix TMUX issues
diff --git a/scripts/Linux-Rpm/Makefile b/scripts/Linux-Rpm/Makefile
@@ -1,6 +1,6 @@
 #!/usr/bin/make -f
 
-VERSION=3.7.8
+VERSION=3.7.9
 PACKAGE_VERSION=1
 
 .PHONY: all clean docker-build-image prepare-source prepare-man-pages prepare-bash-completion pack-source build
diff --git a/scripts/Linux-Rpm/rpm/kathara.spec b/scripts/Linux-Rpm/rpm/kathara.spec
@@ -68,13 +68,7 @@ chmod g+s %{_libdir}/kathara/kathara
 
 %changelog
 *  __DATE__ Kathara Team <******@kathara.org> - __VERSION__-__PACKAGE_VERSION__
-- WARNING: "ltest" command is deprecated. It will be removed in the next release! Please use the "kathara-lab-checker" tool as its replacement with enhanced functionalities.
-- Add "--topology" argument to "kathara linfo" that displays a list of collision domains and the devices connected to each of them
-- "kathara linfo" now displays a column with the connected interfaces of each device
-- "kathara exec" now returns the exact exit code of the command
-- API Improvements in the "Lab" object
-- (Docker) Fix "rp_filter" sysctl assigment on Docker Engine >= v27.0.0
-- (Docker) Add the possibility to specify "ulimits" in network scenario metadata (thanks to g4br-i)
-- (Docker) Fix compatibility with docker-io version numbers
-- (Kubernetes) Add the support to private image registries through the "docker.json" file (thanks to Giovanni Barbiero)
-- Minor bug fixes
+- (Docker) Fix user-defined interface-specific sysctls on Docker Engine >= v27.0.0
+- Open device terminals when "--privileged" flag is set
+- Assign device FQDN in "/etc/hosts" (if no "/etc/hosts" is passed by the user)
+- Fix TMUX issues
diff --git a/scripts/OSX/Makefile b/scripts/OSX/Makefile
@@ -1,7 +1,7 @@
 #!/usr/bin/make -s
 
 PRODUCT=Kathara
-VERSION=3.7.8
+VERSION=3.7.9
 TARGET_DIRECTORY=Output
 APPLE_DEVELOPER_CERTIFICATE_ID=FakeID
 ROFF_DIR=../../docs/Roff
diff --git a/scripts/Windows/installer.iss b/scripts/Windows/installer.iss
@@ -2,7 +2,7 @@
 ; SEE THE DOCUMENTATION FOR DETAILS ON CREATING INNO SETUP SCRIPT FILES!
 
 #define MyAppName "Kathara"
-#define MyAppVersion "3.7.8"
+#define MyAppVersion "3.7.9"
 #define MyAppPublisher "Kathara Team"
 #define MyAppURL "https://www.kathara.org"
 #define MyAppExeName "kathara.exe"
diff --git a/setup.cfg b/setup.cfg
@@ -1,6 +1,6 @@
 [metadata]
 name = kathara
-version = 3.7.8
+version = 3.7.9
 author = Kathara Framework
 author_email = contact@kathara.org
 description = A lightweight container-based network emulation tool.
diff --git a/setup.py b/setup.py
@@ -7,13 +7,13 @@
     package_dir={'': 'src'},
     packages=find_packages('src'),
     py_modules=['kathara'],
-    version='3.7.8',
+    version='3.7.9',
     license='gpl-3.0',
     description='A lightweight container-based network emulation tool.',
     author='Kathara Framework',
     author_email='contact@kathara.org',
     url='https://www.kathara.org',
-    download_url='https://github.com/KatharaFramework/Kathara/archive/refs/tags/3.7.8.tar.gz',
+    download_url='https://github.com/KatharaFramework/Kathara/archive/refs/tags/3.7.9.tar.gz',
     keywords=['NETWORK-EMULATION', 'CONTAINERS', 'NFV'],
     install_requires=[
         "binaryornot>=0.4.4",
diff --git a/src/Kathara/cli/command/LrestartCommand.py b/src/Kathara/cli/command/LrestartCommand.py
@@ -42,7 +42,7 @@ def __init__(self) -> None:
             const=True,
             help='Start the network scenario opening terminal windows.'
         )
-        group.add_argument(
+        self.parser.add_argument(
             "--privileged",
             action="store_const",
             const=True,
diff --git a/src/Kathara/cli/command/LstartCommand.py b/src/Kathara/cli/command/LstartCommand.py
@@ -52,7 +52,7 @@ def __init__(self) -> None:
             const=True,
             help='Start the network scenario opening terminal windows.'
         )
-        group.add_argument(
+        self.parser.add_argument(
             "--privileged",
             action="store_const",
             const=True,
@@ -219,8 +219,10 @@ def run(self, current_path: str, argv: List[str]) -> int:
             if not utils.is_admin():
                 raise PrivilegeError("You must be root in order to start Kathara devices in privileged mode.")
             else:
-                self.console.print("[yellow]\u26a0 Running devices with privileged capabilities, terminals won't open!")
-                Setting.get_instance().open_terminals = False
+                if Setting.get_instance().open_terminals:
+                    self.console.print(
+                        "[yellow]\u26a0 Running devices with privileged capabilities, terminals might not open!"
+                    )
 
         Kathara.get_instance().deploy_lab(
             lab, selected_machines=set(args['machine_name']), excluded_machines=set(args['excluded_machines'])
diff --git a/src/Kathara/cli/command/VstartCommand.py b/src/Kathara/cli/command/VstartCommand.py
diff --git a/src/Kathara/manager/docker/DockerMachine.py b/src/Kathara/manager/docker/DockerMachine.py
diff --git a/src/Kathara/manager/docker/DockerManager.py b/src/Kathara/manager/docker/DockerManager.py
diff --git a/src/Kathara/manager/kubernetes/KubernetesMachine.py b/src/Kathara/manager/kubernetes/KubernetesMachine.py
diff --git a/src/Kathara/version.py b/src/Kathara/version.py
diff --git a/tests/cli/lstart_command_test.py b/tests/cli/lstart_command_test.py
diff --git a/tests/cli/vstart_command_test.py b/tests/cli/vstart_command_test.py
diff --git a/tests/manager/docker/docker_link_test.py b/tests/manager/docker/docker_link_test.py
diff --git a/tests/manager/docker/docker_machine_test.py b/tests/manager/docker/docker_machine_test.py
diff --git a/tests/manager/kubernetes/kubernetes_link_test.py b/tests/manager/kubernetes/kubernetes_link_test.py
