PR Checks

Author: Anuj Modi

hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/AbfsConfiguration.java

@@ -959,7 +959,7 @@ public AccessTokenProvider getTokenProvider() throws TokenAccessProviderExceptio
    * requires relying on the raw configurations. It is more stable to depend on the
    * AbfsConfiguration with which a filesystem is initialized,
    * and eliminate chances of dynamic modifications and spurious situations.
-   * @return sasTokenProvider object
+   * @return sasTokenProvider object.
    * @throws AzureBlobFileSystemException
    */
   public SASTokenProvider getSASTokenProvider() throws AzureBlobFileSystemException {

hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/AzureBlobFileSystem.java

@@ -1308,7 +1308,6 @@ public void access(final Path path, final FsAction mode) throws IOException {
 
   /**
    * Incrementing exists() calls from superclass for statistic collection.
-   *
    * @param f source path.
    * @return true if the path exists.
    * @throws IOException

hadoop-tools/hadoop-azure/src/test/java/org/apache/hadoop/fs/azurebfs/ITestAzureBlobFileSystemChooseSAS.java

@@ -39,14 +39,19 @@
 
 /**
  * Tests to validate the choice between using a SASTokenProvider to generate
- * a SAS or using a Fixed SAS Token configured by user. To differentiate which config was used we will use different type of SAS Tokens.
- * For Fixed SAS Token we will use an Account SAS with permissions to do File system level operations.
- * For SASTokenProvider we will use a User Delegation SAS Token Provider such that File System level operations are not permitted.
+ * a SAS or using a Fixed SAS Token configured by user.
  */
 public class ITestAzureBlobFileSystemChooseSAS extends AbstractAbfsIntegrationTest{
 
   private String accountSAS = null;
 
+
+  /**
+   * To differentiate which config was used we will use different type of SAS Tokens.
+   * For Fixed SAS Token we will use an Account SAS with permissions to do File system level operations.
+   * For SASTokenProvider we will use a User Delegation SAS Token Provider
+   * such that File System level operations are not permitted.
+   */
   public ITestAzureBlobFileSystemChooseSAS() throws Exception {
     // SAS Token configured might not have permissions for creating file system.
     // Shared Key must be configured to create one. Once created, a new instance
@@ -61,7 +66,7 @@ public void setup() throws Exception {
     generateAccountSAS();  }
 
   /**
-   * Generates a Account SAS Token using the Account Shared Key to be used as a fixed SAS Token
+   * Generates a Account SAS Token using the Account Shared Key to be used as a fixed SAS Token.
    * This will be used by individual tests to set in the configurations.
    * @throws AzureBlobFileSystemException
    */
@@ -72,7 +77,7 @@ private void generateAccountSAS() throws AzureBlobFileSystemException {
   }
 
   /**
-   * Tests the scenario where both the SASTokenProvider and a fixed SAS token are configured:
+   * Tests the scenario where both the SASTokenProvider and a fixed SAS token are configured.
    * SASTokenProvider class should be chosen and User Delegation SAS should be used.
    * @throws Exception
    */
@@ -85,10 +90,10 @@ public void testBothProviderFixedTokenConfigured() throws Exception {
     testAbfsConfig.set(FS_AZURE_SAS_TOKEN_PROVIDER_TYPE,
         MockDelegationSASTokenProvider.class.getName());
 
-    // configuring the Fixed SAS token which is an Account SAS
+    // configuring the Fixed SAS token which is an Account SAS.
     testAbfsConfig.set(FS_AZURE_SAS_FIXED_TOKEN, accountSAS);
 
-    // Creating a new file system with updated configs
+    // Creating a new file system with updated configs.
     try (AzureBlobFileSystem newTestFs = (AzureBlobFileSystem)
         FileSystem.newInstance(testAbfsConfig.getRawConfiguration())) {
       TracingContext tracingContext = getTestTracingContext(newTestFs, true);
@@ -98,14 +103,14 @@ public void testBothProviderFixedTokenConfigured() throws Exception {
             newTestFs.getAbfsStore().getFilesystemProperties(tracingContext);
           });
 
-      // Asserting that User delegation SAS token is otherwise valid and blob level operations succeed
+      // Asserting that User delegation SAS token is otherwise valid and blob level operations succeed.
       Path testPath = new Path("/testCorrectSASToken");
       newTestFs.create(testPath).close();
     }
   }
 
   /**
-   * Tests the scenario where only the fixed token is configured, and no token provider class is set:
+   * Tests the scenario where only the fixed token is configured, and no token provider class is set.
    * Account SAS Token configured as fixed SAS should be used.
    * @throws IOException
    */
@@ -114,10 +119,10 @@ public void testOnlyFixedTokenConfigured() throws IOException {
     AbfsConfiguration testAbfsConfig = getConfiguration();
     removeAnyPresetConfiguration(testAbfsConfig);
 
-    // setting an account SAS token in the fixed token field
+    // setting an account SAS token in the fixed token field.
     testAbfsConfig.set(FS_AZURE_SAS_FIXED_TOKEN, accountSAS);
 
-    // Creating a new filesystem with updated configs
+    // Creating a new filesystem with updated configs.
     try (AzureBlobFileSystem newTestFs = (AzureBlobFileSystem)
         FileSystem.newInstance(testAbfsConfig.getRawConfiguration())) {
 
@@ -130,8 +135,8 @@ public void testOnlyFixedTokenConfigured() throws IOException {
   }
 
   /**
-   * Tests the scenario where both the token provider class and the fixed token are not configured:
-   * whether the code errors out at the initialization stage itself
+   * Tests the scenario where both the token provider class and the fixed token are not configured.
+   * The code errors out at the initialization stage itself.
    * @throws IOException
    */
   @Test

hadoop-tools/hadoop-azure/src/test/java/org/apache/hadoop/fs/azurebfs/extensions/MockDelegationSASTokenProvider.java

@@ -40,7 +40,7 @@
 import org.apache.hadoop.security.AccessControlException;
 
 /**
- * A mock SAS token provider implementation
+ * A mock SAS token provider implementation.
  */
 public class MockDelegationSASTokenProvider implements SASTokenProvider {
 

hadoop-tools/hadoop-azure/src/test/java/org/apache/hadoop/fs/azurebfs/extensions/MockSASTokenProvider.java

@@ -32,8 +32,8 @@
 import org.apache.hadoop.fs.azurebfs.utils.ServiceSASGenerator;
 
 /**
- * A mock SAS token provider implementation for testing purpose
- * Account SAS with full permission is created using storage account key
+ * A mock SAS token provider implementation for testing purpose.
+ * Account SAS with full permission is created using storage account key.
  */
 public class MockSASTokenProvider implements SASTokenProvider {
 

hadoop-tools/hadoop-azure/src/test/java/org/apache/hadoop/fs/azurebfs/utils/AccountSASGenerator.java

@@ -30,8 +30,8 @@
 public class AccountSASGenerator extends SASGenerator {
   /**
    * Creates Account SAS from Storage Account Key.
-   * https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas
-   * @param accountKey: the storage account key
+   * https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas.
+   * @param accountKey: the storage account key.
    */
   public AccountSASGenerator(byte[] accountKey) {
     super(accountKey);

hadoop-tools/hadoop-azure/src/test/java/org/apache/hadoop/fs/azurebfs/utils/SASGenerator.java

@@ -70,7 +70,7 @@ private SASGenerator() {
 
   /**
    * Called by subclasses to initialize the cryptographic SHA-256 HMAC provider.
-   * @param key - a 256-bit secret key
+   * @param key - a 256-bit secret key.
    */
   protected SASGenerator(byte[] key) {
     this.key = key;

hadoop-tools/hadoop-azure/src/test/java/org/apache/hadoop/fs/azurebfs/utils/ServiceSASGenerator.java

@@ -25,14 +25,14 @@
 
 /**
  * Test Service SAS Generator.
- * SAS Generated by this will have full access to specified container(filesystem)
+ * SAS Generated by this will have full access to specified container(filesystem).
  */
 public class ServiceSASGenerator extends SASGenerator {
 
   /**
-   * Creates a SAS Generator for Service SAS
+   * Creates a SAS Generator for Service SAS.
    * (https://docs.microsoft.com/en-us/rest/api/storageservices/create-service-sas).
-   * @param accountKey - the storage account key
+   * @param accountKey - the storage account key.
    */
   public ServiceSASGenerator(byte[] accountKey) {
     super(accountKey);
@@ -70,7 +70,7 @@ private String computeSignatureForSAS(String sp, String st, String se, String sv
     sb.append("\n");
     sb.append(se);
     sb.append("\n");
-    // canonicalized resource
+    // canonicalize resource
     sb.append("/blob/");
     sb.append(accountName);
     sb.append("/");