Merge pull request #2 from andreped/test-ci

Implemented CI workflow for unit tests and linting

.github/workflows/tests.yml

@@ -0,0 +1,27 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - '**'
+
+jobs:
+  tests:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      
+      - name: Set up Python 3.6
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.6"
+
+      - name: Install dependencies
+        run: pip install -r requirements.txt
+      
+      - name: Check formatting
+        run: sh shell/lint.sh
+      
+      - name: Run tests
+        run: pytest -v tests/

postly/clients/postly_client.py

@@ -54,13 +54,13 @@ class PostlyClient:
         """
         if user_name not in self.userPosts:
             raise KeyError(f"User {user_name} not found.")
-        
+
         if len(post_text) > self.post_max_length:
             raise RuntimeError("Post is too long")
 
         if not post_text.strip():
             raise ValueError("Post cannot be empty.")
-        
+
         if not isinstance(timestamp, int) or timestamp < 0:
             raise ValueError("Timestamp must be a non-negative integer.")
 
@@ -80,7 +80,7 @@ class PostlyClient:
         """
         if user_name not in self.userPosts:
             raise KeyError(f"User '{user_name}' not found.")
-        
+
         self.userPosts.pop(user_name, None)
 
     def get_posts_for_user(self, user_name: str) -> List[str]:
@@ -94,7 +94,7 @@ class PostlyClient:
         """
         if user_name not in self.userPosts:
             raise KeyError(f"User '{user_name} not found.")
-        
+
         return [post_data.content for post_data in self.userPosts[user_name][::-1]]
 
     def get_posts_for_topic(self, topic: str) -> List[str]:
@@ -126,13 +126,13 @@ class PostlyClient:
         """
         if not isinstance(from_timestamp, int) or from_timestamp < 0:
             raise ValueError("from_timestamp must be a non-negative integer.")
-        
+
         if not isinstance(to_timestamp, int) or to_timestamp < 0:
             raise ValueError("to_timestamp must be a non-negative integer.")
-        
+
         if from_timestamp > to_timestamp:
             raise ValueError("from_timestamp cannot be greater than to_timestamp.")
-        
+
         # construct topic histogram
         topics_frequency = Counter()
         for user in self.userPosts:

postly/common/models.py

@@ -1,7 +1,8 @@
 from dataclasses import dataclass
-from pydantic import BaseModel
 from typing import List
 
+from pydantic import BaseModel
+
 
 class StrictPost(BaseModel):
     content: str

shell/format.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+isort --sl postly/
+black --line-length 120 postly/
+flake8 --max-line-length 120 postly/

shell/lint.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+isort --check --sl -c postly/
+if ! [ $? -eq 0 ]
+then
+  echo "Please run \"sh shell/format.sh\" to format the code."
+  exit 1
+fi
+echo "no issues with isort"
+flake8 --max-line-length 120 postly/
+if ! [ $? -eq 0 ]
+then
+  echo "Please fix the code style issue."
+  exit 1
+fi
+echo "no issues with flake8"
+black --check --line-length 120 postly/
+if ! [ $? -eq 0 ]
+then
+  echo "Please run \"sh shell/format.sh\" to format the code."
+    exit 1
+fi
+echo "no issues with black"
+echo "linting success!"