Merge pull request #46 from FlysonBot/dev

test: add and improve test

Author: FlysonBot

.github/workflows/coveralls.yaml .github/workflows/coverage.yaml.github/workflows/coveralls.yaml renamed to .github/workflows/coverage.yaml

@@ -1,6 +1,6 @@
 on: ["push", "pull_request"]
 
-name: Coveralls Test Coverage
+name: Update Test Coverage
 
 permissions:
   contents: read
@@ -24,11 +24,21 @@ jobs:
           pip install -r src/requirements.txt
           pip install coveralls
           pip install pytest
-
-      - name: Run Coverall
+      
+      - name: Generate Coverage Report
         env:
           PYTHONPATH: ./src
-          GITHUB_TOKEN: ${{ secrets. GITHUB_TOKEN }}
         run: |
           coverage run -m pytest tests/
-          coveralls
+          coverage xml
+
+      - name: Upload Report to Coveralls
+        env:
+          GITHUB_TOKEN: ${{ secrets. GITHUB_TOKEN }}
+        run: coveralls
+
+      - name: Upload Report to Codacy
+        uses: codacy/[email protected]
+        with:
+          project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
+          coverage-reports: coverage.xml

.github/workflows/ossf_scorecard.yml

@@ -3,9 +3,6 @@ on:
   push:
     branches:
       - main
-  pull_request_target:
-    branches:
-      - main
   workflow_dispatch:
 
 permissions: read-all

examples/install.sh

@@ -4,7 +4,7 @@ check_python() {
     # Check for Python installation
     if ! command -v python3 &>/dev/null; then
         echo "Python is not installed."
-        read -p "Do you want to install Python 3.10.12? (y/n): " install_python
+        read -r -p "Do you want to install Python 3.10.12? (y/n): " install_python
         if [[ "$install_python" == "y" ]]; then
             install_python
         else
@@ -15,7 +15,7 @@ check_python() {
         PYTHON_VERSION=$(python3 --version | grep -oP '\d+\.\d+')
         if (( $(echo "$PYTHON_VERSION < 3.10" | bc -l) )); then
             echo "Python version is less than 3.10."
-            read -p "Do you want to update to Python 3.10.12? (y/n): " update_python
+            read -r -p "Do you want to update to Python 3.10.12? (y/n): " update_python
             if [[ "$update_python" == "y" ]]; then
                 install_python
             else
@@ -52,7 +52,7 @@ check_mastermind_ai() {
     else
         echo "mastermind-ai is already installed."
         if pip list --outdated | grep mastermind-ai &>/dev/null; then
-            read -p "An update for mastermind-ai is available. Do you want to update it? (y/n): " update_package
+            read -r -p "An update for mastermind-ai is available. Do you want to update it? (y/n): " update_package
             if [[ "$update_package" == "y" ]]; then
                 pip install --upgrade mastermind-ai
             fi

src/mastermind/game/board.py

@@ -25,8 +25,6 @@ class EmptyBoardError(Exception):
         Exception raised when trying to access the game board when it is empty.
         """
 
-        pass
-
     def __init__(self, number_of_colors: int, number_of_dots: int) -> None:
         self.NUMBER_OF_COLORS = number_of_colors
         self.NUMBER_OF_DOTS = number_of_dots

src/mastermind/ui/menu/base_menu.py

@@ -18,7 +18,6 @@ def name(self) -> str:
 
         This is an abstract property that must be implemented by subclasses.
         """
-        pass
 
     @property
     def width(self) -> int:
@@ -52,7 +51,6 @@ def _print_content(self) -> None:
 
         This is an abstract method that must be implemented by subclasses.
         """
-        pass
 
     def _print_separator(self) -> None:
         """

src/mastermind/ui/menu/data_menu.py

@@ -28,7 +28,6 @@ def _fetch_data(self) -> Optional[Any]:
 
         This is an abstract method that must be implemented by subclasses.
         """
-        pass
 
     @abstractmethod
     def _render_data(self, data: Any) -> None:
@@ -37,7 +36,6 @@ def _render_data(self, data: Any) -> None:
 
         This is an abstract method that must be implemented by subclasses.
         """
-        pass
 
     @property
     @abstractmethod
@@ -47,4 +45,3 @@ def _empty_message(self) -> str:
 
         This is an abstract property that must be implemented by subclasses.
         """
-        pass

src/mastermind/ui/menu/resume_game_menu.py

@@ -63,5 +63,5 @@ def get_option(self) -> Union[str, int]:
             self.display()
 
 
-def _is_option_valid(option: int, number_of_options: int) -> bool:
-    return option.isdigit() and 0 <= option <= number_of_options
+def _is_option_valid(option: str, number_of_options: int) -> bool:
+    return option.isdigit() and 0 <= int(option) <= number_of_options

src/mastermind/validation/base/base.py

@@ -22,7 +22,6 @@ def validate_value(self, value: Any) -> T:
         Returns:
             T: The validated value.
         """
-        pass
 
 
 class ValidationModel(Validator[T], ABC):
@@ -49,7 +48,6 @@ def validate_arguments(self) -> None:
 
         This method must be implemented by subclasses to perform any necessary validation.
         """
-        pass
 
 
 class StateValidator(Validator[T], ABC):
@@ -79,7 +77,6 @@ def validate_modifications(self, new_value: Any) -> None:
         Raises:
             ValidationError: If the new value is invalid.
         """
-        pass
 
     @property
     def value(self) -> T:

src/mastermind/validation/base/exceptions.py

@@ -3,44 +3,32 @@ class ValidationError(Exception):
     The base class for all validation-related exceptions.
     """
 
-    pass
-
 
 class MissingParameterError(ValidationError):
     """
     Raised when a required parameter is missing.
     """
 
-    pass
-
 
 class TypeValidationError(ValidationError):
     """
     Raised when a value does not match the expected type.
     """
 
-    pass
-
 
 class InputConversionError(ValidationError):
     """
     Raised when a value cannot be converted to the expected type.
     """
 
-    pass
-
 
 class RangeError(ValidationError):
     """
     Raised when a value is outside the expected range.
     """
 
-    pass
-
 
 class InvalidModificationError(ValidationError):
     """
     Raised when a modification to a validated value is invalid.
     """
-
-    pass

src/mastermind/validation/base/numeric.py

@@ -90,7 +90,6 @@ def convert(self, value: str) -> Number:
         Raises:
             InputConversionError: If the value cannot be converted to the expected numeric type.
         """
-        pass
 
     def validate_range(self, value: Number) -> None:
         """