standardbots 2.0.0.dev1736549072__tar.gz → 2.0.0.dev1737492400__tar.gz

{standardbots-2.0.0.dev1736549072 → standardbots-2.0.0.dev1737492400}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: standardbots
-Version: 2.0.0.dev1736549072
+Version: 2.0.0.dev1737492400
 Summary: Standard Bots RO1 Robotics API
 Home-page: 
 Author: Standard Bots Support

standardbots-2.0.0.dev1737492400/README.md

@@ -0,0 +1,141 @@
+You can test the API by using the playground, add your own file or use the existing python scripts.
+When a client has an issue, and they send their code. It's helpful to test their code to see possible issues
+
+# ENABLE API ON YOUR LOCAL MACHINE
+
+Follow the steps here https://www.notion.so/standardbots/Using-the-REST-API-b2c778d47969444dac61483f0117acad
+
+# CONFIG
+
+At the top of the file, use your token
+
+# RUN
+
+To run a script move into the `sdks/python` folder and run `python playground/filename.py`
+
+# To create a test build
+
+1. Update version in `setup.py`
+2. Run `python3 setup.py sdist bdist_wheel`
+
+# Tests
+
+## Setup
+
+To set up tests:
+
+```bash
+cd sdks/python
+
+pip install -r requirements.txt
+pip install -r requirements-dev.txt
+```
+
+### Create sample data
+
+#### Sample routine
+
+You need to add the sample routine in [sdks/python/tests/fixtures/test_public_api_routine.json](./tests/fixtures/test_public_api_routine.json) to your target test environment (i.e. upload the routine to ).
+
+The name of routine should be "Test Public API"
+
+#### Sample globals
+
+- _Variable._ Add global variable called "test_public_api_global" with any value.
+- _Space._ Create a global space called "Test global space" of any kind.
+
+
+## Running
+
+Here is a basic test command:
+
+```bash
+SB_API_URL=http://34.162.0.32:3000
+SB_API_TOKEN=...
+
+python3 -m pytest ./tests --cov=standardbots --token=$SB_API_TOKEN --api-url=$SB_API_URL
+```
+
+You may also set up a `.env` file at `sdks/python/.env` with the following contents:
+
+```bash
+export SB_API_URL=http://34.162.0.32:3000
+export SB_API_TOKEN=...
+```
+
+Then you can just do:
+
+```bash
+python3 -m pytest ./tests --cov=standardbots
+```
+
+### Robot state and testing (Markers)
+
+We need the bot to be in a certain state to run certain tests. For example, we need a routine to be running in order to stop the routine.
+
+At start of testing, robot should:
+
+- _NOT_ be e-stopped.
+
+
+The basic idea here is:
+
+- These special tests will not be run by default.
+- You may pass a flag (e.g. `--routine-running`) when the bot is in the correct state to run the tests.
+- When the flag is passed:
+  1. Tests with the flag are run.
+  2. Tests without the flag are not run.
+
+We use [pytest markers](https://docs.pytest.org/en/7.1.x/example/markers.html) to do this.
+
+#### Routine running
+
+The special sample routine ("Test Public API") should be running prior to running these tests. Then do:
+
+```bash
+python3 -m pytest ./tests --cov=standardbots --routine-running
+```
+
+#### E-stop
+
+No marker needed for e-stop. However, we do rely on active recovery of e-stop and getting the failure state in order to do these tests.
+
+When e-stop test runs, cannot have bot in a failure state (pre-test will fail).
+
+## Troubleshooting
+
+### Tests are hanging
+
+The first test appears to start but then nothing happens for several seconds:
+
+```bash
+$ python3 -m pytest ./tests --cov=standardbots
+========================================================================================================== test session starts ===========================================================================================================
+platform linux -- Python 3.10.12, pytest-6.2.5, py-1.10.0, pluggy-0.13.0
+rootdir: /workspaces/sb/sdks/python, configfile: pytest.ini
+plugins: ament-pep257-0.12.11, ament-xmllint-0.12.11, launch-testing-1.0.6, launch-testing-ros-0.19.7, ament-flake8-0.12.11, ament-lint-0.12.11, ament-copyright-0.12.11, colcon-core-0.18.1, cov-6.0.0
+collected 110 items
+
+tests/test_apis.py
+```
+
+Fixes:
+
+- _Make sure you can log into remote control._ Ensure that botman is connected.
+- _Ensure that the robot URL is up-to-date._ Botman url will often change when you reboot.
+
+### Custom sensors
+
+To test custom sensors:
+- go to the menu on the left bottom corner;
+- Click on 'Equipment';
+- Add Gripper > Custom Gripper;
+- Go to the Sensors tab and click 'Add Sensor';
+- Keep the default values as they are (name: 'Sensor 1', kind: 'Control Box IO', sensor value: 'low');
+- Hit 'Save' and make sure the Custom Gripper is enabled.
+
+Then run:
+
+```bash
+python3 -m pytest ./tests --cov=standardbots --custom-sensors
+```

{standardbots-2.0.0.dev1736549072 → standardbots-2.0.0.dev1737492400}/setup.py

@@ -13,7 +13,7 @@
 from setuptools import setup, find_packages  # noqa: H301
 
 NAME = "standardbots"
-VERSION = "2.0.0-dev1736549072"
+VERSION = "2.0.0-dev1737492400"
 # To install the library, run the following
 #
 # python setup.py install

{standardbots-2.0.0.dev1736549072 → standardbots-2.0.0.dev1737492400}/standardbots/auto_generated/models.py

@@ -1087,6 +1087,8 @@ class ErrorEnum(Enum):
   """Requested resource not found"""
   InvalidSpaceSpecified = "invalid_space_specified"
   """Space specified was invalid or not found"""
+  InvalidParameters = "invalid_parameters"
+  """Parameters are invalid"""
 
 def parse_error_enum(data: object) -> ErrorEnum:
   return ErrorEnum(data)
@@ -3037,7 +3039,7 @@ class ErrorResponse:
     if value is None:
       return [False, "error is required for ErrorResponse"]
 
-    if not ((isinstance(value, str) and ErrorEnum in ['authorization_required', 'routine_must_be_running', 'api_control_required', 'robot_brakes_disengage_failed', 'robot_brakes_engage_failed', 'request_failed_validation', 'robot_not_idle', 'brakes_must_be_engaged', 'brakes_must_be_disengaged', 'equipment_no_matching', 'service_initializing', 'camera_disconnected', 'settings_validation_error', 'settings_timeout', 'internal_server_error', 'recovery_error', 'not_found', 'invalid_space_specified']) or isinstance(value, ErrorEnum)):
+    if not ((isinstance(value, str) and ErrorEnum in ['authorization_required', 'routine_must_be_running', 'api_control_required', 'robot_brakes_disengage_failed', 'robot_brakes_engage_failed', 'request_failed_validation', 'robot_not_idle', 'brakes_must_be_engaged', 'brakes_must_be_disengaged', 'equipment_no_matching', 'service_initializing', 'camera_disconnected', 'settings_validation_error', 'settings_timeout', 'internal_server_error', 'recovery_error', 'not_found', 'invalid_space_specified', 'invalid_parameters']) or isinstance(value, ErrorEnum)):
       return [False, "error must be of type ErrorEnum for ErrorResponse, got " + type(value).__name__]
 
     return [True, ""]
@@ -5935,7 +5937,7 @@ class Space:
   kind: Union[str, None] = None
   name: Union[str, None] = None
   description: Union[str, None] = None
-  isGlobal: Union[bool, None] = None
+  is_global: Union[bool, None] = None
   positions: Union[SpacePositionsMap, None] = None
 
   def validate_id(self, value: str) -> Tuple[bool, str]:
@@ -5974,12 +5976,12 @@ class Space:
 
     return [True, ""]
 
-  def validate_isGlobal(self, value: bool) -> Tuple[bool, str]:
+  def validate_is_global(self, value: bool) -> Tuple[bool, str]:
     if value is None:
       return [True, ""]
 
     if not isinstance(value, bool):
-      return [False, "isGlobal must be of type bool for Space, got " + type(value).__name__]
+      return [False, "is_global must be of type bool for Space, got " + type(value).__name__]
 
     return [True, ""]
 
@@ -6006,7 +6008,7 @@ class Space:
     is_valid, error_str = self.validate_description(self.description)
     if not is_valid:
       raise TypeError(error_str)
-    is_valid, error_str = self.validate_isGlobal(self.isGlobal)
+    is_valid, error_str = self.validate_is_global(self.is_global)
     if not is_valid:
       raise TypeError(error_str)
     is_valid, error_str = self.validate_positions(self.positions)
@@ -6019,7 +6021,7 @@ def parse_space(data: object):
     kind=parse_str(data["kind"]) if "kind" in data and data.get("kind") is not None else None,
     name=parse_str(data["name"]) if "name" in data and data.get("name") is not None else None,
     description=parse_str(data["description"]) if "description" in data and data.get("description") is not None else None,
-    isGlobal=parse_bool(data["isGlobal"]) if "isGlobal" in data and data.get("isGlobal") is not None else None,
+    is_global=parse_bool(data["is_global"]) if "is_global" in data and data.get("is_global") is not None else None,
     positions=parse_space_positions_map(data["positions"]) if "positions" in data and data.get("positions") is not None else None,
   )
 
@@ -6029,7 +6031,7 @@ def serialize_space(data: Space) -> object:
     "kind": None if data.kind is None else serialize_str(data.kind),
     "name": None if data.name is None else serialize_str(data.name),
     "description": None if data.description is None else serialize_str(data.description),
-    "isGlobal": None if data.isGlobal is None else serialize_bool(data.isGlobal),
+    "is_global": None if data.is_global is None else serialize_bool(data.is_global),
     "positions": None if data.positions is None else serialize_space_positions_map(data.positions),
   }
 

{standardbots-2.0.0.dev1736549072 → standardbots-2.0.0.dev1737492400}/standardbots.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: standardbots
-Version: 2.0.0.dev1736549072
+Version: 2.0.0.dev1737492400
 Summary: Standard Bots RO1 Robotics API
 Home-page: 
 Author: Standard Bots Support

{standardbots-2.0.0.dev1736549072 → standardbots-2.0.0.dev1737492400}/standardbots.egg-info/SOURCES.txt

@@ -1,3 +1,4 @@
+README.md
 setup.py
 standardbots/__init__.py
 standardbots.egg-info/PKG-INFO
@@ -7,4 +8,8 @@ standardbots.egg-info/requires.txt
 standardbots.egg-info/top_level.txt
 standardbots/auto_generated/__init__.py
 standardbots/auto_generated/apis.py
-standardbots/auto_generated/models.py
+standardbots/auto_generated/models.py
+tests/test_apis.py
+tests/fixtures/__init__.py
+tests/fixtures/client_fixt.py
+tests/fixtures/routines_fixt.py

{standardbots-2.0.0.dev1736549072 → standardbots-2.0.0.dev1737492400}/standardbots.egg-info/top_level.txt

@@ -1 +1,2 @@
 standardbots
+tests

standardbots-2.0.0.dev1737492400/tests/fixtures/client_fixt.py

@@ -0,0 +1,25 @@
+"""Fixtures: API Clients"""
+
+import os
+
+import pytest
+from standardbots import StandardBotsRobot
+from standardbots.auto_generated.apis import RobotKind
+
+
+@pytest.fixture(scope="session")
+def client_live(api_url: str, api_token: str):
+    """StandardBotsRobot API client - Live mode"""
+    return StandardBotsRobot(
+        url=api_url,
+        token=api_token,
+        robot_kind=RobotKind.Live,
+    )
+
+
+@pytest.fixture(scope="session")
+def client_sim(api_url: str, api_token: str):
+    """StandardBotsRobot API client - Simulated mode"""
+    return StandardBotsRobot(
+        url=api_url, token=api_token, robot_kind=RobotKind.Simulated
+    )

standardbots-2.0.0.dev1737492400/tests/fixtures/routines_fixt.py

@@ -0,0 +1,48 @@
+"""Fixtures: Routines"""
+
+import pytest
+from standardbots import StandardBotsRobot
+from standardbots.auto_generated import models
+
+SAMPLE_ROUTINE_NAME = "Test Public API"
+
+
+@pytest.fixture(scope="session")
+def routine_sample(client_live: StandardBotsRobot) -> models.Routine:
+    """Fixture: Get a sample routine.
+
+    Relies on `StandardBotsRobot#routine_editor#routines#list`
+    """
+    limit = 100
+    offset = 0
+    i = 0
+    while i < 100:
+        try:
+            with client_live.connection():
+                res = client_live.routine_editor.routines.list(
+                    limit=limit, offset=offset
+                )
+
+            data = res.ok()
+        except Exception as e:
+            raise ValueError("Failed to fetch a sample routine.") from e
+
+        if len(data.items) == 0:
+            break
+
+        routines = [r for r in data.items if r.name == SAMPLE_ROUTINE_NAME]
+        if len(routines) != 0:
+            return routines[0]
+
+        offset += limit
+        i += 1
+
+    raise ValueError(
+        f"Failed to find a routine named '{SAMPLE_ROUTINE_NAME}'. Please create a routine with this name in order to continue testing."
+    )
+
+
+@pytest.fixture(scope="session")
+def routine_sample_id(routine_sample: models.Routine) -> str:
+    """Fixture: ID of sample routine"""
+    return routine_sample.id