Merge pull request #891 from arkid15r/add-nettacker-command

Implement `nettacker` command

Author: securestep9

.github/workflows/ci_cd.yml

@@ -104,6 +104,40 @@ jobs:
           name: dist
           path: dist
 
+  test-build-package:
+    name: Test build on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    needs: build-package
+    strategy:
+      matrix:
+        os:
+          - macos-latest
+          - ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Get package artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+
+      - name: Run tests
+        shell: bash
+        run: |
+          rm -rf nettacker
+          python -m pip install dist/*.whl
+          nettacker --version
+          python -m pip uninstall -y nettacker
+          python -m pip install dist/*.tar.gz
+          nettacker --version
+
   test-docker-image:
     name: Test Docker image
     needs:
@@ -231,7 +265,7 @@ jobs:
       github.ref_name == 'master'
     environment: dev
     needs:
-      - build-package
+      - test-build-package
     permissions:
       contents: read
       id-token: write
@@ -257,7 +291,7 @@ jobs:
       startsWith(github.event.ref, 'refs/tags/v')
     environment: release
     needs:
-      - build-package
+      - test-build-package
     permissions:
       contents: read
       id-token: write

nettacker.py

@@ -1,7 +1,6 @@
 """OWASP Nettacker application entry point."""
 
-from nettacker.core.app import Nettacker
+from nettacker.main import run
 
 if __name__ == "__main__":
-    app = Nettacker()
-    app.run()
+    run()

nettacker/config.py

@@ -2,8 +2,7 @@
 from functools import lru_cache
 from pathlib import Path
 
-import tomli
-
+from nettacker import version
 from nettacker.core.utils.common import now, generate_random_token
 
 CWD = Path.cwd()
@@ -18,10 +17,8 @@ def version_info():
     Returns:
         an array of version and code name
     """
-    with open("pyproject.toml", "rb") as toml_file:
-        tools = tomli.load(toml_file)["tool"]
 
-    return tools["poetry"]["version"], tools["nettacker"]["release_name"]
+    return version.__version__, version.__release_name__
 
 
 class ConfigBase:

nettacker/core/app.py

@@ -69,29 +69,17 @@ def check_dependencies(self):
         if sys.platform not in {"darwin", "linux"}:
             die_failure(_("error_platform"))
 
-        if not os.path.exists(Config.path.home_dir):
-            try:
-                os.mkdir(Config.path.home_dir)
-                os.mkdir(Config.path.tmp_dir)
-                os.mkdir(Config.path.results_dir)
-            except Exception:
-                die_failure("cannot access the directory {0}".format(Config.path.home_dir))
-        if not os.path.exists(Config.path.tmp_dir):
-            try:
-                os.mkdir(Config.path.tmp_dir)
-            except Exception:
-                die_failure("cannot access the directory {0}".format(Config.path.tmp_dir))
-        if not os.path.exists(Config.path.results_dir):
-            try:
-                os.mkdir(Config.path.results_dir)
-            except Exception:
-                die_failure("cannot access the directory {0}".format(Config.path.results_dir))
+        try:
+            Config.path.tmp_dir.mkdir(exist_ok=True, parents=True)
+            Config.path.results_dir.mkdir(exist_ok=True, parents=True)
+        except PermissionError:
+            die_failure("Cannot access the directory {0}".format(Config.path.tmp_dir))
 
         if Config.db.engine == "sqlite":
             try:
-                if not os.path.isfile(Config.path.database_file):
+                if not Config.path.database_file.exists():
                     sqlite_create_tables()
-            except Exception:
+            except PermissionError:
                 die_failure("cannot access the directory {0}".format(Config.path.home_dir))
         elif Config.db.engine == "mysql":
             try:

nettacker/main.py

@@ -0,0 +1,8 @@
+"""Nettacker main.py."""
+
+from nettacker.core.app import Nettacker
+
+
+def run():
+    app = Nettacker()
+    app.run()

nettacker/version.py

@@ -0,0 +1,5 @@
+"""Nettacker version."""
+
+__version__ = "0.4.0"
+__version_tuple__ = (0, 4, 0)
+__release_name__ = "QUIN"

poetry.lock

@@ -41,6 +41,9 @@ packages = [{ include = "nettacker"}]
 [tool.nettacker]
 release_name = "QUIN"
 
+[tool.poetry.scripts]
+nettacker = "nettacker.main:run"
+
 [tool.poetry.dependencies]
 python = "^3.9, <3.13"
 aiohttp = "^3.9.5"
@@ -59,7 +62,6 @@ pyyaml = "^6.0.1"
 requests = "^2.32.3"
 sqlalchemy = "^2.0.22"
 texttable = "^1.7.0"
-tomli = "^2.0.1"
 zipp = "^3.19.1"
 
 [tool.poetry.group.dev.dependencies]