MS Backend server for BIT development purpose

replace db uri

add Flask-Cors to requirements.txt

linting with black formatter

remove fetch env variables duplication

change pull-push branch for github action to bit branch

add postgresql test db

add shell_context_processor

Add -h postgres to psql command

Place PGPASSWORD at the start of psql command

Add env for running test

* Update main.yml (Patch #21)

Co-authored-by: Aditya Kurkure

use non-macOS syntax for db_uri and add db envs

Add postgres db url for github action

Add test for db_test_uri

remove hard coded test db uri

Add psycopg2

Fix db type to postgres+psycopg2

add env to Generate coverage report

move env to global runner

focus pytest cov on tests folder

Remove print command

.github/workflows/main.yml

@@ -5,33 +5,66 @@ name: Run tests
 
 on:
   push:
-    branches: [ develop ]
+    branches: [ bit ]
   pull_request:
-    branches: [ develop ]
+    branches: [ bit ]
 
 jobs:
   build:
 
     runs-on: ubuntu-latest
-
+    env:
+      DB_TYPE: postgresql+psycopg2
+      DB_USERNAME: postgres
+      DB_PASSWORD: postgres
+      DB_ENDPOINT: localhost:5432 
+      DB_TEST_NAME: bit_schema_test
+    services:
+      postgres:
+        image: postgres
+        env: 
+          POSTGRES_PASSWORD: postgres
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
     steps:
     - uses: actions/checkout@v2
+    - name: Connect to PostgreSQL
+      run: |
+        PGPASSWORD=postgres psql -h localhost -c 'CREATE DATABASE bit_schema_test;' -U postgres
+        PGPASSWORD=postgres psql -h localhost -c 'CREATE SCHEMA bitschema;' -U postgres -d bit_schema_test
+        PGPASSWORD=postgres psql -h localhost -c 'CREATE SCHEMA test_schema;' -U postgres -d bit_schema_test
+        PGPASSWORD=postgres psql -h localhost -c 'create SCHEMA test_schema_2;' -U postgres -d bit_schema_test
+        PGPASSWORD=postgres psql -h localhost -c '\dn;' -U postgres -d bit_schema_test
+        PGPASSWORD=postgres psql -h localhost -c 'show search_path;' -U postgres -d bit_schema_test
+        PGPASSWORD=postgres psql -h localhost -c "ALTER DATABASE bit_schema_test SET search_path TO bitschema,public;" -U postgres -d bit_schema_test
+        PGPASSWORD=postgres psql -h localhost -c 'show search_path;' -U postgres -d bit_schema_test
+      env:
+        POSTGRES_HOST: localhost
+        POSTGRES_PORT: 5432
     - name: Set up Python 3.6
       uses: actions/setup-python@v2
       with:
         python-version: 3.6
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip
+        sudo -H python -m pip install --upgrade pip
+        pip --version
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
     - name: Run tests
       run: |
         python -m unittest discover tests -v
+       
     - name: Generate coverage report
       run: |
         pip install pytest
         pip install pytest-cov
-        pytest --cov=./ --cov-report=xml
+        pytest --cov tests/ --cov-report=xml
+ 
     - name: Upload coverage to Codecov
       uses: codecov/codecov-action@v1
       with:

app/api/dao/user.py

@@ -259,11 +259,11 @@ def update_user_profile(user_id: int, data: Dict[str, str]):
             else:
                 user.occupation = None
 
-        if "organization" in data:
-            if data["organization"]:
-                user.organization = data["organization"]
+        if "current_organization" in data:
+            if data["current_organization"]:
+                user.current_organization = data["current_organization"]
             else:
-                user.organization = None
+                user.current_organization = None
 
         if "slack_username" in data:
             if data["slack_username"]:

app/api/models/admin.py

@@ -32,7 +32,9 @@ def add_models_to_namespace(api_namespace):
         "bio": fields.String(required=True, description="User bio"),
         "location": fields.String(required=True, description="User location"),
         "occupation": fields.String(required=True, description="User occupation"),
-        "organization": fields.String(required=True, description="User organization"),
+        "current_organization": fields.String(
+            required=True, description="User current organization"
+        ),
         "skills": fields.String(required=True, description="User skills"),
     },
 )

app/api/models/user.py

@@ -47,7 +47,9 @@ def add_models_to_namespace(api_namespace):
         "bio": fields.String(required=True, description="User bio"),
         "location": fields.String(required=True, description="User location"),
         "occupation": fields.String(required=True, description="User occupation"),
-        "organization": fields.String(required=True, description="User organization"),
+        "current_organization": fields.String(
+            required=True, description="User current_organization"
+        ),
         "interests": fields.String(required=True, description="User interests"),
         "skills": fields.String(required=True, description="User skills"),
         "need_mentoring": fields.Boolean(
@@ -91,7 +93,9 @@ def add_models_to_namespace(api_namespace):
         "bio": fields.String(required=False, description="User bio"),
         "location": fields.String(required=False, description="User location"),
         "occupation": fields.String(required=False, description="User occupation"),
-        "organization": fields.String(required=False, description="User organization"),
+        "current_organization": fields.String(
+            required=False, description="User current_organization"
+        ),
         "slack_username": fields.String(
             required=False, description="User slack username"
         ),
@@ -179,7 +183,9 @@ def add_models_to_namespace(api_namespace):
         "bio": fields.String(required=False, description="User bio"),
         "location": fields.String(required=False, description="User location"),
         "occupation": fields.String(required=False, description="User occupation"),
-        "organization": fields.String(required=False, description="User organization"),
+        "current_organization": fields.String(
+            required=False, description="User current_organization"
+        ),
         "slack_username": fields.String(
             required=False, description="User slack username"
         ),

app/api/resources/admin.py

@@ -98,7 +98,7 @@ def get(cls):
         A admin user with valid access token can view the list of all admins. The endpoint
         doesn't take any other input. A JSON array having an object for each admin user is
         returned. The array contains id, username, name, slack_username, bio,
-        location, occupation, organization, skills.
+        location, occupation, current_organization, skills.
         The current admin user's details are not returned.
         """
         user_id = get_jwt_identity()

app/api/resources/user.py

@@ -63,8 +63,8 @@ def get(cls):
         A user with valid access token can view the list of users. The endpoint
         doesn't take any other input. A JSON array having an object for each user is
         returned. The array contains id, username, name, slack_username, bio,
-        location, occupation, organization, interests, skills, need_mentoring,
-        available_to_mentor, registration_date. The current user's details are not returned.
+        location, occupation, current_organization, interests, skills, need_mentoring,
+        available_to_mentor. The current user's details are not returned.
         """
 
         page = request.args.get("page", default=UserDAO.DEFAULT_PAGE, type=int)
@@ -158,7 +158,7 @@ def put(cls):
 
         A user with valid access token can use this endpoint to edit his/her own
         user details. The endpoint takes any of the given parameters (name, username,
-        bio, location, occupation, organization, slack_username, social_media_links,
+        bio, location, occupation, current_organization, slack_username, social_media_links,
         skills, interests, resume_url, photo_url, need_mentoring, available_to_mentor).
         The response contains a success message.
         """
@@ -269,7 +269,7 @@ def get(cls):
         A user with valid access token can view the list of verified users. The endpoint
         doesn't take any other input. A JSON array having an object for each user is
         returned. The array contains id, username, name, slack_username, bio,
-        location, occupation, organization, interests, skills, need_mentoring,
+        location, occupation, current_organization, interests, skills, need_mentoring,
         available_to_mentor. The current user's details are not returned.
         """
 
@@ -337,7 +337,6 @@ def post(cls):
 
         if result[1] is HTTPStatus.CREATED:
             send_email_verification_message(data["name"], data["email"])
-
         return result
 
 

app/api/validations/user.py

@@ -162,13 +162,13 @@ def validate_update_profile_request_data(data):
         if not is_valid[0]:
             return is_valid[1]
 
-    organization = data.get("organization", None)
-    if organization:
+    current_organization = data.get("current_organization", None)
+    if current_organization:
         is_valid = validate_length(
-            len(get_stripped_string(organization)),
+            len(get_stripped_string(current_organization)),
             0,
             ORGANIZATION_MAX_LENGTH,
-            "organization",
+            "current_organization",
         )
         if not is_valid[0]:
             return is_valid[1]

app/database/models/mentorship_relation.py

@@ -16,10 +16,10 @@ class MentorshipRelationModel(db.Model):
         action_user_id: integer indicates id of action user.
         mentor: relationship between UserModel and mentorship_relation.
         mentee: relationship between UserModel and mentorship_relation.
-        creation_date: float that defines the date of creation of the mentorship.
-        accept_date: float that indicates the date of acceptance of mentorship.
-        start_date: float that indicates the starting date of mentorship.
-        end_date: float that indicates the ending date of mentorship.
+        creation_date: numeric that defines the date of creation of the mentorship.
+        accept_date: numeric that indicates the date of acceptance of mentorship.
+        start_date: numeric that indicates the starting date of mentorship.
+        end_date: numeric that indicates the ending date of mentorship.
         state: enumeration that indicates state of mentorship.
         notes: string that indicates any notes.
         tasks_list_id: integer indicates the id of the tasks_list
@@ -47,10 +47,10 @@ class MentorshipRelationModel(db.Model):
         primaryjoin="MentorshipRelationModel.mentee_id == UserModel.id",
     )
 
-    creation_date = db.Column(db.Float, nullable=False)
-    accept_date = db.Column(db.Float)
-    start_date = db.Column(db.Float)
-    end_date = db.Column(db.Float)
+    creation_date = db.Column(db.Numeric("16,6", asdecimal=False), nullable=False)
+    accept_date = db.Column(db.Numeric("16,6", asdecimal=False))
+    start_date = db.Column(db.Numeric("16,6", asdecimal=False))
+    end_date = db.Column(db.Numeric("16,6", asdecimal=False))
 
     state = db.Column(db.Enum(MentorshipRelationState), nullable=False)
     notes = db.Column(db.String(400))

app/database/models/task_comment.py

@@ -11,8 +11,8 @@ class TaskCommentModel(db.Model):
         task_id: An integer for storing the task's id.
         user_id: An integer for storing the user's id.
         relation_id: An integer for storing the relation's id.
-        creation_date: A float indicating comment's creation date.
-        modification_date: A float indicating the modification date.
+        creation_date: A numeric indicating comment's creation date.
+        modification_date: A numeric indicating the modification date.
         comment: A string indicating the comment.
     """
 
@@ -24,8 +24,8 @@ class TaskCommentModel(db.Model):
     user_id = db.Column(db.Integer, db.ForeignKey("users.id"))
     task_id = db.Column(db.Integer, db.ForeignKey("tasks_list.id"))
     relation_id = db.Column(db.Integer, db.ForeignKey("mentorship_relations.id"))
-    creation_date = db.Column(db.Float, nullable=False)
-    modification_date = db.Column(db.Float)
+    creation_date = db.Column(db.Numeric("16,6", asdecimal=False), nullable=False)
+    modification_date = db.Column(db.Numeric("16,6", asdecimal=False))
     comment = db.Column(db.String(COMMENT_MAX_LENGTH), nullable=False)
 
     def __init__(self, user_id, task_id, relation_id, comment):

app/database/models/user.py

@@ -46,7 +46,7 @@ class UserModel(db.Model):
     bio = db.Column(db.String(500))
     location = db.Column(db.String(80))
     occupation = db.Column(db.String(80))
-    organization = db.Column(db.String(80))
+    current_organization = db.Column(db.String(80))
     slack_username = db.Column(db.String(80))
     social_media_links = db.Column(db.String(500))
     skills = db.Column(db.String(500))
@@ -97,7 +97,7 @@ def json(self):
             "bio": self.bio,
             "location": self.location,
             "occupation": self.occupation,
-            "organization": self.organization,
+            "current_organization": self.current_organization,
             "slack_username": self.slack_username,
             "social_media_links": self.social_media_links,
             "skills": self.skills,

config.py

@@ -42,6 +42,7 @@ class BaseConfig(object):
     DB_PASSWORD = os.getenv("DB_PASSWORD")
     DB_ENDPOINT = os.getenv("DB_ENDPOINT")
     DB_NAME = os.getenv("DB_NAME")
+    DB_TEST_NAME = os.getenv("DB_TEST_NAME")
 
     UNVERIFIED_USER_THRESHOLD = 2592000  # 30 days
 
@@ -84,15 +85,17 @@ def build_db_uri(
         db_endpoint_arg=DB_ENDPOINT,
         db_name_arg=DB_NAME,
     ):
-        """Build remote database uri using specific environment variables."""
-
-        return "{db_type}://{db_user}:{db_password}@{db_endpoint}/{db_name}".format(
-            db_type=db_type_arg,
-            db_user=db_user_arg,
-            db_password=db_password_arg,
-            db_endpoint=db_endpoint_arg,
-            db_name=db_name_arg,
-        )
+        return f"{db_type_arg}://{db_user_arg}:{db_password_arg}@{db_endpoint_arg}/{db_name_arg}"
+
+    @staticmethod
+    def build_db_test_uri(
+        db_type_arg=DB_TYPE,
+        db_user_arg=DB_USERNAME,
+        db_password_arg=DB_PASSWORD,
+        db_endpoint_arg=DB_ENDPOINT,
+        db_name_arg=DB_TEST_NAME,
+    ):
+        return f"{db_type_arg}://{db_user_arg}:{db_password_arg}@{db_endpoint_arg}/{db_name_arg}"
 
 
 class ProductionConfig(BaseConfig):
@@ -122,8 +125,11 @@ class LocalConfig(BaseConfig):
 
     DEBUG = True
 
-    # Using a local sqlite database
-    SQLALCHEMY_DATABASE_URI = "sqlite:///local_data.db"
+    # Using a local postgre databases on MacOS
+    SQLALCHEMY_DATABASE_URI = "postgresql:///bit_schema"
+
+    # Using a local postgre databases on other OS
+    # SQLALCHEMY_DATABASE_URI = BaseConfig.build_db_uri()
 
 
 class TestingConfig(BaseConfig):
@@ -132,8 +138,11 @@ class TestingConfig(BaseConfig):
     TESTING = True
     MOCK_EMAIL = True
 
-    # Use in-memory SQLite database for testing
-    SQLALCHEMY_DATABASE_URI = "sqlite://"
+    # Using a local postgre database on MacOS
+    # SQLALCHEMY_DATABASE_URI = "postgresql:///bit_schema_test"
+
+    # Using a local postgre database on other OS
+    SQLALCHEMY_DATABASE_URI = BaseConfig.build_db_test_uri()
 
 
 def get_env_config() -> str:

requirements.txt

@@ -1,6 +1,7 @@
 APScheduler==3.6.3
 coverage==5.3
 Flask==1.0.2
+Flask-Cors==3.0.9
 Flask-JWT-Extended==3.25.0
 Flask-Mail==0.9.1
 Flask-Migrate==2.5.3