add models and database

Author: john0isaac

README.md

@@ -1,2 +1,42 @@
 # flask-api-sqlite-db
 API for Managing test cases and their execution results across multiple test assets, with data stored in a SQLite database.
+
+## Running the web app
+
+To run the Flask application, follow these steps:
+
+1. **Download the project starter code locally**
+
+    ```bash
+    git clone https://github.com/john0isaac/flask-api-sqlite-db.git
+    cd flask-api-sqlite-db
+    ```
+
+1. **Install, initialize and activate a virtualenv using:**
+
+    ```bash
+    pip install virtualenv
+    python -m virtualenv venv
+    source venv/bin/activate
+    ```
+
+    >**Note** - In Windows, the `venv` does not have a `bin` directory. Therefore, you'd use the analogous command shown below:
+
+    ```bash
+    source venv\Scripts\activate
+    ```
+
+1. **Install the dependencies:**
+
+    ```bash
+    pip install -r requirements.txt
+    ```
+
+1. **Execute the following command in your terminal to start the flask app**
+
+    ```bash
+    export DATABASE_FILENAME=testdb.db
+    export FLASK_APP=src.app
+    export FLASK_ENV=development
+    flask run --reload
+    ```

mock_up_data.sql

@@ -0,0 +1,18 @@
+GRANT ALL PRIVILEGES ON DATABASE testdb TO john;
+
+-- TestCase
+INSERT INTO `test_case` VALUES (1, 'First Test');
+INSERT INTO `test_case` VALUES (2, 'Second Test');
+INSERT INTO `test_case` VALUES (3, 'Third Test');
+
+-- Asset
+INSERT INTO `asset` VALUES (1, 'First Asset');
+INSERT INTO `asset` VALUES (2, 'Second Asset');
+INSERT INTO `asset` VALUES (3, 'Third Asset');
+
+-- Execution
+INSERT INTO `execution` VALUES (1, 1, 3, TRUE, 'Success');
+INSERT INTO `execution` VALUES (2, 2, 2, FALSE, 'Failure');
+INSERT INTO `execution` VALUES (3, 3, 1, FALSE, 'Failure');
+INSERT INTO `execution` VALUES (4, 1, 3, TRUE, 'Success');
+INSERT INTO `execution` VALUES (5, 2, 2, TRUE, 'Success');

requirements.txt

@@ -0,0 +1,3 @@
+SQLAlchemy==2.0.27
+Flask==3.0.2
+Flask-SQLAlchemy==3.1.1

src/__init__.py

@@ -0,0 +1,93 @@
+from flask import (
+  Flask,
+  request,
+  abort,
+  jsonify
+)
+import os
+from src.database.models import (
+    setup_db,
+    db_drop_and_create_all,
+    TestCase,
+    Asset,
+    Execution
+)
+
+
+app = Flask(__name__)
+
+# Load configuration for prod vs. dev
+is_prod_env = "RUNNING_IN_PRODUCTION" in os.environ
+if not is_prod_env:
+    print("Loading config.development.")
+    app.config.from_object("src.config.development")
+    setup_db(app)
+    # db_drop_and_create_all(app)
+else:
+    print("Loading config.production.")
+    app.config.from_object("src.config.production")
+    setup_db(app)
+    # db_drop_and_create_all(app)
+
+PAGINATION_PER_PAGE = 10
+
+def paginate_results(flask_request, selection):
+    page = flask_request.args.get('page', 1, type=int)
+    start =  (page - 1) * PAGINATION_PER_PAGE
+    end = start + PAGINATION_PER_PAGE
+
+    results = [result.format() for result in selection]
+    paginated_results = results[start:end]
+
+    return paginated_results
+
+@app.route('/')
+def index():
+    return "Welcome to the Test Case Execution API"
+
+@app.route('/tests')
+def get_all_tests():
+    selection = TestCase.query.order_by(TestCase.id).all()
+    current_test_cases = paginate_results(request, selection)
+    if len(current_test_cases) == 0:
+        abort(404)
+    return jsonify({
+        'success': True,
+        'test_cases': current_test_cases,
+        'total_test_cases': len(TestCase.query.all())
+    })
+
+@app.errorhandler(404)
+def not_found(error):
+    return jsonify({
+        "success": False,
+        "error": 404,
+        "message": "Not found"
+    }), 404
+
+@app.errorhandler(422)
+def unprocessable(error):
+    return jsonify({
+        "success": False,
+        "error": 422,
+        "message": "unprocessable"
+    }), 422
+
+@app.errorhandler(400)
+def bad_request(error):
+    return jsonify({
+        "success": False,
+        "error": 400,
+        "message": "bad request"
+    }), 400
+
+@app.errorhandler(405)
+def method_not_allowed(error):
+    return jsonify({
+        "success": False,
+        "error": 405,
+        "message": "method not allowed"
+    }), 405
+
+if __name__ == '__main__':
+    app.run()

src/app.py

@@ -0,0 +1,9 @@
+import os
+from pathlib import Path
+
+DEBUG = True
+
+database_filename = os.environ["DATABASE_FILENAME"]
+BASE_DIR = Path(__file__).resolve().parent.parent
+database_dir = os.path.join(BASE_DIR, "database")
+DATABASE_URI = f"sqlite:///{os.path.join(database_dir, database_filename)}"

src/config/__init__.py

@@ -0,0 +1,134 @@
+"""
+Models for MySQL
+
+"""
+from typing import List
+
+from sqlalchemy import ForeignKey, String, Boolean
+from sqlalchemy.orm import Mapped, mapped_column, relationship
+from flask_sqlalchemy import SQLAlchemy
+from sqlalchemy.orm import DeclarativeBase
+
+class Base(DeclarativeBase):
+    pass
+
+db = SQLAlchemy(model_class=Base)
+
+'''
+    setup_db(app)
+    binds a flask application and a SQLAlchemy service
+'''
+
+def setup_db(app):
+    app.config["SQLALCHEMY_DATABASE_URI"] = app.config.get('DATABASE_URI')
+    app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False
+    db.app = app
+    db.init_app(app)
+    with app.app_context():
+        db.create_all()
+
+'''
+    db_drop_and_create_all()
+    drops the database tables and starts fresh
+    can be used to initialize a clean database
+'''
+
+def db_drop_and_create_all(app):
+    with app.app_context():
+        db.drop_all()
+        db.create_all()
+
+#----------------------------------------------------------------------------#
+# Models.
+#----------------------------------------------------------------------------#
+
+class TestCase(db.Model):
+    __tablename__ = "test_case"
+
+    id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True)
+    name: Mapped[str] = mapped_column(String(255), nullable=False)
+    executions: Mapped[List["Execution"]] = relationship("Execution", back_populates="test_case")
+
+    def __init__(self, name):
+        self.name = name
+
+    def insert(self):
+        db.session.add(self)
+        db.session.commit()
+
+    def update(self):
+        db.session.commit()
+
+    def delete(self):
+        db.session.delete(self)
+        db.session.commit()
+
+    def format(self):
+        return {
+            'id': self.id,
+            'name': self.name
+        }
+
+class Asset(db.Model):
+    __tablename__ = "asset"
+
+    id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True)
+    name: Mapped[str] = mapped_column(String(255), nullable=False)
+    executions: Mapped[List["Execution"]] = relationship("Execution", back_populates="asset")
+
+    def __init__(self, name):
+        self.name = name
+
+    def insert(self):
+        db.session.add(self)
+        db.session.commit()
+
+    def update(self):
+        db.session.commit()
+
+    def delete(self):
+        db.session.delete(self)
+        db.session.commit()
+
+    def format(self):
+        return {
+            'id': self.id,
+            'name': self.name
+        }
+
+class Execution(db.Model):
+    __tablename__ = "execution"
+
+    id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True)
+    test_case_id: Mapped[int] = mapped_column(ForeignKey("test_case.id"))
+    test_case: Mapped["TestCase"] = relationship("TestCase", back_populates="executions")
+    asset_id: Mapped[int] = mapped_column(ForeignKey("asset.id"))
+    asset: Mapped["Asset"] = relationship("Asset", back_populates="executions")
+    passed: Mapped[bool] = mapped_column(Boolean, nullable=False)
+    details: Mapped[str] = mapped_column(String(500))
+
+    def __init__(self, test_case_id, asset_id, passed, details):
+        self.test_case_id = test_case_id
+        self.asset_id = asset_id
+        self.passed = passed
+        self.details = details
+
+    def insert(self):
+        db.session.add(self)
+        db.session.commit()
+
+    def update(self):
+        db.session.commit()
+
+    def delete(self):
+        db.session.delete(self)
+        db.session.commit()
+
+    def format(self):
+        return {
+            'id': self.id,
+            'test_case_id': self.test_case_id,
+            'asset_id': self.asset_id,
+            'passed': self.passed,
+            'details' : self.details
+        }