Add pre-commit checks

Author: Dramelac

.gitattributes

@@ -5,4 +5,4 @@
 *.py text
 
 # Every shell file must be cloned with LF line ending
-*.sh text eol=lf
+*.sh text eol=lf

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -8,8 +8,8 @@ body:
     attributes:
       value: |
         Verification before publication:
-        
-        - You are creating a bug report in the Exegol **WRAPPER** repository (the exegol command)! 
+
+        - You are creating a bug report in the Exegol **WRAPPER** repository (the exegol command)!
         > If your problem concerns the environment, tools or other elements specific to the Exegol **IMAGE**, please open your issue on the [Exegol-images](https://github.com/ThePorgs/Exegol-images) repository.
         - Check that there is not already a issue for the **same** problem.
         - Some problems are already well known and can be found in the **documentation** or on the Exegol **Discord**.

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -8,7 +8,7 @@ body:
       value: |
         Verification before publication:
 
-        - You are creating a feature request in the Exegol **WRAPPER** repository (the exegol command)! 
+        - You are creating a feature request in the Exegol **WRAPPER** repository (the exegol command)!
         > If your request concerns the exegol environment, tools or other elements specific to the Exegol **IMAGE**, please open your issue on the [Exegol-images](https://github.com/ThePorgs/Exegol-images) repository.
         - Check that there is not already your feature request on the Exegol **roadmap** (can be consulted in the **documentation** or on the Exegol **Discord**)
 

.github/workflows/entrypoint_prerelease.yml

@@ -40,4 +40,3 @@ jobs:
     name: Python tests and checks
     needs: preprod_test
     uses: ./.github/workflows/sub_testing.yml
-

.github/workflows/sub_testing.yml

@@ -23,6 +23,8 @@ jobs:
         run: pdm run -v mypy ./exegol.py --ignore-missing-imports --check-untyped-defs --pretty # TODO add --disallow-untyped-defs
       - name: Find spawn.sh script version
         run: egrep '^# Spawn Version:[0-9ab]+$' ./exegol/utils/imgsync/spawn.sh | cut -d ':' -f2
+      - name: Pre-commit checks
+        run: pdm run -v pre-commit run --all-files --hook-stage pre-commit
 
   compatibility:
     name: Compatibility checks

.pre-commit-config.yaml

@@ -0,0 +1,42 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+default_install_hook_types: [ pre-commit, pre-push ]
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+        exclude: 'exegol/config/UserConfig.py'
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-shebang-scripts-are-executable
+      - id: check-case-conflict
+      - id: name-tests-test
+      - id: check-illegal-windows-names
+      - id: mixed-line-ending
+        args:
+          - --fix=lf
+      - id: check-added-large-files
+        args:
+          - --maxkb=200  # Max 200kb file can be added
+  - repo: https://github.com/pre-commit/pygrep-hooks
+    rev: v1.10.0
+    hooks:
+      - id: python-no-eval
+      - id: python-use-type-annotations
+  - repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: v0.10.0.1
+    hooks:
+      - id: shellcheck
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: 'v1.15.0'
+    hooks:
+      - id: mypy
+        stages: [pre-push]
+        additional_dependencies: ["types-PyYAML", "types-requests", "types-tzlocal"]
+        exclude: "exegol.py"
+        args:
+          - --ignore-missing-imports
+          - --check-untyped-defs
+          - --pretty

CONTRIBUTING.md

@@ -7,8 +7,8 @@ Check the full contributors (up-to-date) documentation here: https://exegol.read
 - the `Exegol` repository includes the exegol.py wrapper code base, and features a `exegol-docker-build` submodule tracking [Exegol-images](https://github.com/ThePorgs/Exegol-images).
 - changes to the images/dockerfiles/tools/installs must be done on the [Exegol-images](https://github.com/ThePorgs/Exegol-images) repo.
 - by default, the wrapper pulls the latest DockerHub pre-built image for the install and updates
-- DockerHub automatic builds are configured as follows 
-  - `nightly` image is built using the base Dockerfile whenever a commit is made on [Exegol-images](https://github.com/ThePorgs/Exegol-images) `dev` branch. 
+- DockerHub automatic builds are configured as follows
+  - `nightly` image is built using the base Dockerfile whenever a commit is made on [Exegol-images](https://github.com/ThePorgs/Exegol-images) `dev` branch.
   - `full` image is built using the base Dockerfile whenever a new tag is pushed on [Exegol-images](https://github.com/ThePorgs/Exegol-images).
   - `ad`, `osint`, `web` and `light` images are built using specific Dockerfiles whenever a new tag is pushed on [Exegol-images](https://github.com/ThePorgs/Exegol-images).
 - if you want to locally build your image with your changes, run `exegol install local`. If you have local changes to the dockerfiles, they won't be overwritten.

README.md

@@ -58,4 +58,3 @@ Below are some bullet points to better understand how Exegol works
 </div>
 
 Dramelac and I work at [Capgemini](https://www.capgemini.com/) and we thank them for believing in the project since day 1, and for allowing us to have this personal initiative keep going.
-

exegol/config/DataCache.py

@@ -18,7 +18,7 @@ class DataCache(DataFileUtils, metaclass=MetaSingleton):
                 last_version: STR
             }
         }
-        images: 
+        images:
             metadata: {
                     last_check: DATE
             }

exegol/config/UserConfig.py

@@ -70,22 +70,22 @@ def _build_file_content(self) -> str:
     enable_exegol_resources: {self.enable_exegol_resources}
     
     # Change the configuration of the shell logging functionality
-    shell_logging: 
+    shell_logging:
         #Choice of the method used to record the sessions (script or asciinema)
         logging_method: {self.shell_logging_method}
         
         # Enable automatic compression of log files (with gzip)
         enable_log_compression: {self.shell_logging_compress}
-    
+        
     # Configure your Exegol Desktop
     desktop:
         # Enables or not the desktop mode by default
         # If this attribute is set to True, then using the CLI --desktop option will be inverted and will DISABLE the feature
         enabled_by_default: {self.desktop_default_enable}
-    
+        
         # Default desktop protocol,can be "http", or "vnc" (additional protocols to come in the future, check online documentation for updates).
         default_protocol: {self.desktop_default_proto}
-    
+        
         # Desktop service is exposed on localhost by default. If set to true, services will be exposed on localhost (127.0.0.1) otherwise it will be exposed on 0.0.0.0. This setting can be overwritten with --desktop-config
         localhost_by_default: {self.desktop_default_localhost}
 

exegol/model/ExegolContainer.py

@@ -370,7 +370,7 @@ def __applyX11ACLs(self) -> None:
                 return
 
             # If the left part of the display variable is "localhost", x11 socket is exposed only on loopback and remote access is used
-            # If the container is not in host mode, it won't be able to reach the loopback interface of the host 
+            # If the container is not in host mode, it won't be able to reach the loopback interface of the host
             if display_host == "localhost" and self.config.getNetworkMode() != "host":
                 logger.warning("X11 forwarding won't work on a bridged container unless you specify \"X11UseLocalhost no\" in your host sshd_config")
                 logger.warning("[red]Be aware[/red] changing \"X11UseLocalhost\" value can [red]expose your device[/red], correct firewalling is [red]required[/red]")

exegol/utils/imgsync/entrypoint.sh

@@ -33,9 +33,8 @@ function endless() {
   finish
   # Entrypoint for the container, in order to have a process hanging, to keep the container alive
   # Alternative to running bash/zsh/whatever as entrypoint, which is longer to start and to stop and to very clean
-  # shellcheck disable=SC2162
   mkfifo -m 000 /tmp/.entrypoint # Create an empty fifo for sleep by read.
-  read <> /tmp/.entrypoint  # read from /tmp/.entrypoint => endlessly wait without sub-process or need for TTY option
+  read -r <> /tmp/.entrypoint  # read from /tmp/.entrypoint => endlessly wait without sub-process or need for TTY option
 }
 
 function shutdown() {
@@ -68,7 +67,7 @@ function _resolv_docker_host() {
     # Add docker internal host resolution to the hosts file to preserve access to the X server
     echo "$DOCKER_IP        host.docker.internal" >>/etc/hosts
     # If the container share the host networks, no need to add a static mapping
-    ip route list match "$DOCKER_IP" table all | grep -v default || ip route add "$DOCKER_IP/32" $(ip route list | grep default | head -n1 | grep -Eo '(via [0-9]+\.[0-9]+\.[0-9]+\.[0-9]+ )?dev [a-zA-Z0-9]+') || echo '[W]Exegol cannot add a static route to resolv your host X11 server. GUI applications may not work.'
+    ip route list match "$DOCKER_IP" table all | grep -v default || ip route add "$DOCKER_IP/32" "$(ip route list | grep default | head -n1 | grep -Eo '(via [0-9]+\.[0-9]+\.[0-9]+\.[0-9]+ )?dev [a-zA-Z0-9]+')" || echo '[W]Exegol cannot add a static route to resolv your host X11 server. GUI applications may not work.'
   fi
 }