venv added, updated

myenv/lib/python3.12/site-packages/tests/conftest.py

@@ -0,0 +1,33 @@
+import os
+import pathlib
+
+import pytest
+
+import openhab.oauth2_helper
+
+# ruff: noqa: S106
+
+@pytest.fixture(scope='session')
+def oh() -> 'openhab.OpenHAB':
+  """Setup a generic connection."""
+  base_url = 'http://localhost:8080/rest'
+  return openhab.OpenHAB(base_url)
+
+
+@pytest.fixture(scope='session')
+def oh_oauth2() -> 'openhab.OpenHAB':
+  """Setup a generic connection."""
+  url_base = 'http://localhost:8080'
+  url_rest = f'{url_base}/rest'
+
+  # this must be set for oauthlib to work on http
+  os.environ['OAUTHLIB_INSECURE_TRANSPORT'] = '1'
+
+  oauth2_token = openhab.oauth2_helper.get_oauth2_token(url_base, username='admin', password='admin')
+
+  oauth2_config = {'client_id': r'http://127.0.0.1/auth',
+                   'token_cache': str(pathlib.Path(__file__).resolve().parent.parent / '.oauth2_token_test'),
+                   'token': oauth2_token,
+                   }
+
+  return openhab.OpenHAB(url_rest, oauth2_config=oauth2_config)

myenv/lib/python3.12/site-packages/tests/test_basic.py

@@ -0,0 +1,113 @@
+import datetime
+import time
+
+import openhab
+
+# ruff: noqa: S101, ANN201, T201
+
+
+def test_fetch_all_items(oh: openhab.OpenHAB):
+  items = oh.fetch_all_items()
+
+  assert len(items)
+
+
+def test_datetime_update(oh: openhab.OpenHAB):
+  dt_obj = oh.get_item('TheDateTime')
+  dt_utc_now = datetime.datetime.now(tz=datetime.timezone.utc)
+  dt_obj.state = dt_utc_now
+
+  time.sleep(0.5)
+  assert dt_obj.state.isoformat(timespec='seconds') == dt_utc_now.isoformat(timespec='seconds')
+
+
+def test_datetime_command(oh: openhab.OpenHAB):
+  dt_obj = oh.get_item('TheDateTime')
+  dt_utc_now = datetime.datetime.now(tz=datetime.timezone.utc)
+  dt_obj.command(dt_utc_now)
+
+  time.sleep(0.5)
+  assert dt_obj.state.isoformat(timespec='seconds') == dt_utc_now.isoformat(timespec='seconds')
+
+
+def test_null_undef(oh: openhab.OpenHAB):
+  float_obj = oh.get_item('floattest')
+
+  float_obj.update_state_null()
+  assert float_obj.is_state_null()
+
+  float_obj.update_state_undef()
+  assert float_obj.is_state_undef()
+
+
+def test_float(oh: openhab.OpenHAB):
+  float_obj = oh.get_item('floattest')
+
+  float_obj.state = 1.0
+  assert float_obj.state == 1.0
+
+
+def test_scientific_notation(oh: openhab.OpenHAB):
+  float_obj = oh.get_item('floattest')
+
+  float_obj.state = 1e-10
+  time.sleep(1)  # Allow time for OpenHAB test instance to process state update
+  assert float_obj.state == 1e-10
+
+
+def test_non_ascii_string(oh: openhab.OpenHAB):
+  string_obj = oh.get_item('stringtest')
+
+  string_obj.state = 'שלום'
+  assert string_obj.state == 'שלום'
+
+  string_obj.state = '°F'
+  assert string_obj.state == '°F'
+
+
+def test_color_item(oh: openhab.OpenHAB):
+  coloritem = oh.get_item('color_item')
+
+  coloritem.update_state_null()
+  assert coloritem.is_state_null()
+
+  coloritem.state = 1
+  assert coloritem.state == (0.0, 0.0, 1.0)
+
+  coloritem.state = '1.1, 1.2, 1.3'
+  assert coloritem.state == (1.1, 1.2, 1.3)
+
+  coloritem.state = 'OFF'
+  assert coloritem.state == (1.1, 1.2, 0.0)
+
+  coloritem.state = 'ON'
+  assert coloritem.state == (1.1, 1.2, 100.0)
+
+
+def test_number_temperature(oh: openhab.OpenHAB):
+  # Tests below require the OpenHAB test instance to be configured with '°C' as
+  # the unit of measure for the 'Dining_Temperature' item
+  temperature_item = oh.get_item('Dining_Temperature')
+
+  temperature_item.state = 1.0
+  time.sleep(1)  # Allow time for OpenHAB test instance to process state update
+  assert temperature_item.state == 1.0
+  assert temperature_item.unit_of_measure == '°C'
+
+  temperature_item.state = '2 °C'
+  time.sleep(1)
+  assert temperature_item.state == 2
+  assert temperature_item.unit_of_measure == '°C'
+
+  temperature_item.state = (3, '°C')
+  time.sleep(1)
+  assert temperature_item.state == 3
+  assert temperature_item.unit_of_measure == '°C'
+
+  # Unit of measure conversion (performed by OpenHAB server)
+  temperature_item.state = (32, '°F')
+  assert round(temperature_item.state, 2) == 0
+  temperature_item.state = (212, '°F')
+  time.sleep(1)
+  assert temperature_item.state == 100
+  assert temperature_item.unit_of_measure == '°C'

myenv/lib/python3.12/site-packages/tests/test_oauth.py

@@ -0,0 +1,120 @@
+import datetime
+import os
+import time
+
+import pytest
+
+import openhab.oauth2_helper
+
+# ruff: noqa: S101, ANN201, T201
+
+pytestmark = pytest.mark.skipif('CI' in os.environ, reason='oauth2 tests currently not working in github CI')
+
+
+def test_fetch_all_items(oh_oauth2: openhab.OpenHAB):
+  items = oh_oauth2.fetch_all_items()
+
+  assert len(items)
+
+
+def test_datetime_update(oh_oauth2: openhab.OpenHAB):
+  dt_obj = oh_oauth2.get_item('TheDateTime')
+  dt_utc_now = datetime.datetime.now(tz=datetime.timezone.utc)
+  dt_obj.state = dt_utc_now
+
+  assert dt_obj.state.isoformat(timespec='seconds') == dt_utc_now.isoformat(timespec='seconds')
+
+
+def test_datetime_command(oh_oauth2: openhab.OpenHAB):
+  dt_obj = oh_oauth2.get_item('TheDateTime')
+  dt_utc_now = datetime.datetime.now(tz=datetime.timezone.utc)
+  dt_obj.command(dt_utc_now)
+
+  assert dt_obj.state.isoformat(timespec='seconds') == dt_utc_now.isoformat(timespec='seconds')
+
+
+def test_null_undef(oh_oauth2: openhab.OpenHAB):
+  float_obj = oh_oauth2.get_item('floattest')
+
+  float_obj.update_state_null()
+  assert float_obj.is_state_null()
+
+  float_obj.update_state_undef()
+  assert float_obj.is_state_undef()
+
+
+def test_float(oh_oauth2: openhab.OpenHAB):
+  float_obj = oh_oauth2.get_item('floattest')
+
+  float_obj.state = 1.0
+  assert float_obj.state == 1.0
+
+
+def test_scientific_notation(oh_oauth2: openhab.OpenHAB):
+  float_obj = oh_oauth2.get_item('floattest')
+
+  float_obj.state = 1e-10
+  time.sleep(1)  # Allow time for OpenHAB test instance to process state update
+  assert float_obj.state == 1e-10
+
+
+def test_non_ascii_string(oh_oauth2: openhab.OpenHAB):
+  string_obj = oh_oauth2.get_item('stringtest')
+
+  string_obj.state = 'שלום'
+  assert string_obj.state == 'שלום'
+
+  string_obj.state = '°F'
+  assert string_obj.state == '°F'
+
+
+def test_color_item(oh_oauth2: openhab.OpenHAB):
+  coloritem = oh_oauth2.get_item('color_item')
+
+  coloritem.update_state_null()
+  assert coloritem.is_state_null()
+
+  coloritem.state = 1
+  assert coloritem.state == (0.0, 0.0, 1.0)
+
+  coloritem.state = '1.1, 1.2, 1.3'
+  assert coloritem.state == (1.1, 1.2, 1.3)
+
+  coloritem.state = 'OFF'
+  assert coloritem.state == (1.1, 1.2, 0.0)
+
+  coloritem.state = 'ON'
+  assert coloritem.state == (1.1, 1.2, 100.0)
+
+
+def test_number_temperature(oh_oauth2: openhab.OpenHAB):
+  # Tests below require the OpenHAB test instance to be configured with '°C' as
+  # the unit of measure for the 'Dining_Temperature' item
+  temperature_item = oh_oauth2.get_item('Dining_Temperature')
+
+  temperature_item.state = 1.0
+  time.sleep(1)  # Allow time for OpenHAB test instance to process state update
+  assert temperature_item.state == 1.0
+  assert temperature_item.unit_of_measure == '°C'
+
+  temperature_item.state = '2 °C'
+  time.sleep(1)
+  assert temperature_item.state == 2
+  assert temperature_item.unit_of_measure == '°C'
+
+  temperature_item.state = (3, '°C')
+  time.sleep(1)
+  assert temperature_item.state == 3
+  assert temperature_item.unit_of_measure == '°C'
+
+  # Unit of measure conversion (performed by OpenHAB server)
+  temperature_item.state = (32, '°F')
+  assert round(temperature_item.state, 2) == 0
+  temperature_item.state = (212, '°F')
+  time.sleep(1)
+  assert temperature_item.state == 100
+  assert temperature_item.unit_of_measure == '°C'
+
+
+def test_session_logout(oh_oauth2: openhab.OpenHAB):
+  assert oh_oauth2.logout() is True