Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*******************************************************************************
* Copyright (C) 2020, exense GmbH
*
* This file is part of STEP
*
* STEP is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* STEP is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with STEP. If not, see .
******************************************************************************/
package step.automation.packages.yaml.schema;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import jakarta.json.JsonObjectBuilder;
import jakarta.json.spi.JsonProvider;
import step.parameter.automation.AutomationPackageParameterJsonSchema;
import step.core.Version;
import step.core.scheduler.automation.AutomationPackageScheduleJsonSchema;
import step.automation.packages.schema.AutomationPackageJsonSchemaExtension;
import step.core.yaml.schema.JsonSchemaExtension;
import step.core.yaml.schema.YamlJsonSchemaHelper;
import step.handlers.javahandler.jsonschema.JsonSchemaPreparationException;
import step.plans.parser.yaml.model.YamlPlanVersions;
import step.plans.parser.yaml.schema.YamlPlanJsonSchemaGenerator;
import java.util.ArrayList;
import java.util.List;
public class YamlAutomationPackageSchemaGenerator {
protected final String targetPackage;
protected final Version actualVersion;
protected final ObjectMapper objectMapper = new ObjectMapper();
protected final JsonProvider jsonProvider = JsonProvider.provider();
private final YamlKeywordSchemaGenerator keywordSchemaGenerator;
private final YamlPlanJsonSchemaGenerator planSchemaGenerator;
protected final List extensions;
public YamlAutomationPackageSchemaGenerator(String targetPackage, Version actualVersion) {
this.targetPackage = targetPackage;
this.actualVersion = actualVersion;
this.keywordSchemaGenerator = new YamlKeywordSchemaGenerator(jsonProvider);
this.planSchemaGenerator = new YamlPlanJsonSchemaGenerator("step", YamlPlanVersions.ACTUAL_VERSION, null);
this.extensions = new ArrayList<>();
this.extensions.add(new AutomationPackageScheduleJsonSchema());
this.extensions.add(new AutomationPackageParameterJsonSchema());
}
public JsonNode generateJsonSchema() throws JsonSchemaPreparationException {
JsonObjectBuilder topLevelBuilder = jsonProvider.createObjectBuilder();
// common fields for json schema
topLevelBuilder.add("$schema", "http://json-schema.org/draft-07/schema#");
topLevelBuilder.add("title", "Step Automation Package");
topLevelBuilder.add("type", "object");
// prepare definitions to be reused in subschemas (referenced via $ref property)
JsonObjectBuilder allDefs = prepareDefinitions();
topLevelBuilder.add("$defs", allDefs);
// add properties for top-level
topLevelBuilder.add("properties", createMainAutomationPackageProperties());
topLevelBuilder.add("required", jsonProvider.createArrayBuilder());
// additional properties allowed to support extensions (for instance, in Step EE)
topLevelBuilder.add("additionalProperties", true);
// convert jakarta objects to jackson JsonNode
try {
return fromJakartaToJsonNode(topLevelBuilder);
} catch (JsonProcessingException e) {
throw new JsonSchemaPreparationException("Unable to convert json to jackson jsonNode", e);
}
}
protected JsonObjectBuilder prepareDefinitions() throws JsonSchemaPreparationException {
JsonObjectBuilder result = keywordSchemaGenerator.createKeywordDefs()
.addAll(planSchemaGenerator.createDefs());
for (AutomationPackageJsonSchemaExtension extension : extensions) {
if (extension.getExtendedDefinitions() != null) {
for (JsonSchemaExtension additionalDefinition : extension.getExtendedDefinitions()) {
additionalDefinition.addToJsonSchema(result, jsonProvider);
}
}
}
return result;
}
protected JsonObjectBuilder createMainAutomationPackageProperties() throws JsonSchemaPreparationException {
JsonObjectBuilder objectBuilder = jsonProvider.createObjectBuilder();
// in 'schemaVersion' we should either explicitly specify the current json schema version or skip this field
objectBuilder.add("schemaVersion", jsonProvider.createObjectBuilder().add("const", actualVersion.toString()));
objectBuilder.add("version", jsonProvider.createObjectBuilder().add("type", "string"));
objectBuilder.add("name", jsonProvider.createObjectBuilder().add("type", "string"));
objectBuilder.add("attributes", jsonProvider.createObjectBuilder().add("type", "object"));
// TODO: split keyword and plans definitions
JsonObjectBuilder builder = jsonProvider.createObjectBuilder();
objectBuilder.add("keywords",
jsonProvider.createObjectBuilder()
.add("type", "array")
.add("items", YamlJsonSchemaHelper.addRef(builder, YamlKeywordSchemaGenerator.KEYWORD_DEF)));
objectBuilder.add("plans",
jsonProvider.createObjectBuilder()
.add("type", "array")
.add("items", jsonProvider.createObjectBuilder()
.add("type", "object")
.add("properties", planSchemaGenerator.createYamlPlanProperties(false)))
.add("required", jsonProvider.createArrayBuilder().add("name").add("root"))
);
objectBuilder.add("fragments",
jsonProvider.createObjectBuilder()
.add("type", "array")
.add("items", jsonProvider.createObjectBuilder().add("type", "string"))
);
for (AutomationPackageJsonSchemaExtension extension : extensions) {
if (extension.getAdditionalAutomationPackageFields() != null) {
for (JsonSchemaExtension additionalField : extension.getAdditionalAutomationPackageFields()) {
additionalField.addToJsonSchema(objectBuilder, jsonProvider);
}
}
}
return objectBuilder;
}
private JsonNode fromJakartaToJsonNode(JsonObjectBuilder objectBuilder) throws JsonProcessingException {
return objectMapper.readTree(objectBuilder.build().toString());
}
}
