Merge branch 'main' into 33_pre-commit-hook

Author: RavenDenster

.flake8

@@ -0,0 +1,8 @@
+[flake8]
+max-line-length = 120
+extend-ignore = E203, E402
+exclude = 
+    .git,
+    __pycache__
+per-file-ignores =
+    __init__.py: F401, F403, W391

.github/workflows/flake8.yml

@@ -0,0 +1,20 @@
+name: Flake8 check (style check)
+
+on: [push]
+
+jobs:
+  flake8-lint:
+    runs-on: ubuntu-latest
+    name: Linters
+    steps:
+    - name: Check out source repository
+      uses: actions/checkout@v4
+    - name: Set up Python environment
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.10"
+        cache: "pip"
+    - name: flake8 Lint
+      uses: py-actions/flake8@v2
+      with:
+        path: "src"

README.md

@@ -1,5 +1,7 @@
 # qemu-riscv-cluster
 
+![Flake8 Status](https://img.shields.io/github/actions/workflow/status/moevm/qemu-riscv-cluster/.github/workflows/flake8.yml?branch=main&label=Flake8%20Check)
+
 ## Project structure
 -- This repository contains gRPC client and scripts to build and deploy workers in the RISC-V VM.
 

examples/simple_grpc/client.py

@@ -2,12 +2,14 @@
 import sum_pb2
 import sum_pb2_grpc
 
+
 def run():
     channel = grpc.insecure_channel('localhost:50051')
     stub = sum_pb2_grpc.SumServiceStub(channel)
-    
+
     response = stub.Sum(sum_pb2.SumRequest(a=22, b=2332))
     print(f"The result of the addition: {response.result}")
 
+
 if __name__ == '__main__':
     run()

examples/simple_grpc/server.py

@@ -4,11 +4,14 @@
 import sum_pb2_grpc
 
 SERVER_PORT = 50051
+
+
 class SumService(sum_pb2_grpc.SumServiceServicer):
     def Sum(self, request, context):
         result = request.a + request.b
         return sum_pb2.SumResponse(result=result)
-    
+
+
 def serve():
     server = grpc.server(futures.ThreadPoolExecutor(max_workers=10))
     sum_pb2_grpc.add_SumServiceServicer_to_server(SumService(), server)
@@ -17,5 +20,6 @@ def serve():
     print(f"The server is running on the port {SERVER_PORT}")
     server.wait_for_termination()
 
+
 if __name__ == '__main__':
     serve()

src/client/client.py

@@ -1,14 +1,14 @@
 import grpc
 from dotenv import load_dotenv
 import os
-from typing import Optional
 from src.utils.payload_generator import PayloadGenerator
 from src.protobuf import file_service_pb2
 from src.protobuf import file_service_pb2_grpc
 
 load_dotenv(os.path.join(os.path.dirname(__file__), "..", "..", "env", ".grpc.env"))
 
 
+
 class FileClient:
     def __init__(self):
         self.host: str = os.environ["GRPC_CLIENT_HOST"]
@@ -21,6 +21,7 @@ def __init__(self):
         ]
 
         self.channel: grpc.Channel = grpc.insecure_channel(f"{self.host}:{self.port}", options=options)
+
         self.stub: file_service_pb2_grpc.FileServiceStub = file_service_pb2_grpc.FileServiceStub(self.channel)
 
     def upload_and_validate(self, file_path: str, file_type: str) -> file_service_pb2.FileResponse:

src/server_tests/payload_generator_server.py

@@ -3,12 +3,13 @@
 import traceback
 from concurrent import futures
 from dotenv import load_dotenv
-from typing import Set, Optional
+from typing import Set
 from src.protobuf import file_service_pb2
 from src.protobuf import file_service_pb2_grpc
 
 load_dotenv(os.path.join(os.path.dirname(__file__), '..', '..', 'env', '.grpc.env'))
-AVAILABLE_CHARACTERS="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789 !?.,\n"
+AVAILABLE_CHARACTERS = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789 !?.,\n"
+
 
 class FileValidator:
     @staticmethod
@@ -23,7 +24,7 @@ def validate_text(content: bytes, charset: Set[str]) -> bool:
         `charset: Set[str]` - A set of valid characters.
 
         Output data:
-    
+
         `bool` - True if the content is valid, otherwise False.
         """
         try:
@@ -47,11 +48,13 @@ def validate_binary(content: bytes) -> bool:
         """
         return True
 
+
 class FileService(file_service_pb2_grpc.FileServiceServicer):
     def __init__(self, text_charset: str) -> None:
         self.text_charset: Set[str] = set(text_charset)
-        
-    def UploadFile(self, request: file_service_pb2.FileRequest, context: grpc.ServicerContext) -> file_service_pb2.FileResponse:
+
+    def UploadFile(self, request: file_service_pb2.FileRequest,
+                   context: grpc.ServicerContext) -> file_service_pb2.FileResponse:
         """
         Processes a request to upload a file.
 
@@ -62,7 +65,7 @@ def UploadFile(self, request: file_service_pb2.FileRequest, context: grpc.Servic
         `context: grpc.ServicerContext` - The gRPC Context
 
         Output data:
- 
+
         `file_service_pb2.FileResponse` - The response with the validation result.
         """
         try:
@@ -73,7 +76,7 @@ def UploadFile(self, request: file_service_pb2.FileRequest, context: grpc.Servic
                 is_valid = FileValidator.validate_text(request.content, self.text_charset)
             elif request.file_type == "binary":
                 is_valid = FileValidator.validate_binary(request.content)
-            
+
             return file_service_pb2.FileResponse(
                 size=actual_size,
                 is_valid=is_valid,
@@ -86,6 +89,7 @@ def UploadFile(self, request: file_service_pb2.FileRequest, context: grpc.Servic
             context.set_details(f"Error: {e}")
             return file_service_pb2.FileResponse()
 
+
 def serve():
     """
     Starts the gRPC server.
@@ -95,23 +99,24 @@ def serve():
     host = os.environ['GRPC_SERVER_HOST']
 
     options = [
-        ('grpc.max_receive_message_length', max_message_length), 
-        ('grpc.max_send_message_length', max_message_length), 
+        ('grpc.max_receive_message_length', max_message_length),
+        ('grpc.max_send_message_length', max_message_length),
     ]
-    
+
     server = grpc.server(
         futures.ThreadPoolExecutor(max_workers=10),
         options=options
     )
-    
+
     file_service_pb2_grpc.add_FileServiceServicer_to_server(
-        FileService(text_charset=AVAILABLE_CHARACTERS), 
+        FileService(text_charset=AVAILABLE_CHARACTERS),
         server
     )
     server.add_insecure_port(f'{host}:{port}')
     server.start()
     print(f"Server started on port {port}")
     server.wait_for_termination()
 
+
 if __name__ == '__main__':
-    serve()
+    serve()

src/utils/payload_generator.py

@@ -3,6 +3,7 @@
 import uuid
 from typing import Optional, Literal
 
+
 class PayloadGenerator:
     """
     This class is a payload generator.
@@ -18,7 +19,7 @@ def __init__(
     ):
         if unit not in ("B", "KB", "MB"):
             raise ValueError("Invalid unit of measurement. Allowed: 'B', 'KB', 'MB'")
-        
+
         multipliers = {
             "B": 1,
             "KB": 1024,
@@ -86,7 +87,7 @@ def _generate_text(self, path: str):
         """text data generation"""
         charset = self.text_charset
         buffer_size = 128 * 1024
-        
+
         with open(path, 'w', encoding='utf-8') as f:
             remaining = self.file_size
             buffer = []
@@ -100,11 +101,11 @@ def _generate_text(self, path: str):
                 if len(encoded) > remaining:
                     encoded = encoded[:remaining]
                     chunk = encoded.decode('utf-8', errors='ignore')
-                
+
                 buffer.append(chunk)
                 current_buffer_size += len(encoded)
                 remaining -= len(encoded)
-                
+
                 if current_buffer_size >= buffer_size:
                     f.write(''.join(buffer))
                     buffer = []
@@ -114,4 +115,4 @@ def _generate_text(self, path: str):
                 f.write(''.join(buffer))
 
     def get_charset(self):
-        return self.text_charset
+        return self.text_charset

tests/conftest.py

@@ -10,23 +10,25 @@
 
 from src.client.client import FileClient
 
+
 @pytest.fixture(scope="module")
 def grpc_server():
     controller_path = os.path.join(
         os.path.dirname(__file__), '..', 'src', 'server_tests', 'payload_generator_server.py'
     )
     env = os.environ.copy()
     env["PYTHONPATH"] = os.pathsep.join(sys.path)
-    
+
     server_process = subprocess.Popen(
         ['python3', controller_path],
         env=env
     )
-    time.sleep(2) 
+    time.sleep(2)
     yield
     server_process.terminate()
 
+
 @pytest.fixture(scope="module")
 def grpc_client():
     client = FileClient()
-    return client
+    return client

tests/integration/test_grpc_payload_generator.py

@@ -1,17 +1,13 @@
-import subprocess
-import time
 import pytest
-import grpc
-import sys
 import os
-
 from src.utils.payload_generator import PayloadGenerator
 
+
 @pytest.mark.integration
 def test_text_file_upload(tmpdir, grpc_server, grpc_client):
     text_size = 10
     file_path = os.path.join(tmpdir, "test_text_file.txt")
-    
+
     generator = PayloadGenerator(size=text_size, file_type="text", unit="MB")
     generated_path = generator.generate(path=file_path)
     response = grpc_client.upload_and_validate(generated_path, "text")
@@ -20,15 +16,16 @@ def test_text_file_upload(tmpdir, grpc_server, grpc_client):
     assert response.is_valid is True
     assert response.message == "Validation successful"
 
+
 @pytest.mark.integration
 def test_binary_file_upload(tmpdir, grpc_server, grpc_client):
     binary_size = 2048
     file_path = os.path.join(tmpdir, "test_binary_file.bin")
-    
+
     generator = PayloadGenerator(size=binary_size, file_type="binary")
     generated_path = generator.generate(path=file_path)
     response = grpc_client.upload_and_validate(generated_path, "binary")
 
     assert response.size == binary_size
     assert response.is_valid is True
-    assert response.message == "Validation successful"
+    assert response.message == "Validation successful"