HDDS-13402. Speed up TestOmSnapshotFileSystem (#8756)

Author: adoroszlai

hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/om/snapshot/SnapshotTests.java

@@ -0,0 +1,82 @@
+/*
+ * 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.hadoop.ozone.om.snapshot;
+
+import static org.apache.hadoop.ozone.om.helpers.BucketLayout.FILE_SYSTEM_OPTIMIZED;
+import static org.apache.hadoop.ozone.om.helpers.BucketLayout.LEGACY;
+
+import org.apache.hadoop.ozone.MiniOzoneCluster;
+import org.apache.ozone.test.ClusterForTests;
+import org.junit.jupiter.api.Nested;
+
+abstract class SnapshotTests extends ClusterForTests<MiniOzoneCluster> {
+
+  @Override
+  protected void onClusterReady() throws Exception {
+    // stop the deletion services so that keys can still be read
+    getCluster().getOzoneManager().getKeyManager().stop();
+  }
+
+  @Nested
+  class OmSnapshotFileSystemFso extends TestOmSnapshotFileSystem {
+    OmSnapshotFileSystemFso() {
+      super(FILE_SYSTEM_OPTIMIZED, false);
+    }
+
+    @Override
+    public MiniOzoneCluster cluster() {
+      return getCluster();
+    }
+  }
+
+  @Nested
+  class OmSnapshotFileSystemFsoWithLinkedBuckets extends TestOmSnapshotFileSystem {
+    OmSnapshotFileSystemFsoWithLinkedBuckets() {
+      super(FILE_SYSTEM_OPTIMIZED, true);
+    }
+
+    @Override
+    public MiniOzoneCluster cluster() {
+      return getCluster();
+    }
+  }
+
+  @Nested
+  class OmSnapshotFileSystemLegacy extends TestOmSnapshotFileSystem {
+    OmSnapshotFileSystemLegacy() {
+      super(LEGACY, false);
+    }
+
+    @Override
+    public MiniOzoneCluster cluster() {
+      return getCluster();
+    }
+  }
+
+  @Nested
+  class OmSnapshotFileSystemLegacyWithLinkedBuckets extends TestOmSnapshotFileSystem {
+    OmSnapshotFileSystemLegacyWithLinkedBuckets() {
+      super(LEGACY, true);
+    }
+
+    @Override
+    public MiniOzoneCluster cluster() {
+      return getCluster();
+    }
+  }
+}

hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/om/snapshot/TestOmSnapshotFileSystem.java

@@ -23,8 +23,6 @@
 import static org.apache.hadoop.ozone.OzoneConsts.OM_KEY_PREFIX;
 import static org.apache.hadoop.ozone.OzoneConsts.OZONE_URI_SCHEME;
 import static org.apache.hadoop.ozone.om.OmSnapshotManager.getSnapshotPath;
-import static org.apache.hadoop.ozone.om.helpers.BucketLayout.FILE_SYSTEM_OPTIMIZED;
-import static org.apache.hadoop.ozone.om.helpers.BucketLayout.LEGACY;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.jupiter.api.Assertions.assertArrayEquals;
 import static org.junit.jupiter.api.Assertions.assertEquals;
@@ -54,7 +52,6 @@
 import java.util.UUID;
 import java.util.concurrent.TimeoutException;
 import org.apache.commons.io.IOUtils;
-import org.apache.commons.lang3.RandomStringUtils;
 import org.apache.hadoop.fs.CommonConfigurationKeysPublic;
 import org.apache.hadoop.fs.FSDataInputStream;
 import org.apache.hadoop.fs.FSDataOutputStream;
@@ -66,27 +63,26 @@
 import org.apache.hadoop.fs.permission.FsPermission;
 import org.apache.hadoop.hdds.client.StandaloneReplicationConfig;
 import org.apache.hadoop.hdds.conf.OzoneConfiguration;
-import org.apache.hadoop.ozone.MiniOzoneCluster;
 import org.apache.hadoop.ozone.OzoneConsts;
 import org.apache.hadoop.ozone.TestDataUtil;
-import org.apache.hadoop.ozone.client.BucketArgs;
 import org.apache.hadoop.ozone.client.ObjectStore;
 import org.apache.hadoop.ozone.client.OzoneBucket;
 import org.apache.hadoop.ozone.client.OzoneClient;
 import org.apache.hadoop.ozone.client.OzoneKey;
 import org.apache.hadoop.ozone.client.OzoneSnapshot;
 import org.apache.hadoop.ozone.client.OzoneVolume;
-import org.apache.hadoop.ozone.om.KeyManagerImpl;
-import org.apache.hadoop.ozone.om.OMConfigKeys;
+import org.apache.hadoop.ozone.om.OmConfig;
 import org.apache.hadoop.ozone.om.OmSnapshotManager;
 import org.apache.hadoop.ozone.om.OzoneManager;
 import org.apache.hadoop.ozone.om.exceptions.OMException;
+import org.apache.hadoop.ozone.om.helpers.BucketLayout;
 import org.apache.hadoop.ozone.om.helpers.OmKeyArgs;
 import org.apache.hadoop.ozone.om.helpers.OpenKeySession;
 import org.apache.hadoop.ozone.om.helpers.SnapshotInfo;
 import org.apache.hadoop.ozone.om.protocol.OzoneManagerProtocol;
 import org.apache.hadoop.security.UserGroupInformation;
 import org.apache.ozone.test.GenericTestUtils;
+import org.apache.ozone.test.NonHATests;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeAll;
@@ -99,72 +95,53 @@
  * Abstract class for OmSnapshot file system tests.
  */
 @TestInstance(TestInstance.Lifecycle.PER_CLASS)
-public abstract class TestOmSnapshotFileSystem {
-  protected static final String VOLUME_NAME =
-      "volume" + RandomStringUtils.secure().nextNumeric(5);
-  protected static final String BUCKET_NAME_FSO =
-      "bucket-fso-" + RandomStringUtils.secure().nextNumeric(5);
-  protected static final String BUCKET_NAME_LEGACY =
-      "bucket-legacy-" + RandomStringUtils.secure().nextNumeric(5);
-
-  private MiniOzoneCluster cluster = null;
+public abstract class TestOmSnapshotFileSystem implements NonHATests.TestCase {
+
   private OzoneClient client;
   private ObjectStore objectStore;
   private OzoneConfiguration conf;
   private OzoneManagerProtocol writeClient;
   private OzoneManager ozoneManager;
   private String keyPrefix;
-  private final String bucketName;
+  private String volumeName;
+  private String bucketName;
+  private final BucketLayout bucketLayout;
   private final boolean createLinkedBuckets;
   private FileSystem fs;
   private OzoneFileSystem o3fs;
-  private Map<String, String> linkedBucketMaps = new HashMap<>();
+  private final Map<String, String> linkedBucketMaps = new HashMap<>();
+  private OmConfig originalOmConfig;
 
   private static final Logger LOG =
-      LoggerFactory.getLogger(TestOmSnapshot.class);
+      LoggerFactory.getLogger(TestOmSnapshotFileSystem.class);
 
-  public TestOmSnapshotFileSystem(String bucketName, boolean createLinkedBuckets) throws Exception {
-    this.bucketName = bucketName;
+  protected TestOmSnapshotFileSystem(BucketLayout layout, boolean createLinkedBuckets) {
+    this.bucketLayout = layout;
     this.createLinkedBuckets = createLinkedBuckets;
-    init();
   }
 
-  private void init() throws Exception {
-    conf = new OzoneConfiguration();
-    conf.setBoolean(OMConfigKeys.OZONE_OM_ENABLE_FILESYSTEM_PATHS, true);
-    cluster = MiniOzoneCluster.newBuilder(conf).build();
-    cluster.waitForClusterToBeReady();
-    client = cluster.newClient();
+  @BeforeAll
+  public void setupFsClient() throws IOException {
+    OmConfig omConfig = cluster().getOzoneManager().getConfig();
+    originalOmConfig = omConfig.copy();
+    omConfig.setFileSystemPathEnabled(true);
+
+    client = cluster().newClient();
 
     objectStore = client.getObjectStore();
     writeClient = objectStore.getClientProxy().getOzoneManagerClient();
-    ozoneManager = cluster.getOzoneManager();
+    ozoneManager = cluster().getOzoneManager();
 
-    TestDataUtil.createVolume(client, VOLUME_NAME);
-    OzoneBucket bucket = TestDataUtil.createBucket(client, VOLUME_NAME,
-        new BucketArgs.Builder().setBucketLayout(FILE_SYSTEM_OPTIMIZED).build(),
-        BUCKET_NAME_FSO, createLinkedBuckets);
+    OzoneBucket bucket = TestDataUtil.createVolumeAndBucket(client, bucketLayout, createLinkedBuckets);
     if (createLinkedBuckets) {
       linkedBucketMaps.put(bucket.getName(), bucket.getSourceBucket());
     }
-    bucket = TestDataUtil.createBucket(client, VOLUME_NAME,
-        new BucketArgs.Builder().setBucketLayout(LEGACY).build(),
-        BUCKET_NAME_LEGACY, createLinkedBuckets);
-    if (createLinkedBuckets) {
-      linkedBucketMaps.put(bucket.getName(), bucket.getSourceBucket());
-    }
-
-
-
-    // stop the deletion services so that keys can still be read
-    KeyManagerImpl keyManager = (KeyManagerImpl) ozoneManager.getKeyManager();
-    keyManager.stop();
-  }
+    volumeName = bucket.getVolumeName();
+    bucketName = bucket.getName();
 
-  @BeforeAll
-  public void setupFsClient() throws IOException {
     String rootPath = String.format("%s://%s.%s/",
-        OzoneConsts.OZONE_URI_SCHEME, bucketName, VOLUME_NAME);
+        OzoneConsts.OZONE_URI_SCHEME, bucketName, volumeName);
+    conf = new OzoneConfiguration(cluster().getConf());
     // Set the fs.defaultFS and start the filesystem
     conf.set(CommonConfigurationKeysPublic.FS_DEFAULT_NAME_KEY, rootPath);
     // Set the number of keys to be processed during batch operate.
@@ -177,9 +154,7 @@ public void setupFsClient() throws IOException {
   void tearDown() {
     IOUtils.closeQuietly(client);
     IOUtils.closeQuietly(fs);
-    if (cluster != null) {
-      cluster.shutdown();
-    }
+    cluster().getOzoneManager().getConfig().setFrom(originalOmConfig);
   }
 
   /**
@@ -198,24 +173,16 @@ public void deleteRootDir()
     }
 
     for (FileStatus fStatus : fileStatuses) {
+      assertEquals(fs.getScheme(), fStatus.getPath().toUri().getScheme(), "unexpected scheme");
       fs.delete(fStatus.getPath(), true);
     }
-
-
-    GenericTestUtils.waitFor(() -> {
-      try {
-        return fs.listStatus(root).length == 0;
-      } catch (Exception e) {
-        return false;
-      }
-    }, 1000, 120000);
   }
 
   @Test
   // based on TestObjectStoreWithFSO:testListKeysAtDifferentLevels
   public void testListKeysAtDifferentLevels() throws Exception {
-    OzoneVolume ozoneVolume = objectStore.getVolume(VOLUME_NAME);
-    assertEquals(ozoneVolume.getName(), VOLUME_NAME);
+    OzoneVolume ozoneVolume = objectStore.getVolume(volumeName);
+    assertEquals(ozoneVolume.getName(), volumeName);
     OzoneBucket ozoneBucket = ozoneVolume.getBucket(bucketName);
     assertEquals(ozoneBucket.getName(), bucketName);
 
@@ -282,7 +249,7 @@ public void testListKeysAtDifferentLevels() throws Exception {
     deleteSnapshot(snapshotName);
     String expectedMessage = String.format("Unable to load snapshot. " +
             "Snapshot with table key '/%s/%s/%s' is no longer active",
-        VOLUME_NAME, linkedBucketMaps.getOrDefault(bucketName, bucketName), snapshotName);
+        volumeName, linkedBucketMaps.getOrDefault(bucketName, bucketName), snapshotName);
     OMException exception = assertThrows(OMException.class,
         () -> ozoneBucket.listKeys(keyPrefix + "a/", null));
     assertEquals(expectedMessage, exception.getMessage());
@@ -370,7 +337,7 @@ private void readkey(OzoneBucket ozoneBucket, String key, int length, byte[] inp
 
     // Read using filesystem.
     String rootPath = String.format("%s://%s.%s/", OZONE_URI_SCHEME,
-        bucketName, VOLUME_NAME);
+        bucketName, volumeName);
     OzoneFileSystem o3fsNew = (OzoneFileSystem) FileSystem
         .get(new URI(rootPath), conf);
     try (InputStream fsDataInputStream = o3fsNew.open(new Path(key))) {
@@ -497,21 +464,21 @@ public void testListStatus() throws Exception {
         () -> fs.listStatus(snapshotRoot1));
     assertEquals(String.format("Unable to load snapshot. " +
             "Snapshot with table key '/%s/%s/%s' is no longer active",
-        VOLUME_NAME, linkedBucketMaps.getOrDefault(bucketName, bucketName), snapshotName1), exception1.getMessage());
+        volumeName, linkedBucketMaps.getOrDefault(bucketName, bucketName), snapshotName1), exception1.getMessage());
 
     deleteSnapshot(snapshotName2);
     FileNotFoundException exception2 = assertThrows(FileNotFoundException.class,
         () -> fs.listStatus(snapshotRoot2));
     assertEquals(String.format("Unable to load snapshot. " +
             "Snapshot with table key '/%s/%s/%s' is no longer active",
-        VOLUME_NAME, linkedBucketMaps.getOrDefault(bucketName, bucketName), snapshotName2), exception2.getMessage());
+        volumeName, linkedBucketMaps.getOrDefault(bucketName, bucketName), snapshotName2), exception2.getMessage());
 
     deleteSnapshot(snapshotName3);
     FileNotFoundException exception3 = assertThrows(FileNotFoundException.class,
         () -> fs.listStatus(snapshotParent3));
     assertEquals(String.format("Unable to load snapshot. " +
             "Snapshot with table key '/%s/%s/%s' is no longer active",
-        VOLUME_NAME, linkedBucketMaps.getOrDefault(bucketName, bucketName), snapshotName3), exception3.getMessage());
+        volumeName, linkedBucketMaps.getOrDefault(bucketName, bucketName), snapshotName3), exception3.getMessage());
   }
 
   @Test
@@ -546,7 +513,7 @@ public void testListStatusWithIntermediateDir() throws Exception {
         () -> fs.listStatus(snapshotParent));
     assertEquals(String.format("Unable to load snapshot. " +
             "Snapshot with table key '/%s/%s/%s' is no longer active",
-        VOLUME_NAME, linkedBucketMaps.getOrDefault(bucketName, bucketName), snapshotName), exception.getMessage());
+        volumeName, linkedBucketMaps.getOrDefault(bucketName, bucketName), snapshotName), exception.getMessage());
   }
 
   @Test
@@ -582,7 +549,7 @@ public void testGetFileStatus() throws Exception {
         () -> fs.listStatus(snapshotParent));
     assertEquals(String.format("Unable to load snapshot. " +
             "Snapshot with table key '/%s/%s/%s' is no longer active",
-        VOLUME_NAME, linkedBucketMaps.getOrDefault(bucketName, bucketName), snapshotName), exception.getMessage());
+        volumeName, linkedBucketMaps.getOrDefault(bucketName, bucketName), snapshotName), exception.getMessage());
   }
 
   @Test
@@ -623,11 +590,11 @@ void testReadFileFromSnapshot() throws Exception {
         () -> fs.open(fileInSnapshot));
     assertEquals(String.format("FILE_NOT_FOUND: Unable to load snapshot. " +
             "Snapshot with table key '/%s/%s/%s' is no longer active",
-        VOLUME_NAME, linkedBucketMaps.getOrDefault(bucketName, bucketName), snapshotName), exception.getMessage());
+        volumeName, linkedBucketMaps.getOrDefault(bucketName, bucketName), snapshotName), exception.getMessage());
   }
 
   private void createAndCommitKey(String keyName) throws IOException {
-    OmKeyArgs keyArgs = new OmKeyArgs.Builder().setVolumeName(VOLUME_NAME)
+    OmKeyArgs keyArgs = new OmKeyArgs.Builder().setVolumeName(volumeName)
         .setBucketName(bucketName).setKeyName(keyName)
         .setAcls(Collections.emptyList())
         .setReplicationConfig(StandaloneReplicationConfig.getInstance(ONE))
@@ -673,7 +640,7 @@ public void testListStatusOnRoot() throws Exception {
         () -> fs.listStatus(snapshotRoot));
     assertEquals(String.format("Unable to load snapshot. " +
             "Snapshot with table key '/%s/%s/%s' is no longer active",
-        VOLUME_NAME, linkedBucketMaps.getOrDefault(bucketName, bucketName), snapshotName), exception.getMessage());
+        volumeName, linkedBucketMaps.getOrDefault(bucketName, bucketName), snapshotName), exception.getMessage());
   }
 
   /**
@@ -728,17 +695,17 @@ public void testListStatusOnLargeDirectory() throws Exception {
         () -> fs.listStatus(snapshotRoot));
     assertEquals(String.format("Unable to load snapshot. " +
             "Snapshot with table key '/%s/%s/%s' is no longer active",
-        VOLUME_NAME, linkedBucketMaps.getOrDefault(bucketName, bucketName), snapshotName), exception.getMessage());
+        volumeName, linkedBucketMaps.getOrDefault(bucketName, bucketName), snapshotName), exception.getMessage());
   }
 
   private String createSnapshot(String snapshotName)
       throws IOException, InterruptedException, TimeoutException {
 
     // create snapshot
-    writeClient.createSnapshot(VOLUME_NAME, bucketName, snapshotName);
+    writeClient.createSnapshot(volumeName, bucketName, snapshotName);
 
     // wait till the snapshot directory exists
-    OzoneSnapshot snapshot = objectStore.getSnapshotInfo(VOLUME_NAME, bucketName, snapshotName);
+    OzoneSnapshot snapshot = objectStore.getSnapshotInfo(volumeName, bucketName, snapshotName);
     SnapshotInfo snapshotInfo = ozoneManager.getMetadataManager()
         .getSnapshotInfoTable()
         .get(SnapshotInfo.getTableKey(snapshot.getVolumeName(), snapshot.getBucketName(), snapshotName));
@@ -751,6 +718,6 @@ private String createSnapshot(String snapshotName)
   }
 
   private void deleteSnapshot(String snapshotName) throws IOException {
-    writeClient.deleteSnapshot(VOLUME_NAME, bucketName, snapshotName);
+    writeClient.deleteSnapshot(volumeName, bucketName, snapshotName);
   }
 }