|
| 1 | +/* |
| 2 | + * Licensed to the Apache Software Foundation (ASF) under one |
| 3 | + * or more contributor license agreements. See the NOTICE file |
| 4 | + * distributed with this work for additional information |
| 5 | + * regarding copyright ownership. The ASF licenses this file |
| 6 | + * to you under the Apache License, Version 2.0 (the |
| 7 | + * "License"); you may not use this file except in compliance |
| 8 | + * with the License. You may obtain a copy of the License at |
| 9 | + * |
| 10 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 11 | + * |
| 12 | + * Unless required by applicable law or agreed to in writing, software |
| 13 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 14 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 15 | + * See the License for the specific language governing permissions and |
| 16 | + * limitations under the License. |
| 17 | + */ |
| 18 | + |
| 19 | +package org.apache.hadoop.fs.s3a; |
| 20 | + |
| 21 | +import java.io.IOException; |
| 22 | +import java.util.HashMap; |
| 23 | +import java.util.Map; |
| 24 | +import java.util.function.Consumer; |
| 25 | + |
| 26 | +import org.assertj.core.api.Assertions; |
| 27 | +import org.junit.Test; |
| 28 | + |
| 29 | +import org.apache.hadoop.conf.Configuration; |
| 30 | +import org.apache.hadoop.fs.FileSystem; |
| 31 | + |
| 32 | +/** |
| 33 | + * Checks that classloader isolation for loading extension classes is applied |
| 34 | + * correctly. Both default, true and false tests performed. |
| 35 | + * See {@link Constants#AWS_S3_CLASSLOADER_ISOLATION} property and |
| 36 | + * HADOOP-17372 and follow-up on HADOOP-18993 for more info. |
| 37 | + */ |
| 38 | +public class ITestS3AFileSystemIsolatedClassloader extends AbstractS3ATestBase { |
| 39 | + |
| 40 | + private static class CustomClassLoader extends ClassLoader { |
| 41 | + } |
| 42 | + |
| 43 | + private final ClassLoader customClassLoader = new CustomClassLoader(); |
| 44 | + |
| 45 | + private S3AFileSystem createNewTestFs(Configuration conf) throws IOException { |
| 46 | + S3AFileSystem fs = new S3AFileSystem(); |
| 47 | + fs.initialize(getFileSystem().getUri(), conf); |
| 48 | + return fs; |
| 49 | + } |
| 50 | + |
| 51 | + /** |
| 52 | + * Asserts that the given assertions are valid in a new filesystem context. |
| 53 | + * The filesystem is created after setting the context classloader to |
| 54 | + * {@link ITestS3AFileSystemIsolatedClassloader#customClassLoader} in this way we are |
| 55 | + * able to check if the classloader is reset during the initialization or not. |
| 56 | + * |
| 57 | + * @param confToSet The configuration settings to be applied to the new filesystem. |
| 58 | + * @param asserts The assertions to be performed on the new filesystem. |
| 59 | + * @throws IOException If an I/O error occurs. |
| 60 | + */ |
| 61 | + private void assertInNewFilesystem(Map<String, String> confToSet, Consumer<FileSystem> asserts) |
| 62 | + throws IOException { |
| 63 | + ClassLoader previousClassloader = Thread.currentThread().getContextClassLoader(); |
| 64 | + try { |
| 65 | + Thread.currentThread().setContextClassLoader(customClassLoader); |
| 66 | + Configuration conf = new Configuration(); |
| 67 | + Assertions.assertThat(conf.getClassLoader()).isEqualTo(customClassLoader); |
| 68 | + S3ATestUtils.prepareTestConfiguration(conf); |
| 69 | + for (Map.Entry<String, String> e : confToSet.entrySet()) { |
| 70 | + conf.set(e.getKey(), e.getValue()); |
| 71 | + } |
| 72 | + try (S3AFileSystem fs = createNewTestFs(conf)) { |
| 73 | + asserts.accept(fs); |
| 74 | + } |
| 75 | + } finally { |
| 76 | + Thread.currentThread().setContextClassLoader(previousClassloader); |
| 77 | + } |
| 78 | + } |
| 79 | + |
| 80 | + private Map<String, String> mapOf() { |
| 81 | + return new HashMap<>(); |
| 82 | + } |
| 83 | + |
| 84 | + private Map<String, String> mapOf(String key, String value) { |
| 85 | + HashMap<String, String> m = new HashMap<>(); |
| 86 | + m.put(key, value); |
| 87 | + return m; |
| 88 | + } |
| 89 | + |
| 90 | + @Test |
| 91 | + public void defaultIsolatedClassloader() throws IOException { |
| 92 | + assertInNewFilesystem(mapOf(), (fs) -> { |
| 93 | + Assertions.assertThat(fs.getConf().getClassLoader()) |
| 94 | + .describedAs("The classloader used to load s3a fs extensions") |
| 95 | + .isNotEqualTo(Thread.currentThread().getContextClassLoader()) |
| 96 | + .describedAs("the current classloader"); |
| 97 | + |
| 98 | + Assertions.assertThat(fs.getConf().getClassLoader()) |
| 99 | + .describedAs("The classloader used to load s3a fs extensions") |
| 100 | + .isEqualTo(fs.getClass().getClassLoader()) |
| 101 | + .describedAs("the classloader that loaded the fs"); |
| 102 | + }); |
| 103 | + } |
| 104 | + |
| 105 | + @Test |
| 106 | + public void isolatedClassloader() throws IOException { |
| 107 | + assertInNewFilesystem(mapOf(Constants.AWS_S3_CLASSLOADER_ISOLATION, "true"), (fs) -> { |
| 108 | + Assertions.assertThat(fs.getConf().getClassLoader()) |
| 109 | + .describedAs("The classloader used to load s3a fs extensions") |
| 110 | + .isNotEqualTo(Thread.currentThread().getContextClassLoader()) |
| 111 | + .describedAs("the current context classloader"); |
| 112 | + |
| 113 | + Assertions.assertThat(fs.getConf().getClassLoader()) |
| 114 | + .describedAs("The classloader used to load s3a fs extensions") |
| 115 | + .isEqualTo(fs.getClass().getClassLoader()) |
| 116 | + .describedAs("the classloader that loaded the fs"); |
| 117 | + }); |
| 118 | + } |
| 119 | + |
| 120 | + @Test |
| 121 | + public void notIsolatedClassloader() throws IOException { |
| 122 | + assertInNewFilesystem(mapOf(Constants.AWS_S3_CLASSLOADER_ISOLATION, "false"), (fs) -> { |
| 123 | + Assertions.assertThat(fs.getConf().getClassLoader()) |
| 124 | + .describedAs("The classloader used to load s3a fs extensions") |
| 125 | + .isEqualTo(Thread.currentThread().getContextClassLoader()) |
| 126 | + .describedAs("the current context classloader"); |
| 127 | + |
| 128 | + Assertions.assertThat(fs.getConf().getClassLoader()) |
| 129 | + .describedAs("The classloader used to load s3a fs extensions") |
| 130 | + .isNotEqualTo(fs.getClass().getClassLoader()) |
| 131 | + .describedAs("the classloader that loaded the fs"); |
| 132 | + }); |
| 133 | + } |
| 134 | +} |
0 commit comments