diff --git a/-/bin/Activate.ps1 b/-/bin/Activate.ps1 new file mode 100644 index 000000000..b49d77ba4 --- /dev/null +++ b/-/bin/Activate.ps1 @@ -0,0 +1,247 @@ +<# +.Synopsis +Activate a Python virtual environment for the current PowerShell session. + +.Description +Pushes the python executable for a virtual environment to the front of the +$Env:PATH environment variable and sets the prompt to signify that you are +in a Python virtual environment. Makes use of the command line switches as +well as the `pyvenv.cfg` file values present in the virtual environment. + +.Parameter VenvDir +Path to the directory that contains the virtual environment to activate. The +default value for this is the parent of the directory that the Activate.ps1 +script is located within. + +.Parameter Prompt +The prompt prefix to display when this virtual environment is activated. By +default, this prompt is the name of the virtual environment folder (VenvDir) +surrounded by parentheses and followed by a single space (ie. '(.venv) '). + +.Example +Activate.ps1 +Activates the Python virtual environment that contains the Activate.ps1 script. + +.Example +Activate.ps1 -Verbose +Activates the Python virtual environment that contains the Activate.ps1 script, +and shows extra information about the activation as it executes. + +.Example +Activate.ps1 -VenvDir C:\Users\MyUser\Common\.venv +Activates the Python virtual environment located in the specified location. + +.Example +Activate.ps1 -Prompt "MyPython" +Activates the Python virtual environment that contains the Activate.ps1 script, +and prefixes the current prompt with the specified string (surrounded in +parentheses) while the virtual environment is active. + +.Notes +On Windows, it may be required to enable this Activate.ps1 script by setting the +execution policy for the user. You can do this by issuing the following PowerShell +command: + +PS C:\> Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser + +For more information on Execution Policies: +https://go.microsoft.com/fwlink/?LinkID=135170 + +#> +Param( + [Parameter(Mandatory = $false)] + [String] + $VenvDir, + [Parameter(Mandatory = $false)] + [String] + $Prompt +) + +<# Function declarations --------------------------------------------------- #> + +<# +.Synopsis +Remove all shell session elements added by the Activate script, including the +addition of the virtual environment's Python executable from the beginning of +the PATH variable. + +.Parameter NonDestructive +If present, do not remove this function from the global namespace for the +session. + +#> +function global:deactivate ([switch]$NonDestructive) { + # Revert to original values + + # The prior prompt: + if (Test-Path -Path Function:_OLD_VIRTUAL_PROMPT) { + Copy-Item -Path Function:_OLD_VIRTUAL_PROMPT -Destination Function:prompt + Remove-Item -Path Function:_OLD_VIRTUAL_PROMPT + } + + # The prior PYTHONHOME: + if (Test-Path -Path Env:_OLD_VIRTUAL_PYTHONHOME) { + Copy-Item -Path Env:_OLD_VIRTUAL_PYTHONHOME -Destination Env:PYTHONHOME + Remove-Item -Path Env:_OLD_VIRTUAL_PYTHONHOME + } + + # The prior PATH: + if (Test-Path -Path Env:_OLD_VIRTUAL_PATH) { + Copy-Item -Path Env:_OLD_VIRTUAL_PATH -Destination Env:PATH + Remove-Item -Path Env:_OLD_VIRTUAL_PATH + } + + # Just remove the VIRTUAL_ENV altogether: + if (Test-Path -Path Env:VIRTUAL_ENV) { + Remove-Item -Path env:VIRTUAL_ENV + } + + # Just remove VIRTUAL_ENV_PROMPT altogether. + if (Test-Path -Path Env:VIRTUAL_ENV_PROMPT) { + Remove-Item -Path env:VIRTUAL_ENV_PROMPT + } + + # Just remove the _PYTHON_VENV_PROMPT_PREFIX altogether: + if (Get-Variable -Name "_PYTHON_VENV_PROMPT_PREFIX" -ErrorAction SilentlyContinue) { + Remove-Variable -Name _PYTHON_VENV_PROMPT_PREFIX -Scope Global -Force + } + + # Leave deactivate function in the global namespace if requested: + if (-not $NonDestructive) { + Remove-Item -Path function:deactivate + } +} + +<# +.Description +Get-PyVenvConfig parses the values from the pyvenv.cfg file located in the +given folder, and returns them in a map. + +For each line in the pyvenv.cfg file, if that line can be parsed into exactly +two strings separated by `=` (with any amount of whitespace surrounding the =) +then it is considered a `key = value` line. The left hand string is the key, +the right hand is the value. + +If the value starts with a `'` or a `"` then the first and last character is +stripped from the value before being captured. + +.Parameter ConfigDir +Path to the directory that contains the `pyvenv.cfg` file. +#> +function Get-PyVenvConfig( + [String] + $ConfigDir +) { + Write-Verbose "Given ConfigDir=$ConfigDir, obtain values in pyvenv.cfg" + + # Ensure the file exists, and issue a warning if it doesn't (but still allow the function to continue). + $pyvenvConfigPath = Join-Path -Resolve -Path $ConfigDir -ChildPath 'pyvenv.cfg' -ErrorAction Continue + + # An empty map will be returned if no config file is found. + $pyvenvConfig = @{ } + + if ($pyvenvConfigPath) { + + Write-Verbose "File exists, parse `key = value` lines" + $pyvenvConfigContent = Get-Content -Path $pyvenvConfigPath + + $pyvenvConfigContent | ForEach-Object { + $keyval = $PSItem -split "\s*=\s*", 2 + if ($keyval[0] -and $keyval[1]) { + $val = $keyval[1] + + # Remove extraneous quotations around a string value. + if ("'""".Contains($val.Substring(0, 1))) { + $val = $val.Substring(1, $val.Length - 2) + } + + $pyvenvConfig[$keyval[0]] = $val + Write-Verbose "Adding Key: '$($keyval[0])'='$val'" + } + } + } + return $pyvenvConfig +} + + +<# Begin Activate script --------------------------------------------------- #> + +# Determine the containing directory of this script +$VenvExecPath = Split-Path -Parent $MyInvocation.MyCommand.Definition +$VenvExecDir = Get-Item -Path $VenvExecPath + +Write-Verbose "Activation script is located in path: '$VenvExecPath'" +Write-Verbose "VenvExecDir Fullname: '$($VenvExecDir.FullName)" +Write-Verbose "VenvExecDir Name: '$($VenvExecDir.Name)" + +# Set values required in priority: CmdLine, ConfigFile, Default +# First, get the location of the virtual environment, it might not be +# VenvExecDir if specified on the command line. +if ($VenvDir) { + Write-Verbose "VenvDir given as parameter, using '$VenvDir' to determine values" +} +else { + Write-Verbose "VenvDir not given as a parameter, using parent directory name as VenvDir." + $VenvDir = $VenvExecDir.Parent.FullName.TrimEnd("\\/") + Write-Verbose "VenvDir=$VenvDir" +} + +# Next, read the `pyvenv.cfg` file to determine any required value such +# as `prompt`. +$pyvenvCfg = Get-PyVenvConfig -ConfigDir $VenvDir + +# Next, set the prompt from the command line, or the config file, or +# just use the name of the virtual environment folder. +if ($Prompt) { + Write-Verbose "Prompt specified as argument, using '$Prompt'" +} +else { + Write-Verbose "Prompt not specified as argument to script, checking pyvenv.cfg value" + if ($pyvenvCfg -and $pyvenvCfg['prompt']) { + Write-Verbose " Setting based on value in pyvenv.cfg='$($pyvenvCfg['prompt'])'" + $Prompt = $pyvenvCfg['prompt']; + } + else { + Write-Verbose " Setting prompt based on parent's directory's name. (Is the directory name passed to venv module when creating the virtual environment)" + Write-Verbose " Got leaf-name of $VenvDir='$(Split-Path -Path $venvDir -Leaf)'" + $Prompt = Split-Path -Path $venvDir -Leaf + } +} + +Write-Verbose "Prompt = '$Prompt'" +Write-Verbose "VenvDir='$VenvDir'" + +# Deactivate any currently active virtual environment, but leave the +# deactivate function in place. +deactivate -nondestructive + +# Now set the environment variable VIRTUAL_ENV, used by many tools to determine +# that there is an activated venv. +$env:VIRTUAL_ENV = $VenvDir + +if (-not $Env:VIRTUAL_ENV_DISABLE_PROMPT) { + + Write-Verbose "Setting prompt to '$Prompt'" + + # Set the prompt to include the env name + # Make sure _OLD_VIRTUAL_PROMPT is global + function global:_OLD_VIRTUAL_PROMPT { "" } + Copy-Item -Path function:prompt -Destination function:_OLD_VIRTUAL_PROMPT + New-Variable -Name _PYTHON_VENV_PROMPT_PREFIX -Description "Python virtual environment prompt prefix" -Scope Global -Option ReadOnly -Visibility Public -Value $Prompt + + function global:prompt { + Write-Host -NoNewline -ForegroundColor Green "($_PYTHON_VENV_PROMPT_PREFIX) " + _OLD_VIRTUAL_PROMPT + } + $env:VIRTUAL_ENV_PROMPT = $Prompt +} + +# Clear PYTHONHOME +if (Test-Path -Path Env:PYTHONHOME) { + Copy-Item -Path Env:PYTHONHOME -Destination Env:_OLD_VIRTUAL_PYTHONHOME + Remove-Item -Path Env:PYTHONHOME +} + +# Add the venv to the PATH +Copy-Item -Path Env:PATH -Destination Env:_OLD_VIRTUAL_PATH +$Env:PATH = "$VenvExecDir$([System.IO.Path]::PathSeparator)$Env:PATH" diff --git a/-/bin/activate b/-/bin/activate new file mode 100644 index 000000000..6abe3319b --- /dev/null +++ b/-/bin/activate @@ -0,0 +1,69 @@ +# This file must be used with "source bin/activate" *from bash* +# you cannot run it directly + +deactivate () { + # reset old environment variables + if [ -n "${_OLD_VIRTUAL_PATH:-}" ] ; then + PATH="${_OLD_VIRTUAL_PATH:-}" + export PATH + unset _OLD_VIRTUAL_PATH + fi + if [ -n "${_OLD_VIRTUAL_PYTHONHOME:-}" ] ; then + PYTHONHOME="${_OLD_VIRTUAL_PYTHONHOME:-}" + export PYTHONHOME + unset _OLD_VIRTUAL_PYTHONHOME + fi + + # This should detect bash and zsh, which have a hash command that must + # be called to get it to forget past commands. Without forgetting + # past commands the $PATH changes we made may not be respected + if [ -n "${BASH:-}" -o -n "${ZSH_VERSION:-}" ] ; then + hash -r 2> /dev/null + fi + + if [ -n "${_OLD_VIRTUAL_PS1:-}" ] ; then + PS1="${_OLD_VIRTUAL_PS1:-}" + export PS1 + unset _OLD_VIRTUAL_PS1 + fi + + unset VIRTUAL_ENV + unset VIRTUAL_ENV_PROMPT + if [ ! "${1:-}" = "nondestructive" ] ; then + # Self destruct! + unset -f deactivate + fi +} + +# unset irrelevant variables +deactivate nondestructive + +VIRTUAL_ENV="/Users/raissa/ada/project/solar-system-api/-" +export VIRTUAL_ENV + +_OLD_VIRTUAL_PATH="$PATH" +PATH="$VIRTUAL_ENV/bin:$PATH" +export PATH + +# unset PYTHONHOME if set +# this will fail if PYTHONHOME is set to the empty string (which is bad anyway) +# could use `if (set -u; : $PYTHONHOME) ;` in bash +if [ -n "${PYTHONHOME:-}" ] ; then + _OLD_VIRTUAL_PYTHONHOME="${PYTHONHOME:-}" + unset PYTHONHOME +fi + +if [ -z "${VIRTUAL_ENV_DISABLE_PROMPT:-}" ] ; then + _OLD_VIRTUAL_PS1="${PS1:-}" + PS1="(-) ${PS1:-}" + export PS1 + VIRTUAL_ENV_PROMPT="(-) " + export VIRTUAL_ENV_PROMPT +fi + +# This should detect bash and zsh, which have a hash command that must +# be called to get it to forget past commands. Without forgetting +# past commands the $PATH changes we made may not be respected +if [ -n "${BASH:-}" -o -n "${ZSH_VERSION:-}" ] ; then + hash -r 2> /dev/null +fi diff --git a/-/bin/activate.csh b/-/bin/activate.csh new file mode 100644 index 000000000..c501ecd6e --- /dev/null +++ b/-/bin/activate.csh @@ -0,0 +1,26 @@ +# This file must be used with "source bin/activate.csh" *from csh*. +# You cannot run it directly. +# Created by Davide Di Blasi . +# Ported to Python 3.3 venv by Andrew Svetlov + +alias deactivate 'test $?_OLD_VIRTUAL_PATH != 0 && setenv PATH "$_OLD_VIRTUAL_PATH" && unset _OLD_VIRTUAL_PATH; rehash; test $?_OLD_VIRTUAL_PROMPT != 0 && set prompt="$_OLD_VIRTUAL_PROMPT" && unset _OLD_VIRTUAL_PROMPT; unsetenv VIRTUAL_ENV; unsetenv VIRTUAL_ENV_PROMPT; test "\!:*" != "nondestructive" && unalias deactivate' + +# Unset irrelevant variables. +deactivate nondestructive + +setenv VIRTUAL_ENV "/Users/raissa/ada/project/solar-system-api/-" + +set _OLD_VIRTUAL_PATH="$PATH" +setenv PATH "$VIRTUAL_ENV/bin:$PATH" + + +set _OLD_VIRTUAL_PROMPT="$prompt" + +if (! "$?VIRTUAL_ENV_DISABLE_PROMPT") then + set prompt = "(-) $prompt" + setenv VIRTUAL_ENV_PROMPT "(-) " +endif + +alias pydoc python -m pydoc + +rehash diff --git a/-/bin/activate.fish b/-/bin/activate.fish new file mode 100644 index 000000000..19776d333 --- /dev/null +++ b/-/bin/activate.fish @@ -0,0 +1,69 @@ +# This file must be used with "source /bin/activate.fish" *from fish* +# (https://fishshell.com/); you cannot run it directly. + +function deactivate -d "Exit virtual environment and return to normal shell environment" + # reset old environment variables + if test -n "$_OLD_VIRTUAL_PATH" + set -gx PATH $_OLD_VIRTUAL_PATH + set -e _OLD_VIRTUAL_PATH + end + if test -n "$_OLD_VIRTUAL_PYTHONHOME" + set -gx PYTHONHOME $_OLD_VIRTUAL_PYTHONHOME + set -e _OLD_VIRTUAL_PYTHONHOME + end + + if test -n "$_OLD_FISH_PROMPT_OVERRIDE" + set -e _OLD_FISH_PROMPT_OVERRIDE + # prevents error when using nested fish instances (Issue #93858) + if functions -q _old_fish_prompt + functions -e fish_prompt + functions -c _old_fish_prompt fish_prompt + functions -e _old_fish_prompt + end + end + + set -e VIRTUAL_ENV + set -e VIRTUAL_ENV_PROMPT + if test "$argv[1]" != "nondestructive" + # Self-destruct! + functions -e deactivate + end +end + +# Unset irrelevant variables. +deactivate nondestructive + +set -gx VIRTUAL_ENV "/Users/raissa/ada/project/solar-system-api/-" + +set -gx _OLD_VIRTUAL_PATH $PATH +set -gx PATH "$VIRTUAL_ENV/bin" $PATH + +# Unset PYTHONHOME if set. +if set -q PYTHONHOME + set -gx _OLD_VIRTUAL_PYTHONHOME $PYTHONHOME + set -e PYTHONHOME +end + +if test -z "$VIRTUAL_ENV_DISABLE_PROMPT" + # fish uses a function instead of an env var to generate the prompt. + + # Save the current fish_prompt function as the function _old_fish_prompt. + functions -c fish_prompt _old_fish_prompt + + # With the original prompt function renamed, we can override with our own. + function fish_prompt + # Save the return status of the last command. + set -l old_status $status + + # Output the venv prompt; color taken from the blue of the Python logo. + printf "%s%s%s" (set_color 4B8BBE) "(-) " (set_color normal) + + # Restore the return status of the previous command. + echo "exit $old_status" | . + # Output the original/"old" prompt. + _old_fish_prompt + end + + set -gx _OLD_FISH_PROMPT_OVERRIDE "$VIRTUAL_ENV" + set -gx VIRTUAL_ENV_PROMPT "(-) " +end diff --git a/-/bin/pip b/-/bin/pip new file mode 100755 index 000000000..c84dc4257 --- /dev/null +++ b/-/bin/pip @@ -0,0 +1,8 @@ +#!/Users/raissa/ada/project/solar-system-api/-/bin/python3.10 +# -*- coding: utf-8 -*- +import re +import sys +from pip._internal.cli.main import main +if __name__ == '__main__': + sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0]) + sys.exit(main()) diff --git a/-/bin/pip3 b/-/bin/pip3 new file mode 100755 index 000000000..c84dc4257 --- /dev/null +++ b/-/bin/pip3 @@ -0,0 +1,8 @@ +#!/Users/raissa/ada/project/solar-system-api/-/bin/python3.10 +# -*- coding: utf-8 -*- +import re +import sys +from pip._internal.cli.main import main +if __name__ == '__main__': + sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0]) + sys.exit(main()) diff --git a/-/bin/pip3.10 b/-/bin/pip3.10 new file mode 100755 index 000000000..c84dc4257 --- /dev/null +++ b/-/bin/pip3.10 @@ -0,0 +1,8 @@ +#!/Users/raissa/ada/project/solar-system-api/-/bin/python3.10 +# -*- coding: utf-8 -*- +import re +import sys +from pip._internal.cli.main import main +if __name__ == '__main__': + sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0]) + sys.exit(main()) diff --git a/-/bin/python b/-/bin/python new file mode 120000 index 000000000..c3cc99197 --- /dev/null +++ b/-/bin/python @@ -0,0 +1 @@ +python3.10 \ No newline at end of file diff --git a/-/bin/python3 b/-/bin/python3 new file mode 120000 index 000000000..c3cc99197 --- /dev/null +++ b/-/bin/python3 @@ -0,0 +1 @@ +python3.10 \ No newline at end of file diff --git a/-/bin/python3.10 b/-/bin/python3.10 new file mode 120000 index 000000000..76f29a695 --- /dev/null +++ b/-/bin/python3.10 @@ -0,0 +1 @@ +/opt/homebrew/opt/python@3.10/bin/python3.10 \ No newline at end of file diff --git a/-/pyvenv.cfg b/-/pyvenv.cfg new file mode 100644 index 000000000..4ae9770f4 --- /dev/null +++ b/-/pyvenv.cfg @@ -0,0 +1,3 @@ +home = /opt/homebrew/opt/python@3.10/bin +include-system-site-packages = false +version = 3.10.9 diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..a62bfed4b 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,36 @@ from flask import Flask +from flask_sqlalchemy import SQLAlchemy +from flask_migrate import Migrate +from dotenv import load_dotenv +import os +db = SQLAlchemy() +migrate = Migrate() +load_dotenv() + def create_app(test_config=None): app = Flask(__name__) + if not test_config: + app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False + app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get( + "SQLALCHEMY_DATABASE_URI") + + else: + app.config["TESTING"] = True + app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False + app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get( + "SQLALCHEMY_TEST_DATABASE_URI") + + db.init_app(app) + migrate.init_app(app, db) + + + from app.models.planet import Planet + + from .routes import planet_bp + app.register_blueprint(planet_bp) + return app + diff --git a/app/models/__init__.py b/app/models/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/models/planet.py b/app/models/planet.py new file mode 100644 index 000000000..5512500b7 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,24 @@ +from app import db + +class Planet(db.Model): + id = db.Column(db.Integer, primary_key=True, autoincrement=True) + name = db.Column(db.String) + description = db.Column(db.String) + diameter= db.Column(db.Float) + __tablename__ = "Planets" + + def to_dict(self): + return { + "id": self.id, + "name": self.name, + "description": self.description, + "diameter": self.diameter + } + + @classmethod + def from_dict(cls, planet_data): + return cls( + name=planet_data['name'], + description=planet_data['description'], + diameter=planet_data['diameter'] + ) \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..f8a14a4d1 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,118 @@ -from flask import Blueprint +from app import db +from app.models.planet import Planet +from flask import Blueprint, jsonify, make_response, request, abort +from sqlalchemy.exc import DataError +planet_bp = Blueprint("planet", __name__, url_prefix="/planets") + +def validate_model(cls, model_id): + try: + model_id = int(model_id) + except: + message = f"{cls.__name__} {model_id} invalid" + abort(make_response({"message": message}, 400)) + + model = cls.query.get(model_id) + + if not model: + message = f"{cls.__name__} {model_id} not found" + abort(make_response({"message": message}, 404)) + + return model + +@planet_bp.route("", methods=["POST"]) +def create_planet(): + request_body = request.get_json() + + try: + new_planet = Planet.from_dict(request_body) + db.session.add(new_planet) + db.session.commit() + + message = f"Planet {new_planet.name} successfully created" + return make_response(jsonify(message)), 201 + except KeyError as e: + expected_keys = ["name", "description", "diameter"] + missing_keys = [key for key in expected_keys if key not in request_body] + + message = 'missing required values' + error_dict = {"message": message, "missing_values": missing_keys} + + abort(make_response(error_dict, 400)) + except (TypeError, DataError) as e: + error_dict = { + "message": "Invalid request body", + "error": str(e) + } + abort(make_response(jsonify(error_dict), 400)) + +@planet_bp.route("", methods=['GET']) +def get_all_planets(): + name_query = request.args.get("name") + if name_query: + planets = Planet.query.filter_by(name=name_query) + else: + planets = Planet.query.all() + + planet_list = [planet.to_dict() for planet in planets] + return make_response(jsonify(planet_list)), 200 + +@planet_bp.route("/", methods=['GET']) +def get_planet(planet_id): + planet = validate_model(Planet, planet_id) + return jsonify(planet.to_dict()), 200 + +@planet_bp.route("/", methods=["PUT"]) +def replace_planet(planet_id): + planet = validate_model(Planet, planet_id) + request_body = request.get_json() + + try: + planet.name = request_body["name"] + planet.description = request_body["description"] + planet.diameter = request_body["diameter"] + db.session.commit() + message = f"Planet #{planet.id} successfully updated" + return make_response(jsonify(message)), 200 + except KeyError as e: + expected_keys = ["name", "description", "diameter"] + missing_keys = [key for key in expected_keys if key not in request_body] + + message = 'missing required values' + error_dict = {"message": message, "missing_values": missing_keys} + + abort(make_response(error_dict, 400)) + except (TypeError, DataError) as e: + error_dict = { + "message": "Invalid request body", + "error": str(e) + } + abort(make_response(jsonify(error_dict), 400)) + +@planet_bp.route("/", methods=["PATCH"]) +def update_planet(planet_id): + planet = validate_model(Planet, planet_id) + request_body = request.get_json() + + try: + for key in request_body: + setattr(planet, key, request_body[key]) + db.session.commit() + message = f"Planet #{planet.id} successfully updated" + return make_response(jsonify(message)), 200 + except (TypeError, KeyError, DataError) as e: + error_dict = { + "message": "Invalid request body", + "error": str(e) + } + abort(make_response(jsonify(error_dict), 400)) + +@planet_bp.route("/", methods=['DELETE']) +def delete_planet(planet_id): + planet = validate_model(Planet, planet_id) + + db.session.delete(planet) + db.session.commit() + + message = f"Planet #{planet.id} {planet.name} successfully deleted" + return make_response(jsonify(message)), 200 \ No newline at end of file diff --git a/migrations/README b/migrations/README new file mode 100644 index 000000000..0e0484415 --- /dev/null +++ b/migrations/README @@ -0,0 +1 @@ +Single-database configuration for Flask. diff --git a/migrations/alembic.ini b/migrations/alembic.ini new file mode 100644 index 000000000..ec9d45c26 --- /dev/null +++ b/migrations/alembic.ini @@ -0,0 +1,50 @@ +# A generic, single database configuration. + +[alembic] +# template used to generate migration files +# file_template = %%(rev)s_%%(slug)s + +# set to 'true' to run the environment during +# the 'revision' command, regardless of autogenerate +# revision_environment = false + + +# Logging configuration +[loggers] +keys = root,sqlalchemy,alembic,flask_migrate + +[handlers] +keys = console + +[formatters] +keys = generic + +[logger_root] +level = WARN +handlers = console +qualname = + +[logger_sqlalchemy] +level = WARN +handlers = +qualname = sqlalchemy.engine + +[logger_alembic] +level = INFO +handlers = +qualname = alembic + +[logger_flask_migrate] +level = INFO +handlers = +qualname = flask_migrate + +[handler_console] +class = StreamHandler +args = (sys.stderr,) +level = NOTSET +formatter = generic + +[formatter_generic] +format = %(levelname)-5.5s [%(name)s] %(message)s +datefmt = %H:%M:%S diff --git a/migrations/env.py b/migrations/env.py new file mode 100644 index 000000000..68feded2a --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,91 @@ +from __future__ import with_statement + +import logging +from logging.config import fileConfig + +from flask import current_app + +from alembic import context + +# this is the Alembic Config object, which provides +# access to the values within the .ini file in use. +config = context.config + +# Interpret the config file for Python logging. +# This line sets up loggers basically. +fileConfig(config.config_file_name) +logger = logging.getLogger('alembic.env') + +# add your model's MetaData object here +# for 'autogenerate' support +# from myapp import mymodel +# target_metadata = mymodel.Base.metadata +config.set_main_option( + 'sqlalchemy.url', + str(current_app.extensions['migrate'].db.get_engine().url).replace( + '%', '%%')) +target_metadata = current_app.extensions['migrate'].db.metadata + +# other values from the config, defined by the needs of env.py, +# can be acquired: +# my_important_option = config.get_main_option("my_important_option") +# ... etc. + + +def run_migrations_offline(): + """Run migrations in 'offline' mode. + + This configures the context with just a URL + and not an Engine, though an Engine is acceptable + here as well. By skipping the Engine creation + we don't even need a DBAPI to be available. + + Calls to context.execute() here emit the given string to the + script output. + + """ + url = config.get_main_option("sqlalchemy.url") + context.configure( + url=url, target_metadata=target_metadata, literal_binds=True + ) + + with context.begin_transaction(): + context.run_migrations() + + +def run_migrations_online(): + """Run migrations in 'online' mode. + + In this scenario we need to create an Engine + and associate a connection with the context. + + """ + + # this callback is used to prevent an auto-migration from being generated + # when there are no changes to the schema + # reference: http://alembic.zzzcomputing.com/en/latest/cookbook.html + def process_revision_directives(context, revision, directives): + if getattr(config.cmd_opts, 'autogenerate', False): + script = directives[0] + if script.upgrade_ops.is_empty(): + directives[:] = [] + logger.info('No changes in schema detected.') + + connectable = current_app.extensions['migrate'].db.get_engine() + + with connectable.connect() as connection: + context.configure( + connection=connection, + target_metadata=target_metadata, + process_revision_directives=process_revision_directives, + **current_app.extensions['migrate'].configure_args + ) + + with context.begin_transaction(): + context.run_migrations() + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/migrations/script.py.mako b/migrations/script.py.mako new file mode 100644 index 000000000..2c0156303 --- /dev/null +++ b/migrations/script.py.mako @@ -0,0 +1,24 @@ +"""${message} + +Revision ID: ${up_revision} +Revises: ${down_revision | comma,n} +Create Date: ${create_date} + +""" +from alembic import op +import sqlalchemy as sa +${imports if imports else ""} + +# revision identifiers, used by Alembic. +revision = ${repr(up_revision)} +down_revision = ${repr(down_revision)} +branch_labels = ${repr(branch_labels)} +depends_on = ${repr(depends_on)} + + +def upgrade(): + ${upgrades if upgrades else "pass"} + + +def downgrade(): + ${downgrades if downgrades else "pass"} diff --git a/migrations/versions/0a6971d40876_create_planet_table.py b/migrations/versions/0a6971d40876_create_planet_table.py new file mode 100644 index 000000000..49016055b --- /dev/null +++ b/migrations/versions/0a6971d40876_create_planet_table.py @@ -0,0 +1,34 @@ +"""Create planet table + +Revision ID: 0a6971d40876 +Revises: +Create Date: 2023-04-29 16:53:27.534489 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '0a6971d40876' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('Planets', + sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('name', sa.String(), nullable=True), + sa.Column('description', sa.String(), nullable=True), + sa.Column('diameter', sa.Float(), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('Planets') + # ### end Alembic commands ### diff --git a/requirements.txt b/requirements.txt index ae59e7b55..966d770b4 100644 --- a/requirements.txt +++ b/requirements.txt @@ -4,14 +4,19 @@ blinker==1.4 certifi==2020.12.5 chardet==4.0.0 click==7.1.2 +coverage==7.2.3 +exceptiongroup==1.1.1 Flask==1.1.2 Flask-Migrate==2.6.0 Flask-SQLAlchemy==2.4.4 idna==2.10 +iniconfig==2.0.0 itsdangerous==1.1.0 Jinja2==2.11.3 Mako==1.1.4 MarkupSafe==1.1.1 +packaging==23.1 +pluggy==1.0.0 psycopg2-binary==2.9.5 pycodestyle==2.6.0 pytest==7.3.1 @@ -23,5 +28,6 @@ requests==2.25.1 six==1.15.0 SQLAlchemy==1.3.23 toml==0.10.2 +tomli==2.0.1 urllib3==1.26.4 Werkzeug==1.0.1 diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/tests/conftest.py b/tests/conftest.py new file mode 100644 index 000000000..c8c5fab8d --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,39 @@ +import pytest +from app import create_app +from app import db +from flask.signals import request_finished +from app.models.planet import Planet + +@pytest.fixture +def app(): + app = create_app({"TESTING": True}) + + @request_finished.connect_via(app) + def expire_session(sender, response, **extra): + db.session.remove() + + with app.app_context(): + db.create_all() + yield app + + with app.app_context(): + db.drop_all() + +@pytest.fixture +def client(app): + return app.test_client() + +@pytest.fixture +def two_saved_planets(app): + # Arrange + mercury_planet = Planet(name="Mercury", + description="smallest planet", + diameter=3031.9) + jupter_planet = Planet(name="Jupiter", + description="biggest planet", + diameter="86881") + + db.session.add_all([mercury_planet, jupter_planet]) + db.session.commit() + + diff --git a/tests/test_routes.py b/tests/test_routes.py new file mode 100644 index 000000000..1da4a9c89 --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,592 @@ +import pytest +from werkzeug.exceptions import HTTPException +from app.routes import validate_model +from app.models.planet import Planet + +def test_get_all_planets_with_no_records(client): + # Act + response = client.get("/planets") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == [] + +def test_get_all_planets_with_two_records(client, two_saved_planets): + # Act + response = client.get("/planets") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert len(response_body) == 2 + assert response_body[0] == { + "id": 1, + "name": "Mercury", + "description": "smallest planet", + "diameter": 3031.9 + } + assert response_body[1] == { + "id": 2, + "name": "Jupiter", + "description": "biggest planet", + "diameter": 86881 + } + +def test_get_all_planets_with_title_query_matching_none(client, two_saved_planets): + # Act + data = {'name': 'Dog'} + response = client.get("/planets", query_string = data) + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == [] + +def test_get_all_planets_with_title_query_matching_one(client, two_saved_planets): + # Act + data = {'name': 'Mercury'} + response = client.get("/planets", query_string = data) + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert len(response_body) == 1 + assert response_body[0] == { + "id": 1, + "name": "Mercury", + "description": "smallest planet", + "diameter": 3031.9 + } + +def test_get_one_planet_missing_record(client, two_saved_planets): + # Act + response = client.get("/planets/3") + response_body = response.get_json() + + # Assert + assert response.status_code == 404 + assert response_body == {"message": "Planet 3 not found"} + +def test_get_one_planet_invalid_id(client, two_saved_planets): + # Act + response = client.get("/planets/earth") + response_body = response.get_json() + + # Assert + assert response.status_code == 400 + assert response_body == {"message":"Planet earth invalid"} + +def test_get_one_planet(client, two_saved_planets): + # Act + response = client.get("/planets/1") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == { + "id": 1, + "name": "Mercury", + "description": "smallest planet", + "diameter": 3031.9 + } + +def test_create_one_planet(client): + # Act + response = client.post("/planets", json={ + "name": "Pluto", + "description": "dwarf planet", + "diameter": 1473 + }) + response_body = response.get_json() + + # Assert + assert response.status_code == 201 + assert response_body == "Planet Pluto successfully created" + +def test_create_one_planet_no_name(client): + # Arrange + test_data = {"description": "The Best!", "diameter": 1000} + response = client.post("/planets", json=test_data) + response_body = response.get_json() + + assert response.status_code == 400 + assert response_body["message"] == 'missing required values' + assert response_body["missing_values"] == ['name'] + +def test_create_one_planet_no_description(client): + # Arrange + test_data = {"name": "New planet", "diameter": 1000} + response = client.post("/planets", json=test_data) + response_body = response.get_json() + + # Act & Assert + assert response.status_code == 400 + assert response_body["message"] == 'missing required values' + assert response_body["missing_values"] == ['description'] + +def test_create_one_planet_no_diameter(client): + # Arrange + test_data = {"name": "New planet", "description": "The Best!"} + response = client.post("/planets", json=test_data) + response_body = response.get_json() + + # Act & Assert + assert response.status_code == 400 + assert response_body["message"] == 'missing required values' + assert response_body["missing_values"] == ['diameter'] + +def test_create_one_planet_no_name_and_no_description(client): + # Arrange + test_data = {"diameter": 1000} + response = client.post("/planets", json=test_data) + response_body = response.get_json() + + assert response.status_code == 400 + assert response_body["message"] == 'missing required values' + assert response_body["missing_values"] == ['name', 'description'] + +def test_create_one_planet_no_name_and_no_diameter(client): + # Arrange + test_data = {"description": "The Best!"} + response = client.post("/planets", json=test_data) + response_body = response.get_json() + + assert response.status_code == 400 + assert response_body["message"] == 'missing required values' + assert response_body["missing_values"] == ['name', 'diameter'] + +def test_create_one_planet_no_description_and_no_diameter(client): + # Arrange + test_data = {"name": "New planet"} + response = client.post("/planets", json=test_data) + response_body = response.get_json() + + assert response.status_code == 400 + assert response_body["message"] == 'missing required values' + assert response_body["missing_values"] == ['description', 'diameter'] + +def test_create_one_planet_with_extra_keys(client, two_saved_planets): + # Arrange + test_data = { + "extra": "some stuff", + "name": "New planet", + "description": "The Best!", + "diameter": 1000, + "another": "last value" + } + + # Act + response = client.post("/planets", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 201 + assert response_body == "Planet New planet successfully created" + +def test_create_one_planet_with_invalid_diameter(client, two_saved_planets): + # Arrange + test_data = { + "name": "New planet", + "description": "The Best!", + "diameter": "dog" + } + + # Act + response = client.post("/planets", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 400 + assert response_body["error"] + +def test_replace_planet(client, two_saved_planets): + # Arrange + test_data = { + "name": "New planet", + "description": "The Best!", + "diameter": 1000 + } + + # Act + response = client.put("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == "Planet #1 successfully updated" + +def test_replace_planet_with_extra_keys(client, two_saved_planets): + # Arrange + test_data = { + "extra": "some stuff", + "name": "New planet", + "description": "The Best!", + "diameter": 1000, + "another": "last value" + } + + # Act + response = client.put("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == "Planet #1 successfully updated" + +def test_replace_planet_missing_record(client, two_saved_planets): + # Arrange + test_data = { + "name": "New planet", + "description": "The Best!", + "diameter": 1000 + } + + # Act + response = client.put("/planets/3", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 404 + assert response_body == {"message": "Planet 3 not found"} + +def test_replace_planet_no_name(client, two_saved_planets): + # Arrange + test_data = { + "description": "The Best!", + "diameter": 1000 + } + + # Act + response = client.put("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 400 + assert response_body["message"] == "missing required values" + assert response_body["missing_values"] == ["name"] + +def test_replace_planet_no_description(client, two_saved_planets): + # Arrange + test_data = { + "name": "New planet", + "diameter": 1000 + } + + # Act + response = client.put("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 400 + assert response_body["message"] == "missing required values" + assert response_body["missing_values"] == ["description"] + +def test_replace_planet_no_diameter(client, two_saved_planets): + # Arrange + test_data = { + "name": "New planet", + "description": "The Best!" + } + + # Act + response = client.put("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 400 + assert response_body["message"] == "missing required values" + assert response_body["missing_values"] == ["diameter"] + +def test_replace_planet_no_name_no_description(client, two_saved_planets): + # Arrange + test_data = { + "diameter": 1000 + } + + # Act + response = client.put("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 400 + assert response_body["message"] == "missing required values" + assert response_body["missing_values"] == ["name", "description"] + +def test_replace_planet_no_name_no_diameter(client, two_saved_planets): + # Arrange + test_data = { + "description": "The Best!" + } + + # Act + response = client.put("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 400 + assert response_body["message"] == "missing required values" + assert response_body["missing_values"] == ["name", "diameter"] + +def test_replace_planet_no_description_no_diameter(client, two_saved_planets): + # Arrange + test_data = { + "name": "New planet" + } + + # Act + response = client.put("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 400 + assert response_body["message"] == "missing required values" + assert response_body["missing_values"] == ["description", "diameter"] + +def test_replace_planet_invalid_id(client, two_saved_planets): + # Arrange + test_data = { + "name": "New planet", + "description": "The Best!", + "diameter": 1000 + } + + # Act + response = client.put("/planets/dog", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 400 + assert response_body == {"message": "Planet dog invalid"} + +def test_replace_planet_invalid_diameter(client, two_saved_planets): + # Arrange + test_data = { + "name": "New planet", + "description": "The Best!", + "diameter": "dog" + } + + # Act + response = client.put("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 400 + assert response_body['error'] + +def test_update_planet_name_only(client, two_saved_planets): + # Arrange + test_data = { + "name": "New planet" + } + + # Act + response = client.patch("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == "Planet #1 successfully updated" + +def test_update_planet_description_only(client, two_saved_planets): + # Arrange + test_data = { + "description": "The Best!" + } + + # Act + response = client.patch("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == "Planet #1 successfully updated" + +def test_update_planet_diameter_only(client, two_saved_planets): + # Arrange + test_data = { + "diameter": 1000 + } + + # Act + response = client.patch("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == "Planet #1 successfully updated" + +def test_update_planet_name_and_description(client, two_saved_planets): + # Arrange + test_data = { + "name": "New planet", + "description": "The Best!" + } + + # Act + response = client.patch("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == "Planet #1 successfully updated" + +def test_update_planet_name_and_diameter(client, two_saved_planets): + # Arrange + test_data = { + "name": "New planet", + "diameter": 1000 + } + + # Act + response = client.patch("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == "Planet #1 successfully updated" + +def test_update_planet_description_and_diameter(client, two_saved_planets): + # Arrange + test_data = { + "description": "The Best!", + "diameter": 1000 + } + + # Act + response = client.patch("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == "Planet #1 successfully updated" + +def test_update_planet_name_description_and_diameter(client, two_saved_planets): + # Arrange + test_data = { + "name": "New planet", + "description": "The Best!", + "diameter": 1000 + } + + # Act + response = client.patch("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == "Planet #1 successfully updated" + +def test_update_planet_with_extra_keys(client, two_saved_planets): + # Arrange + test_data = { + "name": "New planet", + "description": "The Best!", + "diameter": 1000, + "another": "last value" + } + + # Act + response = client.patch("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == "Planet #1 successfully updated" + +def test_update_planet_missing_record(client, two_saved_planets): + # Arrange + test_data = { + "name": "New planet", + "description": "The Best!", + "diameter": 1000 + } + + # Act + response = client.patch("/planets/3", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 404 + assert response_body == {"message": "Planet 3 not found"} + +def test_update_planet_invalid_id(client, two_saved_planets): + # Arrange + test_data = { + "name": "New planet", + "description": "The Best!", + "diameter": 1000 + } + + # Act + response = client.patch("/planets/dog", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 400 + assert response_body == {"message": "Planet dog invalid"} + +def test_update_planet_invalid_diameter(client, two_saved_planets): + # Arrange + test_data = { + "name": "New planet", + "description": "The Best!", + "diameter": "dog" + } + + # Act + response = client.patch("/planets/1", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 400 + assert response_body["message"] == "Invalid request body" + assert response_body["error"] + +def test_delete_planet(client, two_saved_planets): + # Act + response = client.delete("/planets/1") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == "Planet #1 Mercury successfully deleted" + +def test_delete_planet_missing_record(client, two_saved_planets): + # Act + response = client.delete("/planets/3") + response_body = response.get_json() + + # Assert + assert response.status_code == 404 + assert response_body == {"message": "Planet 3 not found"} + +def test_delete_planet_invalid_id(client, two_saved_planets): + # Act + response = client.delete("/planets/dog") + response_body = response.get_json() + + # Assert + assert response.status_code == 400 + assert response_body == {"message": "Planet dog invalid"} + +def test_validate_model(two_saved_planets): + # Act + result_planet = validate_model(Planet, 1) + + # Assert + assert result_planet.id == 1 + assert result_planet.name == "Mercury" + assert result_planet.description == "smallest planet" + assert result_planet.diameter == 3031.9 + +def test_validate_model_missing_record(two_saved_planets): + # Act & Assert + with pytest.raises(HTTPException): + result_planet = validate_model(Planet, "3") + +def test_validate_model_invalid_id(two_saved_planets): + # Act & Assert + with pytest.raises(HTTPException): + result_planet = validate_model(Planet, "dog") \ No newline at end of file