standardbots 2.0.0.dev1745455051__tar.gz → 2.0.0.dev1750459189__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of standardbots might be problematic. Click here for more details.

Files changed (18) hide show
  1. {standardbots-2.0.0.dev1745455051 → standardbots-2.0.0.dev1750459189}/PKG-INFO +1 -1
  2. {standardbots-2.0.0.dev1745455051 → standardbots-2.0.0.dev1750459189}/README.md +42 -8
  3. {standardbots-2.0.0.dev1745455051 → standardbots-2.0.0.dev1750459189}/setup.py +1 -1
  4. {standardbots-2.0.0.dev1745455051 → standardbots-2.0.0.dev1750459189}/standardbots/auto_generated/apis.py +1022 -27
  5. {standardbots-2.0.0.dev1745455051 → standardbots-2.0.0.dev1750459189}/standardbots/auto_generated/models.py +4733 -2324
  6. {standardbots-2.0.0.dev1745455051 → standardbots-2.0.0.dev1750459189}/standardbots.egg-info/PKG-INFO +1 -1
  7. {standardbots-2.0.0.dev1745455051 → standardbots-2.0.0.dev1750459189}/standardbots.egg-info/SOURCES.txt +1 -0
  8. {standardbots-2.0.0.dev1745455051 → standardbots-2.0.0.dev1750459189}/tests/fixtures/client_fixt.py +0 -2
  9. standardbots-2.0.0.dev1750459189/tests/fixtures/robot_fixt.py +49 -0
  10. {standardbots-2.0.0.dev1745455051 → standardbots-2.0.0.dev1750459189}/tests/fixtures/routines_fixt.py +23 -0
  11. {standardbots-2.0.0.dev1745455051 → standardbots-2.0.0.dev1750459189}/tests/test_apis.py +441 -47
  12. {standardbots-2.0.0.dev1745455051 → standardbots-2.0.0.dev1750459189}/setup.cfg +0 -0
  13. {standardbots-2.0.0.dev1745455051 → standardbots-2.0.0.dev1750459189}/standardbots/__init__.py +0 -0
  14. {standardbots-2.0.0.dev1745455051 → standardbots-2.0.0.dev1750459189}/standardbots/auto_generated/__init__.py +0 -0
  15. {standardbots-2.0.0.dev1745455051 → standardbots-2.0.0.dev1750459189}/standardbots.egg-info/dependency_links.txt +0 -0
  16. {standardbots-2.0.0.dev1745455051 → standardbots-2.0.0.dev1750459189}/standardbots.egg-info/requires.txt +0 -0
  17. {standardbots-2.0.0.dev1745455051 → standardbots-2.0.0.dev1750459189}/standardbots.egg-info/top_level.txt +0 -0
  18. {standardbots-2.0.0.dev1745455051 → standardbots-2.0.0.dev1750459189}/tests/fixtures/__init__.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: standardbots
3
- Version: 2.0.0.dev1745455051
3
+ Version: 2.0.0.dev1750459189
4
4
  Summary: Standard Bots RO1 Robotics API
5
5
  Home-page:
6
6
  Author: Standard Bots Support
@@ -24,6 +24,8 @@ To run a script move into the `sdks/python` folder and run `python playground/fi
24
24
 
25
25
  You may now use the `botctl` commands to setup and run tests.
26
26
 
27
+ Set up the testing environment on the computer where you are running the tests:
28
+
27
29
  ```bash
28
30
  # Setup testing environment
29
31
  botctl publicapi test:setup --help
@@ -32,6 +34,11 @@ botctl publicapi test:setup --help
32
34
  botctl publicapi test --help
33
35
  ```
34
36
 
37
+ Set up the bot environment on the robot:
38
+
39
+ ```bash
40
+ botctl publicapi test:setup-bot
41
+ ```
35
42
 
36
43
  ## Setup
37
44
 
@@ -99,11 +106,8 @@ At start of testing, robot should:
99
106
  The basic idea here is:
100
107
 
101
108
  - These special tests will not be run by default.
102
- - You may pass a flag (e.g. `--routine-running`) when the bot is in the correct state to run the tests.
109
+ - You may pass a flag (e.g. `--camera-disconnected`) when the bot is in the correct state to run the tests.
103
110
  - Markers usage:
104
- - When `--routine-running` flag is passed:
105
- 1. Tests with the flag are run.
106
- 2. Tests without the flag are not run.
107
111
  - When `--gripper=<type>` flag is passed(`type` is value from `GripperKindEnum` enum):
108
112
  1. Tests expect that this specific gripper is connected
109
113
  2. Tests without the flag are not run.
@@ -113,12 +117,12 @@ The basic idea here is:
113
117
 
114
118
  We use [pytest markers](https://docs.pytest.org/en/7.1.x/example/markers.html) to do this.
115
119
 
116
- #### Routine running
120
+ #### Camera disconnected
117
121
 
118
- The special sample routine ("Test Public API") should be running prior to running these tests. Then do:
122
+ The wrist camera should be disabled. Then run:
119
123
 
120
124
  ```bash
121
- python3 -m pytest ./tests --cov=standardbots --routine-running
125
+ python3 -m pytest ./tests --cov=standardbots --camera-disconnected
122
126
  ```
123
127
 
124
128
  #### E-stop
@@ -162,5 +166,35 @@ To test custom sensors:
162
166
  Then run:
163
167
 
164
168
  ```bash
165
- python3 -m pytest ./tests --cov=standardbots --custom-sensors
169
+ python3 -m pytest ./tests --cov=standardbots --gripper=custom_sensors
170
+ ```
171
+
172
+ ## Database backups
173
+
174
+ > See command: `botctl publicapi test:setup-bot`.
175
+
176
+ We now have a common robot database state that can be used for testing. While this isn't necessary for use, it does provide a common state for testing.
177
+
178
+ ### How to create a new backup
179
+
180
+ In the place where you are running the stack and want to create the backup (e.g. on the control box):
181
+
182
+ ```bash
183
+ DB_USER=sb
184
+ DB_NAME=sb
185
+ BACKUP_FILE=$HOME/db-backup-publicapi-test.sql
186
+
187
+ docker exec -it postgres-bot pg_dump -U $DB_USER -d $DB_NAME -F c -f /tmp/backup.sql
188
+
189
+ docker cp postgres-bot:/tmp/backup.sql $BACKUP_FILE
190
+ ```
191
+
192
+ If you need to download to the actual development environment:
193
+
194
+ ```bash
195
+ CB_FILE=/home/control-box-bot/db-backup-publicapi-test.sql
196
+ VM_FILE=~/sb/golang/apps/botctl/commands/publicapi/db-backup-publicapi-test.sql
197
+
198
+ # Move directly to VM:
199
+ scp cb2047:$CB_FILE $VM_FILE
166
200
  ```
@@ -13,7 +13,7 @@
13
13
  from setuptools import setup, find_packages # noqa: H301
14
14
 
15
15
  NAME = "standardbots"
16
- VERSION = "2.0.0-dev1745455051"
16
+ VERSION = "2.0.0-dev1750459189"
17
17
  # To install the library, run the following
18
18
  #
19
19
  # python setup.py install