def setup_api_test_data(db):
"""
Set up data for API v2.0 tests.
"""
print("Setting up data for API v2.0 tests on %s" % db.engine)
from flexmeasures.data.models.user import User, Role
from flexmeasures.data.models.assets import Asset
user_datastore = SQLAlchemySessionUserDatastore(db.session, User, Role)
test_supplier = user_datastore.find_user(email="*****@*****.**")
battery = Asset.query.filter(Asset.name == "Test battery").one_or_none()
battery.owner = test_supplier
test_prosumer = user_datastore.find_user(email="*****@*****.**")
admin_role = user_datastore.create_role(name="admin",
description="God powers")
user_datastore.add_role_to_user(test_prosumer, admin_role)
# an inactive user
user_datastore.create_user(
username="******",
email="*****@*****.**",
password=hash_password("testtest"),
active=False,
)
def setup_api_test_data(db, setup_accounts, setup_roles_users):
"""
Adding the task-runner
"""
print("Setting up data for API task runner tests on %s" % db.engine)
from flexmeasures.data.models.user import User, Role
from flexmeasures.data.models.task_runs import LatestTaskRun
# Create test role
user_datastore = SQLAlchemySessionUserDatastore(db.session, User, Role)
test_task_runner_role = user_datastore.create_role(
name="task-runner", description="A node running repeated tasks.")
# Create test user
test_task_runner = user_datastore.create_user(
username="******",
email="*****@*****.**",
password=hash_password("testtest"),
account_id=setup_accounts["Prosumer"].id,
)
user_datastore.add_role_to_user(test_task_runner, test_task_runner_role)
# More task stuff
older_task = LatestTaskRun(
name="task-A",
status=True,
datetime=datetime.utcnow().replace(tzinfo=pytz.utc) -
timedelta(days=1),
)
recent_task = LatestTaskRun(name="task-B", status=False)
db.session.add(older_task)
db.session.add(recent_task)
print("Done setting up data for API task runner tests")
def create_user( # noqa: C901
password: str = None,
user_roles: Union[Dict[str, str], List[Dict[str, str]], str,
List[str]] = None,
check_email_deliverability: bool = True,
account_name: Optional[str] = None,
**kwargs,
) -> User:
"""
Convenience wrapper to create a new User object.
It hashes the password.
In addition to the user, this function can create
- new Role objects (if user roles do not already exist)
- an Account object (if it does not exist yet)
- a new DataSource object that corresponds to the user
Remember to commit the session after calling this function!
"""
# Check necessary input explicitly before anything happens
if password is None or password == "":
raise InvalidFlexMeasuresUser("No password provided.")
if "email" not in kwargs:
raise InvalidFlexMeasuresUser("No email address provided.")
email = kwargs.pop("email").strip()
try:
email_info = validate_email(email, check_deliverability=False)
# The mx check talks to the SMTP server. During testing, we skip it because it
# takes a bit of time and without internet connection it fails.
if check_email_deliverability and not current_app.testing:
try:
validate_email_deliverability(email_info.domain,
email_info["domain_i18n"])
except EmailUndeliverableError as eue:
raise InvalidFlexMeasuresUser(
"The email address %s does not seem to be deliverable: %s"
% (email, str(eue)))
except EmailNotValidError as enve:
raise InvalidFlexMeasuresUser("%s is not a valid email address: %s" %
(email, str(enve)))
if "username" not in kwargs:
username = email.split("@")[0]
else:
username = kwargs.pop("username").strip()
# Check integrity explicitly before anything happens
existing_user_by_email = User.query.filter_by(email=email).one_or_none()
if existing_user_by_email is not None:
raise InvalidFlexMeasuresUser("User with email %s already exists." %
email)
existing_user_by_username = User.query.filter_by(
username=username).one_or_none()
if existing_user_by_username is not None:
raise InvalidFlexMeasuresUser("User with username %s already exists." %
username)
# check if we can link/create an account
if account_name is None:
raise InvalidFlexMeasuresUser(
"Cannot create user without knowing the name of the account which this user is associated with."
)
account = db.session.query(Account).filter_by(
name=account_name).one_or_none()
if account is None:
print(f"Creating account {account_name} ...")
account = Account(name=account_name)
db.session.add(account)
user_datastore = SQLAlchemySessionUserDatastore(db.session, User, Role)
kwargs.update(password=hash_password(password),
email=email,
username=username)
user = user_datastore.create_user(**kwargs)
user.account = account
# add roles to user (creating new roles if necessary)
if user_roles:
if not isinstance(user_roles, list):
user_roles = [user_roles] # type: ignore
for user_role in user_roles:
if isinstance(user_role, dict):
role = user_datastore.find_role(user_role["name"])
else:
role = user_datastore.find_role(user_role)
if role is None:
if isinstance(user_role, dict):
role = user_datastore.create_role(**user_role)
else:
role = user_datastore.create_role(name=user_role)
user_datastore.add_role_to_user(user, role)
# create data source
db.session.add(DataSource(user=user))
return user
def create_user( # noqa: C901
user_roles: Union[Dict[str, str], List[Dict[str, str]], str,
List[str]] = None,
check_deliverability: bool = True,
**kwargs) -> User:
"""
Convenience wrapper to create a new User object and new Role objects (if user roles do not already exist),
and new DataSource object that corresponds to the user.
Remember to commit the session after calling this function!
"""
# Check necessary input explicitly before anything happens
if "email" not in kwargs:
raise InvalidFlexMeasuresUser("No email address provided.")
email = kwargs.pop("email").strip()
try:
email_info = validate_email(email, check_deliverability=False)
# The mx check talks to the SMTP server. During testing, we skip it because it
# takes a bit of time and without internet connection it fails.
if check_deliverability and not current_app.testing:
try:
validate_email_deliverability(email_info.domain,
email_info["domain_i18n"])
except EmailUndeliverableError as eue:
raise InvalidFlexMeasuresUser(
"The email address %s does not seem to be deliverable: %s"
% (email, str(eue)))
except EmailNotValidError as enve:
raise InvalidFlexMeasuresUser("%s is not a valid email address: %s" %
(email, str(enve)))
if "username" not in kwargs:
username = email.split("@")[0]
else:
username = kwargs.pop("username").strip()
# Check integrity explicitly before anything happens
existing_user_by_email = User.query.filter_by(email=email).one_or_none()
if existing_user_by_email is not None:
raise InvalidFlexMeasuresUser("User with email %s already exists." %
email)
existing_user_by_username = User.query.filter_by(
username=username).one_or_none()
if existing_user_by_username is not None:
raise InvalidFlexMeasuresUser("User with username %s already exists." %
username)
user_datastore = SQLAlchemySessionUserDatastore(db.session, User, Role)
kwargs.update(email=email, username=username)
user = user_datastore.create_user(**kwargs)
if user.password is None:
set_random_password(user)
# add roles to user (creating new roles if necessary)
if user_roles:
if not isinstance(user_roles, list):
user_roles = [user_roles] # type: ignore
for user_role in user_roles:
if isinstance(user_role, dict):
role = user_datastore.find_role(user_role["name"])
else:
role = user_datastore.find_role(user_role)
if role is None:
if isinstance(user_role, dict):
role = user_datastore.create_role(**user_role)
else:
role = user_datastore.create_role(name=user_role)
user_datastore.add_role_to_user(user, role)
# create data source
db.session.add(DataSource(user=user))
return user
