Skip to content

GitLab

Merged
Created by Trishna Saeharaseelan@trishnaOwner

feat: support binary payload

All threads resolved
Compare
and
15 files
+ 994
- 698
exam‎ples‎
autonomy_en‎gine_adapter‎
mission_plan‎_encoded.json‎ +18 -0
observation_‎encoded.json‎ +18 -0
platform_statu‎s_encoded.json‎ +18 -0
ecosub_‎adapter‎
observation_‎encoded.json‎ +17 -0
for‎mats‎
encod‎ed.py‎ +42 -0
mission_pla‎n_encoded.py‎ +10 -0
observation‎_encoded.py‎ +10 -0
planning_con‎figuration.py‎ +2 -1
platform_stat‎us_encoded.py‎ +10 -0
projec‎t/soar‎
swagge‎r.json‎ +825 -691
test‎s-js‎
doc‎ker‎
docker-co‎mpose.yml‎ +2 -1
soar-examp‎les.test.js‎ +5 -3
tests/f‎ixtures‎
schem‎as.py‎ +1 -1
swagge‎r.json‎ +1 -1
generate_sch‎ema_config.py‎ +15 -0
examples/autonomy_engine_adapter/mission_plan_encoded.json
+ 18
- 0
{
"header": {
"message_ID": "t1237003c-0000-11aa-a1eb-bvcdfghjgfdd",
"timestamp": "2023-03-16T00:00:00Z",
"version": 2,
"source": "autonomy_engine",
"destination": "soar.hermes.autosub.alr-52.send.mission_plan_encoded",
"delivery_type": "publish",
"encoded": true
},
"payload": {
"message_type": "mission_plan_encoded",
"data": "SDQke4uwyP/YQQAgAhA2AND/nu8nvQAAAAAAAAAACtejPa5HHUGkcBlB/tRYQW3nez5HWYFBAAD+zwBySUAAAADVek72v1N2lUQAAAABAQAAAAAAAAAAAAAAAAAAIAAAAQAAAAAAAAAA9P2cP166ab+9cg==",
"file_name": "ah1_03837434286438.sbd",
"mime_type": "application/gzip",
"is_binary": true
}
}
examples/autonomy_engine_adapter/observation_encoded.json
+ 18
- 0
{
"header": {
"message_ID": "e1237003c-0000-11aa-a1eb-bvcdfghjgfdd",
"timestamp": "2023-03-16T00:00:00Z",
"version": 2,
"source": "hermes.ecosub2",
"destination": "soar.planet-ocean.ecosub.ecosub-2.receive.observation_encoded",
"delivery_type": "publish",
"encoded": true
},
"payload": {
"message_type": "observation_encoded",
"data": "T1N2lUQAAAABAQAAAAAAAAAAAAAAAAAAIAAAAQAAAAAAAAAA9P2cP166ab+9cg==",
"file_name": "ecosub1_200002114.bin",
"mime_type": "application/gzip",
"is_binary": true
}
}
examples/autonomy_engine_adapter/platform_status_encoded.json
+ 18
- 0
{
"header": {
"message_ID": "t1237003c-0000-11aa-a1eb-bvcdfghjgfdd",
"timestamp": "2023-03-16T00:00:00Z",
"version": 2,
"source": "hermes.ah1",
"destination": "soar.noc.autosub.alr-52.receive.platform_status_encoded",
"delivery_type": "publish",
"encoded": true
},
"payload": {
"message_type": "platform_status_encoded",
"data": "HWYFBAAD+zwBySUAAAADVek72v1N2lUQAAAABAQAAAAAAAAAAAAAAAAAAIAAAAQAAAAAAAAAA9P2cP166ab+9cg==",
"file_name": "ah1_03837434286438.sbd",
"mime_type": "application/gzip",
"is_binary": true
}
}
examples/ecosub_adapter/observation_encoded.json
+ 17
- 0
{
"header": {
"message_ID": "e1237003c-0000-11aa-a1eb-bvcdfghjgfdd",
"timestamp": "2023-03-16T00:00:00Z",
"version": 2,
"source": "hermes.ecosub2",
"destination": "soar.planet-ocean.ecosub.ecosub-2.receive.observation_encoded",
"delivery_type": "publish",
"encoded": true
},
"payload": {
"message_type": "observation_encoded",
"data": "T1N2lUQAAAABAQAAAAAAAAAAAAAAAAAAIAAAAQAAAAAAAAAA9P2cP166ab+9cg==",
"file_name": "ecosub1_200002114.txt",
"is_binary": true
}
}
formats/encoded.py
+ 42
- 0
"""
schemas: Encoded (compiled) type messages that are applicable to compiled
platform statuses and observations (from the platform), and compiled
mission plans (to the platform). This encoded schema is applicable to the
different message types: mission_plan_encoded, observation_encoded, and
platform_status_encoded.
"""
encoded_schema = {
"type": "object",
"properties": {
"message_type": {
"type": "string",
"description": "Type of message",
},
"data": {
"type": "string",
"description": "encoded string. E.g. Base64 encoded",
"example": "SDQke4uwyP/YQQAgAhA2AND/nu8nvQAAAAAAAAAACtejPa5HHUGkcB"
+ "AAAAIAAAAQAAAAAAAAAA9P2cP166ab+9cg==",
},
"file_name": {
"type": "string",
"description": "Name of file",
"example": "ah1-0238126349247372.bin",
},
"mime_type": {
"type": "string",
"description": "MIME type",
"example": "application/gzip",
},
"is_binary": {
"type": "boolean",
"description": (
"True if the data field contains binary format data encoded as base64."
+ " False if the data field contains ascii content such as NMEA."
),
"example": True,
},
},
"required": ["data", "is_binary"],
}
formats/mission_plan_encoded.py
+ 10
- 0
from formats.encoded import encoded_schema
mission_plan_encoded_schema = encoded_schema
mission_plan_encoded_schema["properties"]["message_type"]["enum"] = [
"mission_plan_encoded"
]
mission_plan_encoded_schema["properties"]["message_type"][
"example"
] = "mission_plan_encoded"
formats/observation_encoded.py
+ 10
- 0
from formats.encoded import encoded_schema
observation_encoded_schema = encoded_schema
observation_encoded_schema["properties"]["message_type"]["enum"] = [
"observation_encoded"
]
observation_encoded_schema["properties"]["message_type"][
"example"
] = "observation_encoded"
formats/planning_configuration.py
+ 2
- 1
Show all unchanged lines Show 20 lines
"example": 10.0,
},
"additional_data": {
"type": "object",
"description": "Any addition fields/data to be added here",
"example": {},
},
Show 20 lines Show all unchanged lines Show 20 lines
"description": "Maximum altitude set for squad.",
"example": 0.9,
},
"additional_specs": {
"additional_data": {
"description": "Any addition fields/data to be added here",
"example": {"swath_width": 10.0, "scan_type": "DVL"},
"type": "object",
Show 20 lines Show all unchanged lines
formats/platform_status_encoded.py
+ 10
- 0
from formats.encoded import encoded_schema
platform_status_encoded_schema = encoded_schema
platform_status_encoded_schema["properties"]["message_type"]["enum"] = [
"platform_status_encoded"
]
platform_status_encoded_schema["properties"]["message_type"][
"example"
] = "platform_status_encoded"
project/soar/swagger.json
+ 825
- 691

Files with large changes are collapsed by default.

tests/fixtures/schemas.py
+ 1
- 1
Show all unchanged lines Show 20 lines
"description": "Maximum altitude set for squad.",
"example": 0.9,
},
"additional_specs": {
"additional_data": {
"description": "Any addition fields/data to be added here",
"example": {"swath_width": 10.0, "scan_type": "DVL"},
},
Show 20 lines Show all unchanged lines
tests/fixtures/swagger.json
+ 1
- 1
Show all unchanged lines Show 20 lines
"description": "Squad consists of these platforms",
"items": {
"properties": {
"additional_specs": {
"additional_data": {
"description": "Any addition fields/data to be added here",
"example": {
"scan_type": "DVL",
Show 20 lines Show all unchanged lines
tests-js/docker/docker-compose.yml
+ 2
- 1
Show all unchanged lines Show 20 lines
dockerfile: tests-js/docker/Dockerfile
container_name: soar_js_test
volumes:
- ../../:/app
- ../../examples:/app/examples
- ../../project:/app/project
command: "yarn test"
tests-js/soar-examples.test.js
+ 5
- 3
Show all unchanged lines Show 20 lines
const OpenAPISchemaValidator = require('openapi-schema-validator').default;
const getSchema = () => {
const schema = require(`${__dirname}/../projects/soar/swagger.json`);
const schema = require(`${__dirname}/../project/soar/swagger.json`);
return schema;
};
Show 20 lines Show all unchanged lines Show 20 lines
validation = validateMessage(message, schema);
valid = validation.valid;
if (!valid) {
console.log(`validation: ${messageFile}`, validation);
console.log(`validation: ${messageFile}`, validation.GetErrorMessages());
payloadValidation = validateMessage(message.payload, schema, message.payload.message_type)
console.log(`payload ${message.payload.message_type}`, payloadValidation);
if (!payloadValidation.valid) {
console.log(`payload ${message.payload.message_type}`, payloadValidation.GetErrorMessages());
}
}
expect(valid).toBe(true);
});
Show 20 lines Show all unchanged lines
generate_schema_config.py
+ 15
- 0
from formats import message_header
from formats.mission_plan import mission_plan_schema
from formats.mission_plan_encoded import mission_plan_encoded_schema
from formats.observation import observation_schema
from formats.observation_encoded import observation_encoded_schema
from formats.planning_configuration import planning_configuration_schema
from formats.platform_status import platform_status_schema
from formats.platform_status_encoded import platform_status_encoded_schema
from formats.acknowledgement import acknowledgement_schema
from flasgger import Swagger
Show 20 lines Show all unchanged lines Show 20 lines
"propertyName": "message_type",
"mapping": {
"mission_plan": "#/components/schemas/mission_plan",
"mission_plan_encoded": "#/components/schemas/"
+ "mission_plan_encoded",
"observation": "#/components/schemas/observation",
"observation_encoded": "#/components/schemas/"
+ "observation_encoded",
"planning_configuration": "#/components/schemas/"
+ "planning_configuration",
"platform_status": "#/components/schemas/platform_status",
"platform_status_encoded": "#/components/schemas/"
+ "platform_status_encoded",
"acknowledgement": "#/components/schemas/acknowledgement",
},
},
"oneOf": [
{"$ref": "#/components/schemas/acknowledgement"},
{"$ref": "#/components/schemas/mission_plan"},
{"$ref": "#/components/schemas/mission_plan_encoded"},
{"$ref": "#/components/schemas/observation"},
{"$ref": "#/components/schemas/observation_encoded"},
{"$ref": "#/components/schemas/planning_configuration"},
{"$ref": "#/components/schemas/platform_status"},
{"$ref": "#/components/schemas/platform_status_encoded"},
],
},
"header": message_header,
"mission_plan": mission_plan_schema,
"mission_plan_encoded": mission_plan_encoded_schema,
"observation": observation_schema,
"observation_encoded": observation_encoded_schema,
"planning_configuration": planning_configuration_schema,
"platform_status": platform_status_schema,
"platform_status_encoded": platform_status_encoded_schema,
"acknowledgement": acknowledgement_schema,
}
},
Show 20 lines Show all unchanged lines