PathMatchingResourceLoaderAwsTest.java

/*
 * Copyright 2013-2014 the original author or authors.
 *
 * Licensed 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.springframework.cloud.aws.context.support.io;

import com.amazonaws.services.s3.AmazonS3;
import com.amazonaws.services.s3.model.ObjectMetadata;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cloud.aws.core.env.stack.StackResourceRegistry;
import org.springframework.core.io.support.ResourcePatternResolver;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;

import java.io.ByteArrayInputStream;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;

import static org.junit.Assert.assertEquals;

/**
 * @author Alain Sahli
 * @author Agim Emruli
 * @since 1.0
 */
@SuppressWarnings("SpringJavaAutowiringInspection")
@RunWith(SpringJUnit4ClassRunner.class)
public abstract class PathMatchingResourceLoaderAwsTest {

    private static final List<String> FILES_FOR_HIERARCHY = Arrays.asList("foo1/bar1/baz1/test1.txt", "foo1/bar1/test1.txt",
            "foo1/test1.txt", "test1.txt", "foo2/bar2/test2.txt", "foo2/bar2/baz2/test2.txt");
    private final ExecutorService executor = Executors.newFixedThreadPool(10);
    @Autowired
    private ResourcePatternResolver resourceLoader;
    @Autowired
    private AmazonS3 amazonS3;
    @Autowired
    private StackResourceRegistry stackResourceRegistry;

    @Test
    public void testWildcardsInKey() throws Exception {
        String bucketName = this.stackResourceRegistry.lookupPhysicalResourceId("PathMatcherBucket");
        createTestFiles(bucketName);

        String protocolAndBucket = "s3://" + bucketName;
        try {
            assertEquals("test the '?' wildcard", 1, this.resourceLoader.getResources(protocolAndBucket + "/foo1/bar?/test1.txt").length);
            assertEquals("test the '*' wildcard", 1, this.resourceLoader.getResources(protocolAndBucket + "/foo*/bar2/test2.txt").length);
            assertEquals("test the '**' wildcard", 4, this.resourceLoader.getResources(protocolAndBucket + "/**/test1.txt").length);
            assertEquals("test a mix of '**' and '?'", 6, this.resourceLoader.getResources(protocolAndBucket + "/**/test?.txt").length);
            assertEquals("test all together", 2, this.resourceLoader.getResources(protocolAndBucket + "/**/baz*/test?.txt").length);
        } finally {
            deleteTestFiles(bucketName);
        }
    }

    @Test
    public void testWildcardsInBucket() throws Exception {
        String firstBucket = this.stackResourceRegistry.lookupPhysicalResourceId("PathMatcherBucket01");
        String secondBucket = this.stackResourceRegistry.lookupPhysicalResourceId("PathMatcherBucket02");
        String thirdBucket = this.stackResourceRegistry.lookupPhysicalResourceId("PathMatcherBucket03");
        String bucketPrefix = firstBucket.substring(0, firstBucket.lastIndexOf("-") - 2);
        try {
            createTestFiles(firstBucket, secondBucket, thirdBucket);
            assertEquals("test the '?' wildcard", 1, this.resourceLoader.getResources("s3://" + bucketPrefix + "??" + firstBucket.substring(firstBucket.lastIndexOf("-")) + "/test1.txt").length);
            assertEquals("test the '*' wildcard", 3, this.resourceLoader.getResources("s3://" + bucketPrefix + "*/test1.txt").length);
            assertEquals("test the '**' wildcard", 4 * 3, this.resourceLoader.getResources("s3://**/test1.txt").length);
        } finally {
            deleteTestFiles(firstBucket, secondBucket, thirdBucket);
        }
    }

    private void createTestFiles(String... bucketNames) throws InterruptedException {
        List<CreateFileCallable> callables = new ArrayList<>();

        for (String bucketName : bucketNames) {
            for (String fileName : FILES_FOR_HIERARCHY) {
                callables.add(new CreateFileCallable(bucketName, fileName, this.amazonS3));
            }
        }
        this.executor.invokeAll(callables);
    }

    private void deleteTestFiles(String... bucketNames) throws InterruptedException {
        List<DeleteFileCallable> deleteFileCallables = new ArrayList<>();
        for (String bucketName : bucketNames) {
            for (String fileName : FILES_FOR_HIERARCHY) {
                deleteFileCallables.add(new DeleteFileCallable(bucketName, fileName, this.amazonS3));
            }
        }
        this.executor.invokeAll(deleteFileCallables);
    }

    private static class CreateFileCallable implements Callable<String> {

        private final String fileName;
        private final AmazonS3 amazonS3;
        private final String bucketName;

        private CreateFileCallable(String bucketName, String fileName, AmazonS3 amazonS3) {
            this.fileName = fileName;
            this.amazonS3 = amazonS3;
            this.bucketName = bucketName;
        }


        @Override
        public String call() throws Exception {
            this.amazonS3.putObject(this.bucketName, this.fileName, new ByteArrayInputStream(this.fileName.getBytes()), new ObjectMetadata());
            return this.fileName;
        }
    }

    private static class DeleteFileCallable implements Callable<String> {

        private final String fileName;
        private final AmazonS3 amazonS3;
        private final String bucketName;

        private DeleteFileCallable(String bucketName, String fileName, AmazonS3 amazonS3) {
            this.fileName = fileName;
            this.amazonS3 = amazonS3;
            this.bucketName = bucketName;
        }

        @Override
        public String call() throws Exception {
            this.amazonS3.deleteObject(this.bucketName, this.fileName);
            return this.fileName;
        }
    }
}