Skip to content

Commit

Permalink
refactor: cli demo,templates -> fixtures
Browse files Browse the repository at this point in the history
  • Loading branch information
@utnapischtim
utnapischtim committed Jan 24, 2025
1 parent 81a391b commit 16c9490
Show file tree
Hide file tree
Showing 12 changed files with 458 additions and 488 deletions.
282 changes: 61 additions & 221 deletions invenio_records_marc21/cli.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,191 +2,79 @@
#
# This file is part of Invenio.
#
# Copyright (C) 2021-2023 Graz University of Technology.
# Copyright (C) 2021-2025 Graz University of Technology.
#
# Invenio-Records-Marc21 is free software; you can redistribute it and/or
# modify it under the terms of the MIT License; see LICENSE file for more
# details.

"""Command-line tools for demo module."""

import json
import random
from datetime import timedelta
from os.path import dirname, join

import arrow
from collections.abc import Callable
from functools import wraps

import click
from flask.cli import with_appcontext
from flask_principal import Identity, RoleNeed, UserNeed
from invenio_access.permissions import (
any_user,
authenticated_user,
system_identity,
system_user_id,
)
from invenio_rdm_records.records.systemfields.access.field.record import (
AccessStatusEnum,
)
from invenio_rdm_records.utils import get_or_create_user
from invenio_access.permissions import system_identity
from invenio_accounts.proxies import current_datastore
from invenio_db import db

from .errors import log_exceptions
from .fixtures.demo import create_fake_record
from .fixtures.tasks import create_demo_record
from .fixtures.templates import create_templates, delete_templates
from .proxies import current_records_marc21
from .services.record import Marc21Metadata
from .tasks import create_marc21_record
from .utils import create_fake_data


def get_user_identity(user_id):
"""Get user identity."""
identity = Identity(user_id)
# TODO: we need to get the user roles for specific user groups and add to the identity
identity.provides.add(any_user)
identity.provides.add(UserNeed(user_id))
identity.provides.add(authenticated_user)
identity.provides.add(RoleNeed("Marc21Manager"))
return identity


def fake_access_right():
"""Generates a fake access_right."""
_type = random.choice(list(AccessStatusEnum)).value
if (
_type == AccessStatusEnum.METADATA_ONLY.value
or _type == AccessStatusEnum.OPEN.value
):
return "public"
return _type


def fake_feature_date(days=365):
"""Generates a fake feature_date."""
start_date = arrow.utcnow().datetime
random_number_of_days = random.randrange(1, days)
_date = start_date + timedelta(days=random_number_of_days)
return _date.strftime("%Y-%m-%d")


def _load_file(filename):
with open(join(dirname(__file__), filename), "rb") as fp:
input = fp.read()
return input.decode("utf-8")


def _load_json(filename):
with open(join(dirname(__file__), filename), "rb") as fp:
return json.load(fp)


def create_fake_celery():
"""Create records for demo purposes in backend."""
data = create_fake_data()
metadata_access = fake_access_right()
data_access = {
"files": "public",
"record": metadata_access,
}
if metadata_access == AccessStatusEnum.EMBARGOED.value:
embargo = {
"embargo": {
"until": fake_feature_date(),
"active": True,
"reason": "Because I can!",
}
}
data_access.update(embargo)
data_access["record"] = AccessStatusEnum.RESTRICTED.value
data["access"] = data_access
create_marc21_record.delay(data, data_access)
def get_user(user_email):
"""Get user."""
with db.session.no_autoflush:
user = current_datastore.get_user_by_email(user_email)

if not user:
msg = f"NO user found for email: {user_email}"
raise RuntimeError(msg)

def create_fake_metadata(identity, filename):
"""Create records for demo purposes."""
data = create_fake_data()
metadata_access = fake_access_right()
data_access = {
"files": "public",
"record": metadata_access,
}
if metadata_access == AccessStatusEnum.EMBARGOED.value:
embargo = {
"embargo": {
"until": fake_feature_date(),
"active": True,
"reason": "Because I can!",
}
}
data_access.update(embargo)
data_access["record"] = AccessStatusEnum.RESTRICTED.value
return user

data["access"] = data_access

service = current_records_marc21.records_service
def wrap_messages(before: str, after: str) -> Callable:
"""Wrap messages with entry and exit message."""

draft = service.create(
data=data,
identity=identity,
access=data_access,
)
def decorator[T](func: Callable[..., T]) -> Callable:
@wraps(func)
def wrapper(**kwargs: dict) -> None:
"""Wrapper."""
click.secho(before, fg="blue")
try:
func(**kwargs)
except RuntimeError as error:
click.secho(str(error), fg="red")
else:
click.secho(after, fg="green")

record = service.publish(id_=draft.id, identity=identity)
return wrapper

return record


def create_fake_record(identity, filename):
"""Create records for demo purposes."""
data_to_use = _load_json(filename)
metadata_access = fake_access_right()
data_access = {
"files": "public",
"record": metadata_access,
}

if metadata_access == AccessStatusEnum.EMBARGOED.value:
embargo = {
"embargo": {
"until": fake_feature_date(),
"active": True,
"reason": "Because I can!",
}
}
data_access.update(embargo)
data_access["record"] = AccessStatusEnum.RESTRICTED.value

service = current_records_marc21.records_service

marc21_metadata = Marc21Metadata()
marc21_metadata.xml = data_to_use["metadata"]["xml"]
draft = service.create(
metadata=marc21_metadata,
identity=identity,
access=data_access,
files=False,
)

record = service.publish(id_=draft.id, identity=identity)

return record
return decorator


@click.group()
def marc21():
"""InvenioMarc21 records commands."""
pass


@marc21.command("rebuild-index")
@with_appcontext
@wrap_messages(
before="Reindexing records and drafts...",
after="Reindexed records!",
)
def rebuild_index():
"""Reindex all drafts, records."""
click.secho("Reindexing records and drafts...", fg="green")

rec_service = current_records_marc21.records_service
rec_service.rebuild_index(identity=system_identity)

click.secho("Reindexed records!", fg="green")


@marc21.command("demo")
@with_appcontext
Expand All @@ -200,86 +88,38 @@ def rebuild_index():
@click.option(
"--number",
"-n",
"n_records",
default=10,
show_default=True,
type=int,
help="Number of records will be created.",
)
@click.option(
"--fake-file",
"-f",
default="data/fake-metadata.xml",
show_default=True,
type=str,
help="Relative path to file",
)
@click.option(
"--metadata-only",
"-m",
default=False,
type=bool,
is_flag=True,
help="Provided metadata only in file",
)
@click.option(
"--backend",
"-b",
default=False,
type=bool,
is_flag=True,
help="Create in backend for large datasets",
)
@with_appcontext
@log_exceptions
def demo(user_email, number, fake_file, metadata_only, backend):
@wrap_messages(
before="Creating demo records...",
after="Created records!",
)
def demo(user_email, n_records):
"""Create number of fake records for demo purposes."""
click.secho("Creating demo records...", fg="blue")

user = get_or_create_user(user_email)
if user.id == system_user_id:
identity = system_identity
else:
identity = get_user_identity(user.id)
user = get_user(user_email)

for _ in range(number):
if backend:
create_fake_celery()
elif metadata_only:
create_fake_metadata(identity, fake_file)
else:
create_fake_record(identity, fake_file)

click.secho("Created records!", fg="green")


def create_templates(filename):
"""Create templates with the service."""
data_to_use = _load_json(filename)

service = current_records_marc21.templates_service
templates = []
for data in data_to_use:
template = service.create(data=data["values"], name=data["name"])
templates.append(template.to_dict())
return templates


def delete_templates(name, all, force):
"""Delete templates with the service."""
service = current_records_marc21.templates_service
result = service.delete(name=name, all=all, force=force)
return result
for _ in range(n_records):
fake_data = create_fake_record()
create_file = True # TODO: make that random
create_demo_record.delay(
user.id, fake_data, publish=True, create_file=create_file
)


@marc21.group()
def templates():
"""InvenioMarc21 templates commands."""
pass


@templates.command("create")
@click.option(
"--file",
"--input-file",
"-f",
required=True,
show_default=True,
Expand All @@ -288,13 +128,13 @@ def templates():
)
@with_appcontext
@log_exceptions
def create(file):
@wrap_messages(
before="Creating template/s..",
after="Successfully created Template/s!",
)
def create(input_file):
"""Create Templates for Marc21 Deposit app."""
click.secho("Creating template/s..", fg="blue")

create_templates(file)

click.secho("Successfully created Template/s!", fg="green")
create_templates(input_file)


@templates.command("delete")
Expand Down Expand Up @@ -322,10 +162,10 @@ def create(file):
)
@with_appcontext
@log_exceptions
@wrap_messages(
before="Deleting template/s...",
after="Successfully deleted Template!",
)
def delete(name, all, force):
"""Delete Templates for Marc21 Deposit app."""
click.secho("Deleting template/s...", fg="blue")

delete_templates(name, all, force)

click.secho("Successfully deleted Template!", fg="green")
7 changes: 5 additions & 2 deletions invenio_records_marc21/config.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# This file is part of Invenio.
#
# Copyright (C) 2021-2024 Graz University of Technology.
# Copyright (C) 2021-2025 Graz University of Technology.
#
# Invenio-Records-Marc21 is free software; you can redistribute it and/or
# modify it under the terms of the MIT License; see LICENSE file for more
Expand All @@ -13,7 +13,7 @@
from __future__ import absolute_import, print_function

import idutils
from celery.schedules import crontab, timedelta
from celery.schedules import crontab
from flask_principal import RoleNeed
from invenio_i18n import lazy_gettext as _
from invenio_rdm_records.services import facets as rdm_facets
Expand Down Expand Up @@ -293,6 +293,9 @@ def make_doi(prefix, record):
MARC21_RECORD_CREATOR_NEEDS = [RoleNeed("Marc21Creator")]
"""This Role is here to create and modify records, no publish allowed."""

MARC21_ALLOW_METADATA_ONLY_RECORDS = True
"""Allow marc21 records with only metadata."""


# Statistics configuration

Expand Down
Loading

0 comments on commit 16c9490

Please sign in to comment.