Exegol 4.2.0

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,6 +1,6 @@
 # Description
 
-> A description of your PR, what it brings or corrects.
+> A description of your PR, what it brings or corrects. Don't forget to configure your PR to the dev branch (cf. https://exegol.readthedocs.io/en/latest/community/contributors.html)
 
 # Related issues
 

.github/workflows/entrypoint_nightly.yml

@@ -0,0 +1,38 @@
+name: Nightly build
+
+on:
+  push:
+    branches:
+      - "dev"
+    paths:
+      - "**.py"
+
+jobs:
+  test:
+    name: Python tests and checks
+    uses: ./.github/workflows/sub_testing.yml
+
+  build-n-publish:
+    name: Build and publish Python 🐍 distributions to TestPyPI 📦
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - uses: actions/checkout@master
+        with:
+          submodules: true
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - name: Install requirements
+        run: python -m pip install --user build
+      - name: Cleaning
+        run : python setup.py clean
+      - name: Build Exegol
+        run: python -m build --sdist --outdir dist/ .
+      - name: Publish distribution 📦 to Test PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+          repository-url: https://test.pypi.org/legacy/
+          skip-existing: true

.github/workflows/entrypoint_prerelease.yml

@@ -0,0 +1,33 @@
+name: Pre-release PR
+
+on:
+  pull_request:
+    branches:
+      - "master"
+    paths-ignore:
+      - ".github/**"
+      - "**.md"
+
+jobs:
+  test:
+    name: Python tests and checks
+    uses: ./.github/workflows/sub_testing.yml
+
+  build:
+    name: Build Python 🐍 distributions
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - uses: actions/checkout@master
+        with:
+          submodules: true
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - name: Install requirements
+        run: python -m pip install --user build
+      - name: Cleaning
+        run : python setup.py clean test
+      - name: Build Exegol
+        run: python -m build --sdist --outdir dist/ .

.github/workflows/entrypoint_pull_request.yml

@@ -0,0 +1,52 @@
+name: Ext. PR tests & int. branches pushes
+
+# for external contribution pull requests,
+#  and internal pushes to specific branches (!= dev)
+
+on:
+  pull_request:
+    branches-ignore:
+      - "master"
+    paths-ignore:
+      - ".github/**"
+      - "**.md"
+  push:
+    branches-ignore:
+      - "dev"
+    paths-ignore:
+      - ".github/**"
+      - "**.md"
+
+# todo add whitelist paths like entrypoint_nightly.yml
+
+# creating a separate concurrency group for each PR
+# so that our "PR checks" are always running for the latest commit in the PR
+# and as PRs are updated we want to make sure "in progress" jobs are killed so we don't waste resources
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress: true
+
+
+jobs:
+  test:
+    name: Python tests and checks
+    uses: ./.github/workflows/sub_testing.yml
+
+  build:
+    name: Build Python 🐍 distributions
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - uses: actions/checkout@master
+        with:
+          submodules: true
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - name: Install requirements
+        run: python -m pip install --user build
+      - name: Cleaning
+        run : python setup.py clean
+      - name: Build Exegol
+        run: python -m build --sdist --outdir dist/ .

.github/workflows/entrypoint_release.yml

@@ -0,0 +1,40 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  test:
+    name: Python tests and checks
+    uses: ./.github/workflows/sub_testing.yml
+
+  build-n-publish:
+    name: Build and publish Python 🐍 distributions to PyPI 📦
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - uses: actions/checkout@master
+        with:
+          submodules: true
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - name: Install requirements
+        run: python -m pip install --user build
+      - name: Run package unitest
+        run : python setup.py clean test
+      - name: Build Exegol release
+        run: python -m build --sdist --outdir dist/ .
+      - name: Publish distribution 📦 to Test PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+          repository_url: https://test.pypi.org/legacy/
+          skip_existing: true
+      - name: Publish distribution 📦 to PyPI (prod)
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/sub_testing.yml

@@ -0,0 +1,43 @@
+name: Testing
+
+on:
+  workflow_call:
+
+jobs:
+  testing:
+    name: Code testing
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+        with:
+          submodules: false
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - name: Install requirements
+        run: python -m pip install --user mypy types-requests types-PyYAML
+      - name: Run code analysis
+        run: mypy ./exegol/ --ignore-missing-imports --check-untyped-defs --pretty # TODO add --disallow-untyped-defs
+
+  compatibility:
+    name: Compatibility checks
+    runs-on: ubuntu-latest
+    needs: testing
+    strategy:
+      fail-fast: false
+      matrix:
+        version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        os: [win32, linux, darwin]
+    steps:
+      - uses: actions/checkout@master
+        with:
+          submodules: false
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - name: Install requirements
+        run: python -m pip install --user mypy types-requests types-PyYAML
+      - name: Check python compatibility for ${{ matrix.os }}/${{ matrix.version }}
+        run: mypy ./exegol.py --ignore-missing-imports --check-untyped-defs --python-version ${{ matrix.version }} --platform ${{ matrix.os }}

README.md

@@ -1,9 +1,9 @@
 <div align="center">
-  <img alt="exegol logo" width="600" src="https://raw.githubusercontent.com/ThePorgs/Exegol-docs/main/.assets/rounded_social_preview.png">
+  <img alt="latest commit on master" width="600" src="https://raw.githubusercontent.com/ThePorgs/Exegol-docs/main/.assets/rounded_social_preview.png">
   <br><br>
-  <a href="https://pypi.org/project/Exegol" title=""><img src="https://img.shields.io/pypi/v/Exegol?color=informational" alt="pip package version"></a>
+  <a target="_blank" rel="noopener noreferrer" href="https://pypi.org/project/Exegol" title=""><img src="https://img.shields.io/pypi/v/Exegol?color=informational" alt="pip package version"></a>
   <img alt="Python3.7" src="https://img.shields.io/badge/Python-3.7+-informational">
-  <a href="https://pepy.tech/project/exegol" title=""><img src="https://static.pepy.tech/personalized-badge/exegol?period=total&units=international_system&left_color=grey&right_color=brightgreen&left_text=Downloads" alt="pip stats"></a>
+  <a target="_blank" rel="noopener noreferrer" href="https://pepy.tech/project/exegol" title=""><img src="https://static.pepy.tech/personalized-badge/exegol?period=total&units=international_system&left_color=grey&right_color=brightgreen&left_text=Downloads" alt="pip stats"></a>
   <br><br>
   <img alt="latest commit on master" src="https://img.shields.io/github/last-commit/ThePorgs/Exegol/master?label=latest%20release">
   <img alt="latest commit on dev" src="https://img.shields.io/github/last-commit/ThePorgs/Exegol/dev?label=latest%20dev">
@@ -15,10 +15,17 @@
   <img alt="amd64" src="https://img.shields.io/badge/amd64%20(x86__64)-supported-success">
   <img alt="arm64" src="https://img.shields.io/badge/arm64%20(aarch64)-supported-success">
   <br><br>
-  <a href="https://twitter.com/intent/follow?screen_name=_nwodtuhs" title="Follow"><img src="https://img.shields.io/twitter/follow/_nwodtuhs?label=Shutdown&style=social" alt="Twitter Shutdown"></a>
-  <a href="https://twitter.com/intent/follow?screen_name=Dramelac_" title="Follow"><img src="https://img.shields.io/twitter/follow/Dramelac_?label=Dramelac&style=social" alt="Twitter Dramelac"></a>
+  <a target="_blank" rel="noopener noreferrer" href="https://twitter.com/intent/follow?screen_name=_nwodtuhs" title="Follow"><img src="https://img.shields.io/twitter/follow/_nwodtuhs?label=Shutdown&style=social" alt="Twitter Shutdown"></a>
+  <a target="_blank" rel="noopener noreferrer" href="https://twitter.com/intent/follow?screen_name=Dramelac_" title="Follow"><img src="https://img.shields.io/twitter/follow/Dramelac_?label=Dramelac&style=social" alt="Twitter Dramelac"></a>
+  <br>
+  <a target="_blank" rel="noopener noreferrer" href="https://www.blackhat.com/eu-22/arsenal/schedule/index.html#exegol-29180" title="Schedule">
+   <img alt="Black Hat Europe 2022" src="https://img.shields.io/badge/Black%20Hat%20Arsenal-Europe%202022-blueviolet">
+  </a>
+  <a target="_blank" rel="noopener noreferrer" href="https://www.blackhat.com/asia-23/arsenal/schedule/#exegol-professional-hacking-setup-30815" title="Schedule">
+   <img alt="Black Hat Asia 2023" src="https://img.shields.io/badge/Black%20Hat%20Arsenal-Asia%202023-blueviolet">
+  </a>
   <br><br>
-  <a href="https://discord.gg/cXThyp7D6P" title="Join us on Discord"><img src="https://raw.githubusercontent.com/ThePorgs/Exegol-docs/main/.assets/discord_join_us.png" width="150" alt="Join us on Discord"></a>
+  <a target="_blank" rel="noopener noreferrer" href="https://discord.gg/cXThyp7D6P" title="Join us on Discord"><img src="https://raw.githubusercontent.com/ThePorgs/Exegol-docs/main/.assets/discord_join_us.png" width="150" alt="Join us on Discord"></a>
   <br><br>
 </div>
 
@@ -27,7 +34,9 @@
 
 # Getting started
 
-You can refer to the [Exegol documentations](https://exegol.readthedocs.io/).
+You can refer to the [Exegol documentations](https://exegol.readthedocs.io/en/latest/getting-started/install.html).
+
+> Full documentation homepage: https://exegol.rtfd.io/.
 
 ## Project structure
 

exegol.py

@@ -1,5 +1,6 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
+# PYTHON_ARGCOMPLETE_OK
 from exegol.manager.ExegolController import main
 
 

exegol/__init__.py

@@ -1,4 +1,4 @@
-from exegol.utils.ConstantConfig import ConstantConfig
+from exegol.config.ConstantConfig import ConstantConfig
 
 __version__ = ConstantConfig.version
 __title__ = "exegol"

exegol/utils/ConstantConfig.py → exegol/config/ConstantConfig.py

@@ -5,7 +5,7 @@
 class ConstantConfig:
     """Constant parameters information"""
     # Exegol Version
-    version: str = "4.1.1"
+    version: str = "4.2.0"
 
     # Exegol documentation link
     documentation: str = "https://exegol.rtfd.io/"

exegol/config/DataCache.py

@@ -0,0 +1,64 @@
+import json
+
+from exegol.model.CacheModels import *
+from exegol.utils.DataFileUtils import DataFileUtils
+from exegol.utils.MetaSingleton import MetaSingleton
+
+
+class DataCache(DataFileUtils, metaclass=MetaSingleton):
+    """This class allows loading cached information defined configurations
+
+    Exemple of data:
+    {
+        wrapper: {
+            update: {
+                metadata: {
+                    last_check DATE
+                }
+                last_version: STR
+            }
+        }
+        images: 
+            metadata: {
+                    last_check: DATE
+            }
+            data: [
+                {
+                    name: STR (tag name)
+                    last_version: STR (x.y.z|commit_id)
+                    type: STR (local|remote)
+                }
+            ]
+    }
+    """
+
+    def __init__(self):
+        # Cache data
+        self.__cache_data = CacheDB()
+
+        # Config file options
+        super().__init__(".datacache", "json")
+
+    def _process_data(self):
+        if len(self._raw_data) >= 2:
+            self.__cache_data.load(**self._raw_data)
+
+    def _build_file_content(self) -> str:
+        return json.dumps(self.__cache_data, cls=self.ObjectJSONEncoder)
+
+    def save_updates(self):
+        self._create_config_file()
+
+    def get_wrapper_data(self) -> WrapperCacheModel:
+        """Get Wrapper information from cache"""
+        return self.__cache_data.wrapper
+
+    def get_images_data(self) -> ImagesCacheModel:
+        """Get Images information from cache"""
+        return self.__cache_data.images
+
+    def update_image_cache(self, images: List):
+        """Refresh image cache data"""
+        cache_images = [ImageCacheModel(img.getName(), img.getLatestVersion(), img.getLatestRemoteId(), "local" if img.isLocal() else "remote") for img in images]
+        self.__cache_data.images = ImagesCacheModel(cache_images)
+        self.save_updates()