software.amazon.smithy.build.model.SmithyBuildConfig Maven / Gradle / Ivy
/*
* Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package software.amazon.smithy.build.model;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import software.amazon.smithy.model.node.Node;
import software.amazon.smithy.model.node.ObjectNode;
import software.amazon.smithy.utils.ListUtils;
import software.amazon.smithy.utils.MapUtils;
import software.amazon.smithy.utils.SetUtils;
import software.amazon.smithy.utils.SmithyBuilder;
import software.amazon.smithy.utils.ToSmithyBuilder;
/**
* Filter configuration that contains a list of named projections that
* are used to apply filters to a model.
*/
public final class SmithyBuildConfig implements ToSmithyBuilder {
private static final Set BUILTIN_PLUGINS = SetUtils.of("build-info", "model", "sources");
private final String version;
private final List imports;
private final String outputDirectory;
private final Map projections;
private final Map plugins;
private SmithyBuildConfig(Builder builder) {
SmithyBuilder.requiredState("version", builder.version);
version = builder.version;
outputDirectory = builder.outputDirectory;
imports = ListUtils.copyOf(builder.imports);
projections = MapUtils.copyOf(builder.projections);
plugins = new HashMap<>(builder.plugins);
for (String builtin : BUILTIN_PLUGINS) {
plugins.put(builtin, Node.objectNode());
}
}
/**
* @return Creates a builder used to build a {@link SmithyBuildConfig}.
*/
public static Builder builder() {
return new Builder();
}
/**
* Loads a SmithyBuildConfig from a JSON file on disk.
*
* The file is expected to contain the following structure:
*
*
* {
* "version": "1.0",
* "imports": ["foo.json", "baz.json"],
* "outputDirectory": "build/output",
* "projections": {
* "projection-name": {
* "transforms": [
* {"name": "transform-name", "args": ["argument1", "argument2", "..."]},
* {"name": "other-transform"}
* },
* "plugins": {
* "plugin-name": {
* "plugin-config": "value"
* },
* "...": {}
* }
* }
* },
* "plugins": {
* "plugin-name": {
* "plugin-config": "value"
* },
* "...": {}
* }
* }
*
*
* @param file File to load and parse.
* @return Returns the loaded FileConfig.
* @throws RuntimeException if the file cannot be loaded.
*/
public static SmithyBuildConfig load(Path file) {
return builder().load(file).build();
}
@Override
public Builder toBuilder() {
return builder()
.version(version)
.outputDirectory(outputDirectory)
.imports(imports)
.projections(projections)
.plugins(plugins);
}
/**
* Gets the version of Smithy-Build.
*
* @return Returns the version.
*/
public String getVersion() {
return version;
}
/**
* Gets the paths to all of the models to import.
*
*
Paths can point to individual model files or directories.
* All models stored in all recursive directories will be imported.
*
* @return Gets the list of models to import.
*/
public List getImports() {
return imports;
}
/**
* @return Gets the optional output directory to store artifacts.
*/
public Optional getOutputDirectory() {
return Optional.ofNullable(outputDirectory);
}
/**
* Gets all of the configured projections.
*
* @return Gets the available projections as a map of name to config.
*/
public Map getProjections() {
return Collections.unmodifiableMap(projections);
}
/**
* Gets the globally configured plugins that are applied to every
* projection.
*
* @return Gets plugin settings.
*/
public Map getPlugins() {
return Collections.unmodifiableMap(plugins);
}
/**
* Builder used to create a {@link SmithyBuildConfig}.
*/
public static final class Builder implements SmithyBuilder {
private final List imports = new ArrayList<>();
private final Map projections = new LinkedHashMap<>();
private final Map plugins = new LinkedHashMap<>();
private String version;
private String outputDirectory;
Builder() {}
@Override
public SmithyBuildConfig build() {
return new SmithyBuildConfig(this);
}
/**
* Sets the builder config file version.
*
* @param version Version to set.
* @return Returns the builder.
*/
public Builder version(String version) {
this.version = version;
return this;
}
/**
* Loads and merges the config file into the builder.
*
* @param config Config file to load, parse, and merge.
* @return Returns the updated builder.
*/
public Builder load(Path config) {
return merge(ConfigLoader.load(config));
}
/**
* Updates this configuration with the configuration of another file.
*
* @param config Config to update with.
* @return Returns the builder.
*/
public Builder merge(SmithyBuildConfig config) {
config.getOutputDirectory().ifPresent(this::outputDirectory);
version(config.getVersion());
imports.addAll(config.getImports());
projections.putAll(config.getProjections());
plugins.putAll(config.getPlugins());
return this;
}
/**
* Set a directory where the build artifacts are written.
*
* @param outputDirectory Directory where artifacts are written.
* @return Returns the builder.
*/
public Builder outputDirectory(String outputDirectory) {
this.outputDirectory = outputDirectory;
return this;
}
/**
* Sets imports on the config.
*
* @param imports Imports to set.
* @return Returns the builder.
*/
public Builder imports(Collection imports) {
this.imports.clear();
this.imports.addAll(imports);
return this;
}
/**
* Sets projections on the config.
*
* @param projections Projections to set.
* @return Returns the builder.
*/
public Builder projections(Map projections) {
this.projections.clear();
this.projections.putAll(projections);
return this;
}
/**
* Sets plugins on the config.
*
* @param plugins Plugins to set.
* @return Returns the builder.
*/
public Builder plugins(Map plugins) {
this.plugins.clear();
this.plugins.putAll(plugins);
return this;
}
}
}