/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License 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 org.apache.brooklyn.camp.brooklyn.catalog;
import static org.testng.Assert.assertEquals;
import static org.testng.Assert.assertTrue;
import java.util.List;
import org.apache.brooklyn.api.entity.Application;
import org.apache.brooklyn.api.entity.Entity;
import org.apache.brooklyn.api.entity.EntitySpec;
import org.apache.brooklyn.api.typereg.RegisteredType;
import org.apache.brooklyn.camp.brooklyn.AbstractYamlTest;
import org.apache.brooklyn.core.entity.Entities;
import org.apache.brooklyn.core.mgmt.BrooklynTags;
import org.apache.brooklyn.core.mgmt.BrooklynTags.NamedStringTag;
import org.apache.brooklyn.core.mgmt.EntityManagementUtils;
import org.apache.brooklyn.core.mgmt.osgi.OsgiStandaloneTest;
import org.apache.brooklyn.core.test.entity.TestEntity;
import org.apache.brooklyn.core.typereg.RegisteredTypePredicates;
import org.apache.brooklyn.core.typereg.RegisteredTypes;
import org.apache.brooklyn.entity.group.DynamicCluster;
import org.apache.brooklyn.entity.stock.BasicApplication;
import org.apache.brooklyn.test.Asserts;
import org.apache.brooklyn.test.support.TestResourceUnavailableException;
import org.apache.brooklyn.util.core.config.ConfigBag;
import org.apache.brooklyn.util.osgi.OsgiTestResources;
import org.testng.Assert;
import org.testng.TestListenerAdapter;
import org.testng.TestNG;
import org.testng.annotations.Test;
import com.google.common.collect.Iterables;
public class CatalogYamlTemplateTest extends AbstractYamlTest {
private static final String SIMPLE_ENTITY_TYPE = OsgiTestResources.BROOKLYN_TEST_OSGI_ENTITIES_SIMPLE_ENTITY;
@Test
public void testAddCatalogItem() throws Exception {
RegisteredType item = makeItem();
Assert.assertTrue(RegisteredTypePredicates.IS_APPLICATION.apply(item), "item: "+item);
String yaml = RegisteredTypes.getImplementationDataStringForSpec(item);
Assert.assertTrue(yaml.indexOf("sample comment")>=0,
"YAML did not include original comments; it was:\n"+yaml);
Assert.assertFalse(yaml.indexOf("description")>=0,
"YAML included metadata which should have been excluded; it was:\n"+yaml);
deleteCatalogEntity("t1");
}
@Test
public void testAddCatalogItemAndCheckSource() throws Exception {
// this will fail with the Eclipse TestNG plugin -- use the static main instead to run in eclipse!
// see Yamls.KnownClassVersionException for details
RegisteredType item = makeItem();
String yaml = RegisteredTypes.getImplementationDataStringForSpec(item);
Assert.assertTrue(yaml.indexOf("sample comment")>=0,
"YAML did not include original comments; it was:\n"+yaml);
Assert.assertFalse(yaml.indexOf("description")>=0,
"YAML included metadata which should have been excluded; it was:\n"+yaml);
deleteCatalogEntity("t1");
}
public void testServiceTypeEntityOfTypeCatalogTemplateNotWrapped() throws Exception {
addCatalogItems(
"brooklyn.catalog:",
" id: t1",
" item_type: template",
" name: myT1",
" item:",
" services:",
" - type: " + TestEntity.class.getName());
addCatalogItems(
"brooklyn.catalog:",
" id: t2",
" item_type: template",
" name: myT2",
" item:",
" services:",
" - type: t1",
" - type: t1");
Entity app = createAndStartApplication(
"services:",
"- type: t2");
waitForApplicationTasks(app);
Entities.dumpInfo(app);
Entity t1a = Iterables.get(app.getChildren(), 0);
Entity t1b = Iterables.get(app.getChildren(), 1);
assertEquals(app.getChildren().size(), 2);
assertEquals(t1a.getChildren().size(), 0);
assertEquals(t1b.getChildren().size(), 0);
assertTrue(app instanceof BasicApplication);
assertTrue(t1a instanceof TestEntity);
assertTrue(t1b instanceof TestEntity);
}
@Test
public void testChildEntityOfTypeCatalogTemplateNotWrapped() throws Exception {
addCatalogItems(
"brooklyn.catalog:",
" id: t1",
" item_type: template",
" name: myT1",
" item:",
" services:",
" - type: " + TestEntity.class.getName());
addCatalogItems(
"brooklyn.catalog:",
" id: t2",
" item_type: template",
" name: myT2",
" item:",
" services:",
" - type: " + TestEntity.class.getName(),
" brooklyn.children:",
" - type: t1");
Entity app = createAndStartApplication(
"services:",
"- type: t2");
waitForApplicationTasks(app);
Entities.dumpInfo(app);
Entity t2 = Iterables.getOnlyElement(app.getChildren());
Entity t1 = Iterables.getOnlyElement(t2.getChildren());
assertEquals(t1.getChildren().size(), 0);
assertTrue(app instanceof BasicApplication);
assertTrue(t1 instanceof TestEntity);
assertTrue(t2 instanceof TestEntity);
}
@Test
public void testMemberSpecEntityOfTypeCatalogTemplateNotWrapped() throws Exception {
addCatalogItems(
"brooklyn.catalog:",
" id: t1",
" item_type: template",
" name: myT1",
" item:",
" services:",
" - type: " + TestEntity.class.getName());
addCatalogItems(
"brooklyn.catalog:",
" id: t2",
" item_type: template",
" name: myT2",
" item:",
" services:",
" - type: " + DynamicCluster.class.getName(),
" brooklyn.config:",
" memberSpec:",
" $brooklyn:entitySpec:",
" type: t1",
" cluster.initial.size: 1");
Entity app = createAndStartApplication(
"location: localhost",
"services:",
"- type: t2");
waitForApplicationTasks(app);
Entities.dumpInfo(app);
DynamicCluster t2 = (DynamicCluster) Iterables.getOnlyElement(app.getChildren());
Entity t1 = Iterables.getOnlyElement(t2.getMembers());
assertEquals(t1.getChildren().size(), 0);
assertTrue(app instanceof BasicApplication);
assertTrue(t2 instanceof DynamicCluster);
assertTrue(t1 instanceof TestEntity);
}
@Test
public void testMetadataOnSpecCreatedFromItem() throws Exception {
makeItem();
EntitySpec<? extends Application> spec = EntityManagementUtils.createEntitySpecForApplication(mgmt(),
"services: [ { type: t1 } ]\n" +
"location: localhost");
List<NamedStringTag> yamls = BrooklynTags.findAll(BrooklynTags.YAML_SPEC_KIND, spec.getTags());
Assert.assertEquals(yamls.size(), 1, "Expected 1 yaml tag; instead had: "+yamls);
String yaml = Iterables.getOnlyElement(yamls).getContents();
Asserts.assertStringContains(yaml, "services:", "t1", "localhost");
EntitySpec<?> child = Iterables.getOnlyElement( spec.getChildren() );
Assert.assertEquals(child.getType().getName(), SIMPLE_ENTITY_TYPE);
Assert.assertEquals(child.getCatalogItemId(), "t1:"+TEST_VERSION);
}
@Test
public void testMetadataOnSpecCreatedFromItemReferencingAnApp() throws Exception {
// this nested ref to an app caused nested plan contents also to be recorded,
// due to how tags are merged. the *first* one is the most important, however,
// and ordering of tags should guarantee that.
// similarly ensure we get the right outermost non-null catalog item id.
addCatalogItems(
"brooklyn.catalog:",
" version: '1'",
" items:",
" - id: app1",
" name: myApp1",
" item:",
" type: org.apache.brooklyn.entity.stock.BasicApplication",
" brooklyn.config: { foo: bar }",
" - id: app1r",
" item_type: template",
" item:",
" services:",
" - type: app1",
" brooklyn.config:",
" foo: boo"
);
EntitySpec<? extends Application> spec = EntityManagementUtils.createEntitySpecForApplication(mgmt(),
"services: [ { type: app1r } ]\n" +
"location: localhost");
List<NamedStringTag> yamls = BrooklynTags.findAll(BrooklynTags.YAML_SPEC_KIND, spec.getTags());
Assert.assertTrue(yamls.size() >= 1, "Expected at least 1 yaml tag; instead had: "+yamls);
String yaml = yamls.iterator().next().getContents();
Asserts.assertStringContains(yaml, "services:", "type: app1r", "localhost");
Assert.assertEquals(spec.getChildren().size(), 0);
Assert.assertEquals(spec.getType(), BasicApplication.class);
Assert.assertEquals(ConfigBag.newInstance(spec.getConfig()).getStringKey("foo"), "boo");
Assert.assertEquals(spec.getCatalogItemId(), "app1r:1");
}
private RegisteredType makeItem() {
TestResourceUnavailableException.throwIfResourceUnavailable(getClass(), OsgiStandaloneTest.BROOKLYN_TEST_OSGI_ENTITIES_PATH);
addCatalogItems(
"brooklyn.catalog:",
" id: t1",
" item_type: template",
" name: My Catalog App",
" description: My description",
" icon_url: classpath://path/to/myicon.jpg",
" version: " + TEST_VERSION,
" libraries:",
" - url: " + OsgiStandaloneTest.BROOKLYN_TEST_OSGI_ENTITIES_URL,
" item:",
" services:",
" # this sample comment should be included",
" - type: " + SIMPLE_ENTITY_TYPE);
return mgmt().getTypeRegistry().get("t1", TEST_VERSION);
}
// convenience for running in eclipse when the TestNG plugin drags in old version of snake yaml
public static void main(String[] args) {
TestListenerAdapter tla = new TestListenerAdapter();
TestNG testng = new TestNG();
testng.setTestClasses(new Class[] { CatalogYamlTemplateTest.class });
testng.addListener(tla);
testng.run();
}
}