Skip to content

GitLab

Merged
Created by Trishna Saeharaseelan@trishnaOwner

feat: support binary payload

All threads resolved
Compare
and
11 files
+ 55
- 32
Show latest version
for‎mats‎
encod‎ed.py‎ +0 -6
mission_pla‎n_encoded.py‎ +10 -0
observation‎_encoded.py‎ +10 -0
planning_con‎figuration.py‎ +1 -1
platform_stat‎us_encoded.py‎ +10 -0
projec‎t/soar‎
swagge‎r.json‎ +9 -15
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‎ +6 -4
formats/encoded.py
+ 0
- 6
Show all unchanged lines Show 20 lines
"message_type": {
"type": "string",
"description": "Type of message",
"example": "mission_plan",
"enum": [
"mission_plan_encoded",
"observation_encoded",
"platform_status_encoded",
],
},
"data": {
"type": "string",
Show 20 lines Show all unchanged lines
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
+ 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"},
"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
+ 9
- 15
Show all unchanged lines Show 20 lines
"mission_plan_encoded":{
"properties":{
"data":{
"description":"Encoded string. E.g.: base64 encoded",
"description":"encoded string. E.g. Base64 encoded",
"example":"SDQke4uwyP/YQQAgAhA2AND/nu8nvQAAAAAAAAAACtejPa5HHUGkcBAAAAIAAAAQAAAAAAAAAA9P2cP166ab+9cg==",
"type":"string"
},
Show 20 lines Show all unchanged lines Show 20 lines
"message_type":{
"description":"Type of message",
"enum":[
"mission_plan_encoded",
"observation_encoded",
"platform_status_encoded"
"mission_plan_encoded"
],
"example":"mission_plan",
"example":"mission_plan_encoded",
"type":"string"
},
"mime_type":{
Show 20 lines Show all unchanged lines Show 20 lines
"observation_encoded":{
"properties":{
"data":{
"description":"Encoded string. E.g. base64 encoding",
"description":"encoded string. E.g. Base64 encoded",
"example":"SDQke4uwyP/YQQAgAhA2AND/nu8nvQAAAAAAAAAACtejPa5HHUGkcBAAAAIAAAAQAAAAAAAAAA9P2cP166ab+9cg==",
"type":"string"
},
Show 20 lines Show all unchanged lines Show 20 lines
"message_type":{
"description":"Type of message",
"enum":[
"mission_plan_encoded",
"observation_encoded",
"platform_status_encoded"
"observation_encoded"
],
"example":"mission_plan",
"example":"observation_encoded",
"type":"string"
},
"mime_type":{
Show 20 lines 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 Show 20 lines
"platform_status_encoded":{
"properties":{
"data":{
"description":"Encoded string. E.g. base64 encoding",
"description":"encoded string. E.g. Base64 encoded",
"example":"SDQke4uwyP/YQQAgAhA2AND/nu8nvQAAAAAAAAAACtejPa5HHUGkcBAAAAIAAAAQAAAAAAAAAA9P2cP166ab+9cg==",
"type":"string"
},
Show 20 lines Show all unchanged lines Show 20 lines
"message_type":{
"description":"Type of message",
"enum":[
"mission_plan_encoded",
"observation_encoded",
"platform_status_encoded"
],
"example":"mission_plan",
"example":"platform_status_encoded",
"type":"string"
},
"mime_type":{
Show 20 lines Show all unchanged lines
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
+ 6
- 4
from formats import message_header
from formats.encoded import encoded_schema
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
},
"header": message_header,
"mission_plan": mission_plan_schema,
"mission_plan_encoded": encoded_schema,
"mission_plan_encoded": mission_plan_encoded_schema,
"observation": observation_schema,
"observation_encoded": encoded_schema,
"observation_encoded": observation_encoded_schema,
"planning_configuration": planning_configuration_schema,
"platform_status": platform_status_schema,
"platform_status_encoded": encoded_schema,
"platform_status_encoded": platform_status_encoded_schema,
"acknowledgement": acknowledgement_schema,
}
},
Show 20 lines Show all unchanged lines