Merge pull request #57 from abbastoof/feature/015-game-history-microservice

Feature/015 game history microservice

Author: mtoof

Diff for: .github/workflows/ci-pipeline.yml

@@ -16,11 +16,36 @@ jobs:
       - name: Check out code
         uses: actions/checkout@v2
 
-      - name: Build and run linter
-        uses: docker/build-push-action@v3
+      - name: Set up Python
+        uses: actions/setup-python@v2
         with:
-          context: .
-          file: ./Dockerfile.lint
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: |
+          python -m venv venv
+          . venv/bin/activate
+          python -m pip install --upgrade pip
+          pip install setuptools==58.0.4 wheel
+          pip install -r requirements.txt
+          pip install flake8
+      - name: Create flake8 configuration file
+        run: |
+          echo "[flake8]" > .flake8
+          echo "exclude = venv/*" >> .flake8
+          echo "max-line-length = 99" >> .flake8
+
+      - name: Verify installed packages
+        run: |
+          . venv/bin/activate
+          pip check
+
+      - name: Run linters
+        run: |
+          . venv/bin/activate
+          flake8 .
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
   run-tests:
     needs: lint-project
@@ -29,11 +54,24 @@ jobs:
       - name: Check out code
         uses: actions/checkout@v2
 
-      - name: Build and run tests
-        uses: docker/build-push-action@v3
+      - name: Set up Python
+        uses: actions/setup-python@v2
         with:
-          context: .
-          file: ./Dockerfile.test
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: |
+          python -m venv venv
+          . venv/bin/activate
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      - name: Run tests
+        run: |
+          . venv/bin/activate
+          pytest --maxfail=1 --disable-warnings
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
   publish-test-image:
     needs: run-tests
@@ -56,7 +94,7 @@ jobs:
         uses: docker/build-push-action@v3
         with:
           context: .
-          file: ./Dockerfile.publish
+          file: ./Dockerfile
           push: true
           tags: ghcr.io/${{ github.repository }}:${{ github.ref_name }}
 

Diff for: Backend/game_history/game_history/game_data/models.py

@@ -3,13 +3,17 @@
 
 class GameHistory(models.Model):
     game_id = models.AutoField(primary_key=True)
+    player1_username = models.CharField(max_length=50)
     player1_id = models.IntegerField()
+    player2_username = models.CharField(max_length=50)
     player2_id = models.IntegerField()
     winner_id = models.IntegerField()
     start_time = models.DateTimeField()
     end_time = models.DateTimeField(null=True, blank=True)
     def __str__(self):
-        return f"Game {self.game_id}: {self.player1_id} vs {self.player2_id} - Winner: {self.winner_id}"
+        return f"Game {self.game_id}: {self.player1_username} vs {self.player2_username} - Winner: {self.winner_id}"
+
+    REQUIRED_FIELDS = ['player1_id', 'player2_id']
 
 class GameStat(models.Model):
     game_id = models.OneToOneField(GameHistory, on_delete=models.CASCADE, primary_key=True) # this field is a foreign key to the GameHistory model

Diff for: Backend/game_history/game_history/game_data/serializers.py

@@ -4,9 +4,12 @@
 from .models import GameHistory, GameStat
 
 class GameHistorySerializer(serializers.ModelSerializer):
+    game_summary = serializers.SerializerMethodField()
     class Meta:
         model = GameHistory
         fields = '__all__'
+    def get_game_summary(self, obj):
+        return str(obj)
 class GameStatSerializer(serializers.ModelSerializer):
     class Meta:
         model = GameStat

Diff for: Backend/game_history/game_history/game_history/tests/conftest.py

@@ -13,11 +13,11 @@
         DATABASES={
             "default": {
                 "ENGINE": "django.db.backends.postgresql",
-                "NAME": "postgres",
+                "NAME": "game_history",
+                "HOST": "postgresql",
                 "USER": "root",
                 "PASSWORD": "root",
                 "PORT": "5432",
-                "HOST": "localhost",
                 "ATOMIC_REQUESTS": True,
             "TEST": {
                 "NAME": "mytestdatabase",
@@ -95,7 +95,7 @@
 django.setup()
 
 @pytest.fixture(scope='session', autouse=True)
-def django_db_setup():
+def django_db_modify_db_settings():
     settings.DATABASES['default'] = settings.DATABASES['default']['TEST']
 
 @pytest.fixture(scope='session')

Diff for: Backend/game_history/game_history/game_history/tests/test_game_history.py

@@ -14,7 +14,9 @@ def api_client():
 def test_create_game_history(api_client):
     url = reverse('game-history-list') # reverse() is used to generate the URL for the 'game-history-list' view
     data = {
+        'player1_username': 'player1',
         'player1_id': 1,
+        'player2_username': 'player2',
         'player2_id': 2,
         'winner_id': 1,
         'start_time': '2024-07-03T12:00:00Z'
@@ -23,7 +25,9 @@ def test_create_game_history(api_client):
     assert response.status_code == status.HTTP_201_CREATED
     assert GameHistory.objects.count() == 1 # Objects count should be 1 after creating a new GameHistory object in the database
     game_history = GameHistory.objects.first() # Get the first GameHistory object from the database (there should be only one) because we just created it
+    assert game_history.player1_username == 'player1'
     assert game_history.player1_id == 1 # The player1_id should be 1 because we set it to 1 in the data
+    assert game_history.player2_username == 'player2'
     assert game_history.player2_id == 2 # The player2_id should be 2 because we set it to 2 in the data
     assert game_history.winner_id == 1 # The winner_id should be 1 because we set it to 1 in the data
     assert game_history.start_time.isoformat() == '2024-07-03T12:00:00+00:00' # The start_time should be '2024-07-03T12:00:00+00:00' because we set it to that value in the data
@@ -68,18 +72,22 @@ def test_retrieve_game_history(api_client):
 
 @pytest.mark.django_db
 def test_update_game_history(api_client):
-    game = GameHistory.objects.create(player1_id=1, player2_id=2, winner_id=1, start_time=now())
+    game = GameHistory.objects.create(player1_username='player1', player1_id=1, player2_username='player2', player2_id=2, winner_id=1, start_time=now())
 
     url = reverse('game-history-detail', args=[game.pk])
     data = {
+        'player1_username': 'player1_updated',
         'player1_id': 1,
+        'player2_username': 'player2_updated',
         'player2_id': 2,
         'winner_id': 2,
         'start_time': game.start_time.isoformat().replace('+00:00', 'Z')
     }
     response = api_client.put(url, data, format='json')
     assert response.status_code == status.HTTP_200_OK
     game.refresh_from_db()
+    assert game.player1_username == 'player1_updated'
+    assert game.player2_username == 'player2_updated'
     assert game.winner_id == 2
 
 @pytest.mark.django_db
@@ -108,9 +116,10 @@ def test_create_game_history_validation_error(api_client):
 def test_primary_key_increment(api_client):
     initial_count = GameHistory.objects.count()
 
-    # Create a new game history entry
     data = {
+        'player1_username': 'player1',
         'player1_id': 1,
+        'player2_username': 'player2',
         'player2_id': 2,
         'winner_id': 1,
         'start_time': '2024-07-03T12:00:00Z',
@@ -119,13 +128,11 @@ def test_primary_key_increment(api_client):
     response = api_client.post('/game-history/', data, format='json')
     assert response.status_code == 201
 
-    # Check the count after insertion
     new_count = GameHistory.objects.count()
     assert new_count == initial_count + 1
 
-    # Get the latest entry and check the primary key
     latest_entry = GameHistory.objects.latest('game_id')
-    print(latest_entry.game_id)  # This will print the latest primary key value
+    print(latest_entry.game_id)
 
 @pytest.mark.django_db
 def test_create_game_stat(api_client):

Diff for: Backend/token_service/token_service/token_app/serializers.py

@@ -1,6 +1,4 @@
 from rest_framework_simplejwt.serializers import TokenObtainPairSerializer
-from rest_framework import serializers
-from .models import UserTokens
 import asyncio
 
 class CustomTokenObtainPairSerializer(TokenObtainPairSerializer):
@@ -10,20 +8,15 @@ def get_token(cls, user) -> dict:
         """
             Get token method to generate tokens for the user.
 
-            This method overrides the get_token method of TokenObtainPairSerializer to generate tokens for the user. 
+            This method overrides the get_token method of TokenObtainPairSerializer to generate tokens for the user.
             It generates the tokens for the user and returns the tokens.
 
             Args:
                 user: The user object.
-            
+
             Returns:
                 dict: The dictionary containing the tokens.
         """
         token = super().get_token(user)
         token["custom_claims"] = {"username": user.username, "password": user.password}
         return token
-    
-class UserTokenModelSerializer(serializers.ModelSerializer):
-    class Meta:
-        model = UserTokens
-        fields = "__all__"

Diff for: Backend/token_service/token_service/token_service/settings.py

@@ -59,8 +59,8 @@
 SIMPLE_JWT = {
     "ACCESS_TOKEN_LIFETIME": timedelta(minutes=60),
     "REFRESH_TOKEN_LIFETIME": timedelta(days=1),
-    "ROTATE_REFRESH_TOKENS": False,  # If True, refresh tokens will rotate, meaning that a new token is returned with each request to the refresh endpoint. for example, if a user is logged in on multiple devices, rotating refresh tokens will cause all devices to be logged out when the user logs out on one device.
-    "BLACKLIST_AFTER_ROTATION": True,  # If True, the refresh token will be blacklisted after it is used to obtain a new access token. This means that if a refresh token is stolen, it can only be used once to obtain a new access token. This is useful if rotating refresh tokens is enabled, but can cause problems if a refresh token is shared between multiple clients.
+    "ROTATE_REFRESH_TOKENS": False,
+    "BLACKLIST_AFTER_ROTATION": True,
     "AUTH_HEADER_TYPES": ("Bearer",),
     "AUTH_TOKEN_CLASSES": ("rest_framework_simplejwt.tokens.AccessToken",),
     "TOKEN_OBTAIN_SERIALIZER": "token_app.serializers.CustomTokenObtainPairSerializer"

Diff for: Backend/user_service/user_service/user_app/rabbitmq_utils.py

@@ -2,7 +2,7 @@
 import pika
 from django.conf import settings
 
-# Singleton pattern for managing RabbitMQ connection
+
 class RabbitMQManager:
     _connection = None
 

Diff for: Dockerfile

@@ -1,17 +1,15 @@
 FROM alpine:3.20
 
 # Install Python and pip
-RUN apk add --no-cache python3 py3-pip && \
-    python3 -m ensurepip && \
-    ln -sf python3 /usr/bin/python
+RUN apk add --no-cache python3 py3-pip
 
-ENV PYTHONDONTWRITEBYTECODE 1
-ENV PYTHONUNBUFFERED 1
+# Create and activate virtual environment
+RUN python3 -m venv /venv
 
+# Copy requirements and install within virtual environment
 COPY ./requirements.txt /requirements.txt
-RUN python -m pip install --upgrade pip
-RUN pip install setuptools==58.0.4 wheel
-RUN pip install flake8
+RUN /venv/bin/pip install --no-cache-dir -r /requirements.txt
+RUN /venv/bin/pip install --no-cache-dir flake8
 
 WORKDIR /app
 
@@ -22,4 +20,4 @@ RUN addgroup -S www-data && adduser -S www-data -G www-data && \
 
 USER www-data
 
-CMD ["flake8", "."]
+CMD ["/venv/bin/flake8", "."]

Diff for: Dockerfile.lint

@@ -1,17 +1,14 @@
 FROM alpine:3.20
 
 # Install Python and pip
-RUN apk add --no-cache python3 py3-pip && \
-    python3 -m ensurepip && \
-    ln -sf python3 /usr/bin/python
+RUN apk add --no-cache python3 py3-pip
 
-ENV PYTHONDONTWRITEBYTECODE 1
-ENV PYTHONUNBUFFERED 1
+# Create and activate virtual environment
+RUN python3 -m venv /venv
 
+# Copy requirements and install within virtual environment
 COPY ./requirements.txt /requirements.txt
-RUN python -m pip install --upgrade pip
-RUN pip install setuptools==58.0.4 wheel
-RUN pip install -r /requirements.txt
+RUN /venv/bin/pip install --no-cache-dir -r /requirements.txt
 
 WORKDIR /app
 
@@ -24,4 +21,4 @@ USER www-data
 
 EXPOSE 8000
 
-CMD ["python", "manage.py", "runserver", "0.0.0.0:8000"]
+CMD ["/venv/bin/python", "manage.py", "runserver", "0.0.0.0:8000"]

Diff for: Dockerfile.publish

@@ -1,17 +1,14 @@
 FROM alpine:3.20
 
 # Install Python and pip
-RUN apk add --no-cache python3 py3-pip && \
-    python3 -m ensurepip && \
-    ln -sf python3 /usr/bin/python
+RUN apk add --no-cache python3 py3-pip
 
-ENV PYTHONDONTWRITEBYTECODE 1
-ENV PYTHONUNBUFFERED 1
+# Create and activate virtual environment
+RUN python3 -m venv /venv
 
+# Copy requirements and install within virtual environment
 COPY ./requirements.txt /requirements.txt
-RUN python -m pip install --upgrade pip
-RUN pip install setuptools==58.0.4 wheel
-RUN pip install -r /requirements.txt
+RUN /venv/bin/pip install --no-cache-dir -r /requirements.txt
 
 WORKDIR /app
 
@@ -22,4 +19,4 @@ RUN addgroup -S www-data && adduser -S www-data -G www-data && \
 
 USER www-data
 
-CMD ["pytest", "--maxfail=1", "--disable-warnings"]
+CMD ["/venv/bin/pytest", "--maxfail=1", "--disable-warnings"]