diff --git a/ambuda/templates/proofing/projects/replace.html b/ambuda/templates/proofing/projects/replace.html
new file mode 100644
index 00000000..3bbb8f98
--- /dev/null
+++ b/ambuda/templates/proofing/projects/replace.html
@@ -0,0 +1,47 @@
+{% extends 'proofing/base.html' %}
+{% from "macros/forms.html" import field %}
+{% import "macros/proofing.html" as m %}
+
+{% block title %}Search and Replace {{ project.title }} | Ambuda{% endblock %}
+
+{% block content %}
+
+{{ m.project_header_nested('Search and Replace', project) }}
+{{ m.project_nav(project=project, active='edit') }}
+
+
+
Use this simple search and replace form to make edits across this project.
+
+
+
+
+{% if query %}
+
+
+{% macro sp(s, p, n) %}{% if n == 1 %}{{ s }}{% else %}{{ p }}{% endif %}{% endmacro %}
+
+{% set nr = results|length %}
+
Found {{ nr }} {{ sp("page", "pages", nr) }} that {{ sp("contains", "contain", nr) }} {{ query }}.
+
+
+{% for page in results %}
+{% set page_url = url_for("proofing.page.edit", project_slug=project.slug, page_slug=page.slug) %}
+-
+ {{ project.title }}/{{ page.slug }}
+
+ {% for match in page.matches %}
+
{{ match.query }}
+
{{ match.update }}
+ {%- endfor %}
+
+{% endfor %}
+
+
+
+{% endif %}
+{% endblock %}
\ No newline at end of file
diff --git a/ambuda/views/auth.py b/ambuda/views/auth.py
index 47d5c5dd..7de9a360 100644
--- a/ambuda/views/auth.py
+++ b/ambuda/views/auth.py
@@ -5,12 +5,17 @@
https://www.uxmatters.com/mt/archives/2018/09/signon-signoff-and-registration.php
Security reference:
-
- https://cheatsheetseries.owasp.org/cheatsheets/Password_Storage_Cheat_Sheet.html
- https://cheatsheetseries.owasp.org/cheatsheets/Forgot_Password_Cheat_Sheet.html
+
+Max lengths:
+- https://cheatsheetseries.owasp.org/cheatsheets/Authentication_Cheat_Sheet.html suggests 64 characters for password
+- https://www.rfc-editor.org/errata_search.php?rfc=3696 specifies 254 characters for email address
+
"""
import secrets
+import sys
from datetime import datetime, timedelta
from typing import Optional
@@ -27,7 +32,15 @@
bp = Blueprint("auth", __name__)
+# maximum lengths of authentication fields
+MIN_EMAIL_ADDRESS_LEN = 4
+MAX_EMAIL_ADDRESS_LEN = 254
+MIN_PASSWORD_LEN = 8
+MAX_PASSWORD_LEN = 256
+MIN_USERNAME_LEN = 6
+MAX_USERNAME_LEN = 64
+# token lifetime
MAX_TOKEN_LIFESPAN_IN_HOURS = 24
# FIXME: redirect to site.index once user accounts are more useful.
POST_AUTH_ROUTE = "proofing.index"
@@ -79,51 +92,107 @@ def _is_valid_reset_token(row: db.PasswordResetToken, raw_token: str, now=None):
return True
-class SignupForm(FlaskForm):
- username = StringField(
- _l("Username"), [val.Length(min=6, max=25), val.DataRequired()]
+# The native val.Length() validator silently snips username and
+# password to the maximum length.
+# So, database stores the snipped username and password resulting
+# in information loss. For instance, user may have copy pasted 240
+# chars our form will only store MAX_##_LEN bytes of it to the db. Creating
+# our own validator will show a clear error that username cannot
+# exceed MAX_##_LEN bytes. I'm not sure if it is a bug or a feature
+# in the val.Length()
+# Copied from https://wtforms.readthedocs.io/en/2.3.x/validators/
+class FieldLength(object):
+ def __init__(self, min=None, max=None, message=None):
+ self.min = min or 0
+ self.max = max or sys.maxsize
+ if not message:
+ message = f"Field must be between {min} and {max} characters long."
+ self.message = message
+
+ def __call__(self, form, field):
+ field_len = field.data and len(field.data or [])
+ if not (self.min <= field_len <= self.max):
+ raise val.ValidationError(self.message)
+
+
+def get_field_validators(field_name: str, min_len: int, max_len: int):
+ field_name_capitalized = field_name.capitalize()
+ return [
+ val.DataRequired(),
+ FieldLength(
+ min=min_len,
+ max=max_len,
+ message=f"{field_name_capitalized} must be between {min_len} and {max_len} characters long",
+ ),
+ ]
+
+
+def get_username_validators():
+ validators = get_field_validators("username", MIN_USERNAME_LEN, MAX_USERNAME_LEN)
+ validators.append(
+ val.Regexp("^[^\s]*$", message="Username must not contain spaces")
)
- password = PasswordField(_l("Password"), [val.Length(min=8), val.DataRequired()])
- email = StringField(_l("Email address"), [val.DataRequired(), val.Email()])
+ return validators
+
+
+def get_legacy_username_validators():
+ return get_field_validators("username", MIN_USERNAME_LEN, MAX_USERNAME_LEN)
+
+
+def get_password_validators():
+ return get_field_validators("password", MIN_PASSWORD_LEN, MAX_PASSWORD_LEN)
+
+
+def get_email_validators():
+ validators = get_field_validators(
+ "email", MIN_EMAIL_ADDRESS_LEN, MAX_EMAIL_ADDRESS_LEN
+ )
+ validators.append(val.Email())
+ return validators
+
+
+class SignupForm(FlaskForm):
+ username = StringField(_l("Username"), get_username_validators())
+ password = PasswordField(_l("Password"), get_password_validators())
+ email = EmailField(_l("Email address"), get_email_validators())
recaptcha = RecaptchaField()
def validate_username(self, username):
+ # TODO: make username case insensitive
user = q.user(username.data)
if user:
raise val.ValidationError("Please use a different username.")
def validate_email(self, email):
session = q.get_session()
+ # TODO: make email case insensitive
user = session.query(db.User).filter_by(email=email.data).first()
if user:
raise val.ValidationError("Please use a different email address.")
class SignInForm(FlaskForm):
- username = StringField(
- _l("Username"), [val.Length(min=6, max=25), val.DataRequired()]
- )
- password = PasswordField(_l("Password"), [val.Length(min=8), val.DataRequired()])
+ username = StringField(_l("Username"), get_legacy_username_validators())
+ password = PasswordField(_l("Password"), get_password_validators())
class ResetPasswordForm(FlaskForm):
- email = EmailField("Email", [val.DataRequired()])
+ email = EmailField(_l("Email address"), get_email_validators())
recaptcha = RecaptchaField()
class ChangePasswordForm(FlaskForm):
#: Old password. No validation requirements, in case we change our password
#: criteria in the future.
- old_password = PasswordField(_l("Old password"), [val.DataRequired()])
+ old_password = PasswordField(_l("Old Password"), get_password_validators())
+
#: New password.
- new_password = PasswordField(
- _l("New password"), [val.Length(min=8), val.DataRequired()]
- )
+ new_password = PasswordField(_l("New password"), get_password_validators())
class ResetPasswordFromTokenForm(FlaskForm):
- password = PasswordField(_l("Password"), [val.DataRequired()])
- confirm_password = PasswordField(_l("Confirm password"), [val.DataRequired()])
+ password = PasswordField(_l("Password"), get_password_validators())
+ confirm_password = PasswordField(_l("Confirm password"), get_password_validators())
@bp.route("/register", methods=["GET", "POST"])
@@ -133,6 +202,7 @@ def register():
return redirect(url_for("site.index"))
form = SignupForm()
+ # save username and email in lowercase
if form.validate_on_submit():
user = q.create_user(
username=form.username.data,
@@ -157,6 +227,7 @@ def sign_in():
return redirect(url_for("site.index"))
form = SignInForm()
+ # TODO: make username case insensitive
if form.validate_on_submit():
user = q.user(form.username.data)
if user and user.check_password(form.password.data):
diff --git a/ambuda/views/proofing/project.py b/ambuda/views/proofing/project.py
index 6e7f554b..9a375790 100644
--- a/ambuda/views/proofing/project.py
+++ b/ambuda/views/proofing/project.py
@@ -96,6 +96,13 @@ class DeleteProjectForm(FlaskForm):
slug = StringField("Slug", validators=[DataRequired()])
+class ReplaceForm(SearchForm):
+ class Meta:
+ csrf = False
+
+ replace = StringField(_l("Replace"), validators=[DataRequired()])
+
+
@bp.route("/
/")
def summary(slug):
"""Show basic information about the project."""
@@ -279,6 +286,64 @@ def search(slug):
)
+@bp.route("//replace")
+@login_required
+def replace(slug):
+ """Search and replace a string across all of the project's pages.
+
+ This is useful to replace a string across the project in one shot.
+ """
+ project_ = q.project(slug)
+ if project_ is None:
+ abort(404)
+
+ form = ReplaceForm(request.args)
+ if not form.validate():
+ return render_template(
+ "proofing/projects/replace.html", project=project_, form=form
+ )
+
+ # search for "query" string and replace with "update" string
+ query = form.query.data
+ update = form.replace.data
+
+ results = []
+ for page_ in project_.pages:
+ if not page_.revisions:
+ continue
+
+ matches = []
+
+ latest = page_.revisions[-1]
+ for line in latest.content.splitlines():
+ if query in line:
+ matches.append(
+ {
+ "query": escape(line).replace(
+ query, Markup(f"{escape(query)}")
+ ),
+ "update": escape(line).replace(
+ query, Markup(f"{escape(update)}")
+ ),
+ }
+ )
+ if matches:
+ results.append(
+ {
+ "slug": page_.slug,
+ "matches": matches,
+ }
+ )
+ return render_template(
+ "proofing/projects/replace.html",
+ project=project_,
+ form=form,
+ query=query,
+ update=update,
+ results=results,
+ )
+
+
@bp.route("//batch-ocr", methods=["GET", "POST"])
@p2_required
def batch_ocr(slug):
diff --git a/build/containers/Dockerfile.final b/build/containers/Dockerfile.final
index 7fc6eaee..9f895069 100755
--- a/build/containers/Dockerfile.final
+++ b/build/containers/Dockerfile.final
@@ -113,6 +113,7 @@ COPY wsgi.py /app/
COPY alembic.ini /app/
COPY migrations/ /app/migrations/
COPY scripts/ /app/scripts/
+COPY cli.py /app/scripts/
RUN echo "************* Ambuda application build succeeded! ****************"
# ####################################
@@ -127,5 +128,5 @@ WORKDIR /app
RUN echo "************* Building FINAL ${BUILD_TYPE}*****************"
COPY --from=build-ambuda /venv /venv
COPY --from=build-ambuda /app /app
-CMD ["/app/scripts/start-server.sh"]
+CMD ["/app/scripts/start_server.sh"]
RUN echo "************* Ambuda deploy succeeded! *****************"
diff --git a/config.py b/config.py
index e0018011..bc8bf057 100644
--- a/config.py
+++ b/config.py
@@ -30,6 +30,10 @@
TESTING = "testing"
#: The development environment. For local development.
DEVELOPMENT = "development"
+#: The build environment. For build on github.
+BUILD = "build"
+#: The staging environment. For testing on staging.
+STAGING = "staging"
#: The production environment. For production serving.
PRODUCTION = "production"
@@ -180,6 +184,32 @@ class DevelopmentConfig(BaseConfig):
LOG_LEVEL = logging.INFO
+class BuildConfig(BaseConfig):
+ """For build on GitHub."""
+
+ AMBUDA_ENVIRONMENT = BUILD
+ DEBUG = True
+ #: If set, automatically reload Flask templates (including imports) when
+ #: they change on disk.
+ TEMPLATES_AUTO_RELOAD = False
+
+ #: Logger setup
+ LOG_LEVEL = logging.INFO
+
+
+class StagingConfig(BaseConfig):
+ """For staging."""
+
+ AMBUDA_ENVIRONMENT = STAGING
+ DEBUG = True
+ #: If set, automatically reload Flask templates (including imports) when
+ #: they change on disk.
+ TEMPLATES_AUTO_RELOAD = False
+
+ #: Logger setup
+ LOG_LEVEL = logging.INFO
+
+
class ProductionConfig(BaseConfig):
"""For production."""
@@ -204,7 +234,13 @@ def _validate_config(config: BaseConfig):
:param config: the config to test
"""
- assert config.AMBUDA_ENVIRONMENT in {TESTING, DEVELOPMENT, PRODUCTION}
+ assert config.AMBUDA_ENVIRONMENT in {
+ TESTING,
+ DEVELOPMENT,
+ BUILD,
+ STAGING,
+ PRODUCTION,
+ }
if not config.SQLALCHEMY_DATABASE_URI:
raise ValueError("This config does not define SQLALCHEMY_DATABASE_URI")
@@ -239,6 +275,8 @@ def load_config_object(name: str):
config_map = {
TESTING: UnitTestConfig,
DEVELOPMENT: DevelopmentConfig,
+ BUILD: BuildConfig,
+ STAGING: StagingConfig,
PRODUCTION: ProductionConfig,
}
config = config_map[name]
diff --git a/deploy/local/docker-compose-dbsetup.yml b/deploy/local/docker-compose-dbsetup.yml
index 3181a150..6ff8a272 100644
--- a/deploy/local/docker-compose-dbsetup.yml
+++ b/deploy/local/docker-compose-dbsetup.yml
@@ -3,9 +3,10 @@ version: '3.4'
services:
dbsetup:
image: ${AMBUDA_IMAGE}
- command: "/app/scripts/start-database.sh"
+ command: "/app/scripts/initialize_data.sh"
volumes:
- ${PWD}/deploy/data_database/:/app/data/database/
+ - ${PWD}/deploy/data_files/vidyut:/app/data/vidyut/
environment:
- FLASK_ENV=development
- FLASK_UPLOAD_FOLDER=/app/data/file-uploads
@@ -15,5 +16,6 @@ services:
- REDIS_URL=redis://redis:6579/0
- VIRTUAL_ENV=.
- AMBUDA_BOT_PASSWORD=insecure bot password
+ - VIDYUT_DATA_DIR=/app/data/vidyut/
- PATH=$PATH:/venv/bin/
-
\ No newline at end of file
+
diff --git a/deploy/local/docker-compose.yml b/deploy/local/docker-compose.yml
index 207da6be..04d25cba 100644
--- a/deploy/local/docker-compose.yml
+++ b/deploy/local/docker-compose.yml
@@ -5,7 +5,10 @@ services:
image: ${AMBUDA_IMAGE}
volumes:
- ${PWD}/deploy/data_database/:/app/data/database/
- - ${PWD}/deploy/data_files/:/app/data/file-uploads/
+ - ${PWD}/deploy/data_files/uploads:/app/data/file-uploads/
+ - ${PWD}/deploy/data_files/vidyut:/app/data/vidyut/
+ - ${PWD}/ambuda/static/:/app/ambuda/static/
+
ports:
- target: 5000
host_ip: ${AMBUDA_HOST_IP}
@@ -21,11 +24,13 @@ services:
- REDIS_URL=redis://redis:6579/0
- VIRTUAL_ENV=.
- AMBUDA_BOT_PASSWORD=insecure bot password
+ - VIDYUT_DATA_DIR=/app/data/vidyut/
- PATH=$PATH:/venv/bin/
+
celery:
image: ${AMBUDA_IMAGE}
- command: /app/scripts/start-celery.sh
+ command: /app/scripts/start_celery.sh
environment:
- REDIS_URL=redis://redis:6579/0
depends_on:
diff --git a/deploy/staging/docker-compose-dbsetup.yml b/deploy/staging/docker-compose-dbsetup.yml
index 6c4f981a..5a72e58a 100644
--- a/deploy/staging/docker-compose-dbsetup.yml
+++ b/deploy/staging/docker-compose-dbsetup.yml
@@ -3,9 +3,10 @@ version: '3.4'
services:
dbsetup:
image: ${AMBUDA_IMAGE}
- command: "/app/scripts/start-database.sh"
+ command: "/app/scripts/initialize_data.sh"
volumes:
- ${HOME}/deploy/data_database/:/app/data/database/
+ - ${HOME}/deploy/data_files/vidyut:/app/data/vidyut/
environment:
- FLASK_ENV=development
- FLASK_UPLOAD_FOLDER=/app/data/file-uploads
@@ -15,4 +16,6 @@ services:
- REDIS_URL=redis://redis:6579/0
- VIRTUAL_ENV=.
- AMBUDA_BOT_PASSWORD=insecure bot password
+ - VIDYUT_DATA_DIR=/app/data/vidyut/
+ - PATH=$PATH:/venv/bin/
\ No newline at end of file
diff --git a/deploy/staging/docker-compose.yml b/deploy/staging/docker-compose.yml
index 7fd34d0f..d8afb583 100644
--- a/deploy/staging/docker-compose.yml
+++ b/deploy/staging/docker-compose.yml
@@ -1,11 +1,13 @@
version: '3.4'
services:
- app:
+ ambuda-web:
image: ${AMBUDA_IMAGE}
volumes:
- ${HOME}/deploy/data_database/:/app/data/database/
- - ${HOME}/deploy/data_files/:/app/data/file-uploads
+ - ${HOME}/deploy/data_files/uploads:/app/data/file-uploads/
+ - ${HOME}/deploy/data_files/vidyut:/app/data/vidyut/
+
ports:
- target: 5000
host_ip: ${AMBUDA_HOST_IP}
@@ -13,7 +15,7 @@ services:
protocol: tcp
mode: host
environment:
- - FLASK_ENV=development
+ - FLASK_ENV=staging
- FLASK_UPLOAD_FOLDER=/app/data/file-uploads
- SQLALCHEMY_DATABASE_URI=sqlite:////app/data/database/database.db
- SECRET_KEY=insecure development secret key
@@ -21,15 +23,17 @@ services:
- REDIS_URL=redis://redis:6579/0
- VIRTUAL_ENV=.
- AMBUDA_BOT_PASSWORD=insecure bot password
-
+ - VIDYUT_DATA_DIR=/app/data/vidyut/
+ - PATH=$PATH:/venv/bin/
+
celery:
image: ${AMBUDA_IMAGE}
- command: /app/scripts/start-celery.sh
+ command: /app/scripts/start_celery.sh
environment:
- REDIS_URL=redis://redis:6579/0
depends_on:
- redis
-
+
redis:
image: redis:7.0.4
command: --port 6579
diff --git a/docs/creating-data-from-the-command-line.rst b/docs/creating-data-from-the-command-line.rst
index 7e345c29..97fb4341 100644
--- a/docs/creating-data-from-the-command-line.rst
+++ b/docs/creating-data-from-the-command-line.rst
@@ -10,7 +10,7 @@ Create a new user::
Make that user an administrator::
- ./cli.py add-role admin
+ ./cli.py add-role --username --role admin
Create a fake proofing project::
diff --git a/docs/installation.rst b/docs/installation.rst
index da395ee1..5b956767 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -79,7 +79,7 @@ Docker setup (beta)
This feature is still under development and may change. You can alternatively
run a local development environment using Docker by running:
- make start-docker
+ make docker-start
Data dependencies
diff --git a/docs/quickstart.rst b/docs/quickstart.rst
index c14c0c6e..84fdc832 100644
--- a/docs/quickstart.rst
+++ b/docs/quickstart.rst
@@ -15,7 +15,7 @@ following command::
Next, run the following commands to create a new admin user::
./cli.py create-user
- ./cli.py add-role admin
+ ./cli.py add-role --username --role admin
After that, you can bring up the development server::
diff --git a/scripts/initialize_data.sh b/scripts/initialize_data.sh
new file mode 100755
index 00000000..a0d3cf1a
--- /dev/null
+++ b/scripts/initialize_data.sh
@@ -0,0 +1,66 @@
+#!/usr/bin/env bash
+
+# Build database with dictionaries, texts and other data. Initilalize Vidyut data.
+
+set -e
+
+. /venv/bin/activate
+
+export PATH=$PATH:/venv/bin/
+export PYTHONPATH=$PYTHONPATH:/app
+
+
+function init_vidyut_data ()
+{
+ VIDYUT_DATA_URL="https://github.com/ambuda-org/vidyut-py/releases/download/0.2.0/data-0.2.0.zip"
+
+ if [ -z "${VIDYUT_DATA_DIR}" ];
+ then
+ echo "Error! VIDYUT_DATA_DIR is not set. Please set environment variable VIDYUT_DATA_DIR"
+ return 1
+ fi
+
+ if [ -z "${VIDYUT_DATA_URL}" ];
+ then
+ echo "Error! URL to fetch Vidyut data is not set. Please set environment variable VIDYUT_DATA_URL"
+ return 1
+ fi
+
+
+ VIDYUT_MARKER="${VIDYUT_DATA_DIR}/vidyut_is_here"
+ if [ -f $VIDYUT_MARKER ];
+ then
+ # TODO: calculate SHA256 of installed files and compare
+ echo "Vidyut data found!"
+ return 0
+ fi
+
+ echo "Fetching Vidyut data from ${VIDYUT_DATA_URL} to ${VIDYUT_DATA_DIR}."
+ mkdir -p $VIDYUT_DATA_DIR
+
+ VIDYUT_DATA_FILE=$(basename -- "$VIDYUT_DATA_URL")
+ VIDYUT_DATA_FILENAME_BASE="${VIDYUT_DATA_FILE%.*}"
+
+ wget -P ${VIDYUT_DATA_DIR} ${VIDYUT_DATA_URL} -q
+ unzip -d ${VIDYUT_DATA_DIR} -j ${VIDYUT_DATA_DIR}/${VIDYUT_DATA_FILE}
+ if [ $? -ne 0 ]; then
+ echo "Error! Failed to fetch from ${VIDYUT_DATA_URL}"
+ return 1
+ fi
+
+ # Successfully installed. Leave a mark.
+ touch $VIDYUT_MARKER
+
+ return 0
+}
+
+# Git required only for this run. Keeping git here to curb docker image size.
+apt-get -qq update && apt-get -qq install -y git wget unzip > /dev/null
+
+# Initialize SQLite database
+python scripts/initialize_database.py && echo "Database set up complete." || exit 1
+
+# Initialize Vidyut data
+init_vidyut_data && echo "Vidyut data initialization completed" || echo "Error pulling from Vidyut. Fetch vidyut data later."
+
+exit 0
\ No newline at end of file
diff --git a/scripts/setup_database.py b/scripts/initialize_database.py
similarity index 51%
rename from scripts/setup_database.py
rename to scripts/initialize_database.py
index 9668fcd1..38bb2874 100755
--- a/scripts/setup_database.py
+++ b/scripts/initialize_database.py
@@ -1,13 +1,12 @@
#! /usr/bin/python3
-"""Initializes the development database by creating all tables.
+"""Initializes the database by creating all tables.
-This module is used in `scripts/initialize_from_scratch.sh`.
+This module is called from `scripts/initialize_data.sh`.
-TODO: what are the implications of running `create_all` on app startup?
"""
import subprocess
-from os.path import exists as file_exists
+from pathlib import Path
from dotenv import load_dotenv
from sqlalchemy import create_engine
@@ -24,8 +23,9 @@
def get_sqlalchemy_uri():
- """parse sql alchemy db uri from config file """
+ """parse sql alchemy db uri from config file"""
+ # TODO: don't hard code to dev.
conf = config.load_config_object("development")
sql_uri = conf.SQLALCHEMY_DATABASE_URI
return sql_uri
@@ -37,18 +37,16 @@ def get_db_file_path(sql_uri):
db_file_path = sql_uri.replace("sqlite:///", "")
if db_file_path == sql_uri:
print(f"Error! Invalid SQLALCHEMY_DATABASE_URI {sql_uri}")
- return db_file_path
+ raise ValueError(f"Invalid SQLALCHEMY_DATABASE_URI: {sql_uri}")
+ return Path(db_file_path)
def run_module(module_name):
print(f'{"#"}' * 20)
print(f"Intializing {module_name}")
- if not module_name.run():
- print(f"Error! {module_name}.run() failed")
- return False
+ module_name.run()
print(f"{module_name} initialization successful!")
print(f'{"#"}' * 20)
- return True
def init_database(sql_uri, db_file_path):
@@ -64,58 +62,42 @@ def init_database(sql_uri, db_file_path):
run_module(texts.gretil)
run_module(dcs)
run_module(monier)
- except Exception as ex:
- print("Error: Failed to initialize database"
- f"Error: {ex}")
- return False
-
- if not alembic_migrations():
- return False
-
+ alembic_migrations()
+ except Exception as init_ex:
+ print(f"Error: Failed to initialize database. Error: {init_ex}")
+ raise init_ex
print(f"Success! Database initialized at {db_file_path}")
- return True
def alembic_migrations():
try:
subprocess.run(["/venv/bin/alembic", "ensure_version"])
- except subprocess.CalledProcessError as err:
- print(f"Error processing alembic ensure_versions - {err}")
- return False
- try:
subprocess.run(["/venv/bin/alembic", "stamp", "head"])
- except subprocess.CalledProcessError as err:
- print(f"Error processing alembic stamp head - {err}")
- return False
- return True
+ print("Success! Database version check completed.")
+ except subprocess.CalledProcessError as mig_ex:
+ print(f"Error processing alembic commands - {mig_ex}")
+ raise mig_ex
-def setup_database(db_file_path):
- """Lookup and Update to the latest migration."""
- if not file_exists(db_file_path):
- print(f"Database found at {db_file_path}...")
- return False
+def load_database(db_file_path):
+ """Database already initialized. Run lookup module (TODO: Legacy step. Check why?). Update to the latest migration."""
+ if not db_file_path.exists():
+ print(f"Database not found at {db_file_path}...")
+ raise FileNotFoundError("Database file not found")
try:
run_module(lookup)
- except Exception as ex:
- print("Error: Failed to initialize database"
- f"Error: {ex}")
- return False
- # Set the most recent revision as the current one.
- try:
subprocess.run(["/venv/bin/alembic", "upgrade", "head"])
- except subprocess.CalledProcessError as err:
- print(f"Error processing alembic upgrade head - {err}")
- return False
-
- print(f"Success! Database setup at {db_file_path}")
- return True
+ print(f"Success! Database is ready at {db_file_path}")
+ except Exception as load_ex:
+ print(f"Error: Failed to load database. Error: {load_ex}")
+ raise load_ex
def run():
"""
- Initialize db for fresh installs. Bootup db on restarts
+ Initialize db for fresh installs. Load db on restarts.
+ Return value is boolean as the caller is a shell script.
"""
load_dotenv()
@@ -124,18 +106,26 @@ def run():
db_file_path = get_db_file_path(sql_uri)
except Exception as err:
print(f"Failed to get db path - {err}")
+ return False
- if file_exists(db_file_path):
+ if db_file_path.exists():
print(f"Database found at {db_file_path}..")
- ret_setup = setup_database(db_file_path)
- if not ret_setup:
- print(f"Error! Database setup at {db_file_path}..")
+ try:
+ load_database(db_file_path)
+ except Exception as load_ex:
+ print(
+ f"Error! Failed to load database from {db_file_path}. Error: {load_ex}"
+ )
return False
else:
- print("Initialize Database not found")
- ret_init = init_database(sql_uri, db_file_path)
- if not ret_init:
- print(f"Error! Database setup at {db_file_path}..")
+ # This is a new deployment.
+ print("Initialize database")
+ try:
+ init_database(sql_uri, db_file_path)
+ except Exception as init_ex:
+ print(
+ f"Error! Failed to initialize database at {db_file_path}. Error: {init_ex}"
+ )
return False
return True
diff --git a/scripts/install_from_scratch.sh b/scripts/install_from_scratch.sh
index 5155ffbd..660236d9 100755
--- a/scripts/install_from_scratch.sh
+++ b/scripts/install_from_scratch.sh
@@ -101,7 +101,7 @@ To create some sample data for our proofing interface, try the commands below.
In these commands, arguments in must be supplied by you:
./cli.py create-user
- ./cli.py add-role admin
+ ./cli.py add-role --username --role admin
./cli.py create-project
To start the development server, run the following commands:
diff --git a/scripts/start-database.sh b/scripts/start-database.sh
deleted file mode 100755
index 521b33f4..00000000
--- a/scripts/start-database.sh
+++ /dev/null
@@ -1,16 +0,0 @@
-#!/usr/bin/env bash
-
-# Entrypoint for running the devserver from within Docker. Before running
-# "make devserver", this file runs database setup / initialization scripts if a
-# database has not already been created.
-
-
-set -e
-
-. /venv/bin/activate
-
-export PATH=$PATH:/venv/bin/
-export PYTHONPATH=$PYTHONPATH:/app
-
-apt-get -qq update && apt-get -qq install -y git > /dev/null
-python scripts/setup_database.py
\ No newline at end of file
diff --git a/scripts/start-server.sh b/scripts/start-server.sh
deleted file mode 100755
index 8c7ed572..00000000
--- a/scripts/start-server.sh
+++ /dev/null
@@ -1,31 +0,0 @@
-#!/usr/bin/env bash
-
-# Entrypoint for running the devserver from within Docker. Before running
-# "make devserver", this file runs database setup / initialization scripts if a
-# database has not already been created.
-
-
-set -e
-
-. /venv/bin/activate
-
-export PATH=$PATH:/venv/bin/
-
-# Extract file path from sqlite:///[file path]
-
-DB_FILE_PATH="${SQLALCHEMY_DATABASE_URI/sqlite:\/\/\//}"
-
-echo "Loading Database from $DB_FILE_PATH"
-
-# Update to the latest migration.
-python -m ambuda.seed.lookup
-
-/venv/bin/alembic upgrade head
-
-# Run the devserver, and live reload our CSS and JS.
-# "npx concurrently" does not work on Docker, but ./node_modules/.bin/concurrently does.
-# We also need to add "--host=0.0.0.0" to "flask run" to allow the host to access the
-# website that is running from the Docker container.
-echo "Flask start from /venv/bin/flask with 0.0.0.0 on port 5000"
-./node_modules/.bin/concurrently "/venv/bin/flask run -h 0.0.0.0 -p 5000"
-
diff --git a/scripts/start-celery.sh b/scripts/start_celery.sh
similarity index 100%
rename from scripts/start-celery.sh
rename to scripts/start_celery.sh
diff --git a/scripts/start_server.sh b/scripts/start_server.sh
new file mode 100755
index 00000000..285a6ab4
--- /dev/null
+++ b/scripts/start_server.sh
@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+# Docker entrypoint.
+set -e
+
+# Switch to python venv
+. /venv/bin/activate
+# Set PATH
+export PATH=$PATH:/venv/bin/
+
+echo "[$FLASK_ENV] Flask start from /venv/bin/flask with 0.0.0.0 on port 5000"
+if [ "$FLASK_ENV" == "development" ]
+then
+ # Start flask server in development mode
+ # Dynamically load css and js changes. Docker compose attaches to the ambuda/static directory on localhost.
+ ./node_modules/.bin/concurrently "/venv/bin/flask run -h 0.0.0.0 -p 5000" "npx tailwindcss -i /app/ambuda/static/css/style.css -o /app/ambuda/static/gen/style.css --watch" "npx esbuild /app/ambuda/static/js/main.js --outfile=/app/ambuda/static/gen/main.js --bundle --watch"
+else
+ # Build, Staging, and Production modes take this route. Load site static files that are within the container.
+ ./node_modules/.bin/concurrently "/venv/bin/flask run -h 0.0.0.0 -p 5000"
+fi
\ No newline at end of file