-
Notifications
You must be signed in to change notification settings - Fork 52
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
585 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
103 changes: 103 additions & 0 deletions
103
test-framework/src/main/java/org/apache/brooklyn/test/framework/TestEndpointReachable.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,103 @@ | ||
/* | ||
* 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.test.framework; | ||
|
||
import org.apache.brooklyn.api.entity.ImplementedBy; | ||
import org.apache.brooklyn.config.ConfigKey; | ||
import org.apache.brooklyn.core.config.ConfigKeys; | ||
|
||
/** | ||
* Entity that checks if a TCP endpoint is reachable. | ||
* | ||
* For example: | ||
* <pre> | ||
* {@code | ||
* services: | ||
* - type: com.acme.MyEntityUnderTest | ||
* id: entity-under-test | ||
* - type: org.apache.brooklyn.test.framework.TestCase | ||
* name: Tests | ||
* brooklyn.children: | ||
* - type: org.apache.brooklyn.test.framework.TestEndpointReachable | ||
* name: Endpoint reachable | ||
* brooklyn.config: | ||
* targetId: entity-under-test | ||
* timeout: 2m | ||
* endpointSensor: datastore.url | ||
* } | ||
* </pre> | ||
* | ||
* The sensor's value can be in a number of different formats: a string in the form of {@code ip:port} | ||
* or URI format; or a {@link com.google.common.net.HostAndPort}; or a {@link java.net.URI}; or a | ||
* {@link java.net.URL} instance. | ||
* | ||
* Alternatively an explicit endpoint can be used (e.g. constructed from other sensors of | ||
* the target entity): | ||
* <pre> | ||
* {@code | ||
* ... | ||
* - type: org.apache.brooklyn.test.framework.TestEndpointReachable | ||
* name: Endpoint reachable | ||
* brooklyn.config: | ||
* targetId: entity-under-test | ||
* timeout: 2m | ||
* endpoint: | ||
* $brooklyn:formatString: | ||
* - %s:%s" | ||
* - $brooklyn:entity("entity-under-test").attributeWhenReady("host.name") | ||
* - $brooklyn:entity("entity-under-test").attributeWhenReady("https.port") | ||
* } | ||
* </pre> | ||
* | ||
* One can also assert that the given endpoint is not reachable. Here the timeout means that at | ||
* some point within this timeout period, we expect the endpoint to become unreachable. As soon | ||
* as it is unreachable, we return: | ||
* | ||
* <pre> | ||
* {@code | ||
* ... | ||
* - type: org.apache.brooklyn.test.framework.TestEndpointReachable | ||
* name: Endpoint reachable | ||
* brooklyn.config: | ||
* targetId: entity-under-test | ||
* timeout: 2m | ||
* endpointSensor: datastore.url | ||
* assertions: | ||
* reachable: false | ||
* } | ||
* </pre> | ||
*/ | ||
@ImplementedBy(value = TestEndpointReachableImpl.class) | ||
public interface TestEndpointReachable extends BaseTest { | ||
|
||
ConfigKey<String> ENDPOINT = ConfigKeys.newStringConfigKey( | ||
"endpoint", | ||
"Endpoint (be it URL or host:port) to test, for tcp-reachability; mutually exclusive with 'endpointSensor'"); | ||
|
||
ConfigKey<Object> ENDPOINT_SENSOR = ConfigKeys.newConfigKey( | ||
Object.class, | ||
"endpointSensor", | ||
"Sensor (or name of sensor) on target that advertises the endpoint (to test for tcp-reachability); mutually exclusive with 'endpoint'"); | ||
|
||
/** | ||
* A key within the assertions map, to say whether we should assert that the endpoint is reachable or not reachable. | ||
* The value in the map should be a boolean. If absent, defaults to true. | ||
*/ | ||
public static final String REACHABLE_KEY = "reachable"; | ||
} |
223 changes: 223 additions & 0 deletions
223
...framework/src/main/java/org/apache/brooklyn/test/framework/TestEndpointReachableImpl.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,223 @@ | ||
/* | ||
* 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.test.framework; | ||
|
||
import static org.apache.brooklyn.test.framework.TestFrameworkAssertions.getAssertions; | ||
|
||
import java.net.URI; | ||
import java.net.URL; | ||
import java.util.Collection; | ||
import java.util.List; | ||
import java.util.Map; | ||
import java.util.Set; | ||
|
||
import org.apache.brooklyn.api.entity.Entity; | ||
import org.apache.brooklyn.api.location.Location; | ||
import org.apache.brooklyn.api.sensor.AttributeSensor; | ||
import org.apache.brooklyn.core.entity.Attributes; | ||
import org.apache.brooklyn.core.entity.lifecycle.Lifecycle; | ||
import org.apache.brooklyn.core.entity.lifecycle.ServiceStateLogic; | ||
import org.apache.brooklyn.core.sensor.Sensors; | ||
import org.apache.brooklyn.test.Asserts; | ||
import org.apache.brooklyn.util.core.flags.TypeCoercions; | ||
import org.apache.brooklyn.util.exceptions.Exceptions; | ||
import org.apache.brooklyn.util.guava.Maybe; | ||
import org.apache.brooklyn.util.net.Networking; | ||
import org.apache.brooklyn.util.text.Strings; | ||
import org.apache.brooklyn.util.time.Duration; | ||
import org.slf4j.Logger; | ||
import org.slf4j.LoggerFactory; | ||
|
||
import com.google.common.base.Objects; | ||
import com.google.common.base.Supplier; | ||
import com.google.common.collect.ImmutableMap; | ||
import com.google.common.collect.ImmutableSet; | ||
import com.google.common.collect.Lists; | ||
import com.google.common.collect.Sets; | ||
import com.google.common.net.HostAndPort; | ||
|
||
/** | ||
* {@inheritDoc} | ||
*/ | ||
public class TestEndpointReachableImpl extends TargetableTestComponentImpl implements TestEndpointReachable { | ||
|
||
private static final Logger LOG = LoggerFactory.getLogger(TestEndpointReachableImpl.class); | ||
|
||
@Override | ||
public void start(Collection<? extends Location> locations) { | ||
if (!getChildren().isEmpty()) { | ||
throw new RuntimeException(String.format("The entity [%s] cannot have child entities", getClass().getName())); | ||
} | ||
ServiceStateLogic.setExpectedState(this, Lifecycle.STARTING); | ||
final String endpoint = getConfig(ENDPOINT); | ||
final Object endpointSensor = getConfig(ENDPOINT_SENSOR); | ||
final Duration timeout = getConfig(TIMEOUT); | ||
final List<Map<String, Object>> assertions = getAssertions(this, ASSERTIONS); | ||
|
||
final Entity target = resolveTarget(); | ||
|
||
if (endpoint == null && endpointSensor == null) { | ||
throw new RuntimeException(String.format("The entity [%s] must be configured with one of endpoint or endpointSensor", getClass().getName())); | ||
} else if (endpoint != null && endpointSensor != null) { | ||
throw new RuntimeException(String.format("The entity [%s] must be configured with only one of endpoint or endpointSensor", getClass().getName())); | ||
} | ||
|
||
final Supplier<HostAndPort> supplier = new Supplier<HostAndPort>() { | ||
@Override | ||
public HostAndPort get() { | ||
Object val; | ||
if (endpoint != null) { | ||
val = endpoint; | ||
} else if (endpointSensor instanceof AttributeSensor) { | ||
val = target.sensors().get((AttributeSensor<?>)endpointSensor); | ||
} else if (endpointSensor instanceof CharSequence) { | ||
AttributeSensor<Object> sensor = Sensors.newSensor(Object.class, ((CharSequence)endpointSensor).toString()); | ||
val = target.sensors().get(sensor); | ||
} else { | ||
throw new IllegalArgumentException(String.format("The entity [%s] has endpointSensor of invalid type %s [%s]", getClass().getName(), endpointSensor.getClass().getName(), endpointSensor)); | ||
} | ||
return (val == null) ? null : toHostAndPort(val); | ||
} | ||
}; | ||
if (endpoint != null) { | ||
// fail-fast if have a static endpoint value | ||
supplier.get(); | ||
} | ||
|
||
try { | ||
Asserts.succeedsEventually(ImmutableMap.of("timeout", timeout), new Runnable() { | ||
@Override | ||
public void run() { | ||
HostAndPort val = supplier.get(); | ||
Asserts.assertNotNull(val); | ||
assertSucceeds(assertions, val); | ||
}}); | ||
sensors().set(Attributes.SERVICE_UP, true); | ||
ServiceStateLogic.setExpectedState(this, Lifecycle.RUNNING); | ||
|
||
} catch (Throwable t) { | ||
LOG.info("{} [{}] test failed", this, endpoint != null ? endpoint : endpointSensor); | ||
sensors().set(Attributes.SERVICE_UP, false); | ||
ServiceStateLogic.setExpectedState(this, Lifecycle.ON_FIRE); | ||
throw Exceptions.propagate(t); | ||
} | ||
} | ||
|
||
protected void assertSucceeds(List<Map<String, Object>> assertions, HostAndPort endpoint) { | ||
Maybe<Object> checkReachableMaybe = getOnlyAssertionsValue(assertions, REACHABLE_KEY); | ||
boolean checkReachable = checkReachableMaybe.isAbsentOrNull() || Boolean.TRUE.equals(TypeCoercions.coerce(checkReachableMaybe.get(), Boolean.class)); | ||
boolean reachable = Networking.isReachable(endpoint); | ||
Asserts.assertEquals(reachable, checkReachable, endpoint+" "+(reachable ? "" : "not ")+"reachable"); | ||
} | ||
|
||
/** | ||
* Finds the value for the given key in one of the maps (or {@link Maybe#absent()} if not found). | ||
* | ||
* @throws IllegalArgumentException if multiple conflicts values for the key, or if there are other (unexpected) keys. | ||
*/ | ||
protected Maybe<Object> getOnlyAssertionsValue(List<Map<String, Object>> assertions, String key) { | ||
Maybe<Object> result = Maybe.absent(); | ||
Set<String> keys = Sets.newLinkedHashSet(); | ||
boolean foundConflictingDuplicate = false; | ||
if (assertions != null) { | ||
for (Map<String, Object> assertionMap : assertions) { | ||
if (assertionMap.containsKey(key)) { | ||
Object val = assertionMap.get(REACHABLE_KEY); | ||
if (result.isPresent() && !Objects.equal(result.get(), val)) { | ||
foundConflictingDuplicate = true; | ||
} else { | ||
result = Maybe.of(val); | ||
} | ||
} | ||
keys.addAll(assertionMap.keySet()); | ||
} | ||
} | ||
Set<String> unhandledKeys = Sets.difference(keys, ImmutableSet.of(key)); | ||
if (foundConflictingDuplicate) { | ||
throw new IllegalArgumentException("Multiple conflicting values for assertion '"+key+"' in "+this); | ||
} else if (unhandledKeys.size() > 0) { | ||
throw new IllegalArgumentException("Unknown assertions "+unhandledKeys+" in "+this); | ||
} | ||
return result; | ||
} | ||
|
||
protected HostAndPort toHostAndPort(Object endpoint) { | ||
if (endpoint == null) { | ||
throw new IllegalArgumentException(String.format("The entity [%s] has no endpoint", getClass().getName())); | ||
} else if (endpoint instanceof String) { | ||
return toHostAndPort((String)endpoint); | ||
} else if (endpoint instanceof URI) { | ||
return toHostAndPort(((URI)endpoint).toString()); | ||
} else if (endpoint instanceof URL) { | ||
return toHostAndPort(((URL)endpoint).toString()); | ||
} else if (endpoint instanceof HostAndPort) { | ||
return (HostAndPort)endpoint; | ||
} else { | ||
throw new IllegalArgumentException(String.format("The entity [%s] has endpoint of invalid type %s [%s]", getClass().getName(), endpoint.getClass().getName(), endpoint)); | ||
} | ||
} | ||
|
||
protected HostAndPort toHostAndPort(String endpoint) { | ||
if (Strings.isEmpty(endpoint)) { | ||
throw new IllegalArgumentException(String.format("The entity [%s] has no endpoint", getClass().getName())); | ||
} | ||
try { | ||
URI uri = URI.create(endpoint); | ||
int port; | ||
if (uri.getPort() != -1) { | ||
port = uri.getPort(); | ||
} else { | ||
if ("http".equalsIgnoreCase(uri.getScheme())) { | ||
port = 80; | ||
} else if ("https".equalsIgnoreCase(uri.getScheme())) { | ||
port = 443; | ||
} else { | ||
throw new IllegalArgumentException(String.format("The entity [%s] with endpoint [%s] has no port", getClass().getName(), endpoint)); | ||
} | ||
} | ||
return HostAndPort.fromParts(uri.getHost(), port); | ||
} catch (IllegalArgumentException e) { | ||
// Not a URL; fall-back to host-and-port | ||
} | ||
|
||
HostAndPort result = HostAndPort.fromString(endpoint); | ||
if (!result.hasPort()) { | ||
throw new IllegalArgumentException(String.format("The entity [%s] with endpoint [%s] has no port", getClass().getName(), endpoint)); | ||
} | ||
return result; | ||
} | ||
|
||
/** | ||
* {@inheritDoc} | ||
*/ | ||
public void stop() { | ||
ServiceStateLogic.setExpectedState(this, Lifecycle.STOPPED); | ||
sensors().set(Attributes.SERVICE_UP, false); | ||
} | ||
|
||
/** | ||
* {@inheritDoc} | ||
*/ | ||
public void restart() { | ||
final Collection<Location> locations = Lists.newArrayList(getLocations()); | ||
stop(); | ||
start(locations); | ||
} | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.