Skip to content

GitLab

Merged
Created by Dan Jones@danjonOwner

Resolve "Test validating messages with references to GeoJson schema in both JS and python"

Compare
and
7 files
+ 1458
- 171
exam‎ples‎
autonomy_en‎gine_adapter‎
planning_conf‎iguration.json‎ +49 -43
gui_a‎dapter‎
planning_conf‎iguration.json‎ +6 -4
for‎mats‎
planning_con‎figuration.py‎ +9 -42
projec‎t/soar‎
swagge‎r.json‎ +1264 -82
.fl‎ake8‎ +38 -0
generate_sch‎ema_config.py‎ +91 -0
requirem‎ents.txt‎ +1 -0
examples/autonomy_engine_adapter/planning_configuration.json
+ 49
- 43
Show all unchanged lines Show 20 lines
"timestamp": "2022-11-16T00:00:00Z",
"version": 2,
"source": "gui",
"destination": "soar.all.all.all.from_platform.planning_configuration",
"destination": "",
"delivery_type": "broadcast",
"encoded": false
},
Show 20 lines Show all unchanged lines Show 20 lines
"planning_config_ID": 1,
"exclusion_zones": [
{
"geometry_coordinates": [
[
"geometry": {
"type": "Polygon",
"coordinates": [
[
-4.1777839187560915,
50.34173405662855
],
[
-4.1777839187560915,
50.33820949229701
],
[
-4.143667777943875,
50.33820949229701
],
[
-4.143667777943875,
50.34173405662855
],
[
-4.1777839187560915,
50.34173405662855
[
-4.1777839187560915,
50.34173405662855
],
[
-4.1777839187560915,
50.33820949229701
],
[
-4.143667777943875,
50.33820949229701
],
[
-4.143667777943875,
50.34173405662855
],
[
-4.1777839187560915,
50.34173405662855
]
]
]
]
}
}
],
"region_of_interest": [
{
"geometry_coordinates": [
[
"geometry": {
"type": "Polygon",
"coordinates": [
[
-4.1777839187560915,
50.34173405662855
],
[
-4.1777839187560915,
50.33820949229701
],
[
-4.143667777943875,
50.33820949229701
],
[
-4.143667777943875,
50.34173405662855
],
[
-4.1777839187560915,
50.34173405662855
[
-4.1777839187560915,
50.34173405662855
],
[
-4.1777839187560915,
50.33820949229701
],
[
-4.143667777943875,
50.33820949229701
],
[
-4.143667777943875,
50.34173405662855
],
[
-4.1777839187560915,
50.34173405662855
]
]
]
]
}
}
],
"squads": [
Show 20 lines Show all unchanged lines
examples/gui_adapter/planning_configuration.json
+ 6
- 4
Show all unchanged lines Show 20 lines
"timestamp": "2022-11-16T00:00:00Z",
"version": 2,
"source": "gui",
"destination": "soar.all.all.all.from_platform.planning_configuration",
"delivery_type": "publish",
"destination": "",
"delivery_type": "broadcast",
"encoded": false
},
"payload":{
Show 20 lines Show all unchanged lines Show 20 lines
"planning_config_ID": 1,
"exclusion_zones": [
{
"geometry_coordinates": [
"type": "Polygon",
"coordinates": [
[
[
-4.1777839187560915,
Show 20 lines Show all unchanged lines Show 20 lines
],
"region_of_interest": [
{
"geometry_coordinates": [
"type": "Polygon",
"coordinates": [
[
[
-4.1777839187560915,
Show 20 lines Show all unchanged lines
formats/planning_configuration.py
+ 9
- 42
Show all unchanged lines Show 20 lines
+ " partner's platform/C2",
"example": "go_home",
},
"target_waypoint_latitude": {
"type": "number",
"format": "float",
"description": "Y-coordinate safe place for respective platform",
"example": 50.365,
},
"target_waypoint_longitude": {
"type": "number",
"format": "float",
"description": "X-coordinate safe place for respective platform",
"example": -7.432,
},
"target_depth": {
"type": "number",
"format": "float",
"description": "Z-coordinate safe place for respective platform"
+ " . If platform to NOT stay at depth, key in `0.0`",
"example": 10.0,
"target_waypoint": {
"$ref": "https://geojson.org/schema/Point.json",
},
},
"required": [
"target_waypoint_latitude",
"target_waypoint_longitude",
"target_depth",
"target_waypoint",
],
}
Show 20 lines Show all unchanged lines Show 20 lines
],
}
region_schema = {
"type": "object",
"properties": {
"geometry_coordinates": {
"type": "array",
"example": [
[
[-4.1777839187560915, 50.34173405662855],
[-4.1777839187560915, 50.33820949229701],
[-4.143667777943875, 50.33820949229701],
[-4.143667777943875, 50.34173405662855],
[-4.1777839187560915, 50.34173405662855],
]
],
},
},
"description": "Using GEOJSON, exact 4-point region (rectangle shaped - 5 points)",
}
squad_metadata_schema = {
"type": "object",
"properties": {
Show 20 lines Show all unchanged lines Show 20 lines
},
"region_of_interest": {
"type": "array",
"items": region_schema,
"items": {
"$ref": "https://geojson.org/schema/Polygon.json",
},
"description": "Region of interest for the entire operation",
},
"exclusion_zones": {
"type": "array",
"items": region_schema,
"items": {
"$ref": "https://geojson.org/schema/Polygon.json",
},
"description": "Exclusion zones for all platforms",
},
"squads": {
Show 20 lines Show all unchanged lines
project/soar/swagger.json
+ 1264
- 82

Files with large changes are collapsed by default.

.flake8
+ 38
- 0
[flake8]
# Black formats code with max line length of 88
# Bugbears B950 warning allows lines to be 10% longer than flake8's max
max-line-length = 80
# Errors and warnings to report
select =
C,
E,
F,
W,
B,
# Allow max line length to be exceeded by 10% before warning.
B950
# Errors and warnings to ignore
ignore =
# Black puts space around slice operator which flake8 errors on.
E203,
# No error on max line length exceeded as B950 is doing this for us.
E501,
# Black puts line breaks before binary operators so don't warn this.
W503
B036
E999
# Folders to ignore
exclude =
.git,
*.pyc,
__pycache__,
./docker,
./docs,
./kustomize
./requirements.txt
./requirements-dev.txt
./CHANGELOG.md
./CONTRIBUTING.md
generate_schema_config.py
+ 91
- 0
Show all unchanged lines Show 20 lines
import argparse
import json
import os
import re
import requests
# Enable running on domain sub-path
Show 20 lines Show all unchanged lines Show 20 lines
}
def resolve_ref(ref):
"""
Get schema URL, parse JSON
Return None if either fails
"""
try:
res = requests.get(ref)
if res.status_code == 200:
return res.json()
else:
return None
except (json.JSONDecodeError, ValueError):
return None
def rename_ref(ref):
"""
Convert remote ref URL into a name that can
be used for a local ref in the schema
Remote the URL scheme and replace / with .
"""
# remove url scheme
deschemed = re.sub(r"^[htps]*\:*[/]{2}", "", ref)
# replace / with . since the name will be in a path
return re.sub(r"[/]", ".", deschemed)
def nested_replace(source, key, value, replace_with):
"""
Find all instances of a key value pair in a nested
dictionary and replace the value with replace_with
"""
for k, v in source.items():
if k == key and v == value:
source[k] = replace_with
elif type(v) is list:
for item in v:
if type(item) is dict:
nested_replace(item, key, value, replace_with)
if type(v) is dict:
nested_replace(v, key, value, replace_with)
def inject_schema(schema, remote_ref):
"""
Given a parent schema and a remote ref
1. get the remote ref schema
2. create a local reference name (without path separators)
3. insert into components.schemas
4. replace remote references with local references
returns True if resolved and injected
"""
local_name = rename_ref(remote_ref)
local_ref = f"#/components/schemas/{local_name}"
ref_schema = resolve_ref(remote_ref)
if ref_schema is not None:
nested_replace(schema, "$ref", remote_ref, local_ref)
schema["components"]["schemas"][local_name] = ref_schema
return True
else:
return False
def import_remote_refs():
"""
inject the following remote refs into the schema
and replace the remote refs with local refs
returns True if all schemas resolved and injected
"""
ref_imports = [
"https://geojson.org/schema/Feature.json",
"https://geojson.org/schema/FeatureCollection.json",
"https://geojson.org/schema/LineString.json",
"https://geojson.org/schema/MultiLineString.json",
"https://geojson.org/schema/MultiPoint.json",
"https://geojson.org/schema/MultiPolygon.json",
"https://geojson.org/schema/Point.json",
"https://geojson.org/schema/Polygon.json",
]
return all([inject_schema(swagger_config, ref) for ref in ref_imports])
def configure_flask(swagger_config):
"""
Setup a flask app, load flasgger
Show 20 lines Show all unchanged lines Show 20 lines
if __name__ == "__main__":
import_remote_refs()
# Parse script args
config = get_options()
Show 20 lines Show all unchanged lines
requirements.txt
+ 1
- 0
Flask
flask-restx
flasgger
requests