Merge pull request #2882 from fractal-analytics-platform/2875-improve-init-db-data-and-settings

Improve `init-db-data` and settings

Author: ychiucco

.github/workflows/benchmarks.yaml

@@ -44,7 +44,7 @@ jobs:
         export JWT_EXPIRE_SECONDS=84600
         cd benchmarks/
         poetry run fractalctl set-db
-        poetry run fractalctl init-db-data --resource default --profile default
+        poetry run fractalctl init-db-data --resource default --profile default --admin-email [email protected] --admin-pwd 1234
         poetry run python populate_db/populate_db_script.py
         poetry run sh serve.sh
 

.github/workflows/oauth.yaml

@@ -80,7 +80,7 @@ jobs:
             FRACTAL_EMAIL_PASSWORD_KEY: lp3j2FVDkzLd0Rklnzg1pHuV9ClCuDE0aGeJfTNCaW4=
           run: |
             fractalctl set-db
-            fractalctl init-db-data --resource default --profile default
+            fractalctl init-db-data --resource default --profile default --admin-email [email protected] --admin-pwd 1234
             fractalctl start --port 8001 &
             sleep 2
 

CHANGELOG.md

@@ -8,7 +8,8 @@ TBD
 \#2870
 \#2874
 \#2877
-\##2884
+\#2882
+\#2884
 
 # 2.16.6
 

benchmarks/populate_db/.fractal_server.env

@@ -1,8 +1,6 @@
 JWT_SECRET_KEY=somethingverysecret
 FRACTAL_LOGGING_LEVEL=0
 FRACTAL_RUNNER_BACKEND=local
-FRACTAL_ADMIN_DEFAULT_EMAIL=[email protected]
-FRACTAL_ADMIN_DEFAULT_PASSWORD=1234
 JWT_EXPIRE_SECONDS=84600
 POSTGRES_HOST=/var/run/postgresql
 POSTGRES_DB=fractal_test

docs/internals/users.md

@@ -21,7 +21,7 @@ Most attributes are [the default ones from `fastapi-users`](https://fastapi-user
 
 In the startup phase, `fractal-server` creates a default user, who also has the superuser privileges that are necessary for managing other users.
 The credentials for this user are defined via the environment variables
-[`FRACTAL_ADMIN_DEFAULT_EMAIL`](../configuration.md/#fractal_server.config.Settings.FRACTAL_DEFAULT_ADMIN_EMAIL) (default: `admin@fractal.xy`)
+[`FRACTAL_ADMIN_DEFAULT_EMAIL`](../configuration.md/#fractal_server.config.Settings.FRACTAL_DEFAULT_ADMIN_EMAIL) (default: `admin@example.org`)
 and
 [`FRACTAL_ADMIN_DEFAULT_PASSWORD`](../configuration.md/#fractal_server.config.Settings.FRACTAL_DEFAULT_ADMIN_PASSWORD) (default: `1234`).
 
@@ -58,7 +58,7 @@ The [Bearer](https://fastapi-users.github.io/fastapi-users/latest/configuration/
 $ curl \
     -X POST \
     -H "Content-Type: application/x-www-form-urlencoded" \
-    -d "username=admin@fractal.xy&password=1234" \
+    -d "username=admin@example.org&password=1234" \
     http://127.0.0.1:8000/auth/token/login/
 
 {
@@ -75,7 +75,7 @@ The [Cookie](https://fastapi-users.github.io/fastapi-users/latest/configuration/
 $ curl \
     -X POST \
     -H "Content-Type: application/x-www-form-urlencoded" \
-    -d "username=admin@fractal.xy&password=1234" \
+    -d "username=admin@example.org&password=1234" \
     --cookie-jar - \
     http://127.0.0.1:8000/auth/login/
 
@@ -94,7 +94,7 @@ $ curl \
 
 {
     "id":1,
-    "email":"admin@fractal.xy",
+    "email":"admin@example.org",
     "is_active":true,
     "is_superuser":true,
     "is_verified":false,
@@ -388,7 +388,7 @@ $ curl \
 [
     {
         "id":1,
-        "email":"admin@fractal.xy",
+        "email":"admin@example.org",
         "is_active":true,
         "is_superuser":true,
         "is_verified":false,

example/run_fractal_server.sh

@@ -5,7 +5,7 @@ set -e
 # Create and init db
 createdb fractal-example-test
 poetry run fractalctl set-db
-poetry run fractalctl init-db-data --resource default --profile default
+poetry run fractalctl init-db-data --resource default --profile default --admin-email [email protected] --admin-pwd 1234
 
 # Start the server
 poetry run gunicorn fractal_server.main:app \

fractal_server/__main__.py

@@ -62,14 +62,26 @@
 init_db_data_parser.add_argument(
     "--resource",
     type=str,
-    help=("Either `default` or path to the JSON file of the first resource."),
-    required=True,
+    help="Either `default` or path to the JSON file of the first resource.",
+    required=False,
 )
 init_db_data_parser.add_argument(
     "--profile",
     type=str,
-    help=("Either `default` or path to the JSON file of the first profile."),
-    required=True,
+    help="Either `default` or path to the JSON file of the first profile.",
+    required=False,
+)
+init_db_data_parser.add_argument(
+    "--admin-email",
+    type=str,
+    help="Email of the first admin user to create.",
+    required=False,
+)
+init_db_data_parser.add_argument(
+    "--admin-pwd",
+    type=str,
+    help="Password of the first admin user to create.",
+    required=False,
 )
 
 # fractalctl update-db-data
@@ -124,119 +136,126 @@ def set_db():
 
 
 def init_db_data(
-    *,
-    resource: str,
-    profile: str,
+    resource: str | None = None,
+    profile: str | None = None,
+    admin_email: str | None = None,
+    admin_password: str | None = None,
 ) -> None:
     from fractal_server.app.security import _create_first_user
     from fractal_server.app.security import _create_first_group
-    from fractal_server.syringe import Inject
-    from fractal_server.config import get_init_data_settings
     from fractal_server.app.db import get_sync_db
     from sqlalchemy import select, func
     from fractal_server.app.models.security import UserOAuth
     from fractal_server.app.models import Resource, Profile
     from fractal_server.app.schemas.v2.resource import cast_serialize_resource
     from fractal_server.app.schemas.v2.profile import cast_serialize_profile
 
-    init_data_settings = Inject(get_init_data_settings)
-
     # Create default group and user
     print()
     _create_first_group()
     print()
-    asyncio.run(
-        _create_first_user(
-            email=init_data_settings.FRACTAL_DEFAULT_ADMIN_EMAIL,
-            password=(
-                init_data_settings.FRACTAL_DEFAULT_ADMIN_PASSWORD.get_secret_value()  # noqa E501
-            ),
-            is_superuser=True,
-            is_verified=True,
-        )
-    )
-    print()
 
-    # Create resource and profile
-    with next(get_sync_db()) as db:
-        # Preliminary check
-        num_resources = db.execute(select(func.count(Resource.id))).scalar()
-        if num_resources != 0:
-            print(f"There exist already {num_resources=} resources. Exit.")
-            sys.exit(1)
-
-        # Get resource/profile data
-        if resource == "default":
-            _python_version = (
-                f"{sys.version_info.major}.{sys.version_info.minor}"
-            )
-            resource_data = {
-                "name": "Local resource",
-                "type": ResourceType.LOCAL,
-                "jobs_local_dir": (Path.cwd() / "data-jobs").as_posix(),
-                "tasks_local_dir": (Path.cwd() / "data-tasks").as_posix(),
-                "tasks_python_config": {
-                    "default_version": _python_version,
-                    "versions": {
-                        _python_version: sys.executable,
-                    },
-                },
-                "jobs_poll_interval": 0,
-                "jobs_runner_config": {},
-                "tasks_pixi_config": {},
-            }
-            print("Prepared default resource data.")
-        else:
-            with open(resource) as f:
-                resource_data = json.load(f)
-            print(f"Read resource data from {resource}.")
-        if profile == "default":
-            profile_data = {
-                "resource_type": "local",
-                "name": "Local profile",
-            }
-            print("Prepared default profile data.")
-        else:
-            with open(profile) as f:
-                profile_data = json.load(f)
-            print(f"Read profile data from {profile}.")
-
-        # Validate resource/profile data
-        try:
-            resource_data = cast_serialize_resource(resource_data)
-        except ValidationError as e:
-            sys.exit(
-                f"ERROR: Invalid resource data.\nOriginal error:\n{str(e)}"
-            )
-        try:
-            profile_data = cast_serialize_profile(profile_data)
-        except ValidationError as e:
-            sys.exit(
-                f"ERROR: Invalid profile data.\nOriginal error:\n{str(e)}"
+    # Create admin user if requested
+    if (admin_email is None) != (admin_password is None):
+        print("You must provide both --admin-email and --admin-pwd. Exit.")
+        sys.exit(1)
+    if admin_password and admin_email:
+        asyncio.run(
+            _create_first_user(
+                email=admin_email,
+                password=admin_password,
+                is_superuser=True,
+                is_verified=True,
             )
-
-        # Create resource/profile db objects
-        resource_obj = Resource(**resource_data)
-        db.add(resource_obj)
-        db.commit()
-        db.refresh(resource_obj)
-        profile_data["resource_id"] = resource_obj.id
-        profile_obj = Profile(**profile_data)
-        db.add(profile_obj)
-        db.commit()
-        db.refresh(profile_obj)
-
-        # Associate profile to users
-        res = db.execute(select(UserOAuth))
-        users = res.unique().scalars().all()
-        for user in users:
-            print(f"Now set profile_id={profile_obj.id} for {user.email}.")
-            user.profile_id = profile_obj.id
-            db.add(user)
-        db.commit()
-        db.expunge_all()
+        )
         print()
 
+    # Create resource and profile if requested
+    if (resource is None) != (profile is None):
+        print("You must provide both --resource and --profile. Exit.")
+        sys.exit(1)
+    if resource and profile:
+        with next(get_sync_db()) as db:
+            # Preliminary check
+            num_resources = db.execute(
+                select(func.count(Resource.id))
+            ).scalar()
+            if num_resources != 0:
+                print(f"There exist already {num_resources=} resources. Exit.")
+                sys.exit(1)
+
+            # Get resource/profile data
+            if resource == "default":
+                _python_version = (
+                    f"{sys.version_info.major}.{sys.version_info.minor}"
+                )
+                resource_data = {
+                    "name": "Local resource",
+                    "type": ResourceType.LOCAL,
+                    "jobs_local_dir": (Path.cwd() / "data-jobs").as_posix(),
+                    "tasks_local_dir": (Path.cwd() / "data-tasks").as_posix(),
+                    "tasks_python_config": {
+                        "default_version": _python_version,
+                        "versions": {
+                            _python_version: sys.executable,
+                        },
+                    },
+                    "jobs_poll_interval": 0,
+                    "jobs_runner_config": {},
+                    "tasks_pixi_config": {},
+                }
+                print("Prepared default resource data.")
+            else:
+                with open(resource) as f:
+                    resource_data = json.load(f)
+                print(f"Read resource data from {resource}.")
+            if profile == "default":
+                profile_data = {
+                    "resource_type": "local",
+                    "name": "Local profile",
+                }
+                print("Prepared default profile data.")
+            else:
+                with open(profile) as f:
+                    profile_data = json.load(f)
+                print(f"Read profile data from {profile}.")
+
+            # Validate resource/profile data
+            try:
+                resource_data = cast_serialize_resource(resource_data)
+            except ValidationError as e:
+                sys.exit(
+                    f"ERROR: Invalid resource data.\nOriginal error:\n{str(e)}"
+                )
+            try:
+                profile_data = cast_serialize_profile(profile_data)
+            except ValidationError as e:
+                sys.exit(
+                    f"ERROR: Invalid profile data.\nOriginal error:\n{str(e)}"
+                )
+
+            # Create resource/profile db objects
+            resource_obj = Resource(**resource_data)
+            db.add(resource_obj)
+            db.commit()
+            db.refresh(resource_obj)
+            profile_data["resource_id"] = resource_obj.id
+            profile_obj = Profile(**profile_data)
+            db.add(profile_obj)
+            db.commit()
+            db.refresh(profile_obj)
+
+            # Associate profile to users
+            res = db.execute(select(UserOAuth))
+            users = res.unique().scalars().all()
+            for user in users:
+                print(f"Now set profile_id={profile_obj.id} for {user.email}.")
+                user.profile_id = profile_obj.id
+                db.add(user)
+            db.commit()
+            db.expunge_all()
+            print()
+
 
 def update_db_data():
     """
@@ -328,6 +347,8 @@ def run():
         init_db_data(
             resource=args.resource,
             profile=args.profile,
+            admin_email=args.admin_email,
+            admin_password=args.admin_pwd,
         )
     elif args.cmd == "update-db-data":
         update_db_data()

fractal_server/config/__init__.py

@@ -1,7 +1,6 @@
 from ._database import DatabaseSettings
 from ._email import EmailSettings
 from ._email import PublicEmailSettings  # noqa F401
-from ._init_data import InitDataSettings
 from ._main import Settings
 from ._oauth import OAuthSettings
 
@@ -18,11 +17,5 @@ def get_email_settings(email_settings=EmailSettings()) -> EmailSettings:
     return email_settings
 
 
-def get_init_data_settings(
-    init_data_settings=InitDataSettings(),
-) -> InitDataSettings:
-    return init_data_settings
-
-
 def get_oauth_settings(oauth_settings=OAuthSettings()) -> OAuthSettings:
     return oauth_settings