diff --git a/vscode-extensions/commons/language-server-commons/src/main/java/org/springframework/ide/vscode/commons/reconcile/IDocument.java b/vscode-extensions/commons/language-server-commons/src/main/java/org/springframework/ide/vscode/commons/reconcile/IDocument.java new file mode 100644 index 000000000..8279929d6 --- /dev/null +++ b/vscode-extensions/commons/language-server-commons/src/main/java/org/springframework/ide/vscode/commons/reconcile/IDocument.java @@ -0,0 +1,5 @@ +package org.springframework.ide.vscode.commons.reconcile; + +public interface IDocument { + +} diff --git a/vscode-extensions/commons/language-server-commons/src/main/java/org/springframework/ide/vscode/commons/reconcile/IProblemCollector.java b/vscode-extensions/commons/language-server-commons/src/main/java/org/springframework/ide/vscode/commons/reconcile/IProblemCollector.java new file mode 100644 index 000000000..773f72b6d --- /dev/null +++ b/vscode-extensions/commons/language-server-commons/src/main/java/org/springframework/ide/vscode/commons/reconcile/IProblemCollector.java @@ -0,0 +1,30 @@ +/******************************************************************************* + * Copyright (c) 2014-2016 Pivotal, Inc. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Pivotal, Inc. - initial API and implementation + *******************************************************************************/ +package org.springframework.ide.vscode.commons.reconcile; + +public interface IProblemCollector { + + void beginCollecting(); + void endCollecting(); + void accept(ReconcileProblem problem); + + /** + * Problem collector that simply ignores/discards anything passed to it. + */ + IProblemCollector NULL = new IProblemCollector() { + public void beginCollecting() { + } + public void endCollecting() { + } + public void accept(ReconcileProblem problem) { + } + }; +} \ No newline at end of file diff --git a/vscode-extensions/commons/language-server-commons/src/main/java/org/springframework/ide/vscode/commons/reconcile/IReconcileEngine.java b/vscode-extensions/commons/language-server-commons/src/main/java/org/springframework/ide/vscode/commons/reconcile/IReconcileEngine.java new file mode 100644 index 000000000..9cf1c2661 --- /dev/null +++ b/vscode-extensions/commons/language-server-commons/src/main/java/org/springframework/ide/vscode/commons/reconcile/IReconcileEngine.java @@ -0,0 +1,17 @@ +/******************************************************************************* + * Copyright (c) 2015 Pivotal, Inc. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Pivotal, Inc. - initial API and implementation + *******************************************************************************/ +package org.springframework.ide.vscode.commons.reconcile; + +import org.springframework.ide.vscode.util.TextDocument; + +public interface IReconcileEngine { + public void reconcile(IDocument doc, IProblemCollector problemCollector); +} diff --git a/vscode-extensions/commons/language-server-commons/src/main/java/org/springframework/ide/vscode/commons/reconcile/ProblemSeverity.java b/vscode-extensions/commons/language-server-commons/src/main/java/org/springframework/ide/vscode/commons/reconcile/ProblemSeverity.java new file mode 100644 index 000000000..d215237eb --- /dev/null +++ b/vscode-extensions/commons/language-server-commons/src/main/java/org/springframework/ide/vscode/commons/reconcile/ProblemSeverity.java @@ -0,0 +1,12 @@ +package org.springframework.ide.vscode.commons.reconcile; + +/** + * @author Kris De Volder + */ +public enum ProblemSeverity { + + IGNORE, + WARNING, + ERROR; + +} diff --git a/vscode-extensions/commons/language-server-commons/src/main/java/org/springframework/ide/vscode/commons/reconcile/ProblemType.java b/vscode-extensions/commons/language-server-commons/src/main/java/org/springframework/ide/vscode/commons/reconcile/ProblemType.java new file mode 100644 index 000000000..8e5e97987 --- /dev/null +++ b/vscode-extensions/commons/language-server-commons/src/main/java/org/springframework/ide/vscode/commons/reconcile/ProblemType.java @@ -0,0 +1,17 @@ +package org.springframework.ide.vscode.commons.reconcile; + +/** + * Besides the methods below, the only hard requirement for a 'problem type' is + * that it is a unique object that is not 'equals' to any other object. + *

+ * It is probably nice if you implement a good toString however. + *

+ * A good way to implement a discrete set of problemType objects is as an enum + * that implements this interace. + * + * @author Kris De Volder + */ +public interface ProblemType { + ProblemSeverity getDefaultSeverity(); + String toString(); +} diff --git a/vscode-extensions/commons/language-server-commons/src/main/java/org/springframework/ide/vscode/commons/reconcile/ReconcileProblem.java b/vscode-extensions/commons/language-server-commons/src/main/java/org/springframework/ide/vscode/commons/reconcile/ReconcileProblem.java new file mode 100644 index 000000000..f1403feb0 --- /dev/null +++ b/vscode-extensions/commons/language-server-commons/src/main/java/org/springframework/ide/vscode/commons/reconcile/ReconcileProblem.java @@ -0,0 +1,14 @@ +package org.springframework.ide.vscode.commons.reconcile; + +/** + * Minamal interface that objects representing a reconciler problem must + * implement. + * + * @author Kris De Volder + */ +public interface ReconcileProblem { + ProblemType getType(); + String getMessage(); + int getOffset(); + int getLength(); +} diff --git a/vscode-extensions/commons/language-server-commons/src/main/java/org/springframework/ide/vscode/util/Assert.java b/vscode-extensions/commons/language-server-commons/src/main/java/org/springframework/ide/vscode/util/Assert.java index 6d0ae7ffd..f9fd476c8 100644 --- a/vscode-extensions/commons/language-server-commons/src/main/java/org/springframework/ide/vscode/util/Assert.java +++ b/vscode-extensions/commons/language-server-commons/src/main/java/org/springframework/ide/vscode/util/Assert.java @@ -7,5 +7,11 @@ public class Assert { throw new IllegalStateException(msg); } } + + public static void isLegal(boolean b) { + if (!b) { + throw new IllegalStateException(); + } + } } diff --git a/vscode-extensions/commons/language-server-commons/src/main/java/org/springframework/ide/vscode/util/StringUtil.java b/vscode-extensions/commons/language-server-commons/src/main/java/org/springframework/ide/vscode/util/StringUtil.java new file mode 100644 index 000000000..f07a9ef5a --- /dev/null +++ b/vscode-extensions/commons/language-server-commons/src/main/java/org/springframework/ide/vscode/util/StringUtil.java @@ -0,0 +1,7 @@ +package org.springframework.ide.vscode.util; + +public class StringUtil { + public static boolean hasText(String name) { + return name!=null && !name.trim().equals(""); + } +} diff --git a/vscode-extensions/commons/language-server-commons/src/main/java/org/springframework/ide/vscode/util/TextDocument.java b/vscode-extensions/commons/language-server-commons/src/main/java/org/springframework/ide/vscode/util/TextDocument.java index 3fbf5bfa7..4e70b2a3e 100644 --- a/vscode-extensions/commons/language-server-commons/src/main/java/org/springframework/ide/vscode/util/TextDocument.java +++ b/vscode-extensions/commons/language-server-commons/src/main/java/org/springframework/ide/vscode/util/TextDocument.java @@ -1,9 +1,11 @@ package org.springframework.ide.vscode.util; +import org.springframework.ide.vscode.commons.reconcile.IDocument; + import io.typefox.lsapi.Range; import io.typefox.lsapi.TextDocumentContentChangeEvent; -public class TextDocument { +public class TextDocument implements IDocument { private final String uri; private String text = ""; diff --git a/vscode-extensions/commons/language-server-test-harness/src/main/java/org/springframework/ide/vscode/testharness/LanguageServerHarness.java b/vscode-extensions/commons/language-server-test-harness/src/main/java/org/springframework/ide/vscode/testharness/LanguageServerHarness.java index d7e81a611..db3838c41 100644 --- a/vscode-extensions/commons/language-server-test-harness/src/main/java/org/springframework/ide/vscode/testharness/LanguageServerHarness.java +++ b/vscode-extensions/commons/language-server-test-harness/src/main/java/org/springframework/ide/vscode/testharness/LanguageServerHarness.java @@ -34,8 +34,7 @@ import io.typefox.lsapi.services.LanguageServer; public class LanguageServerHarness { - //Warning this 'harness' is not very good yet. It just implements bare minimum to - // be able to test the MyLanguageServer example. + //Warning this 'harness' is incomplete. Growing it as needed. private Random random = new Random(); diff --git a/vscode-extensions/commons/pom.xml b/vscode-extensions/commons/pom.xml index 930625f5c..b997db51e 100644 --- a/vscode-extensions/commons/pom.xml +++ b/vscode-extensions/commons/pom.xml @@ -12,11 +12,13 @@ language-server-commons language-server-test-harness + yaml-commons 4.11 3.5.2 + 1.7.21 @@ -35,6 +37,11 @@ + + org.slf4j + slf4j-api + ${slf4j-version} + junit junit diff --git a/vscode-extensions/commons/yaml-commons/.classpath b/vscode-extensions/commons/yaml-commons/.classpath new file mode 100644 index 000000000..fae1a2b37 --- /dev/null +++ b/vscode-extensions/commons/yaml-commons/.classpath @@ -0,0 +1,36 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/vscode-extensions/commons/yaml-commons/.project b/vscode-extensions/commons/yaml-commons/.project new file mode 100644 index 000000000..8a125b66e --- /dev/null +++ b/vscode-extensions/commons/yaml-commons/.project @@ -0,0 +1,23 @@ + + + yaml-commons + + + + + + org.eclipse.jdt.core.javabuilder + + + + + org.eclipse.m2e.core.maven2Builder + + + + + + org.eclipse.jdt.core.javanature + org.eclipse.m2e.core.maven2Nature + + diff --git a/vscode-extensions/commons/yaml-commons/.settings/org.eclipse.jdt.core.prefs b/vscode-extensions/commons/yaml-commons/.settings/org.eclipse.jdt.core.prefs new file mode 100644 index 000000000..714351aec --- /dev/null +++ b/vscode-extensions/commons/yaml-commons/.settings/org.eclipse.jdt.core.prefs @@ -0,0 +1,5 @@ +eclipse.preferences.version=1 +org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.8 +org.eclipse.jdt.core.compiler.compliance=1.8 +org.eclipse.jdt.core.compiler.problem.forbiddenReference=warning +org.eclipse.jdt.core.compiler.source=1.8 diff --git a/vscode-extensions/commons/yaml-commons/.settings/org.eclipse.m2e.core.prefs b/vscode-extensions/commons/yaml-commons/.settings/org.eclipse.m2e.core.prefs new file mode 100644 index 000000000..f897a7f1c --- /dev/null +++ b/vscode-extensions/commons/yaml-commons/.settings/org.eclipse.m2e.core.prefs @@ -0,0 +1,4 @@ +activeProfiles= +eclipse.preferences.version=1 +resolveWorkspaceProjects=true +version=1 diff --git a/vscode-extensions/commons/yaml-commons/pom.xml b/vscode-extensions/commons/yaml-commons/pom.xml new file mode 100644 index 000000000..b6a96a6fd --- /dev/null +++ b/vscode-extensions/commons/yaml-commons/pom.xml @@ -0,0 +1,34 @@ + + 4.0.0 + yaml-commons + yaml-commons + Shared utilities for working with yaml + + + org.springframework.ide.vscode + commons-parent + 0.0.1-SNAPSHOT + ../pom.xml + + + + + org.yaml + snakeyaml + 1.17 + + + javax.inject + javax.inject + 1 + + + com.google.guava + guava + 19.0 + + + + + diff --git a/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/schema/BasicYValueHint.java b/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/schema/BasicYValueHint.java new file mode 100644 index 000000000..f5f89eee4 --- /dev/null +++ b/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/schema/BasicYValueHint.java @@ -0,0 +1,79 @@ +/******************************************************************************* + * Copyright (c) 2016 Pivotal, Inc. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Pivotal, Inc. - initial API and implementation + *******************************************************************************/ +package org.springframework.ide.vscode.yaml.schema; + +public class BasicYValueHint implements YValueHint { + + private final String value; + private String label; + + public BasicYValueHint(String value, String label) { + this.value = value; + this.label = label; + } + + public BasicYValueHint(String value) { + this.value = value; + this.label = value; + } + + /* (non-Javadoc) + * @see org.springframework.ide.eclipse.cloudfoundry.manifest.editor.YValueHint#getValue() + */ + @Override + public String getValue() { + return value; + } + + /* (non-Javadoc) + * @see org.springframework.ide.eclipse.cloudfoundry.manifest.editor.YValueHint#getLabel() + */ + @Override + public String getLabel() { + return label; + } + + @Override + public int hashCode() { + final int prime = 31; + int result = 1; + result = prime * result + ((label == null) ? 0 : label.hashCode()); + result = prime * result + ((value == null) ? 0 : value.hashCode()); + return result; + } + + @Override + public boolean equals(Object obj) { + if (this == obj) + return true; + if (obj == null) + return false; + if (getClass() != obj.getClass()) + return false; + BasicYValueHint other = (BasicYValueHint) obj; + if (label == null) { + if (other.label != null) + return false; + } else if (!label.equals(other.label)) + return false; + if (value == null) { + if (other.value != null) + return false; + } else if (!value.equals(other.value)) + return false; + return true; + } + + @Override + public String toString() { + return "BasicYValueHint [value=" + value + ", label=" + label + "]"; + } +} diff --git a/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/schema/YType.java b/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/schema/YType.java new file mode 100644 index 000000000..7dd565c83 --- /dev/null +++ b/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/schema/YType.java @@ -0,0 +1,29 @@ +/******************************************************************************* + * Copyright (c) 2016 Pivotal, Inc. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Pivotal, Inc. - initial API and implementation + *******************************************************************************/ +package org.springframework.ide.vscode.yaml.schema; + +/** + * Marker interface for objects that carry 'type information'. + *

+ * It may seem odd that this interface has no actual methods. This + * is because the methods for interpreting the types are defined + * by an accompanying {@link YTypeUtil}. + *

+ * The main reason why it works this way is to allow for 'YType' objects + * themselves to be implemented as dumb data objects while making YTypeUtil + * implementations define how to interpret these objects using context + * information (e.g. types resolved from a project's classpath). + * + * @author Kris De Volder + */ +public interface YType { + +} diff --git a/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/schema/YTypeFactory.java b/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/schema/YTypeFactory.java new file mode 100644 index 000000000..d9421c6db --- /dev/null +++ b/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/schema/YTypeFactory.java @@ -0,0 +1,364 @@ +/******************************************************************************* + * Copyright (c) 2016 Pivotal, Inc. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Pivotal, Inc. - initial API and implementation + *******************************************************************************/ +package org.springframework.ide.vscode.yaml.schema; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.LinkedHashMap; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; + +import javax.inject.Provider; + +import org.springframework.ide.vscode.yaml.util.Description; +import org.springframework.ide.vscode.yaml.util.DescriptionProviders; +import org.springframework.ide.vscode.yaml.util.EnumValueParser; +import org.springframework.ide.vscode.yaml.util.ValueParser; + +/** + * Static utility method for creating YType objects representing either + * 'array-like', 'map-like' or 'object-like' types which can be used + * to build up a 'Yaml Schema'. + * + * @author Kris De Volder + */ +public class YTypeFactory { + + public YType yseq(YType el) { + return new YSeqType(el); + } + + public YType ymap(YType key, YType val) { + return new YMapType(key, val); + } + + public YBeanType ybean(String name, YTypedProperty... properties) { + return new YBeanType(name, properties); + } + + /** + * YTypeUtil instances capable of 'interpreting' the YType objects created by this + * YTypeFactory + */ + public final YTypeUtil TYPE_UTIL = new YTypeUtil() { + + @Override + public boolean isSequencable(YType type) { + return ((AbstractType)type).isSequenceable(); + } + + @Override + public boolean isMap(YType type) { + return ((AbstractType)type).isMap(); + } + + @Override + public boolean isAtomic(YType type) { + return ((AbstractType)type).isAtomic(); + } + + @Override + public Map getPropertiesMap(YType type) { + return ((AbstractType)type).getPropertiesMap(); + } + + @Override + public List getProperties(YType type) { + return ((AbstractType)type).getProperties(); + } + + @Override + public YValueHint[] getHintValues(YType type) { + return ((AbstractType)type).getHintValues(); + } + + @Override + public YType getDomainType(YType type) { + return ((AbstractType)type).getDomainType(); + } + + @Override + public String niceTypeName(YType type) { + return type.toString(); + } + + @Override + public YType getKeyType(YType type) { + return ((AbstractType)type).getKeyType(); + } + + @Override + public boolean isBean(YType type) { + return ((AbstractType)type).isBean(); + } + + @Override + public ValueParser getValueParser(YType type) { + return ((AbstractType)type).getParser(); + } + }; + + ///////////////////////////////////////////////////////////////////////////////////// + + /** + * Provides default implementations for all YType methods. + */ + public static abstract class AbstractType implements YType { + + private ValueParser parser; + private List propertyList = new ArrayList<>(); + private final List hints = new ArrayList<>(); + private Map cachedPropertyMap; + private Provider> hintProvider; + + public boolean isSequenceable() { + return false; + } + + public boolean isBean() { + return false; + } + + public YType getKeyType() { + return null; + } + + public YType getDomainType() { + return null; + } + + public void addHintProvider(Provider> hintProvider) { + this.hintProvider = hintProvider; + } + + public YValueHint[] getHintValues() { + Collection providerHints = hintProvider != null ? hintProvider.get() : null; + + if (providerHints == null || providerHints.isEmpty()) { + return hints.toArray(new YValueHint[hints.size()]); + } else { + // Only merge if there are provider hints to merge + Set mergedHints = new LinkedHashSet<>(); + + // Add type hints first + for (YValueHint val : hints) { + mergedHints.add(val); + } + + // merge the provider hints + for (YValueHint val : providerHints) { + mergedHints.add(val); + } + return mergedHints.toArray(new YValueHint[mergedHints.size()]); + } + } + + public final List getProperties() { + return Collections.unmodifiableList(propertyList); + } + + public final Map getPropertiesMap() { + if (cachedPropertyMap==null) { + cachedPropertyMap = new LinkedHashMap<>(); + for (YTypedProperty p : propertyList) { + cachedPropertyMap.put(p.getName(), p); + } + } + return Collections.unmodifiableMap(cachedPropertyMap); + } + + public boolean isAtomic() { + return false; + } + + public boolean isMap() { + return false; + } + + public abstract String toString(); // force each sublcass to implement a (nice) toString method. + + public void addProperty(YTypedProperty p) { + cachedPropertyMap = null; + propertyList.add(p); + } + + public void addProperty(String name, YType type, Provider description) { + YTypedPropertyImpl prop; + addProperty(prop = new YTypedPropertyImpl(name, type)); + prop.setDescriptionProvider(description); + } + + public void addProperty(String name, YType type) { + addProperty(new YTypedPropertyImpl(name, type)); + } + public void addHints(String... strings) { + if (strings != null) { + for (String value : strings) { + BasicYValueHint hint = new BasicYValueHint(value); + if (!hints.contains(hint)) { + hints.add(hint); + } + } + } + } + public void parseWith(ValueParser parser) { + this.parser = parser; + } + public ValueParser getParser() { + return parser; + } + } + + public static class YMapType extends AbstractType { + + private final YType key; + private final YType val; + + private YMapType(YType key, YType val) { + this.key = key; + this.val = val; + } + + @Override + public String toString() { + return "Map<"+key.toString()+", "+val.toString()+">"; + } + + @Override + public boolean isMap() { + return true; + } + + @Override + public YType getKeyType() { + return key; + } + + @Override + public YType getDomainType() { + return val; + } + } + + public static class YSeqType extends AbstractType { + + private YType el; + + private YSeqType(YType el) { + this.el = el; + } + + @Override + public String toString() { + return el.toString()+"[]"; + } + + @Override + public boolean isSequenceable() { + return true; + } + + @Override + public YType getDomainType() { + return el; + } + } + + public static class YBeanType extends AbstractType { + private final String name; + + public YBeanType(String name, YTypedProperty[] properties) { + this.name = name; + for (YTypedProperty p : properties) { + addProperty(p); + } + } + + @Override + public String toString() { + return name; + } + + public boolean isBean() { + return true; + } + } + + public static class YAtomicType extends AbstractType { + private final String name; + private YAtomicType(String name) { + this.name = name; + } + @Override + public String toString() { + return name; + } + @Override + public boolean isAtomic() { + return true; + } + } + + public static class YTypedPropertyImpl implements YTypedProperty { + + final private String name; + final private YType type; + private Provider descriptionProvider = DescriptionProviders.NO_DESCRIPTION; + + private YTypedPropertyImpl(String name, YType type) { + this.name = name; + this.type = type; + } + + @Override + public String getName() { + return this.name; + } + + @Override + public YType getType() { + return this.type; + } + + @Override + public String toString() { + return name + ":" + type; + } + + @Override + public Description getDescription() { + return descriptionProvider.get(); + } + + public void setDescriptionProvider(Provider descriptionProvider) { + this.descriptionProvider = descriptionProvider; + } + + } + + public YAtomicType yatomic(String name) { + return new YAtomicType(name); + } + + public YTypedPropertyImpl yprop(String name, YType type) { + return new YTypedPropertyImpl(name, type); + } + + public YAtomicType yenum(String name, String... values) { + YAtomicType t = yatomic(name); + t.addHints(values); + t.parseWith(new EnumValueParser(name, values)); + return t; + } +} diff --git a/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/schema/YTypeUtil.java b/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/schema/YTypeUtil.java new file mode 100644 index 000000000..a78d47cdc --- /dev/null +++ b/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/schema/YTypeUtil.java @@ -0,0 +1,40 @@ +/******************************************************************************* + * Copyright (c) 2016 Pivotal, Inc. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Pivotal, Inc. - initial API and implementation + *******************************************************************************/ +package org.springframework.ide.vscode.yaml.schema; + +import java.util.List; +import java.util.Map; + +import org.springframework.ide.vscode.yaml.util.ValueParser; + +/** + * An implementation of YTypeUtil provides implementations of various + * methods operating on YTypes and interpreting them in some context + * (e.g. the meaning of YType objects may depend on types resolved + * from the current project's classpath). + * + * @author Kris De Volder + */ +public interface YTypeUtil { + boolean isAtomic(YType type); + boolean isMap(YType type); + boolean isSequencable(YType type); + boolean isBean(YType type); + YType getDomainType(YType type); + YValueHint[] getHintValues(YType yType); + String niceTypeName(YType type); + YType getKeyType(YType type); + ValueParser getValueParser(YType type); + + //TODO: only one of these two should be enough? + List getProperties(YType type); + Map getPropertiesMap(YType yType); +} diff --git a/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/schema/YTypedProperty.java b/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/schema/YTypedProperty.java new file mode 100644 index 000000000..bbc64e41b --- /dev/null +++ b/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/schema/YTypedProperty.java @@ -0,0 +1,22 @@ +/******************************************************************************* + * Copyright (c) 2016 Pivotal, Inc. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Pivotal, Inc. - initial API and implementation + *******************************************************************************/ +package org.springframework.ide.vscode.yaml.schema; + +import org.springframework.ide.vscode.yaml.util.Description; + +/** + * @author Kris De Volder + */ +public interface YTypedProperty { + String getName(); + YType getType(); + Description getDescription(); +} diff --git a/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/schema/YValueHint.java b/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/schema/YValueHint.java new file mode 100644 index 000000000..bac9d7f9c --- /dev/null +++ b/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/schema/YValueHint.java @@ -0,0 +1,19 @@ +/******************************************************************************* + * Copyright (c) 2016 Pivotal, Inc. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Pivotal, Inc. - initial API and implementation + *******************************************************************************/ +package org.springframework.ide.vscode.yaml.schema; + +public interface YValueHint { + + String getValue(); + + String getLabel(); + +} \ No newline at end of file diff --git a/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/schema/YamlSchema.java b/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/schema/YamlSchema.java new file mode 100644 index 000000000..47717841b --- /dev/null +++ b/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/schema/YamlSchema.java @@ -0,0 +1,25 @@ +/******************************************************************************* + * Copyright (c) 2016 Pivotal, Inc. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Pivotal, Inc. - initial API and implementation + *******************************************************************************/ +package org.springframework.ide.vscode.yaml.schema; + +/** + * A 'schema' provides a toplevel type, which dictates the valid structure of a + * YamlDocument and a {@link YTypeUtil} which provides the means to 'interpret' + * the types. + * + * @author Kris De Volder + */ +public interface YamlSchema { + + YType getTopLevelType(); + YTypeUtil getTypeUtil(); + +} diff --git a/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/util/Description.java b/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/util/Description.java new file mode 100644 index 000000000..3caa74646 --- /dev/null +++ b/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/util/Description.java @@ -0,0 +1,31 @@ +package org.springframework.ide.vscode.yaml.util; + +public abstract class Description { + + public abstract void renderAsText(StringBuilder buf); + + public void renderAsHtml(StringBuilder buf) { + throw new UnsupportedOperationException("Rendering as html not supported"); + } + + public static Description text(String text) { + return new Description() { + @Override + public void renderAsText(StringBuilder buf) { + buf.append(text); + } + }; + } + + public static Description italic(Description d) { + //Not really supported, we just ignore italic and display as is + return d; + } + + public String toText() { + StringBuilder buf = new StringBuilder(); + renderAsText(buf); + return buf.toString(); + } + +} diff --git a/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/util/DescriptionProviders.java b/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/util/DescriptionProviders.java new file mode 100644 index 000000000..09e1816be --- /dev/null +++ b/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/util/DescriptionProviders.java @@ -0,0 +1,66 @@ +/******************************************************************************* + * Copyright (c) 2016 Pivotal, Inc. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Pivotal, Inc. - initial API and implementation + *******************************************************************************/ +package org.springframework.ide.vscode.yaml.util; + +import java.io.InputStream; + +import javax.inject.Provider; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import static org.springframework.ide.vscode.yaml.util.Description.*; + +/** + * Static methods and convenience constants for creating some 'description providers'. + * + * @author Kris De Volder + */ +public class DescriptionProviders { + + final static Logger logger = LoggerFactory.getLogger(DescriptionProviders.class); + + public static final Provider NO_DESCRIPTION = () -> italic(text("no description")); + + public static Provider snippet(final Description snippet) { + return new Provider() { + @Override + public String toString() { + return snippet.toString(); + } + @Override + public Description get() { + return snippet; + } + }; + } + + public static Provider fromClasspath(final Class klass, final String resourcePath) { + return new Provider() { + @Override + public String toString() { + return "DescriptionFromClassPth(class="+klass.getSimpleName()+", "+resourcePath+")"; + } + @Override + public Description get() { + try { + InputStream stream = klass.getResourceAsStream(resourcePath); + if (stream!=null) { + return Description.text(IOUtil.toString(stream)); + } + } catch (Exception e) { + logger.error("Error", e);; + } + return NO_DESCRIPTION.get(); + } + }; + } +} diff --git a/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/util/EnumValueParser.java b/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/util/EnumValueParser.java new file mode 100644 index 000000000..1c373754b --- /dev/null +++ b/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/util/EnumValueParser.java @@ -0,0 +1,45 @@ +/******************************************************************************* + * Copyright (c) 2014-2016 Pivotal, Inc. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Pivotal, Inc. - initial API and implementation + *******************************************************************************/ +package org.springframework.ide.vscode.yaml.util; + +import java.util.Collection; +import java.util.Set; + +import com.google.common.collect.ImmutableSet; + +/** + * Parser for checking a 'Enum' style values. + * + * @author Kris De Volder + */ +public class EnumValueParser implements ValueParser { + + private String typeName; + private Set values; + + public EnumValueParser(String typeName, String... values) { + this(typeName, ImmutableSet.copyOf(values)); + } + + public EnumValueParser(String typeName, Collection values) { + this.typeName = typeName; + this.values = ImmutableSet.copyOf(values); + } + + public Object parse(String str) { + if (values.contains(str)) { + return str; + } else { + throw new IllegalArgumentException("'"+str+"' is not valid for Enum '"+typeName+"'"); + } + } + +} diff --git a/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/util/IOUtil.java b/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/util/IOUtil.java new file mode 100644 index 000000000..ac4fc12d7 --- /dev/null +++ b/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/util/IOUtil.java @@ -0,0 +1,86 @@ +/******************************************************************************* + * Copyright (c) 2013 Pivotal Software, Inc. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Pivotal Software, Inc. - initial API and implementation + *******************************************************************************/ +package org.springframework.ide.vscode.yaml.util; + +import java.io.BufferedOutputStream; +import java.io.ByteArrayOutputStream; +import java.io.Closeable; +import java.io.File; +import java.io.FileOutputStream; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; + +public class IOUtil { + + /** + * Copy data from an inputstream into a file until end of the inputstream + * is reached. + *

+ * The input stream is closed automatically. + */ + public static void pipe(InputStream data, File target) throws IOException { + target.getParentFile().mkdirs(); //try to create dirs for parent if they don't exist. + OutputStream out = new BufferedOutputStream(new FileOutputStream(target)); + try { + pipe(data, out); + } finally { + out.close(); + } + } + + /** + * Copy input stream to output stream until end of the inputstream is reached. + * The intpustream is closed automatically, but the output stream is not. + */ + public static void pipe(InputStream input, OutputStream output) throws IOException { + try { + byte[] buf = new byte[1024*4]; + int n = input.read(buf); + while (n >= 0) { + output.write(buf, 0, n); + n = input.read(buf); + } + output.flush(); + } finally { + input.close(); + } + } + + public static String toString(InputStream input) throws Exception { + return toString(input, "UTF8"); + } + + private static String toString(InputStream input, String encoding) throws Exception { + ByteArrayOutputStream buf = new ByteArrayOutputStream(); + pipe(input, buf); + return buf.toString(encoding); + } + + /** + * Sick and tired of writing try-catch around close calls... If something can't close, it usually means it + * was already closed, no longer exists etc. This method catches and ignores the exceptions. + */ + public static void close(Closeable closeable) { + try { + closeable.close(); + } catch (IOException e) { + //ignore + } + } + + public static byte[] toBytes(InputStream stream) throws IOException { + ByteArrayOutputStream bytes = new ByteArrayOutputStream(); + pipe(stream, bytes); + return bytes.toByteArray(); + } + +} diff --git a/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/util/ValueParser.java b/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/util/ValueParser.java new file mode 100644 index 000000000..262052002 --- /dev/null +++ b/vscode-extensions/commons/yaml-commons/src/main/java/org/springframework/ide/vscode/yaml/util/ValueParser.java @@ -0,0 +1,26 @@ +/******************************************************************************* + * Copyright (c) 2015-2016 Pivotal, Inc. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Pivotal, Inc. - initial API and implementation + *******************************************************************************/ +package org.springframework.ide.vscode.yaml.util; + +/** + * A ValueParser provides the means to Strings into some kind of + * value. + * + * @author Kris De Volder + */ +public interface ValueParser { + /** + * Parse the string and return its parsed representation. + * May either return null, or throw an {@link IllegalArgumentException} to indicate + * that the String is not the format this parser expects. + */ + Object parse(String str); +} \ No newline at end of file diff --git a/vscode-extensions/vscode-manifest-yaml/pom.xml b/vscode-extensions/vscode-manifest-yaml/pom.xml index 134110bc1..cc5daa209 100644 --- a/vscode-extensions/vscode-manifest-yaml/pom.xml +++ b/vscode-extensions/vscode-manifest-yaml/pom.xml @@ -38,15 +38,9 @@ - org.yaml - snakeyaml - 1.17 - - - - com.google.guava - guava - 18.0 + org.springframework.ide.vscode + yaml-commons + ${project.version} diff --git a/vscode-extensions/vscode-manifest-yaml/src/main/java/org/springframework/ide/eclipse/cloudfoundry/manifest/editor/ManifestEditorActivator.java b/vscode-extensions/vscode-manifest-yaml/src/main/java/org/springframework/ide/eclipse/cloudfoundry/manifest/editor/ManifestEditorActivator.java new file mode 100644 index 000000000..23a96e8a1 --- /dev/null +++ b/vscode-extensions/vscode-manifest-yaml/src/main/java/org/springframework/ide/eclipse/cloudfoundry/manifest/editor/ManifestEditorActivator.java @@ -0,0 +1,80 @@ +///******************************************************************************* +// * Copyright (c) 2016 Pivotal, Inc. +// * All rights reserved. This program and the accompanying materials +// * are made available under the terms of the Eclipse Public License v1.0 +// * which accompanies this distribution, and is available at +// * http://www.eclipse.org/legal/epl-v10.html +// * +// * Contributors: +// * Pivotal, Inc. - initial API and implementation +// *******************************************************************************/ +//package org.springframework.ide.eclipse.cloudfoundry.manifest.editor; +// +//import java.util.Collection; +// +//import javax.inject.Provider; +// +//import org.springframework.ide.eclipse.editor.support.yaml.schema.YValueHint; +//import org.springsource.ide.eclipse.commons.frameworks.core.ExceptionUtil; +// +//public class ManifestEditorActivator { +// +// // The plug-in ID +// public static final String PLUGIN_ID = "org.springframework.ide.eclipse.cloudfoundry.manifest.editor"; //$NON-NLS-1$ +// +// // The shared instance +// private static ManifestEditorActivator plugin; +// +// /** +// * The constructor +// */ +// public ManifestEditorActivator() { +// } +// +// /* +// * (non-Javadoc) +// * @see org.eclipse.ui.plugin.AbstractUIPlugin#start(org.osgi.framework.BundleContext) +// */ +// public void start(BundleContext context) throws Exception { +// super.start(context); +// plugin = this; +// } +// +// /* +// * (non-Javadoc) +// * @see org.eclipse.ui.plugin.AbstractUIPlugin#stop(org.osgi.framework.BundleContext) +// */ +// public void stop(BundleContext context) throws Exception { +// plugin = null; +// super.stop(context); +// } +// +// /** +// * Returns the shared instance +// * +// * @return the shared instance +// */ +// public static ManifestEditorActivator getDefault() { +// return plugin; +// } +// +// public static void log(Throwable e) { +// getDefault().getLog().log(ExceptionUtil.status(e)); +// } +// +// +// /* +// * +// * "Framework" to contribute value hints into manifest editor +// */ +// +// private Provider> buildpackProvider; +// +// public void setBuildpackProvider(Provider> buildpackProvider) { +// this.buildpackProvider = buildpackProvider; +// } +// +// public Provider> getBuildpackProvider() { +// return this.buildpackProvider; +// } +//} diff --git a/vscode-extensions/vscode-manifest-yaml/src/main/java/org/springframework/ide/eclipse/cloudfoundry/manifest/editor/ManifestYamlEditor.java b/vscode-extensions/vscode-manifest-yaml/src/main/java/org/springframework/ide/eclipse/cloudfoundry/manifest/editor/ManifestYamlEditor.java new file mode 100644 index 000000000..593dd5161 --- /dev/null +++ b/vscode-extensions/vscode-manifest-yaml/src/main/java/org/springframework/ide/eclipse/cloudfoundry/manifest/editor/ManifestYamlEditor.java @@ -0,0 +1,54 @@ +///******************************************************************************* +// * Copyright (c) 2015 Pivotal, Inc. +// * All rights reserved. This program and the accompanying materials +// * are made available under the terms of the Eclipse Public License v1.0 +// * which accompanies this distribution, and is available at +// * http://www.eclipse.org/legal/epl-v10.html +// * +// * Contributors: +// * Pivotal, Inc. - initial API and implementation +// *******************************************************************************/ +//package org.springframework.ide.eclipse.cloudfoundry.manifest.editor; +// +//import org.dadacoalition.yedit.editor.YEditSourceViewerConfiguration; +//import org.springframework.ide.eclipse.editor.support.util.ShellProviders; +//import org.springframework.ide.eclipse.editor.support.yaml.AbstractYamlEditor; +// +// +//public class ManifestYamlEditor extends AbstractYamlEditor { +// +// @Override +// protected YEditSourceViewerConfiguration createSourceViewerConfiguration() { +// return new ManifestYamlSourceViewerConfiguration(ShellProviders.from(this)); +// } +// +// @Override +// protected void initializeEditor() { +// super.initializeEditor(); +//// SpringPropertiesEditorPlugin.getIndexManager().addListener(this); +//// SpringPropertiesEditorPlugin.getDefault().getPreferenceStore().addPropertyChangeListener(this); +// } +// +//// @Override +//// public void changed(SpringPropertiesIndexManager info) { +//// if (sourceViewerConf!=null) { +//// sourceViewerConf.forceReconcile(); +//// } +//// } +// +// @Override +// public void dispose() { +// super.dispose(); +//// SpringPropertiesEditorPlugin.getIndexManager().removeListener(this); +//// SpringPropertiesEditorPlugin.getDefault().getPreferenceStore().removePropertyChangeListener(this); +// } +// +//// @Override +//// public void propertyChange(PropertyChangeEvent event) { +//// if (event.getProperty().startsWith(ProblemSeverityPreferencesUtil.PREFERENCE_PREFIX)) { +//// if (sourceViewerConf!=null) { +//// sourceViewerConf.forceReconcile(); +//// } +//// } +//// } +//} diff --git a/vscode-extensions/vscode-manifest-yaml/src/main/java/org/springframework/ide/eclipse/cloudfoundry/manifest/editor/ManifestYamlSourceViewerConfiguration.java b/vscode-extensions/vscode-manifest-yaml/src/main/java/org/springframework/ide/eclipse/cloudfoundry/manifest/editor/ManifestYamlSourceViewerConfiguration.java new file mode 100644 index 000000000..57f1b017f --- /dev/null +++ b/vscode-extensions/vscode-manifest-yaml/src/main/java/org/springframework/ide/eclipse/cloudfoundry/manifest/editor/ManifestYamlSourceViewerConfiguration.java @@ -0,0 +1,74 @@ +///******************************************************************************* +// * Copyright (c) 2016 Pivotal, Inc. +// * All rights reserved. This program and the accompanying materials +// * are made available under the terms of the Eclipse Public License v1.0 +// * which accompanies this distribution, and is available at +// * http://www.eclipse.org/legal/epl-v10.html +// * +// * Contributors: +// * Pivotal, Inc. - initial API and implementation +// *******************************************************************************/ +//package org.springframework.ide.eclipse.cloudfoundry.manifest.editor; +// +//import javax.inject.Provider; +// +//import org.eclipse.jface.dialogs.IDialogSettings; +//import org.eclipse.jface.preference.IPreferenceStore; +//import org.eclipse.jface.text.reconciler.IReconcilingStrategy; +//import org.eclipse.jface.text.source.ISourceViewer; +//import org.eclipse.swt.widgets.Shell; +//import org.springframework.ide.eclipse.editor.support.reconcile.IReconcileEngine; +//import org.springframework.ide.eclipse.editor.support.reconcile.ReconcileStrategy; +//import org.springframework.ide.eclipse.editor.support.yaml.AbstractYamlSourceViewerConfiguration; +//import org.springframework.ide.eclipse.editor.support.yaml.YamlAssistContextProvider; +//import org.springframework.ide.eclipse.editor.support.yaml.completions.SchemaBasedYamlAssistContextProvider; +//import org.springframework.ide.eclipse.editor.support.yaml.reconcile.YamlSchemaBasedReconcileEngine; +//import org.springframework.ide.eclipse.editor.support.yaml.structure.YamlStructureProvider; +// +///** +// * @author Kris De Volder +// */ +//public class ManifestYamlSourceViewerConfiguration extends AbstractYamlSourceViewerConfiguration { +// +// private ManifestYmlSchema schema = new ManifestYmlSchema(ManifestEditorActivator.getDefault().getBuildpackProvider()); +// private YamlAssistContextProvider assistContextProvider = new SchemaBasedYamlAssistContextProvider(schema); +// +// public ManifestYamlSourceViewerConfiguration(Provider shellProvider) { +// super(shellProvider); +// } +// +// @Override +// protected YamlAssistContextProvider getAssistContextProvider() { +// return assistContextProvider; +// } +// +// @Override +// protected YamlStructureProvider getStructureProvider() { +// return YamlStructureProvider.DEFAULT; +// } +// +// @Override +// protected IDialogSettings getPluginDialogSettings() { +// return ManifestEditorActivator.getDefault().getDialogSettings(); +// } +// +// @Override +// protected IReconcilingStrategy createReconcilerStrategy(ISourceViewer viewer) { +// IReconcileEngine engine = createReconcileEngine(); +// return new ReconcileStrategy(viewer, engine); +// } +// +// private IReconcileEngine createReconcileEngine() { +// return new YamlSchemaBasedReconcileEngine(getAstProvider(), schema); +// } +// +// @Override +// protected IPreferenceStore getPreferencesStore() { +// return ManifestEditorActivator.getDefault().getPreferenceStore(); +// } +// +// @Override +// protected String getPluginId() { +// return ManifestEditorActivator.PLUGIN_ID; +// } +//} diff --git a/vscode-extensions/vscode-manifest-yaml/src/main/java/org/springframework/ide/eclipse/cloudfoundry/manifest/editor/ManifestYmlSchema.java b/vscode-extensions/vscode-manifest-yaml/src/main/java/org/springframework/ide/eclipse/cloudfoundry/manifest/editor/ManifestYmlSchema.java new file mode 100644 index 000000000..01f2c5178 --- /dev/null +++ b/vscode-extensions/vscode-manifest-yaml/src/main/java/org/springframework/ide/eclipse/cloudfoundry/manifest/editor/ManifestYmlSchema.java @@ -0,0 +1,126 @@ +/******************************************************************************* + * Copyright (c) 2016 Pivotal, Inc. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Pivotal, Inc. - initial API and implementation + *******************************************************************************/ +package org.springframework.ide.eclipse.cloudfoundry.manifest.editor; + +import java.util.Collection; +import java.util.Set; + +import javax.inject.Provider; + +import org.springframework.ide.vscode.yaml.schema.YType; +import org.springframework.ide.vscode.yaml.schema.YTypeFactory; +import org.springframework.ide.vscode.yaml.schema.YTypeFactory.YAtomicType; +import org.springframework.ide.vscode.yaml.schema.YTypeFactory.YBeanType; +import org.springframework.ide.vscode.yaml.schema.YTypeFactory.YTypedPropertyImpl; +import org.springframework.ide.vscode.yaml.schema.YTypeUtil; +import org.springframework.ide.vscode.yaml.schema.YValueHint; +import org.springframework.ide.vscode.yaml.schema.YamlSchema; +import org.springframework.ide.vscode.yaml.util.Description; +import org.springframework.ide.vscode.yaml.util.DescriptionProviders; + +import com.google.common.collect.ImmutableSet; + +/** + * @author Kris De Volder + */ +public class ManifestYmlSchema implements YamlSchema { + + private final YBeanType TOPLEVEL_TYPE; + private final YTypeUtil TYPE_UTIL; + private final Provider> buildpackProvider; + + private static final Set TOPLEVEL_EXCLUDED = ImmutableSet.of( + "name", "host", "hosts" + ); + + public ManifestYmlSchema(Provider> buildpackProvider) { + this.buildpackProvider = buildpackProvider; + YTypeFactory f = new YTypeFactory(); + TYPE_UTIL = f.TYPE_UTIL; + + // define schema types + TOPLEVEL_TYPE = f.ybean("manifest.yml schema"); + + YBeanType application = f.ybean("Application"); + YAtomicType t_path = f.yatomic("Path"); + + YAtomicType t_buildpack = f.yatomic("Buildpack"); + + t_buildpack.addHintProvider(this.buildpackProvider); + + YAtomicType t_boolean = f.yenum("boolean", "true", "false"); + YType t_string = f.yatomic("String"); + YType t_strings = f.yseq(t_string); + + YAtomicType t_memory = f.yatomic("Memory"); + t_memory.addHints("256M", "512M", "1024M"); + t_memory.parseWith(ManifestYmlValueParsers.MEMORY); + + YAtomicType t_strictly_pos_integer = f.yatomic("Strictly Positive Integer"); + t_strictly_pos_integer.parseWith(ManifestYmlValueParsers.integerAtLeast(1)); + + YAtomicType t_pos_integer = f.yatomic("Positive Integer"); + t_pos_integer.parseWith(ManifestYmlValueParsers.POS_INTEGER); + + YType t_env = f.ymap(t_string, t_string); + + // define schema structure... + TOPLEVEL_TYPE.addProperty("applications", f.yseq(application)); + TOPLEVEL_TYPE.addProperty("inherit", t_string, descriptionFor("inherit")); + + YTypedPropertyImpl[] props = { + f.yprop("buildpack", t_buildpack), + f.yprop("command", t_string), + f.yprop("disk_quota", t_memory), + f.yprop("domain", t_string), + f.yprop("domains", t_strings), + f.yprop("env", t_env), + f.yprop("host", t_string), + f.yprop("hosts", t_strings), + f.yprop("instances", t_strictly_pos_integer), + f.yprop("memory", t_memory), + f.yprop("name", t_string), + f.yprop("no-hostname", t_boolean), + f.yprop("no-route", t_boolean), + f.yprop("path", t_path), + f.yprop("random-route", t_boolean), + f.yprop("services", t_strings), + f.yprop("stack", t_string), + f.yprop("timeout", t_pos_integer) + }; + + for (YTypedPropertyImpl prop : props) { + prop.setDescriptionProvider(descriptionFor(prop)); + if (!TOPLEVEL_EXCLUDED.contains(prop.getName())) { + TOPLEVEL_TYPE.addProperty(prop); + } + application.addProperty(prop); + } + } + + private Provider descriptionFor(String propName) { + return DescriptionProviders.fromClasspath(this.getClass(), "/description-by-prop-name/"+propName+".html"); + } + + private Provider descriptionFor(YTypedPropertyImpl prop) { + return descriptionFor(prop.getName()); + } + + @Override + public YBeanType getTopLevelType() { + return TOPLEVEL_TYPE; + } + + @Override + public YTypeUtil getTypeUtil() { + return TYPE_UTIL; + } +} diff --git a/vscode-extensions/vscode-manifest-yaml/src/main/java/org/springframework/ide/eclipse/cloudfoundry/manifest/editor/ManifestYmlValueParsers.java b/vscode-extensions/vscode-manifest-yaml/src/main/java/org/springframework/ide/eclipse/cloudfoundry/manifest/editor/ManifestYmlValueParsers.java new file mode 100644 index 000000000..c64bcef0b --- /dev/null +++ b/vscode-extensions/vscode-manifest-yaml/src/main/java/org/springframework/ide/eclipse/cloudfoundry/manifest/editor/ManifestYmlValueParsers.java @@ -0,0 +1,90 @@ +/******************************************************************************* + * Copyright (c) 2016 Pivotal, Inc. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Pivotal, Inc. - initial API and implementation + *******************************************************************************/ +package org.springframework.ide.eclipse.cloudfoundry.manifest.editor; + +import java.util.Set; + +import org.springframework.ide.vscode.util.Assert; +import org.springframework.ide.vscode.yaml.util.ValueParser; + +import com.google.common.collect.ImmutableSet; +import com.google.common.collect.Sets; + +/** + * Methods and constants to create/get parsers for some atomic types + * used in manifest yml schema. + * + * @author Kris De Volder + */ +public class ManifestYmlValueParsers { + + public static final ValueParser POS_INTEGER = integerRange(0, null); + + public static final ValueParser MEMORY = new ValueParser() { + + private final ImmutableSet GIGABYTE = ImmutableSet.of("G", "GB"); + private final ImmutableSet MEGABYTE = ImmutableSet.of("M", "MB"); + private final Set UNITS = Sets.union(GIGABYTE, MEGABYTE); + + @Override + public Object parse(String str) { + str = str.trim(); + String unit = getUnit(str.toUpperCase()); + if (unit==null) { + throw new NumberFormatException( + "'"+str+"' doesn't end with a valid unit of memory ('M', 'MB', 'G' or 'GB')" + ); + } + str = str.substring(0, str.length()-unit.length()); + int unitSize = GIGABYTE.contains(unit)?1024:1; + int value = Integer.parseInt(str); + if (value<0) { + throw new NumberFormatException("Negative value is not allowed"); + } + return value * unitSize; + } + + private String getUnit(String str) { + for (String u : UNITS) { + if (str.endsWith(u)) { + return u; + } + } + return null; + } + }; + + public static ValueParser integerAtLeast(final Integer lowerBound) { + return integerRange(lowerBound, null); + } + + public static ValueParser integerRange(final Integer lowerBound, final Integer upperBound) { + Assert.isLegal(lowerBound==null || upperBound==null || lowerBound <= upperBound); + return new ValueParser() { + @Override + public Object parse(String str) { + int value = Integer.parseInt(str); + if (lowerBound!=null && valueupperBound) { + throw new NumberFormatException("Value must be at most "+upperBound); + } + return value; + } + }; + } + +} diff --git a/vscode-extensions/vscode-manifest-yaml/src/main/java/org/springframework/ide/vscode/yaml/YamlLanguageServer.java b/vscode-extensions/vscode-manifest-yaml/src/main/java/org/springframework/ide/vscode/yaml/YamlLanguageServer.java index 558b307c0..efd82022e 100644 --- a/vscode-extensions/vscode-manifest-yaml/src/main/java/org/springframework/ide/vscode/yaml/YamlLanguageServer.java +++ b/vscode-extensions/vscode-manifest-yaml/src/main/java/org/springframework/ide/vscode/yaml/YamlLanguageServer.java @@ -37,7 +37,6 @@ public class YamlLanguageServer extends SimpleLanguageServer { SimpleTextDocumentService documents = getTextDocumentService(); // SimpleWorkspaceService workspace = getWorkspaceService(); documents.onDidChangeContent(params -> { - System.out.println("Document changed: "+params); TextDocument doc = params.getDocument(); validateDocument(documents, doc); }); diff --git a/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/buildpack.html b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/buildpack.html new file mode 100644 index 000000000..2f3fb4cb2 --- /dev/null +++ b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/buildpack.html @@ -0,0 +1,11 @@ +

If your application requires a custom buildpack, you can use the buildpack attribute to specify its URL or name:

+ +
+---
+  ...
+  buildpack: buildpack_URL
+
+ +

Note: The cf buildpacks command lists the buildpacks that you can refer to by name in a manifest or a command line option.

+ +

The command line option that overrides this attribute is -b.

diff --git a/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/command.html b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/command.html new file mode 100644 index 000000000..aab1e4651 --- /dev/null +++ b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/command.html @@ -0,0 +1,34 @@ +

Some languages and frameworks require that you provide a custom command to start an application. Refer to the buildpack documentation to determine if you need to provide a custom start command.

+ +

You can provide the custom start command in your application manifest or on the command line.

+ +

To specify the custom start command in your application manifest, add it in the command: START-COMMAND format as the following example shows:

+ +
+---
+  ...
+  command: bundle exec rake VERBOSE=true
+
+ +

On the command line, use the -c option to specify the custom start command as the following example shows:

+ +
+$ cf push my-app -c "bundle exec rake VERBOSE=true"
+
+ +

Note: The -c option with a value of ‘null’ forces cf push to use the buildpack start command. See About Starting Applications for more information.

+ +

If you override the start command for a Buildpack application, Linux uses +bash -c YOUR-COMMAND to invoke your application. +If you override the start command for a Docker application, Linux uses sh -c YOUR-COMMAND to invoke your application. +Because of this, if you override a start command, you should prefix exec to the final command in your custom composite start command.

+ +

exec causes the last command to become the root process of your application. The Cloud Foundry Updates and Your Application section of the Considerations for Designing and Running an Application in the Cloud topic explains why your application should handle a termination signal during Cloud Foundry updates. +Without an exec statement, the parent process remains as the implied bash process, and does not propagate signals to your application process.

+ +

For example, both of the following composite start commands run database migrations when the first instance of the app starts, then start the app to serve requests, but they behave differently on graceful shutdown.

+ + \ No newline at end of file diff --git a/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/disk_quota.html b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/disk_quota.html new file mode 100644 index 000000000..f2463dbea --- /dev/null +++ b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/disk_quota.html @@ -0,0 +1,9 @@ +

Use the disk_quota attribute to allocate the disk space for your app instance. This attribute requires a unit of measurement: M, MB, G, or GB, in upper case or lower case.

+ +
+---
+  ...
+  disk_quota: 1024M
+
+ +

The command line option that overrides this attribute is -k.

diff --git a/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/domain.html b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/domain.html new file mode 100644 index 000000000..8f1af1c01 --- /dev/null +++ b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/domain.html @@ -0,0 +1,27 @@ +

Every cf push deploys applications to one particular Cloud Foundry instance. +Every Cloud Foundry instance may have a shared domain set by an admin. +Unless you specify a domain, Cloud Foundry incorporates that shared domain in the route to your application.

+ +

You can use the domain attribute when you want your application to be served from a domain other than the default shared domain.

+ +
+---
+  ...
+  domain: unique-example.com
+
+ +

The command line option that overrides this attribute is -d.

+ +

The domains attribute

+ +

Use the domains attribute to provide multiple domains. If you define both domain and domains attributes, Cloud Foundry creates routes for domains defined in both of these fields.

+ +
+---
+  ...
+  domains:
+  - domain-example1.com
+  - domain-example2.org
+
+ +

The command line option that overrides this attribute is -d.

diff --git a/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/domains.html b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/domains.html new file mode 100644 index 000000000..0df6ef33b --- /dev/null +++ b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/domains.html @@ -0,0 +1,10 @@ +

Use the domains attribute to provide multiple domains. If you define both domain and domains attributes, Cloud Foundry creates routes for domains defined in both of these fields.

+ +
---
+  ...
+  domains:
+  - domain-example1.com
+  - domain-example2.org
+
+ +

The command line option that overrides this attribute is -d.

diff --git a/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/env.html b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/env.html new file mode 100644 index 000000000..4c35fe3d7 --- /dev/null +++ b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/env.html @@ -0,0 +1,28 @@ +

The env block consists of a heading, then one or more environment variable/value pairs.

+ +

For example:

+ +
+---
+  ...
+  env:
+    RAILS_ENV: production
+    RACK_ENV: production
+
+ +

cf push deploys the application to a container on the server. The variables belong to the container environment.

+ +

While the application is running, Cloud Foundry allows you to operate on environment variables.

+ + + +

Environment variables interact with manifests in the following ways:

+ + diff --git a/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/host.html b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/host.html new file mode 100644 index 000000000..04de4aa7b --- /dev/null +++ b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/host.html @@ -0,0 +1,9 @@ +

Use the host attribute to provide a hostname, or subdomain, in the form of a string. This segment of a route helps to ensure that the route is unique. If you do not provide a hostname, the URL for the app takes the form of APP-NAME.DOMAIN.

+ +
+---
+  ...
+  host: my-app
+
+ +

The command line option that overrides this attribute is -n.

diff --git a/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/hosts.html b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/hosts.html new file mode 100644 index 000000000..de25f32ef --- /dev/null +++ b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/hosts.html @@ -0,0 +1,11 @@ +

Use the hosts attribute to provide multiple hostnames, or subdomains. Each hostname generates a unique route for the app. hosts can be used in conjunction with host. If you define both attributes, Cloud Foundry creates routes for hostnames defined in both host and hosts.

+ +
+---
+  ...
+  hosts:
+  - app_host1
+  - app_host2
+
+ +

The command line option that overrides this attribute is -n.

diff --git a/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/inherit.html b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/inherit.html new file mode 100644 index 000000000..184350b67 --- /dev/null +++ b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/inherit.html @@ -0,0 +1,62 @@ +

A single manifest can describe multiple applications. Another powerful technique is to create multiple manifests with inheritance. Here, manifests have parent-child relationships such that children inherit descriptions from a parent. Children can use inherited descriptions as-is, extend them, or override them.

+ +

Content in the child manifest overrides content in the parent manifest, if the two conflict.

+ +

This technique helps in these and other scenarios:

+ + + +

The benefits of multiple manifests with inheritance are similar to those of minimizing duplicated content within single manifests. With inheritance, though, we “promote” content by placing it in the parent manifest.

+ +

Every child manifest must contain an “inherit” line that points to the parent manifest. Place the inherit line immediately after the three dashes at the top of the child manifest. For example, every child of a parent manifest called base-manifest.yml begins like this:

+ +
---
+  ...
+  inherit: base-manifest.yml
+
+ +

You do not need to add anything to the parent manifest.

+ +

In the simple example below, a parent manifest gives each application minimal resources, while a production child manifest scales them up.

+ +

simple-base-manifest.yml

+ +
---
+path: .
+domain: shared-domain.com
+memory: 256M
+instances: 1
+services:
+- singular-backend
+
+# app-specific configuration
+applications:
+ - name: springtock
+   host: 765shower
+   path: ./april/build/libs/april-weather.war
+ - name: wintertick
+   host: 321flurry
+   path: ./december/target/december-weather.war
+
+ +

simple-prod-manifest.yml

+ +
---
+inherit: simple-base-manifest.yml
+applications:
+ - name:springstorm
+   memory: 512M
+   instances: 1
+   host: 765deluge
+   path: ./april/build/libs/april-weather.war
+ - name: winterblast
+   memory: 1G
+   instances: 2
+   host: 321blizzard
+   path: ./december/target/december-weather.war
+
+ +

Note: Inheritance can add an additional level of complexity to manifest creation and maintenance. Comments that precisely explain how the child manifest extends or overrides the descriptions in the parent manifest can alleviate this complexity. \ No newline at end of file diff --git a/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/instances.html b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/instances.html new file mode 100644 index 000000000..021991fa5 --- /dev/null +++ b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/instances.html @@ -0,0 +1,11 @@ +

Use the instances attribute to specify the number of app instances that you want to start upon push:

+ +
+---
+  ...
+  instances: 2
+
+ +

We recommend that you run at least two instances of any apps for which fault tolerance matters.

+ +

The command line option that overrides this attribute is -i.

diff --git a/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/memory.html b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/memory.html new file mode 100644 index 000000000..e25ee286e --- /dev/null +++ b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/memory.html @@ -0,0 +1,11 @@ +

Use the memory attribute to specify the memory limit for all instances of an app. This attribute requires a unit of measurement: M, MB, G, or GB, in upper case or lower case. For example:

+ +
+---
+  ...
+  memory: 1024M
+
+ +

The default memory limit is 1G. You might want to specify a smaller limit to conserve quota space if you know that your app instances do not require 1G of memory.

+ +

The command line option that overrides this attribute is -m.

\ No newline at end of file diff --git a/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/name.html b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/name.html new file mode 100644 index 000000000..39d0aac6a --- /dev/null +++ b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/name.html @@ -0,0 +1,10 @@ +

The name attribute is the only required attribute +for an application in a manifest file.

+ +

This is an example of a minimal manifest:

+ +
+---
+applications:
+- name: nifty-gui
+
\ No newline at end of file diff --git a/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/no-hostname.html b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/no-hostname.html new file mode 100644 index 000000000..b3a6047de --- /dev/null +++ b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/no-hostname.html @@ -0,0 +1,9 @@ +

By default, if you do not provide a hostname, the URL for the app takes the form of APP-NAME.DOMAIN. If you want to override this and map the root domain to this app then you can set no-hostname as true.

+ +
+---
+  ...
+  no-hostname: true
+
+ +

The command line option that corresponds to this attribute is --no-hostname.

diff --git a/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/no-route.html b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/no-route.html new file mode 100644 index 000000000..d631024fd --- /dev/null +++ b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/no-route.html @@ -0,0 +1,18 @@ +

By default, cf push assigns a route to every application. But some applications process data while running in the background, and should not be assigned routes.

+ +

You can use the no-route attribute with a value of true to prevent a route from being created for your application.

+ +
+---
+  ...
+  no-route: true
+
+ +

The command line option that corresponds to this attribute is --no-route.

+ +

If you find that an application which should not have a route does have one:

+ +
    +
  1. Remove the route using the cf unmap-route command.
    2. +
  2. Push the app again with the no-route: true attribute in the manifest or the --no-route command line option.
    3. +
diff --git a/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/path.html b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/path.html new file mode 100644 index 000000000..a1b1cfb23 --- /dev/null +++ b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/path.html @@ -0,0 +1,9 @@ +

You can use the path attribute to tell Cloud Foundry where to find your application. This is generally not necessary when you run cf push from the directory where an application is located.

+ +
+---
+  ...
+  path: path_to_application_bits
+
+ +

The command line option that overrides this attribute is -p.

diff --git a/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/random-route.html b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/random-route.html new file mode 100644 index 000000000..ef432da78 --- /dev/null +++ b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/random-route.html @@ -0,0 +1,11 @@ +

Use the random-route attribute to create a URL that includes the app name and +random words. +Use this attribute to avoid URL collision when pushing the same app to multiple spaces, or to avoid managing app URLs.

+ +

The command line option that corresponds to this attribute is --random-route.

+ +
+---
+  ...
+  random-route: true
+
diff --git a/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/services.html b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/services.html new file mode 100644 index 000000000..c10713143 --- /dev/null +++ b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/services.html @@ -0,0 +1,18 @@ +

Applications can bind to services such as databases, messaging, and key-value stores.

+ +

Applications are deployed into App Spaces. An application can only bind to services instances that exist in the target App Space before the application is deployed.

+ +

The services block consists of a heading, then one or more service instance names.

+ +

Whoever creates the service chooses the service instance names. These names can convey logical information, as in backend_queue, describe the nature of the service, as in mysql_5.x, or do neither, as in the example below.

+ +
+---
+  ...
+  services:
+   - instance_ABC
+   - instance_XYZ
+
+ +

Binding to a service instance is a special case of setting an environment +variable, namely VCAP_SERVICES. diff --git a/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/stack.html b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/stack.html new file mode 100644 index 000000000..021e2788a --- /dev/null +++ b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/stack.html @@ -0,0 +1,11 @@ +

Use the stack attribute to specify which stack to deploy your application to.

+ +

To see a list of available stacks, run cf stacks from the cf cli.

+ +
+---
+  ...
+  stack: cflinuxfs2
+
+ +

The command line option that overrides this attribute is -s.

diff --git a/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/timeout.html b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/timeout.html new file mode 100644 index 000000000..063e26405 --- /dev/null +++ b/vscode-extensions/vscode-manifest-yaml/src/main/resources/description-by-prop-name/timeout.html @@ -0,0 +1,14 @@ +

The timeout attribute defines the number of seconds Cloud Foundry allocates for starting your application.

+ +

For example:

+ +
+---
+  ...
+  timeout: 80
+
+ +

You can increase the timeout length for very large apps that require more time to start. The default timeout is 60 seconds with an upper bound of 180 seconds.

+

Note: Administrators can set the upper bound of the maximum_health_check_timeout property to any value. Any changes to Cloud Controller properties in the deployment manifest require running bosh deploy.

+ +

The command line option that overrides the timeout attribute for the shell is -t. Manifest values still apply to applications pushed to the deployment.

diff --git a/vscode-extensions/vscode-manifest-yaml/src/test/java/org/springframework/ide/vscode/yaml/ManifestYmlSchemaTest.java b/vscode-extensions/vscode-manifest-yaml/src/test/java/org/springframework/ide/vscode/yaml/ManifestYmlSchemaTest.java new file mode 100644 index 000000000..a8aa056ea --- /dev/null +++ b/vscode-extensions/vscode-manifest-yaml/src/test/java/org/springframework/ide/vscode/yaml/ManifestYmlSchemaTest.java @@ -0,0 +1,144 @@ +package org.springframework.ide.vscode.yaml; +/******************************************************************************* + * Copyright (c) 2015, 2016 Pivotal, Inc. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Pivotal, Inc. - initial API and implementation + *******************************************************************************/ + + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; + +import java.util.List; +import java.util.Map; + +import org.junit.Test; +import org.springframework.ide.eclipse.cloudfoundry.manifest.editor.ManifestYmlSchema; +import org.springframework.ide.vscode.util.StringUtil; +import org.springframework.ide.vscode.yaml.schema.YTypeFactory.YBeanType; +import org.springframework.ide.vscode.yaml.schema.YTypeFactory.YSeqType; +import org.springframework.ide.vscode.yaml.schema.YTypedProperty; +import org.springframework.ide.vscode.yaml.util.DescriptionProviders; + +import com.google.common.collect.ImmutableSet; +import com.google.common.collect.ImmutableSet.Builder; + +/** + * @author Kris De Volder + */ +public class ManifestYmlSchemaTest { + + private static final String[] NESTED_PROP_NAMES = { +// "applications", + "buildpack", + "command", + "disk_quota", + "domain", + "domains", + "env", + "host", + "hosts", +// "inherit", + "instances", + "memory", + "name", + "no-hostname", + "no-route", + "path", + "random-route", + "services", + "stack", + "timeout" + }; + + private static final String[] TOPLEVEL_PROP_NAMES = { + "applications", + "buildpack", + "command", + "disk_quota", + "domain", + "domains", + "env", +// "host", +// "hosts", + "inherit", + "instances", + "memory", +// "name", + "no-hostname", + "no-route", + "path", + "random-route", + "services", + "stack", + "timeout" + }; + + ManifestYmlSchema schema = new ManifestYmlSchema(null); + + @Test + public void toplevelProperties() throws Exception { + assertPropNames(schema.getTopLevelType().getProperties(), TOPLEVEL_PROP_NAMES); + assertPropNames(schema.getTopLevelType().getPropertiesMap(), TOPLEVEL_PROP_NAMES); + } + + @Test + public void nestedProperties() throws Exception { + assertPropNames(getNestedProps(), NESTED_PROP_NAMES); + } + + @Test + public void toplevelPropertiesHaveDescriptions() { + for (YTypedProperty p : schema.getTopLevelType().getProperties()) { + if (!p.getName().equals("applications")) { + assertHasRealDescription(p); + } + } + } + + @Test + public void nestedPropertiesHaveDescriptions() { + for (YTypedProperty p : getNestedProps()) { + assertHasRealDescription(p); + } + } + + ////////////////////////////////////////////////////////////////////////////// + + private void assertHasRealDescription(YTypedProperty p) { + String noDescriptionText = DescriptionProviders.NO_DESCRIPTION.get().toText(); + String actual = p.getDescription().toText(); + String msg = "Description missing for '"+p.getName()+"'"; + assertTrue(msg, StringUtil.hasText(actual)); + assertFalse(msg, noDescriptionText.equals(actual)); + } + + private List getNestedProps() { + YSeqType applications = (YSeqType) schema.getTopLevelType().getPropertiesMap().get("applications").getType(); + YBeanType application = (YBeanType) applications.getDomainType(); + return application.getProperties(); + } + + private void assertPropNames(List properties, String... expectedNames) { + assertEquals(ImmutableSet.copyOf(expectedNames), getNames(properties)); + } + + private void assertPropNames(Map propertiesMap, String[] toplevelPropNames) { + assertEquals(ImmutableSet.copyOf(toplevelPropNames), ImmutableSet.copyOf(propertiesMap.keySet())); + } + + private ImmutableSet getNames(Iterable properties) { + Builder builder = ImmutableSet.builder(); + for (YTypedProperty p : properties) { + builder.add(p.getName()); + } + return builder.build(); + } + +}