Examples with NamedTimeoutConstraint org.apache.ivy.core.settings.NamedTimeoutConstraint used on opensource projects

Example 1 with NamedTimeoutConstraint

use of org.apache.ivy.core.settings.NamedTimeoutConstraint in project ant-ivy by apache.

the class URLResolverTest method testTimeoutConstraint.

/**
 * Tests that the timeout constraint set on the URL resolver is used correctly by the resolver
 *
 * @throws Exception if something goes wrong
 */
@Test
public void testTimeoutConstraint() throws Exception {
    final NamedTimeoutConstraint highTimeout = new NamedTimeoutConstraint("test-high-timeout");
    highTimeout.setConnectionTimeout(60000);
    settings.addConfigured(highTimeout);
    final NamedTimeoutConstraint extremelyLowTimeout = new NamedTimeoutConstraint("test-extremely-low-timeout");
    extremelyLowTimeout.setConnectionTimeout(10);
    extremelyLowTimeout.setReadTimeout(20);
    settings.addConfigured(extremelyLowTimeout);
    // setup a HTTP backed repo
    // TODO: Right now the port is hard coded, but we need to find a "available" port to which can be bind to.
    // Else this can lead to occasional bind failures
    final InetSocketAddress fastServerBindAddr = new InetSocketAddress("localhost", 12345);
    final String contextRoot = "/testTimeouts";
    final Path repoRoot = new File("test/repositories/1").toPath();
    assertTrue(repoRoot + " is not a directory", Files.isDirectory(repoRoot));
    final DependencyDescriptor dependency = new DefaultDependencyDescriptor(ModuleRevisionId.newInstance("org1", "mod1.1", "2.0"), false);
    try (final AutoCloseable httpServer = TestHelper.createHttpServerBackedRepository(fastServerBindAddr, contextRoot, repoRoot)) {
        final String ivyPattern = "http://" + fastServerBindAddr.getHostName() + ":" + fastServerBindAddr.getPort() + "/testTimeouts/[organisation]/[module]/ivys/ivy-[revision].xml";
        final String artifactPattern = "http://" + fastServerBindAddr.getHostName() + ":" + fastServerBindAddr.getPort() + "/testTimeouts/[organisation]/[module]/[type]s/[artifact]-[revision].[type]";
        // first use a resolver with a high timeout to make sure
        // it can actually fetch the resources
        final URLResolver highTimeoutResolver = new URLResolver();
        highTimeoutResolver.setName("high-timeout-resolver");
        highTimeoutResolver.setAllownomd(false);
        highTimeoutResolver.setTimeoutConstraint("test-high-timeout");
        highTimeoutResolver.setSettings(settings);
        highTimeoutResolver.setIvyPatterns(Collections.singletonList(ivyPattern));
        highTimeoutResolver.setArtifactPatterns(Collections.singletonList(artifactPattern));
        highTimeoutResolver.validate();
        final TimeoutConstraint resolverTimeoutConstraint = highTimeoutResolver.getTimeoutConstraint();
        assertNotNull("Timeout constraint is missing on resolver " + highTimeoutResolver.getName(), resolverTimeoutConstraint);
        assertEquals("Unexpected connection timeout on resolver", 60000, resolverTimeoutConstraint.getConnectionTimeout());
        assertEquals("Unexpected read timeout on resolver", -1, resolverTimeoutConstraint.getReadTimeout());
        // do the fetch (expected to work fine)
        final ResolvedModuleRevision resolvedModule = highTimeoutResolver.getDependency(dependency, data);
        assertNotNull("Dependency wasn't resolved by resolver " + highTimeoutResolver.getName(), resolvedModule);
        assertEquals("Unexpected dependency resolved by resolver " + highTimeoutResolver.getName(), dependency.getDependencyRevisionId(), resolvedModule.getId());
    }
    // now test this whole fetch using a resolver with a very low connection timeout and
    // by starting the repo server with a delay so that the connection request can timeout
    // clean the cache before testing to ensure the resource isn't fetched from cache
    settings.getDefaultRepositoryCacheManager().clean();
    settings.getResolutionCacheManager().clean();
    final InetSocketAddress slowServerAddr = new InetSocketAddress("localhost", 23456);
    final String ivyPattern = "http://" + slowServerAddr.getHostName() + ":" + slowServerAddr.getPort() + "/testTimeouts/[organisation]/[module]/ivys/ivy-[revision].xml";
    final String artifactPattern = "http://" + slowServerAddr.getHostName() + ":" + slowServerAddr.getPort() + "/testTimeouts/[organisation]/[module]/[type]s/[artifact]-[revision].[type]";
    final URLResolver lowTimeoutResolver = new URLResolver();
    lowTimeoutResolver.setAllownomd(false);
    lowTimeoutResolver.setName("low-timeout-resolver");
    lowTimeoutResolver.setTimeoutConstraint("test-extremely-low-timeout");
    lowTimeoutResolver.setSettings(settings);
    lowTimeoutResolver.setIvyPatterns(Collections.singletonList(ivyPattern));
    lowTimeoutResolver.setArtifactPatterns(Collections.singletonList(artifactPattern));
    lowTimeoutResolver.validate();
    final TimeoutConstraint lowTimeoutConstraint = lowTimeoutResolver.getTimeoutConstraint();
    assertNotNull("Timeout constraint is missing on resolver " + lowTimeoutResolver.getName(), lowTimeoutConstraint);
    assertEquals("Unexpected connection timeout on resolver", 10, lowTimeoutConstraint.getConnectionTimeout());
    assertEquals("Unexpected read timeout on resolver", 20, lowTimeoutConstraint.getReadTimeout());
    final ExecutorService executor = Executors.newSingleThreadExecutor();
    final long serverStartupDelayInMillis = 500;
    final Future<AutoCloseable> httpServer = executor.submit(new ServerManager(slowServerAddr, contextRoot, repoRoot, serverStartupDelayInMillis));
    try {
        // do the fetch (resolution *isn't* expected to return resolved module)
        final ResolvedModuleRevision resolvedModuleFromLowTimeouts = lowTimeoutResolver.getDependency(dependency, data);
        assertNull("Dependency wasn't expected to be resolved by resolver " + lowTimeoutResolver.getName(), resolvedModuleFromLowTimeouts);
    } finally {
        try {
            // stop the server
            httpServer.get().close();
        } catch (Exception e) {
        // ignore
        // TODO: Better log it too. But I don't see usage of loggers in test cases currently. So need to get to this later
        }
        try {
            executor.shutdownNow();
        } catch (Exception e) {
        // ignore
        // TODO: Better log it too. But I don't see usage of loggers in test cases currently. So need to get to this later
        }
    }
}