Add a compatible flask scheduler

.flake8

@@ -3,5 +3,5 @@ exclude = .git,__pycache__,documentation
 max-line-length = 160
 max-complexity = 13
 select = B,C,E,F,W,B9
-ignore = E501, W503, E203
+ignore = E501, W503, E203, E231
 

.gitignore

@@ -176,3 +176,10 @@ cython_debug/
 .vscode
 *.pickle
 flexmeasures.log
+*.png
+
+#MacOS
+.DS_Store
+flexmeasures_s2/profile_steering/examples/example_schedule_itho_flask.py
+flexmeasures_s2/profile_steering/examples/run_itho_with_debug.sh
+flexmeasures_s2/profile_steering/examples/instructions/

README.md

@@ -10,7 +10,14 @@
    using the FLEXMEASURES_PLUGINS setting (a list).
    Alternatively, if you installed this plugin as a package (e.g. via `python setup.py install`, `pip install -e` or `pip install flexmeasures_s2` should this project be on Pypi), then "flexmeasures_s2" suffices.
 
-2.  
+2. Config settings (during development)
+
+In your `flexmeasures.cfg`, you can set the following config settings for this plugin:
+
+- `FLEXMEASURES_S2_TARGET_MODE`: "energy" or "costs"
+- `FLEXMEASURES_S2_PRICE_SENSOR`: sensor ID of the price sensor
+
+To do: move these settings to the db asset (preferred scheduler and flex-context).
 
 
 ## Development
@@ -29,3 +36,7 @@ or:
 Try it:
 
     pre-commit run --all-files --show-diff-on-failure
+
+For profiling, use:
+
+    pyinstrument -o profiling_results.html test_frbc_device.py

flexmeasures_s2/api/somedata.py

@@ -1,5 +1,5 @@
-from flask_security import auth_token_required
 from flask_json import as_json
+from flask_security import auth_token_required
 
 from .. import flexmeasures_s2_api_bp
 

flexmeasures_s2/api/tests/test_api.py

@@ -1,16 +1,52 @@
 from flask import url_for
+from flask_security import decorators as fs_decorators
+from rq.job import Job
 
+from flexmeasures.api.tests.test_auth_token import patched_check_token
+from flexmeasures.api.tests.utils import UserContext
+from flexmeasures.data.services.scheduling import (
+    handle_scheduling_exception,
+    get_data_source_for_job,
+)
+from flexmeasures.data.tests.utils import work_on_rq
 
-def test_get_somedata_needs_authtoken(client):
-    response = client.get(
-        url_for("flexmeasures-s2 API.somedata"),
-        headers={"content-type": "application/json"},
-        follow_redirects=True,
-    )
-    assert response.status_code == 401  # HTTP error code 401 Unauthorized.
-    assert "application/json" in response.content_type
-    assert "not be properly authenticated" in response.json["message"]
 
+def test_s2_frbc_api(monkeypatch, app, setup_frbc_asset):
+    sensor = setup_frbc_asset.sensors[0]
 
-# TODO: The somedata endpoint requires authentication to be testes successfully.
-#       We'll need to add a user in conftest, which also requires us to add a db to testing
+    with UserContext("test_admin_user@seita.nl") as admin:
+        auth_token = admin.get_auth_token()
+
+    monkeypatch.setattr(fs_decorators, "_check_token", patched_check_token)
+    with app.test_client() as client:
+        trigger_schedule_response = client.post(
+            url_for("SensorAPI:trigger_schedule", id=sensor.id),
+            json={
+                "flex-context": {
+                    "target-profile": {},  # add target profile
+                }
+            },
+            headers={"Authorization": auth_token},
+        )
+        print("Server responded with:\n%s" % trigger_schedule_response.json)
+        assert trigger_schedule_response.status_code == 200
+        job_id = trigger_schedule_response.json["schedule"]
+
+    # Now that our scheduling job was accepted, we process the scheduling queue
+    work_on_rq(app.queues["scheduling"], exc_handler=handle_scheduling_exception)
+    job = Job.fetch(job_id, connection=app.queues["scheduling"].connection).is_finished
+    assert job.is_finished is True
+
+    # First, make sure the expected scheduler data source is now there
+    job.refresh()  # catch meta info that was added on this very instance
+    scheduler_source = get_data_source_for_job(job)
+    assert scheduler_source.model == "S2Scheduler"
+
+    # try to retrieve the schedule through the /sensors/<id>/schedules/<job_id> [GET] api endpoint
+    # todo: to be discussed: the response from the S2Scheduler might get a different format than the FM default
+    # get_schedule_response = client.get(
+    #     url_for("SensorAPI:get_schedule", id=sensor.id, uuid=job_id),
+    #     query_string={"duration": "PT48H"},
+    # )
+    # print("Server responded with:\n%s" % get_schedule_response.json)
+    # assert get_schedule_response.status_code == 200

flexmeasures_s2/conftest.py

@@ -1,12 +1,18 @@
 import pytest
 
+from flask_sqlalchemy import SQLAlchemy
+
+from flexmeasures import Asset, AssetType, Sensor, Account
 from flexmeasures.app import create as create_flexmeasures_app
+from flexmeasures.auth.policy import ADMIN_ROLE
 from flexmeasures.conftest import (  # noqa F401
     db,
     fresh_db,
-)  # Use these fixtures to rely on the FlexMeasures database.
+)  # Use these fixtures to rely on the FlexMeasures database. There might be others in flexmeasures/conftest you want to also re-use
+from flexmeasures.data.services.users import create_user
 
-# There might be others in flexmeasures/conftest you want to also re-use
+from flexmeasures_s2 import S2_SCHEDULER_SPECS
+from flexmeasures_s2.models.const import FRBC_TYPE
 
 
 @pytest.fixture(scope="session")
@@ -25,3 +31,43 @@ def app():
     ctx.pop()
 
     print("DONE WITH APP FIXTURE")
+
+
+@pytest.fixture(scope="module")
+def setup_admin(db: SQLAlchemy):  # noqa: F811
+    account = Account(name="Some FlexMeasures host")
+    db.session.add(account)
+    create_user(
+        username="Test Admin User",
+        email="test_admin_user@seita.nl",
+        account_name=account.name,
+        password="testtest",
+        user_roles=dict(name=ADMIN_ROLE, description="A user who can do everything."),
+    )
+    yield account
+
+
+@pytest.fixture(scope="module")
+def setup_frbc_asset(db: SQLAlchemy, setup_admin):  # noqa: F811
+    asset_type = AssetType(name=FRBC_TYPE)
+    asset = Asset(
+        name="Test FRBC asset",
+        generic_asset_type=asset_type,
+        owner=setup_admin,
+    )
+    asset.attributes = {
+        "custom-scheduler": S2_SCHEDULER_SPECS,
+        "flex-model": {
+            "S2-FRBC-device-state": None,  # ?todo: add serialized state
+        },
+    }
+    db.session.add(asset)
+    sensor = Sensor(
+        name="power",
+        unit="kW",
+        event_resolution="PT5M",
+        generic_asset=asset,
+    )
+    db.session.add(sensor)
+    db.session.flush()  # assign (asset and sensor) IDs
+    yield asset

flexmeasures_s2/models/const.py

@@ -0,0 +1,2 @@
+NAMESPACE = "fm-s2"
+FRBC_TYPE = f"{NAMESPACE}.FRBC"