GH-39292 [C++][FS]: Remove the AzureBackend enum and add more flexible connection options#39293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
felipecrv merged 1 commit into from
Dec 19, 2023
Merged

GH-39292 [C++][FS]: Remove the AzureBackend enum and add more flexible connection options #39293

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 40 additions & 21 deletions cpp/src/arrow/filesystem/azurefs.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,10 +51,12 @@ AzureOptions::~AzureOptions() = default;

bool AzureOptions::Equals(const AzureOptions& other) const {
// TODO(GH-38598): update here when more auth methods are added.
const bool equals = backend == other.backend &&
const bool equals = blob_storage_authority == other.blob_storage_authority &&
dfs_storage_authority == other.dfs_storage_authority &&
blob_storage_scheme == other.blob_storage_scheme &&
dfs_storage_scheme == other.dfs_storage_scheme &&
default_metadata == other.default_metadata &&
account_blob_url_ == other.account_blob_url_ &&
account_dfs_url_ == other.account_dfs_url_ &&
account_name_ == other.account_name_ &&
credential_kind_ == other.credential_kind_;
if (!equals) {
return false;
Expand All@@ -72,42 +74,59 @@ bool AzureOptions::Equals(const AzureOptions& other) const {
return false;
}

void AzureOptions::SetUrlsForAccountName(const std::string& account_name) {
if (this->backend == AzureBackend::kAzurite) {
account_blob_url_ = "http://127.0.0.1:10000/" + account_name + "/";
account_dfs_url_ = "http://127.0.0.1:10000/" + account_name + "/";
} else {
account_dfs_url_ = "https://" + account_name + ".dfs.core.windows.net/";
account_blob_url_ = "https://" + account_name + ".blob.core.windows.net/";
namespace {
std::string BuildBaseUrl(const std::string& scheme, const std::string& authority,
const std::string& account_name) {
std::string url;
url += scheme + "://";
if (!authority.empty()) {

@koukouDec 19, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that we should reject empty authority because it builds no host part URL.

@felipecrvfelipecrvDec 19, 2023

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My reasoning here is that there are many validations I could apply, but the most complete validation will come from the error messages triggered by using the filesystem with a bogus URL with 3 slashes after https:.

if (authority[0] == '.') {
url += account_name;
url += authority;
} else {
url += authority;
url += "/";
url += account_name;
}
}
url += "/";
return url;
}
} // namespace

Status AzureOptions::ConfigureDefaultCredential(const std::string& account_name) {
AzureOptions::SetUrlsForAccountName(account_name);
credential_kind_ = CredentialKind::kTokenCredential;
token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
return Status::OK();
std::string AzureOptions::AccountBlobUrl(const std::string& account_name) const {
return BuildBaseUrl(blob_storage_scheme, blob_storage_authority, account_name);
}

std::string AzureOptions::AccountDfsUrl(const std::string& account_name) const {
return BuildBaseUrl(dfs_storage_scheme, dfs_storage_authority, account_name);
}

Status AzureOptions::ConfigureAccountKeyCredential(const std::string& account_name,
const std::string& account_key) {
AzureOptions::SetUrlsForAccountName(account_name);
credential_kind_ = CredentialKind::kStorageSharedKeyCredential;
account_name_ = account_name;
storage_shared_key_credential_ =
std::make_shared<Storage::StorageSharedKeyCredential>(account_name, account_key);
return Status::OK();
}

Status AzureOptions::ConfigureDefaultCredential(const std::string& account_name) {
credential_kind_ = CredentialKind::kTokenCredential;
token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
return Status::OK();
}

Result<std::unique_ptr<Blobs::BlobServiceClient>> AzureOptions::MakeBlobServiceClient()
const {
switch (credential_kind_) {
case CredentialKind::kAnonymous:
break;
case CredentialKind::kTokenCredential:
return std::make_unique<Blobs::BlobServiceClient>(account_blob_url_,
return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name_),
token_credential_);
case CredentialKind::kStorageSharedKeyCredential:
return std::make_unique<Blobs::BlobServiceClient>(account_blob_url_,
return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name_),
storage_shared_key_credential_);
}
return Status::Invalid("AzureOptions doesn't contain a valid auth configuration");
Expand All@@ -119,11 +138,11 @@ AzureOptions::MakeDataLakeServiceClient() const {
case CredentialKind::kAnonymous:
break;
case CredentialKind::kTokenCredential:
return std::make_unique<DataLake::DataLakeServiceClient>(account_dfs_url_,
token_credential_);
return std::make_unique<DataLake::DataLakeServiceClient>(
AccountDfsUrl(account_name_), token_credential_);
case CredentialKind::kStorageSharedKeyCredential:
return std::make_unique<DataLake::DataLakeServiceClient>(
account_dfs_url_, storage_shared_key_credential_);
AccountDfsUrl(account_name_), storage_shared_key_credential_);
}
return Status::Invalid("AzureOptions doesn't contain a valid auth configuration");
}
Expand Down
51 changes: 33 additions & 18 deletions cpp/src/arrow/filesystem/azurefs.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,17 +43,37 @@ class DataLakeServiceClient;

namespace arrow::fs {

enum class AzureBackend {
/// \brief Official Azure Remote Backend
kAzure,
/// \brief Local Simulated Storage
kAzurite
};

/// Options for the AzureFileSystem implementation.
struct ARROW_EXPORT AzureOptions {
/// \brief The backend to connect to: Azure or Azurite (for testing).
AzureBackend backend = AzureBackend::kAzure;
/// \brief hostname[:port] of the Azure Blob Storage Service.
///
/// If the hostname is a relative domain name (one that starts with a '.'), then storage
/// account URLs will be constructed by prepending the account name to the hostname.
/// If the hostname is a fully qualified domain name, then the hostname will be used
/// as-is and the account name will follow the hostname in the URL path.
///
/// Default: ".blob.core.windows.net"
std::string blob_storage_authority = ".blob.core.windows.net";

/// \brief hostname[:port] of the Azure Data Lake Storage Gen 2 Service.
///
/// If the hostname is a relative domain name (one that starts with a '.'), then storage
/// account URLs will be constructed by prepending the account name to the hostname.
/// If the hostname is a fully qualified domain name, then the hostname will be used
/// as-is and the account name will follow the hostname in the URL path.
///
/// Default: ".dfs.core.windows.net"
std::string dfs_storage_authority = ".dfs.core.windows.net";

/// \brief Azure Blob Storage connection transport.
///
/// Default: "https"
std::string blob_storage_scheme = "https";

/// \brief Azure Data Lake Storage Gen 2 connection transport.
///
/// Default: "https"
std::string dfs_storage_scheme = "https";

// TODO(GH-38598): Add support for more auth methods.
// std::string connection_string;
Expand All@@ -65,22 +85,17 @@ struct ARROW_EXPORT AzureOptions {
std::shared_ptr<const KeyValueMetadata> default_metadata;

private:
std::string account_blob_url_;
std::string account_dfs_url_;

enum class CredentialKind {
kAnonymous,
kTokenCredential,
kStorageSharedKeyCredential,
} credential_kind_ = CredentialKind::kAnonymous;

std::string account_name_;
std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;
std::shared_ptr<Azure::Storage::StorageSharedKeyCredential>
storage_shared_key_credential_;

std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;

void SetUrlsForAccountName(const std::string& account_name);

public:
AzureOptions();
~AzureOptions();
Expand All@@ -92,8 +107,8 @@ struct ARROW_EXPORT AzureOptions {

bool Equals(const AzureOptions& other) const;

const std::string& AccountBlobUrl() const { return account_blob_url_; }
const std::string& AccountDfsUrl() const { return account_dfs_url_; }
std::string AccountBlobUrl(const std::string& account_name) const;
std::string AccountDfsUrl(const std::string& account_name) const;

Result<std::unique_ptr<Azure::Storage::Blobs::BlobServiceClient>>
MakeBlobServiceClient() const;
Expand Down
21 changes: 18 additions & 3 deletions cpp/src/arrow/filesystem/azurefs_test.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,13 @@ namespace Blobs = Azure::Storage::Blobs;
namespace Core = Azure::Core;
namespace DataLake = Azure::Storage::Files::DataLake;

enum class AzureBackend {
/// \brief Official Azure Remote Backend
kAzure,
/// \brief Local Simulated Storage
kAzurite
};

class BaseAzureEnv : public ::testing::Environment {
protected:
std::string account_name_;
Expand DownExpand Up@@ -265,8 +272,6 @@ class AzureHierarchicalNSEnv : public AzureEnvImpl<AzureHierarchicalNSEnv> {

TEST(AzureFileSystem, InitializeFilesystemWithDefaultCredential) {
AzureOptions options;
options.backend = AzureBackend::kAzurite; // Irrelevant for this test because it
// doesn't connect to the server.
ARROW_EXPECT_OK(options.ConfigureDefaultCredential("dummy-account-name"));
EXPECT_OK_AND_ASSIGN(auto default_credential_fs, AzureFileSystem::Make(options));
}
Expand DownExpand Up@@ -352,7 +357,17 @@ class TestAzureFileSystem : public ::testing::Test {

static Result<AzureOptions> MakeOptions(BaseAzureEnv* env) {
AzureOptions options;
options.backend = env->backend();
switch (env->backend()) {
case AzureBackend::kAzurite:
options.blob_storage_authority = "127.0.0.1:10000";
options.dfs_storage_authority = "127.0.0.1:10000";
options.blob_storage_scheme = "http";
options.dfs_storage_scheme = "http";
break;
case AzureBackend::kAzure:
// Use the default values
break;
}
ARROW_EXPECT_OK(
options.ConfigureAccountKeyCredential(env->account_name(), env->account_key()));
return options;
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
GH-39292 [C++][FS]: Remove the AzureBackend enum and add more flexible connection options#39293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

felipecrv
merged 1 commit into

from

Dec 19, 2023
 Merged


GH-39292 [C++][FS]: Remove the AzureBackend enum and add more flexible connection options
#39293
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


61 changes: 40 additions & 21 deletions
cpp/src/arrow/filesystem/azurefs.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -51,10 +51,12 @@ AzureOptions::~AzureOptions() = default;

bool AzureOptions::Equals(const AzureOptions& other) const {
 // TODO(GH-38598): update here when more auth methods are added.
 const bool equals = backend == other.backend &&
 const bool equals = blob_storage_authority == other.blob_storage_authority &&
 dfs_storage_authority == other.dfs_storage_authority &&
 blob_storage_scheme == other.blob_storage_scheme &&
 dfs_storage_scheme == other.dfs_storage_scheme &&
 default_metadata == other.default_metadata &&
 account_blob_url_ == other.account_blob_url_ &&
 account_dfs_url_ == other.account_dfs_url_ &&
 account_name_ == other.account_name_ &&
 credential_kind_ == other.credential_kind_;
 if (!equals) {
 return false;
Expand All@@ -72,42 +74,59 @@ bool AzureOptions::Equals(const AzureOptions& other) const {
 return false;
}

void AzureOptions::SetUrlsForAccountName(const std::string& account_name) {
 if (this->backend == AzureBackend::kAzurite) {
 account_blob_url_ = "http://127.0.0.1:10000/" + account_name + "/";
 account_dfs_url_ = "http://127.0.0.1:10000/" + account_name + "/";
 } else {
 account_dfs_url_ = "https://" + account_name + ".dfs.core.windows.net/";
 account_blob_url_ = "https://" + account_name + ".blob.core.windows.net/";
namespace {
std::string BuildBaseUrl(const std::string& scheme, const std::string& authority,
 const std::string& account_name) {
 std::string url;
 url += scheme + "://";
 if (!authority.empty()) {
@koukouDec 19, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that we should reject empty authority because it builds no host part URL.
@felipecrvfelipecrvDec 19, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My reasoning here is that there are many validations I could apply, but the most complete validation will come from the error messages triggered by using the filesystem with a bogus URL with 3 slashes after https:.
 if (authority[0] == '.') {
 url += account_name;
 url += authority;
 } else {
 url += authority;
 url += "/";
 url += account_name;
 }
 }
 url += "/";
 return url;
}
} // namespace

Status AzureOptions::ConfigureDefaultCredential(const std::string& account_name) {
 AzureOptions::SetUrlsForAccountName(account_name);
 credential_kind_ = CredentialKind::kTokenCredential;
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 return Status::OK();
std::string AzureOptions::AccountBlobUrl(const std::string& account_name) const {
 return BuildBaseUrl(blob_storage_scheme, blob_storage_authority, account_name);
}

std::string AzureOptions::AccountDfsUrl(const std::string& account_name) const {
 return BuildBaseUrl(dfs_storage_scheme, dfs_storage_authority, account_name);
}

Status AzureOptions::ConfigureAccountKeyCredential(const std::string& account_name,
 const std::string& account_key) {
 AzureOptions::SetUrlsForAccountName(account_name);
 credential_kind_ = CredentialKind::kStorageSharedKeyCredential;
 account_name_ = account_name;
 storage_shared_key_credential_ =
 std::make_shared<Storage::StorageSharedKeyCredential>(account_name, account_key);
 return Status::OK();
}

Status AzureOptions::ConfigureDefaultCredential(const std::string& account_name) {
 credential_kind_ = CredentialKind::kTokenCredential;
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 return Status::OK();
}

Result<std::unique_ptr<Blobs::BlobServiceClient>> AzureOptions::MakeBlobServiceClient()
 const {
 switch (credential_kind_) {
 case CredentialKind::kAnonymous:
 break;
 case CredentialKind::kTokenCredential:
 return std::make_unique<Blobs::BlobServiceClient>(account_blob_url_,
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name_),
 token_credential_);
 case CredentialKind::kStorageSharedKeyCredential:
 return std::make_unique<Blobs::BlobServiceClient>(account_blob_url_,
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name_),
 storage_shared_key_credential_);
 }
 return Status::Invalid("AzureOptions doesn't contain a valid auth configuration");
Expand All@@ -119,11 +138,11 @@ AzureOptions::MakeDataLakeServiceClient() const {
 case CredentialKind::kAnonymous:
 break;
 case CredentialKind::kTokenCredential:
 return std::make_unique<DataLake::DataLakeServiceClient>(account_dfs_url_,
 token_credential_);
 return std::make_unique<DataLake::DataLakeServiceClient>(
AccountDfsUrl(account_name_), token_credential_);
 case CredentialKind::kStorageSharedKeyCredential:
 return std::make_unique<DataLake::DataLakeServiceClient>(
account_dfs_url_, storage_shared_key_credential_);
AccountDfsUrl(account_name_), storage_shared_key_credential_);
 }
 return Status::Invalid("AzureOptions doesn't contain a valid auth configuration");
}
Expand Down

51 changes: 33 additions & 18 deletions
cpp/src/arrow/filesystem/azurefs.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,17 +43,37 @@ class DataLakeServiceClient;

namespace arrow::fs {

enum class AzureBackend {
 /// \brief Official Azure Remote Backend
 kAzure,
 /// \brief Local Simulated Storage
 kAzurite
};

/// Options for the AzureFileSystem implementation.
struct ARROW_EXPORT AzureOptions {
 /// \brief The backend to connect to: Azure or Azurite (for testing).
 AzureBackend backend = AzureBackend::kAzure;
 /// \brief hostname[:port] of the Azure Blob Storage Service.
 ///
 /// If the hostname is a relative domain name (one that starts with a '.'), then storage
 /// account URLs will be constructed by prepending the account name to the hostname.
 /// If the hostname is a fully qualified domain name, then the hostname will be used
 /// as-is and the account name will follow the hostname in the URL path.
 ///
 /// Default: ".blob.core.windows.net"
 std::string blob_storage_authority = ".blob.core.windows.net";

 /// \brief hostname[:port] of the Azure Data Lake Storage Gen 2 Service.
 ///
 /// If the hostname is a relative domain name (one that starts with a '.'), then storage
 /// account URLs will be constructed by prepending the account name to the hostname.
 /// If the hostname is a fully qualified domain name, then the hostname will be used
 /// as-is and the account name will follow the hostname in the URL path.
 ///
 /// Default: ".dfs.core.windows.net"
 std::string dfs_storage_authority = ".dfs.core.windows.net";

 /// \brief Azure Blob Storage connection transport.
 ///
 /// Default: "https"
 std::string blob_storage_scheme = "https";

 /// \brief Azure Data Lake Storage Gen 2 connection transport.
 ///
 /// Default: "https"
 std::string dfs_storage_scheme = "https";

 // TODO(GH-38598): Add support for more auth methods.
 // std::string connection_string;
Expand All@@ -65,22 +85,17 @@ struct ARROW_EXPORT AzureOptions {
 std::shared_ptr<const KeyValueMetadata> default_metadata;

 private:
 std::string account_blob_url_;
 std::string account_dfs_url_;

 enum class CredentialKind {
 kAnonymous,
 kTokenCredential,
 kStorageSharedKeyCredential,
 } credential_kind_ = CredentialKind::kAnonymous;

 std::string account_name_;
 std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;
 std::shared_ptr<Azure::Storage::StorageSharedKeyCredential>
 storage_shared_key_credential_;

 std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;

 void SetUrlsForAccountName(const std::string& account_name);

 public:
 AzureOptions();
 ~AzureOptions();
Expand All@@ -92,8 +107,8 @@ struct ARROW_EXPORT AzureOptions {

 bool Equals(const AzureOptions& other) const;

const std::string& AccountBlobUrl() const { return account_blob_url_; }
const std::string& AccountDfsUrl() const { return account_dfs_url_; }
 std::string AccountBlobUrl(const std::string& account_name) const;
 std::string AccountDfsUrl(const std::string& account_name) const;

 Result<std::unique_ptr<Azure::Storage::Blobs::BlobServiceClient>>
 MakeBlobServiceClient() const;
Expand Down

21 changes: 18 additions & 3 deletions
cpp/src/arrow/filesystem/azurefs_test.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,13 @@ namespace Blobs = Azure::Storage::Blobs;
namespace Core = Azure::Core;
namespace DataLake = Azure::Storage::Files::DataLake;

enum class AzureBackend {
 /// \brief Official Azure Remote Backend
 kAzure,
 /// \brief Local Simulated Storage
 kAzurite
};

class BaseAzureEnv : public ::testing::Environment {
 protected:
 std::string account_name_;
Expand DownExpand Up@@ -265,8 +272,6 @@ class AzureHierarchicalNSEnv : public AzureEnvImpl<AzureHierarchicalNSEnv> {

TEST(AzureFileSystem, InitializeFilesystemWithDefaultCredential) {
 AzureOptions options;
 options.backend = AzureBackend::kAzurite; // Irrelevant for this test because it
 // doesn't connect to the server.
 ARROW_EXPECT_OK(options.ConfigureDefaultCredential("dummy-account-name"));
 EXPECT_OK_AND_ASSIGN(auto default_credential_fs, AzureFileSystem::Make(options));
}
Expand DownExpand Up@@ -352,7 +357,17 @@ class TestAzureFileSystem : public ::testing::Test {

 static Result<AzureOptions> MakeOptions(BaseAzureEnv* env) {
 AzureOptions options;
 options.backend = env->backend();
 switch (env->backend()) {
 case AzureBackend::kAzurite:
 options.blob_storage_authority = "127.0.0.1:10000";
 options.dfs_storage_authority = "127.0.0.1:10000";
 options.blob_storage_scheme = "http";
 options.dfs_storage_scheme = "http";
 break;
 case AzureBackend::kAzure:
 // Use the default values
 break;
 }
 ARROW_EXPECT_OK(
 options.ConfigureAccountKeyCredential(env->account_name(), env->account_key()));
 return options;
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
GH-39292 [C++][FS]: Remove the AzureBackend enum and add more flexible connection options#39293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

felipecrv
merged 1 commit into

from

Dec 19, 2023
 Merged


GH-39292 [C++][FS]: Remove the AzureBackend enum and add more flexible connection options
#39293
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


61 changes: 40 additions & 21 deletions
cpp/src/arrow/filesystem/azurefs.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -51,10 +51,12 @@ AzureOptions::~AzureOptions() = default;

bool AzureOptions::Equals(const AzureOptions& other) const {
 // TODO(GH-38598): update here when more auth methods are added.
 const bool equals = backend == other.backend &&
 const bool equals = blob_storage_authority == other.blob_storage_authority &&
 dfs_storage_authority == other.dfs_storage_authority &&
 blob_storage_scheme == other.blob_storage_scheme &&
 dfs_storage_scheme == other.dfs_storage_scheme &&
 default_metadata == other.default_metadata &&
 account_blob_url_ == other.account_blob_url_ &&
 account_dfs_url_ == other.account_dfs_url_ &&
 account_name_ == other.account_name_ &&
 credential_kind_ == other.credential_kind_;
 if (!equals) {
 return false;
Expand All@@ -72,42 +74,59 @@ bool AzureOptions::Equals(const AzureOptions& other) const {
 return false;
}

void AzureOptions::SetUrlsForAccountName(const std::string& account_name) {
 if (this->backend == AzureBackend::kAzurite) {
 account_blob_url_ = "http://127.0.0.1:10000/" + account_name + "/";
 account_dfs_url_ = "http://127.0.0.1:10000/" + account_name + "/";
 } else {
 account_dfs_url_ = "https://" + account_name + ".dfs.core.windows.net/";
 account_blob_url_ = "https://" + account_name + ".blob.core.windows.net/";
namespace {
std::string BuildBaseUrl(const std::string& scheme, const std::string& authority,
 const std::string& account_name) {
 std::string url;
 url += scheme + "://";
 if (!authority.empty()) {
@koukouDec 19, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that we should reject empty authority because it builds no host part URL.
@felipecrvfelipecrvDec 19, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My reasoning here is that there are many validations I could apply, but the most complete validation will come from the error messages triggered by using the filesystem with a bogus URL with 3 slashes after https:.
 if (authority[0] == '.') {
 url += account_name;
 url += authority;
 } else {
 url += authority;
 url += "/";
 url += account_name;
 }
 }
 url += "/";
 return url;
}
} // namespace

Status AzureOptions::ConfigureDefaultCredential(const std::string& account_name) {
 AzureOptions::SetUrlsForAccountName(account_name);
 credential_kind_ = CredentialKind::kTokenCredential;
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 return Status::OK();
std::string AzureOptions::AccountBlobUrl(const std::string& account_name) const {
 return BuildBaseUrl(blob_storage_scheme, blob_storage_authority, account_name);
}

std::string AzureOptions::AccountDfsUrl(const std::string& account_name) const {
 return BuildBaseUrl(dfs_storage_scheme, dfs_storage_authority, account_name);
}

Status AzureOptions::ConfigureAccountKeyCredential(const std::string& account_name,
 const std::string& account_key) {
 AzureOptions::SetUrlsForAccountName(account_name);
 credential_kind_ = CredentialKind::kStorageSharedKeyCredential;
 account_name_ = account_name;
 storage_shared_key_credential_ =
 std::make_shared<Storage::StorageSharedKeyCredential>(account_name, account_key);
 return Status::OK();
}

Status AzureOptions::ConfigureDefaultCredential(const std::string& account_name) {
 credential_kind_ = CredentialKind::kTokenCredential;
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 return Status::OK();
}

Result<std::unique_ptr<Blobs::BlobServiceClient>> AzureOptions::MakeBlobServiceClient()
 const {
 switch (credential_kind_) {
 case CredentialKind::kAnonymous:
 break;
 case CredentialKind::kTokenCredential:
 return std::make_unique<Blobs::BlobServiceClient>(account_blob_url_,
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name_),
 token_credential_);
 case CredentialKind::kStorageSharedKeyCredential:
 return std::make_unique<Blobs::BlobServiceClient>(account_blob_url_,
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name_),
 storage_shared_key_credential_);
 }
 return Status::Invalid("AzureOptions doesn't contain a valid auth configuration");
Expand All@@ -119,11 +138,11 @@ AzureOptions::MakeDataLakeServiceClient() const {
 case CredentialKind::kAnonymous:
 break;
 case CredentialKind::kTokenCredential:
 return std::make_unique<DataLake::DataLakeServiceClient>(account_dfs_url_,
 token_credential_);
 return std::make_unique<DataLake::DataLakeServiceClient>(
AccountDfsUrl(account_name_), token_credential_);
 case CredentialKind::kStorageSharedKeyCredential:
 return std::make_unique<DataLake::DataLakeServiceClient>(
account_dfs_url_, storage_shared_key_credential_);
AccountDfsUrl(account_name_), storage_shared_key_credential_);
 }
 return Status::Invalid("AzureOptions doesn't contain a valid auth configuration");
}
Expand Down

51 changes: 33 additions & 18 deletions
cpp/src/arrow/filesystem/azurefs.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,17 +43,37 @@ class DataLakeServiceClient;

namespace arrow::fs {

enum class AzureBackend {
 /// \brief Official Azure Remote Backend
 kAzure,
 /// \brief Local Simulated Storage
 kAzurite
};

/// Options for the AzureFileSystem implementation.
struct ARROW_EXPORT AzureOptions {
 /// \brief The backend to connect to: Azure or Azurite (for testing).
 AzureBackend backend = AzureBackend::kAzure;
 /// \brief hostname[:port] of the Azure Blob Storage Service.
 ///
 /// If the hostname is a relative domain name (one that starts with a '.'), then storage
 /// account URLs will be constructed by prepending the account name to the hostname.
 /// If the hostname is a fully qualified domain name, then the hostname will be used
 /// as-is and the account name will follow the hostname in the URL path.
 ///
 /// Default: ".blob.core.windows.net"
 std::string blob_storage_authority = ".blob.core.windows.net";

 /// \brief hostname[:port] of the Azure Data Lake Storage Gen 2 Service.
 ///
 /// If the hostname is a relative domain name (one that starts with a '.'), then storage
 /// account URLs will be constructed by prepending the account name to the hostname.
 /// If the hostname is a fully qualified domain name, then the hostname will be used
 /// as-is and the account name will follow the hostname in the URL path.
 ///
 /// Default: ".dfs.core.windows.net"
 std::string dfs_storage_authority = ".dfs.core.windows.net";

 /// \brief Azure Blob Storage connection transport.
 ///
 /// Default: "https"
 std::string blob_storage_scheme = "https";

 /// \brief Azure Data Lake Storage Gen 2 connection transport.
 ///
 /// Default: "https"
 std::string dfs_storage_scheme = "https";

 // TODO(GH-38598): Add support for more auth methods.
 // std::string connection_string;
Expand All@@ -65,22 +85,17 @@ struct ARROW_EXPORT AzureOptions {
 std::shared_ptr<const KeyValueMetadata> default_metadata;

 private:
 std::string account_blob_url_;
 std::string account_dfs_url_;

 enum class CredentialKind {
 kAnonymous,
 kTokenCredential,
 kStorageSharedKeyCredential,
 } credential_kind_ = CredentialKind::kAnonymous;

 std::string account_name_;
 std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;
 std::shared_ptr<Azure::Storage::StorageSharedKeyCredential>
 storage_shared_key_credential_;

 std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;

 void SetUrlsForAccountName(const std::string& account_name);

 public:
 AzureOptions();
 ~AzureOptions();
Expand All@@ -92,8 +107,8 @@ struct ARROW_EXPORT AzureOptions {

 bool Equals(const AzureOptions& other) const;

const std::string& AccountBlobUrl() const { return account_blob_url_; }
const std::string& AccountDfsUrl() const { return account_dfs_url_; }
 std::string AccountBlobUrl(const std::string& account_name) const;
 std::string AccountDfsUrl(const std::string& account_name) const;

 Result<std::unique_ptr<Azure::Storage::Blobs::BlobServiceClient>>
 MakeBlobServiceClient() const;
Expand Down

21 changes: 18 additions & 3 deletions
cpp/src/arrow/filesystem/azurefs_test.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,13 @@ namespace Blobs = Azure::Storage::Blobs;
namespace Core = Azure::Core;
namespace DataLake = Azure::Storage::Files::DataLake;

enum class AzureBackend {
 /// \brief Official Azure Remote Backend
 kAzure,
 /// \brief Local Simulated Storage
 kAzurite
};

class BaseAzureEnv : public ::testing::Environment {
 protected:
 std::string account_name_;
Expand DownExpand Up@@ -265,8 +272,6 @@ class AzureHierarchicalNSEnv : public AzureEnvImpl<AzureHierarchicalNSEnv> {

TEST(AzureFileSystem, InitializeFilesystemWithDefaultCredential) {
 AzureOptions options;
 options.backend = AzureBackend::kAzurite; // Irrelevant for this test because it
 // doesn't connect to the server.
 ARROW_EXPECT_OK(options.ConfigureDefaultCredential("dummy-account-name"));
 EXPECT_OK_AND_ASSIGN(auto default_credential_fs, AzureFileSystem::Make(options));
}
Expand DownExpand Up@@ -352,7 +357,17 @@ class TestAzureFileSystem : public ::testing::Test {

 static Result<AzureOptions> MakeOptions(BaseAzureEnv* env) {
 AzureOptions options;
 options.backend = env->backend();
 switch (env->backend()) {
 case AzureBackend::kAzurite:
 options.blob_storage_authority = "127.0.0.1:10000";
 options.dfs_storage_authority = "127.0.0.1:10000";
 options.blob_storage_scheme = "http";
 options.dfs_storage_scheme = "http";
 break;
 case AzureBackend::kAzure:
 // Use the default values
 break;
 }
 ARROW_EXPECT_OK(
 options.ConfigureAccountKeyCredential(env->account_name(), env->account_key()));
 return options;
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
GH-39292 [C++][FS]: Remove the AzureBackend enum and add more flexible connection options#39293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

felipecrv
merged 1 commit into

from

Dec 19, 2023
 Merged


GH-39292 [C++][FS]: Remove the AzureBackend enum and add more flexible connection options
#39293
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


61 changes: 40 additions & 21 deletions
cpp/src/arrow/filesystem/azurefs.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -51,10 +51,12 @@ AzureOptions::~AzureOptions() = default;

bool AzureOptions::Equals(const AzureOptions& other) const {
 // TODO(GH-38598): update here when more auth methods are added.
 const bool equals = backend == other.backend &&
 const bool equals = blob_storage_authority == other.blob_storage_authority &&
 dfs_storage_authority == other.dfs_storage_authority &&
 blob_storage_scheme == other.blob_storage_scheme &&
 dfs_storage_scheme == other.dfs_storage_scheme &&
 default_metadata == other.default_metadata &&
 account_blob_url_ == other.account_blob_url_ &&
 account_dfs_url_ == other.account_dfs_url_ &&
 account_name_ == other.account_name_ &&
 credential_kind_ == other.credential_kind_;
 if (!equals) {
 return false;
Expand All@@ -72,42 +74,59 @@ bool AzureOptions::Equals(const AzureOptions& other) const {
 return false;
}

void AzureOptions::SetUrlsForAccountName(const std::string& account_name) {
 if (this->backend == AzureBackend::kAzurite) {
 account_blob_url_ = "http://127.0.0.1:10000/" + account_name + "/";
 account_dfs_url_ = "http://127.0.0.1:10000/" + account_name + "/";
 } else {
 account_dfs_url_ = "https://" + account_name + ".dfs.core.windows.net/";
 account_blob_url_ = "https://" + account_name + ".blob.core.windows.net/";
namespace {
std::string BuildBaseUrl(const std::string& scheme, const std::string& authority,
 const std::string& account_name) {
 std::string url;
 url += scheme + "://";
 if (!authority.empty()) {
@koukouDec 19, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that we should reject empty authority because it builds no host part URL.
@felipecrvfelipecrvDec 19, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My reasoning here is that there are many validations I could apply, but the most complete validation will come from the error messages triggered by using the filesystem with a bogus URL with 3 slashes after https:.
 if (authority[0] == '.') {
 url += account_name;
 url += authority;
 } else {
 url += authority;
 url += "/";
 url += account_name;
 }
 }
 url += "/";
 return url;
}
} // namespace

Status AzureOptions::ConfigureDefaultCredential(const std::string& account_name) {
 AzureOptions::SetUrlsForAccountName(account_name);
 credential_kind_ = CredentialKind::kTokenCredential;
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 return Status::OK();
std::string AzureOptions::AccountBlobUrl(const std::string& account_name) const {
 return BuildBaseUrl(blob_storage_scheme, blob_storage_authority, account_name);
}

std::string AzureOptions::AccountDfsUrl(const std::string& account_name) const {
 return BuildBaseUrl(dfs_storage_scheme, dfs_storage_authority, account_name);
}

Status AzureOptions::ConfigureAccountKeyCredential(const std::string& account_name,
 const std::string& account_key) {
 AzureOptions::SetUrlsForAccountName(account_name);
 credential_kind_ = CredentialKind::kStorageSharedKeyCredential;
 account_name_ = account_name;
 storage_shared_key_credential_ =
 std::make_shared<Storage::StorageSharedKeyCredential>(account_name, account_key);
 return Status::OK();
}

Status AzureOptions::ConfigureDefaultCredential(const std::string& account_name) {
 credential_kind_ = CredentialKind::kTokenCredential;
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 return Status::OK();
}

Result<std::unique_ptr<Blobs::BlobServiceClient>> AzureOptions::MakeBlobServiceClient()
 const {
 switch (credential_kind_) {
 case CredentialKind::kAnonymous:
 break;
 case CredentialKind::kTokenCredential:
 return std::make_unique<Blobs::BlobServiceClient>(account_blob_url_,
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name_),
 token_credential_);
 case CredentialKind::kStorageSharedKeyCredential:
 return std::make_unique<Blobs::BlobServiceClient>(account_blob_url_,
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name_),
 storage_shared_key_credential_);
 }
 return Status::Invalid("AzureOptions doesn't contain a valid auth configuration");
Expand All@@ -119,11 +138,11 @@ AzureOptions::MakeDataLakeServiceClient() const {
 case CredentialKind::kAnonymous:
 break;
 case CredentialKind::kTokenCredential:
 return std::make_unique<DataLake::DataLakeServiceClient>(account_dfs_url_,
 token_credential_);
 return std::make_unique<DataLake::DataLakeServiceClient>(
AccountDfsUrl(account_name_), token_credential_);
 case CredentialKind::kStorageSharedKeyCredential:
 return std::make_unique<DataLake::DataLakeServiceClient>(
account_dfs_url_, storage_shared_key_credential_);
AccountDfsUrl(account_name_), storage_shared_key_credential_);
 }
 return Status::Invalid("AzureOptions doesn't contain a valid auth configuration");
}
Expand Down

51 changes: 33 additions & 18 deletions
cpp/src/arrow/filesystem/azurefs.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,17 +43,37 @@ class DataLakeServiceClient;

namespace arrow::fs {

enum class AzureBackend {
 /// \brief Official Azure Remote Backend
 kAzure,
 /// \brief Local Simulated Storage
 kAzurite
};

/// Options for the AzureFileSystem implementation.
struct ARROW_EXPORT AzureOptions {
 /// \brief The backend to connect to: Azure or Azurite (for testing).
 AzureBackend backend = AzureBackend::kAzure;
 /// \brief hostname[:port] of the Azure Blob Storage Service.
 ///
 /// If the hostname is a relative domain name (one that starts with a '.'), then storage
 /// account URLs will be constructed by prepending the account name to the hostname.
 /// If the hostname is a fully qualified domain name, then the hostname will be used
 /// as-is and the account name will follow the hostname in the URL path.
 ///
 /// Default: ".blob.core.windows.net"
 std::string blob_storage_authority = ".blob.core.windows.net";

 /// \brief hostname[:port] of the Azure Data Lake Storage Gen 2 Service.
 ///
 /// If the hostname is a relative domain name (one that starts with a '.'), then storage
 /// account URLs will be constructed by prepending the account name to the hostname.
 /// If the hostname is a fully qualified domain name, then the hostname will be used
 /// as-is and the account name will follow the hostname in the URL path.
 ///
 /// Default: ".dfs.core.windows.net"
 std::string dfs_storage_authority = ".dfs.core.windows.net";

 /// \brief Azure Blob Storage connection transport.
 ///
 /// Default: "https"
 std::string blob_storage_scheme = "https";

 /// \brief Azure Data Lake Storage Gen 2 connection transport.
 ///
 /// Default: "https"
 std::string dfs_storage_scheme = "https";

 // TODO(GH-38598): Add support for more auth methods.
 // std::string connection_string;
Expand All@@ -65,22 +85,17 @@ struct ARROW_EXPORT AzureOptions {
 std::shared_ptr<const KeyValueMetadata> default_metadata;

 private:
 std::string account_blob_url_;
 std::string account_dfs_url_;

 enum class CredentialKind {
 kAnonymous,
 kTokenCredential,
 kStorageSharedKeyCredential,
 } credential_kind_ = CredentialKind::kAnonymous;

 std::string account_name_;
 std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;
 std::shared_ptr<Azure::Storage::StorageSharedKeyCredential>
 storage_shared_key_credential_;

 std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;

 void SetUrlsForAccountName(const std::string& account_name);

 public:
 AzureOptions();
 ~AzureOptions();
Expand All@@ -92,8 +107,8 @@ struct ARROW_EXPORT AzureOptions {

 bool Equals(const AzureOptions& other) const;

const std::string& AccountBlobUrl() const { return account_blob_url_; }
const std::string& AccountDfsUrl() const { return account_dfs_url_; }
 std::string AccountBlobUrl(const std::string& account_name) const;
 std::string AccountDfsUrl(const std::string& account_name) const;

 Result<std::unique_ptr<Azure::Storage::Blobs::BlobServiceClient>>
 MakeBlobServiceClient() const;
Expand Down

21 changes: 18 additions & 3 deletions
cpp/src/arrow/filesystem/azurefs_test.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,13 @@ namespace Blobs = Azure::Storage::Blobs;
namespace Core = Azure::Core;
namespace DataLake = Azure::Storage::Files::DataLake;

enum class AzureBackend {
 /// \brief Official Azure Remote Backend
 kAzure,
 /// \brief Local Simulated Storage
 kAzurite
};

class BaseAzureEnv : public ::testing::Environment {
 protected:
 std::string account_name_;
Expand DownExpand Up@@ -265,8 +272,6 @@ class AzureHierarchicalNSEnv : public AzureEnvImpl<AzureHierarchicalNSEnv> {

TEST(AzureFileSystem, InitializeFilesystemWithDefaultCredential) {
 AzureOptions options;
 options.backend = AzureBackend::kAzurite; // Irrelevant for this test because it
 // doesn't connect to the server.
 ARROW_EXPECT_OK(options.ConfigureDefaultCredential("dummy-account-name"));
 EXPECT_OK_AND_ASSIGN(auto default_credential_fs, AzureFileSystem::Make(options));
}
Expand DownExpand Up@@ -352,7 +357,17 @@ class TestAzureFileSystem : public ::testing::Test {

 static Result<AzureOptions> MakeOptions(BaseAzureEnv* env) {
 AzureOptions options;
 options.backend = env->backend();
 switch (env->backend()) {
 case AzureBackend::kAzurite:
 options.blob_storage_authority = "127.0.0.1:10000";
 options.dfs_storage_authority = "127.0.0.1:10000";
 options.blob_storage_scheme = "http";
 options.dfs_storage_scheme = "http";
 break;
 case AzureBackend::kAzure:
 // Use the default values
 break;
 }
 ARROW_EXPECT_OK(
 options.ConfigureAccountKeyCredential(env->account_name(), env->account_key()));
 return options;
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
GH-39292 [C++][FS]: Remove the AzureBackend enum and add more flexible connection options#39293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

felipecrv
merged 1 commit into

from

Dec 19, 2023
 Merged


GH-39292 [C++][FS]: Remove the AzureBackend enum and add more flexible connection options
#39293
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


61 changes: 40 additions & 21 deletions
cpp/src/arrow/filesystem/azurefs.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -51,10 +51,12 @@ AzureOptions::~AzureOptions() = default;

bool AzureOptions::Equals(const AzureOptions& other) const {
 // TODO(GH-38598): update here when more auth methods are added.
 const bool equals = backend == other.backend &&
 const bool equals = blob_storage_authority == other.blob_storage_authority &&
 dfs_storage_authority == other.dfs_storage_authority &&
 blob_storage_scheme == other.blob_storage_scheme &&
 dfs_storage_scheme == other.dfs_storage_scheme &&
 default_metadata == other.default_metadata &&
 account_blob_url_ == other.account_blob_url_ &&
 account_dfs_url_ == other.account_dfs_url_ &&
 account_name_ == other.account_name_ &&
 credential_kind_ == other.credential_kind_;
 if (!equals) {
 return false;
Expand All@@ -72,42 +74,59 @@ bool AzureOptions::Equals(const AzureOptions& other) const {
 return false;
}

void AzureOptions::SetUrlsForAccountName(const std::string& account_name) {
 if (this->backend == AzureBackend::kAzurite) {
 account_blob_url_ = "http://127.0.0.1:10000/" + account_name + "/";
 account_dfs_url_ = "http://127.0.0.1:10000/" + account_name + "/";
 } else {
 account_dfs_url_ = "https://" + account_name + ".dfs.core.windows.net/";
 account_blob_url_ = "https://" + account_name + ".blob.core.windows.net/";
namespace {
std::string BuildBaseUrl(const std::string& scheme, const std::string& authority,
 const std::string& account_name) {
 std::string url;
 url += scheme + "://";
 if (!authority.empty()) {
@koukouDec 19, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that we should reject empty authority because it builds no host part URL.
@felipecrvfelipecrvDec 19, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My reasoning here is that there are many validations I could apply, but the most complete validation will come from the error messages triggered by using the filesystem with a bogus URL with 3 slashes after https:.
 if (authority[0] == '.') {
 url += account_name;
 url += authority;
 } else {
 url += authority;
 url += "/";
 url += account_name;
 }
 }
 url += "/";
 return url;
}
} // namespace

Status AzureOptions::ConfigureDefaultCredential(const std::string& account_name) {
 AzureOptions::SetUrlsForAccountName(account_name);
 credential_kind_ = CredentialKind::kTokenCredential;
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 return Status::OK();
std::string AzureOptions::AccountBlobUrl(const std::string& account_name) const {
 return BuildBaseUrl(blob_storage_scheme, blob_storage_authority, account_name);
}

std::string AzureOptions::AccountDfsUrl(const std::string& account_name) const {
 return BuildBaseUrl(dfs_storage_scheme, dfs_storage_authority, account_name);
}

Status AzureOptions::ConfigureAccountKeyCredential(const std::string& account_name,
 const std::string& account_key) {
 AzureOptions::SetUrlsForAccountName(account_name);
 credential_kind_ = CredentialKind::kStorageSharedKeyCredential;
 account_name_ = account_name;
 storage_shared_key_credential_ =
 std::make_shared<Storage::StorageSharedKeyCredential>(account_name, account_key);
 return Status::OK();
}

Status AzureOptions::ConfigureDefaultCredential(const std::string& account_name) {
 credential_kind_ = CredentialKind::kTokenCredential;
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 return Status::OK();
}

Result<std::unique_ptr<Blobs::BlobServiceClient>> AzureOptions::MakeBlobServiceClient()
 const {
 switch (credential_kind_) {
 case CredentialKind::kAnonymous:
 break;
 case CredentialKind::kTokenCredential:
 return std::make_unique<Blobs::BlobServiceClient>(account_blob_url_,
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name_),
 token_credential_);
 case CredentialKind::kStorageSharedKeyCredential:
 return std::make_unique<Blobs::BlobServiceClient>(account_blob_url_,
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name_),
 storage_shared_key_credential_);
 }
 return Status::Invalid("AzureOptions doesn't contain a valid auth configuration");
Expand All@@ -119,11 +138,11 @@ AzureOptions::MakeDataLakeServiceClient() const {
 case CredentialKind::kAnonymous:
 break;
 case CredentialKind::kTokenCredential:
 return std::make_unique<DataLake::DataLakeServiceClient>(account_dfs_url_,
 token_credential_);
 return std::make_unique<DataLake::DataLakeServiceClient>(
AccountDfsUrl(account_name_), token_credential_);
 case CredentialKind::kStorageSharedKeyCredential:
 return std::make_unique<DataLake::DataLakeServiceClient>(
account_dfs_url_, storage_shared_key_credential_);
AccountDfsUrl(account_name_), storage_shared_key_credential_);
 }
 return Status::Invalid("AzureOptions doesn't contain a valid auth configuration");
}
Expand Down

51 changes: 33 additions & 18 deletions
cpp/src/arrow/filesystem/azurefs.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,17 +43,37 @@ class DataLakeServiceClient;

namespace arrow::fs {

enum class AzureBackend {
 /// \brief Official Azure Remote Backend
 kAzure,
 /// \brief Local Simulated Storage
 kAzurite
};

/// Options for the AzureFileSystem implementation.
struct ARROW_EXPORT AzureOptions {
 /// \brief The backend to connect to: Azure or Azurite (for testing).
 AzureBackend backend = AzureBackend::kAzure;
 /// \brief hostname[:port] of the Azure Blob Storage Service.
 ///
 /// If the hostname is a relative domain name (one that starts with a '.'), then storage
 /// account URLs will be constructed by prepending the account name to the hostname.
 /// If the hostname is a fully qualified domain name, then the hostname will be used
 /// as-is and the account name will follow the hostname in the URL path.
 ///
 /// Default: ".blob.core.windows.net"
 std::string blob_storage_authority = ".blob.core.windows.net";

 /// \brief hostname[:port] of the Azure Data Lake Storage Gen 2 Service.
 ///
 /// If the hostname is a relative domain name (one that starts with a '.'), then storage
 /// account URLs will be constructed by prepending the account name to the hostname.
 /// If the hostname is a fully qualified domain name, then the hostname will be used
 /// as-is and the account name will follow the hostname in the URL path.
 ///
 /// Default: ".dfs.core.windows.net"
 std::string dfs_storage_authority = ".dfs.core.windows.net";

 /// \brief Azure Blob Storage connection transport.
 ///
 /// Default: "https"
 std::string blob_storage_scheme = "https";

 /// \brief Azure Data Lake Storage Gen 2 connection transport.
 ///
 /// Default: "https"
 std::string dfs_storage_scheme = "https";

 // TODO(GH-38598): Add support for more auth methods.
 // std::string connection_string;
Expand All@@ -65,22 +85,17 @@ struct ARROW_EXPORT AzureOptions {
 std::shared_ptr<const KeyValueMetadata> default_metadata;

 private:
 std::string account_blob_url_;
 std::string account_dfs_url_;

 enum class CredentialKind {
 kAnonymous,
 kTokenCredential,
 kStorageSharedKeyCredential,
 } credential_kind_ = CredentialKind::kAnonymous;

 std::string account_name_;
 std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;
 std::shared_ptr<Azure::Storage::StorageSharedKeyCredential>
 storage_shared_key_credential_;

 std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;

 void SetUrlsForAccountName(const std::string& account_name);

 public:
 AzureOptions();
 ~AzureOptions();
Expand All@@ -92,8 +107,8 @@ struct ARROW_EXPORT AzureOptions {

 bool Equals(const AzureOptions& other) const;

const std::string& AccountBlobUrl() const { return account_blob_url_; }
const std::string& AccountDfsUrl() const { return account_dfs_url_; }
 std::string AccountBlobUrl(const std::string& account_name) const;
 std::string AccountDfsUrl(const std::string& account_name) const;

 Result<std::unique_ptr<Azure::Storage::Blobs::BlobServiceClient>>
 MakeBlobServiceClient() const;
Expand Down

21 changes: 18 additions & 3 deletions
cpp/src/arrow/filesystem/azurefs_test.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,13 @@ namespace Blobs = Azure::Storage::Blobs;
namespace Core = Azure::Core;
namespace DataLake = Azure::Storage::Files::DataLake;

enum class AzureBackend {
 /// \brief Official Azure Remote Backend
 kAzure,
 /// \brief Local Simulated Storage
 kAzurite
};

class BaseAzureEnv : public ::testing::Environment {
 protected:
 std::string account_name_;
Expand DownExpand Up@@ -265,8 +272,6 @@ class AzureHierarchicalNSEnv : public AzureEnvImpl<AzureHierarchicalNSEnv> {

TEST(AzureFileSystem, InitializeFilesystemWithDefaultCredential) {
 AzureOptions options;
 options.backend = AzureBackend::kAzurite; // Irrelevant for this test because it
 // doesn't connect to the server.
 ARROW_EXPECT_OK(options.ConfigureDefaultCredential("dummy-account-name"));
 EXPECT_OK_AND_ASSIGN(auto default_credential_fs, AzureFileSystem::Make(options));
}
Expand DownExpand Up@@ -352,7 +357,17 @@ class TestAzureFileSystem : public ::testing::Test {

 static Result<AzureOptions> MakeOptions(BaseAzureEnv* env) {
 AzureOptions options;
 options.backend = env->backend();
 switch (env->backend()) {
 case AzureBackend::kAzurite:
 options.blob_storage_authority = "127.0.0.1:10000";
 options.dfs_storage_authority = "127.0.0.1:10000";
 options.blob_storage_scheme = "http";
 options.dfs_storage_scheme = "http";
 break;
 case AzureBackend::kAzure:
 // Use the default values
 break;
 }
 ARROW_EXPECT_OK(
 options.ConfigureAccountKeyCredential(env->account_name(), env->account_key()));
 return options;
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
GH-39292 [C++][FS]: Remove the AzureBackend enum and add more flexible connection options#39293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

felipecrv
merged 1 commit into

from

Dec 19, 2023
 Merged


GH-39292 [C++][FS]: Remove the AzureBackend enum and add more flexible connection options
#39293
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


61 changes: 40 additions & 21 deletions
cpp/src/arrow/filesystem/azurefs.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -51,10 +51,12 @@ AzureOptions::~AzureOptions() = default;

bool AzureOptions::Equals(const AzureOptions& other) const {
 // TODO(GH-38598): update here when more auth methods are added.
 const bool equals = backend == other.backend &&
 const bool equals = blob_storage_authority == other.blob_storage_authority &&
 dfs_storage_authority == other.dfs_storage_authority &&
 blob_storage_scheme == other.blob_storage_scheme &&
 dfs_storage_scheme == other.dfs_storage_scheme &&
 default_metadata == other.default_metadata &&
 account_blob_url_ == other.account_blob_url_ &&
 account_dfs_url_ == other.account_dfs_url_ &&
 account_name_ == other.account_name_ &&
 credential_kind_ == other.credential_kind_;
 if (!equals) {
 return false;
Expand All@@ -72,42 +74,59 @@ bool AzureOptions::Equals(const AzureOptions& other) const {
 return false;
}

void AzureOptions::SetUrlsForAccountName(const std::string& account_name) {
 if (this->backend == AzureBackend::kAzurite) {
 account_blob_url_ = "http://127.0.0.1:10000/" + account_name + "/";
 account_dfs_url_ = "http://127.0.0.1:10000/" + account_name + "/";
 } else {
 account_dfs_url_ = "https://" + account_name + ".dfs.core.windows.net/";
 account_blob_url_ = "https://" + account_name + ".blob.core.windows.net/";
namespace {
std::string BuildBaseUrl(const std::string& scheme, const std::string& authority,
 const std::string& account_name) {
 std::string url;
 url += scheme + "://";
 if (!authority.empty()) {
@koukouDec 19, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that we should reject empty authority because it builds no host part URL.
@felipecrvfelipecrvDec 19, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My reasoning here is that there are many validations I could apply, but the most complete validation will come from the error messages triggered by using the filesystem with a bogus URL with 3 slashes after https:.
 if (authority[0] == '.') {
 url += account_name;
 url += authority;
 } else {
 url += authority;
 url += "/";
 url += account_name;
 }
 }
 url += "/";
 return url;
}
} // namespace

Status AzureOptions::ConfigureDefaultCredential(const std::string& account_name) {
 AzureOptions::SetUrlsForAccountName(account_name);
 credential_kind_ = CredentialKind::kTokenCredential;
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 return Status::OK();
std::string AzureOptions::AccountBlobUrl(const std::string& account_name) const {
 return BuildBaseUrl(blob_storage_scheme, blob_storage_authority, account_name);
}

std::string AzureOptions::AccountDfsUrl(const std::string& account_name) const {
 return BuildBaseUrl(dfs_storage_scheme, dfs_storage_authority, account_name);
}

Status AzureOptions::ConfigureAccountKeyCredential(const std::string& account_name,
 const std::string& account_key) {
 AzureOptions::SetUrlsForAccountName(account_name);
 credential_kind_ = CredentialKind::kStorageSharedKeyCredential;
 account_name_ = account_name;
 storage_shared_key_credential_ =
 std::make_shared<Storage::StorageSharedKeyCredential>(account_name, account_key);
 return Status::OK();
}

Status AzureOptions::ConfigureDefaultCredential(const std::string& account_name) {
 credential_kind_ = CredentialKind::kTokenCredential;
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 return Status::OK();
}

Result<std::unique_ptr<Blobs::BlobServiceClient>> AzureOptions::MakeBlobServiceClient()
 const {
 switch (credential_kind_) {
 case CredentialKind::kAnonymous:
 break;
 case CredentialKind::kTokenCredential:
 return std::make_unique<Blobs::BlobServiceClient>(account_blob_url_,
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name_),
 token_credential_);
 case CredentialKind::kStorageSharedKeyCredential:
 return std::make_unique<Blobs::BlobServiceClient>(account_blob_url_,
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name_),
 storage_shared_key_credential_);
 }
 return Status::Invalid("AzureOptions doesn't contain a valid auth configuration");
Expand All@@ -119,11 +138,11 @@ AzureOptions::MakeDataLakeServiceClient() const {
 case CredentialKind::kAnonymous:
 break;
 case CredentialKind::kTokenCredential:
 return std::make_unique<DataLake::DataLakeServiceClient>(account_dfs_url_,
 token_credential_);
 return std::make_unique<DataLake::DataLakeServiceClient>(
AccountDfsUrl(account_name_), token_credential_);
 case CredentialKind::kStorageSharedKeyCredential:
 return std::make_unique<DataLake::DataLakeServiceClient>(
account_dfs_url_, storage_shared_key_credential_);
AccountDfsUrl(account_name_), storage_shared_key_credential_);
 }
 return Status::Invalid("AzureOptions doesn't contain a valid auth configuration");
}
Expand Down

51 changes: 33 additions & 18 deletions
cpp/src/arrow/filesystem/azurefs.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,17 +43,37 @@ class DataLakeServiceClient;

namespace arrow::fs {

enum class AzureBackend {
 /// \brief Official Azure Remote Backend
 kAzure,
 /// \brief Local Simulated Storage
 kAzurite
};

/// Options for the AzureFileSystem implementation.
struct ARROW_EXPORT AzureOptions {
 /// \brief The backend to connect to: Azure or Azurite (for testing).
 AzureBackend backend = AzureBackend::kAzure;
 /// \brief hostname[:port] of the Azure Blob Storage Service.
 ///
 /// If the hostname is a relative domain name (one that starts with a '.'), then storage
 /// account URLs will be constructed by prepending the account name to the hostname.
 /// If the hostname is a fully qualified domain name, then the hostname will be used
 /// as-is and the account name will follow the hostname in the URL path.
 ///
 /// Default: ".blob.core.windows.net"
 std::string blob_storage_authority = ".blob.core.windows.net";

 /// \brief hostname[:port] of the Azure Data Lake Storage Gen 2 Service.
 ///
 /// If the hostname is a relative domain name (one that starts with a '.'), then storage
 /// account URLs will be constructed by prepending the account name to the hostname.
 /// If the hostname is a fully qualified domain name, then the hostname will be used
 /// as-is and the account name will follow the hostname in the URL path.
 ///
 /// Default: ".dfs.core.windows.net"
 std::string dfs_storage_authority = ".dfs.core.windows.net";

 /// \brief Azure Blob Storage connection transport.
 ///
 /// Default: "https"
 std::string blob_storage_scheme = "https";

 /// \brief Azure Data Lake Storage Gen 2 connection transport.
 ///
 /// Default: "https"
 std::string dfs_storage_scheme = "https";

 // TODO(GH-38598): Add support for more auth methods.
 // std::string connection_string;
Expand All@@ -65,22 +85,17 @@ struct ARROW_EXPORT AzureOptions {
 std::shared_ptr<const KeyValueMetadata> default_metadata;

 private:
 std::string account_blob_url_;
 std::string account_dfs_url_;

 enum class CredentialKind {
 kAnonymous,
 kTokenCredential,
 kStorageSharedKeyCredential,
 } credential_kind_ = CredentialKind::kAnonymous;

 std::string account_name_;
 std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;
 std::shared_ptr<Azure::Storage::StorageSharedKeyCredential>
 storage_shared_key_credential_;

 std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;

 void SetUrlsForAccountName(const std::string& account_name);

 public:
 AzureOptions();
 ~AzureOptions();
Expand All@@ -92,8 +107,8 @@ struct ARROW_EXPORT AzureOptions {

 bool Equals(const AzureOptions& other) const;

const std::string& AccountBlobUrl() const { return account_blob_url_; }
const std::string& AccountDfsUrl() const { return account_dfs_url_; }
 std::string AccountBlobUrl(const std::string& account_name) const;
 std::string AccountDfsUrl(const std::string& account_name) const;

 Result<std::unique_ptr<Azure::Storage::Blobs::BlobServiceClient>>
 MakeBlobServiceClient() const;
Expand Down

21 changes: 18 additions & 3 deletions
cpp/src/arrow/filesystem/azurefs_test.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,13 @@ namespace Blobs = Azure::Storage::Blobs;
namespace Core = Azure::Core;
namespace DataLake = Azure::Storage::Files::DataLake;

enum class AzureBackend {
 /// \brief Official Azure Remote Backend
 kAzure,
 /// \brief Local Simulated Storage
 kAzurite
};

class BaseAzureEnv : public ::testing::Environment {
 protected:
 std::string account_name_;
Expand DownExpand Up@@ -265,8 +272,6 @@ class AzureHierarchicalNSEnv : public AzureEnvImpl<AzureHierarchicalNSEnv> {

TEST(AzureFileSystem, InitializeFilesystemWithDefaultCredential) {
 AzureOptions options;
 options.backend = AzureBackend::kAzurite; // Irrelevant for this test because it
 // doesn't connect to the server.
 ARROW_EXPECT_OK(options.ConfigureDefaultCredential("dummy-account-name"));
 EXPECT_OK_AND_ASSIGN(auto default_credential_fs, AzureFileSystem::Make(options));
}
Expand DownExpand Up@@ -352,7 +357,17 @@ class TestAzureFileSystem : public ::testing::Test {

 static Result<AzureOptions> MakeOptions(BaseAzureEnv* env) {
 AzureOptions options;
 options.backend = env->backend();
 switch (env->backend()) {
 case AzureBackend::kAzurite:
 options.blob_storage_authority = "127.0.0.1:10000";
 options.dfs_storage_authority = "127.0.0.1:10000";
 options.blob_storage_scheme = "http";
 options.dfs_storage_scheme = "http";
 break;
 case AzureBackend::kAzure:
 // Use the default values
 break;
 }
 ARROW_EXPECT_OK(
 options.ConfigureAccountKeyCredential(env->account_name(), env->account_key()));
 return options;
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
GH-39292 [C++][FS]: Remove the AzureBackend enum and add more flexible connection options#39293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

felipecrv
merged 1 commit into

from

Dec 19, 2023
 Merged


GH-39292 [C++][FS]: Remove the AzureBackend enum and add more flexible connection options
#39293
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


61 changes: 40 additions & 21 deletions
cpp/src/arrow/filesystem/azurefs.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -51,10 +51,12 @@ AzureOptions::~AzureOptions() = default;

bool AzureOptions::Equals(const AzureOptions& other) const {
 // TODO(GH-38598): update here when more auth methods are added.
 const bool equals = backend == other.backend &&
 const bool equals = blob_storage_authority == other.blob_storage_authority &&
 dfs_storage_authority == other.dfs_storage_authority &&
 blob_storage_scheme == other.blob_storage_scheme &&
 dfs_storage_scheme == other.dfs_storage_scheme &&
 default_metadata == other.default_metadata &&
 account_blob_url_ == other.account_blob_url_ &&
 account_dfs_url_ == other.account_dfs_url_ &&
 account_name_ == other.account_name_ &&
 credential_kind_ == other.credential_kind_;
 if (!equals) {
 return false;
Expand All@@ -72,42 +74,59 @@ bool AzureOptions::Equals(const AzureOptions& other) const {
 return false;
}

void AzureOptions::SetUrlsForAccountName(const std::string& account_name) {
 if (this->backend == AzureBackend::kAzurite) {
 account_blob_url_ = "http://127.0.0.1:10000/" + account_name + "/";
 account_dfs_url_ = "http://127.0.0.1:10000/" + account_name + "/";
 } else {
 account_dfs_url_ = "https://" + account_name + ".dfs.core.windows.net/";
 account_blob_url_ = "https://" + account_name + ".blob.core.windows.net/";
namespace {
std::string BuildBaseUrl(const std::string& scheme, const std::string& authority,
 const std::string& account_name) {
 std::string url;
 url += scheme + "://";
 if (!authority.empty()) {
@koukouDec 19, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that we should reject empty authority because it builds no host part URL.
@felipecrvfelipecrvDec 19, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My reasoning here is that there are many validations I could apply, but the most complete validation will come from the error messages triggered by using the filesystem with a bogus URL with 3 slashes after https:.
 if (authority[0] == '.') {
 url += account_name;
 url += authority;
 } else {
 url += authority;
 url += "/";
 url += account_name;
 }
 }
 url += "/";
 return url;
}
} // namespace

Status AzureOptions::ConfigureDefaultCredential(const std::string& account_name) {
 AzureOptions::SetUrlsForAccountName(account_name);
 credential_kind_ = CredentialKind::kTokenCredential;
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 return Status::OK();
std::string AzureOptions::AccountBlobUrl(const std::string& account_name) const {
 return BuildBaseUrl(blob_storage_scheme, blob_storage_authority, account_name);
}

std::string AzureOptions::AccountDfsUrl(const std::string& account_name) const {
 return BuildBaseUrl(dfs_storage_scheme, dfs_storage_authority, account_name);
}

Status AzureOptions::ConfigureAccountKeyCredential(const std::string& account_name,
 const std::string& account_key) {
 AzureOptions::SetUrlsForAccountName(account_name);
 credential_kind_ = CredentialKind::kStorageSharedKeyCredential;
 account_name_ = account_name;
 storage_shared_key_credential_ =
 std::make_shared<Storage::StorageSharedKeyCredential>(account_name, account_key);
 return Status::OK();
}

Status AzureOptions::ConfigureDefaultCredential(const std::string& account_name) {
 credential_kind_ = CredentialKind::kTokenCredential;
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 return Status::OK();
}

Result<std::unique_ptr<Blobs::BlobServiceClient>> AzureOptions::MakeBlobServiceClient()
 const {
 switch (credential_kind_) {
 case CredentialKind::kAnonymous:
 break;
 case CredentialKind::kTokenCredential:
 return std::make_unique<Blobs::BlobServiceClient>(account_blob_url_,
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name_),
 token_credential_);
 case CredentialKind::kStorageSharedKeyCredential:
 return std::make_unique<Blobs::BlobServiceClient>(account_blob_url_,
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name_),
 storage_shared_key_credential_);
 }
 return Status::Invalid("AzureOptions doesn't contain a valid auth configuration");
Expand All@@ -119,11 +138,11 @@ AzureOptions::MakeDataLakeServiceClient() const {
 case CredentialKind::kAnonymous:
 break;
 case CredentialKind::kTokenCredential:
 return std::make_unique<DataLake::DataLakeServiceClient>(account_dfs_url_,
 token_credential_);
 return std::make_unique<DataLake::DataLakeServiceClient>(
AccountDfsUrl(account_name_), token_credential_);
 case CredentialKind::kStorageSharedKeyCredential:
 return std::make_unique<DataLake::DataLakeServiceClient>(
account_dfs_url_, storage_shared_key_credential_);
AccountDfsUrl(account_name_), storage_shared_key_credential_);
 }
 return Status::Invalid("AzureOptions doesn't contain a valid auth configuration");
}
Expand Down

51 changes: 33 additions & 18 deletions
cpp/src/arrow/filesystem/azurefs.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,17 +43,37 @@ class DataLakeServiceClient;

namespace arrow::fs {

enum class AzureBackend {
 /// \brief Official Azure Remote Backend
 kAzure,
 /// \brief Local Simulated Storage
 kAzurite
};

/// Options for the AzureFileSystem implementation.
struct ARROW_EXPORT AzureOptions {
 /// \brief The backend to connect to: Azure or Azurite (for testing).
 AzureBackend backend = AzureBackend::kAzure;
 /// \brief hostname[:port] of the Azure Blob Storage Service.
 ///
 /// If the hostname is a relative domain name (one that starts with a '.'), then storage
 /// account URLs will be constructed by prepending the account name to the hostname.
 /// If the hostname is a fully qualified domain name, then the hostname will be used
 /// as-is and the account name will follow the hostname in the URL path.
 ///
 /// Default: ".blob.core.windows.net"
 std::string blob_storage_authority = ".blob.core.windows.net";

 /// \brief hostname[:port] of the Azure Data Lake Storage Gen 2 Service.
 ///
 /// If the hostname is a relative domain name (one that starts with a '.'), then storage
 /// account URLs will be constructed by prepending the account name to the hostname.
 /// If the hostname is a fully qualified domain name, then the hostname will be used
 /// as-is and the account name will follow the hostname in the URL path.
 ///
 /// Default: ".dfs.core.windows.net"
 std::string dfs_storage_authority = ".dfs.core.windows.net";

 /// \brief Azure Blob Storage connection transport.
 ///
 /// Default: "https"
 std::string blob_storage_scheme = "https";

 /// \brief Azure Data Lake Storage Gen 2 connection transport.
 ///
 /// Default: "https"
 std::string dfs_storage_scheme = "https";

 // TODO(GH-38598): Add support for more auth methods.
 // std::string connection_string;
Expand All@@ -65,22 +85,17 @@ struct ARROW_EXPORT AzureOptions {
 std::shared_ptr<const KeyValueMetadata> default_metadata;

 private:
 std::string account_blob_url_;
 std::string account_dfs_url_;

 enum class CredentialKind {
 kAnonymous,
 kTokenCredential,
 kStorageSharedKeyCredential,
 } credential_kind_ = CredentialKind::kAnonymous;

 std::string account_name_;
 std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;
 std::shared_ptr<Azure::Storage::StorageSharedKeyCredential>
 storage_shared_key_credential_;

 std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;

 void SetUrlsForAccountName(const std::string& account_name);

 public:
 AzureOptions();
 ~AzureOptions();
Expand All@@ -92,8 +107,8 @@ struct ARROW_EXPORT AzureOptions {

 bool Equals(const AzureOptions& other) const;

const std::string& AccountBlobUrl() const { return account_blob_url_; }
const std::string& AccountDfsUrl() const { return account_dfs_url_; }
 std::string AccountBlobUrl(const std::string& account_name) const;
 std::string AccountDfsUrl(const std::string& account_name) const;

 Result<std::unique_ptr<Azure::Storage::Blobs::BlobServiceClient>>
 MakeBlobServiceClient() const;
Expand Down

21 changes: 18 additions & 3 deletions
cpp/src/arrow/filesystem/azurefs_test.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,13 @@ namespace Blobs = Azure::Storage::Blobs;
namespace Core = Azure::Core;
namespace DataLake = Azure::Storage::Files::DataLake;

enum class AzureBackend {
 /// \brief Official Azure Remote Backend
 kAzure,
 /// \brief Local Simulated Storage
 kAzurite
};

class BaseAzureEnv : public ::testing::Environment {
 protected:
 std::string account_name_;
Expand DownExpand Up@@ -265,8 +272,6 @@ class AzureHierarchicalNSEnv : public AzureEnvImpl<AzureHierarchicalNSEnv> {

TEST(AzureFileSystem, InitializeFilesystemWithDefaultCredential) {
 AzureOptions options;
 options.backend = AzureBackend::kAzurite; // Irrelevant for this test because it
 // doesn't connect to the server.
 ARROW_EXPECT_OK(options.ConfigureDefaultCredential("dummy-account-name"));
 EXPECT_OK_AND_ASSIGN(auto default_credential_fs, AzureFileSystem::Make(options));
}
Expand DownExpand Up@@ -352,7 +357,17 @@ class TestAzureFileSystem : public ::testing::Test {

 static Result<AzureOptions> MakeOptions(BaseAzureEnv* env) {
 AzureOptions options;
 options.backend = env->backend();
 switch (env->backend()) {
 case AzureBackend::kAzurite:
 options.blob_storage_authority = "127.0.0.1:10000";
 options.dfs_storage_authority = "127.0.0.1:10000";
 options.blob_storage_scheme = "http";
 options.dfs_storage_scheme = "http";
 break;
 case AzureBackend::kAzure:
 // Use the default values
 break;
 }
 ARROW_EXPECT_OK(
 options.ConfigureAccountKeyCredential(env->account_name(), env->account_key()));
 return options;
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
GH-39292 [C++][FS]: Remove the AzureBackend enum and add more flexible connection options#39293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

felipecrv
merged 1 commit into

from

Dec 19, 2023
 Merged


GH-39292 [C++][FS]: Remove the AzureBackend enum and add more flexible connection options
#39293
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


61 changes: 40 additions & 21 deletions
cpp/src/arrow/filesystem/azurefs.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -51,10 +51,12 @@ AzureOptions::~AzureOptions() = default;

bool AzureOptions::Equals(const AzureOptions& other) const {
 // TODO(GH-38598): update here when more auth methods are added.
 const bool equals = backend == other.backend &&
 const bool equals = blob_storage_authority == other.blob_storage_authority &&
 dfs_storage_authority == other.dfs_storage_authority &&
 blob_storage_scheme == other.blob_storage_scheme &&
 dfs_storage_scheme == other.dfs_storage_scheme &&
 default_metadata == other.default_metadata &&
 account_blob_url_ == other.account_blob_url_ &&
 account_dfs_url_ == other.account_dfs_url_ &&
 account_name_ == other.account_name_ &&
 credential_kind_ == other.credential_kind_;
 if (!equals) {
 return false;
Expand All@@ -72,42 +74,59 @@ bool AzureOptions::Equals(const AzureOptions& other) const {
 return false;
}

void AzureOptions::SetUrlsForAccountName(const std::string& account_name) {
 if (this->backend == AzureBackend::kAzurite) {
 account_blob_url_ = "http://127.0.0.1:10000/" + account_name + "/";
 account_dfs_url_ = "http://127.0.0.1:10000/" + account_name + "/";
 } else {
 account_dfs_url_ = "https://" + account_name + ".dfs.core.windows.net/";
 account_blob_url_ = "https://" + account_name + ".blob.core.windows.net/";
namespace {
std::string BuildBaseUrl(const std::string& scheme, const std::string& authority,
 const std::string& account_name) {
 std::string url;
 url += scheme + "://";
 if (!authority.empty()) {
@koukouDec 19, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that we should reject empty authority because it builds no host part URL.
@felipecrvfelipecrvDec 19, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My reasoning here is that there are many validations I could apply, but the most complete validation will come from the error messages triggered by using the filesystem with a bogus URL with 3 slashes after https:.
 if (authority[0] == '.') {
 url += account_name;
 url += authority;
 } else {
 url += authority;
 url += "/";
 url += account_name;
 }
 }
 url += "/";
 return url;
}
} // namespace

Status AzureOptions::ConfigureDefaultCredential(const std::string& account_name) {
 AzureOptions::SetUrlsForAccountName(account_name);
 credential_kind_ = CredentialKind::kTokenCredential;
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 return Status::OK();
std::string AzureOptions::AccountBlobUrl(const std::string& account_name) const {
 return BuildBaseUrl(blob_storage_scheme, blob_storage_authority, account_name);
}

std::string AzureOptions::AccountDfsUrl(const std::string& account_name) const {
 return BuildBaseUrl(dfs_storage_scheme, dfs_storage_authority, account_name);
}

Status AzureOptions::ConfigureAccountKeyCredential(const std::string& account_name,
 const std::string& account_key) {
 AzureOptions::SetUrlsForAccountName(account_name);
 credential_kind_ = CredentialKind::kStorageSharedKeyCredential;
 account_name_ = account_name;
 storage_shared_key_credential_ =
 std::make_shared<Storage::StorageSharedKeyCredential>(account_name, account_key);
 return Status::OK();
}

Status AzureOptions::ConfigureDefaultCredential(const std::string& account_name) {
 credential_kind_ = CredentialKind::kTokenCredential;
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 return Status::OK();
}

Result<std::unique_ptr<Blobs::BlobServiceClient>> AzureOptions::MakeBlobServiceClient()
 const {
 switch (credential_kind_) {
 case CredentialKind::kAnonymous:
 break;
 case CredentialKind::kTokenCredential:
 return std::make_unique<Blobs::BlobServiceClient>(account_blob_url_,
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name_),
 token_credential_);
 case CredentialKind::kStorageSharedKeyCredential:
 return std::make_unique<Blobs::BlobServiceClient>(account_blob_url_,
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name_),
 storage_shared_key_credential_);
 }
 return Status::Invalid("AzureOptions doesn't contain a valid auth configuration");
Expand All@@ -119,11 +138,11 @@ AzureOptions::MakeDataLakeServiceClient() const {
 case CredentialKind::kAnonymous:
 break;
 case CredentialKind::kTokenCredential:
 return std::make_unique<DataLake::DataLakeServiceClient>(account_dfs_url_,
 token_credential_);
 return std::make_unique<DataLake::DataLakeServiceClient>(
AccountDfsUrl(account_name_), token_credential_);
 case CredentialKind::kStorageSharedKeyCredential:
 return std::make_unique<DataLake::DataLakeServiceClient>(
account_dfs_url_, storage_shared_key_credential_);
AccountDfsUrl(account_name_), storage_shared_key_credential_);
 }
 return Status::Invalid("AzureOptions doesn't contain a valid auth configuration");
}
Expand Down

51 changes: 33 additions & 18 deletions
cpp/src/arrow/filesystem/azurefs.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,17 +43,37 @@ class DataLakeServiceClient;

namespace arrow::fs {

enum class AzureBackend {
 /// \brief Official Azure Remote Backend
 kAzure,
 /// \brief Local Simulated Storage
 kAzurite
};

/// Options for the AzureFileSystem implementation.
struct ARROW_EXPORT AzureOptions {
 /// \brief The backend to connect to: Azure or Azurite (for testing).
 AzureBackend backend = AzureBackend::kAzure;
 /// \brief hostname[:port] of the Azure Blob Storage Service.
 ///
 /// If the hostname is a relative domain name (one that starts with a '.'), then storage
 /// account URLs will be constructed by prepending the account name to the hostname.
 /// If the hostname is a fully qualified domain name, then the hostname will be used
 /// as-is and the account name will follow the hostname in the URL path.
 ///
 /// Default: ".blob.core.windows.net"
 std::string blob_storage_authority = ".blob.core.windows.net";

 /// \brief hostname[:port] of the Azure Data Lake Storage Gen 2 Service.
 ///
 /// If the hostname is a relative domain name (one that starts with a '.'), then storage
 /// account URLs will be constructed by prepending the account name to the hostname.
 /// If the hostname is a fully qualified domain name, then the hostname will be used
 /// as-is and the account name will follow the hostname in the URL path.
 ///
 /// Default: ".dfs.core.windows.net"
 std::string dfs_storage_authority = ".dfs.core.windows.net";

 /// \brief Azure Blob Storage connection transport.
 ///
 /// Default: "https"
 std::string blob_storage_scheme = "https";

 /// \brief Azure Data Lake Storage Gen 2 connection transport.
 ///
 /// Default: "https"
 std::string dfs_storage_scheme = "https";

 // TODO(GH-38598): Add support for more auth methods.
 // std::string connection_string;
Expand All@@ -65,22 +85,17 @@ struct ARROW_EXPORT AzureOptions {
 std::shared_ptr<const KeyValueMetadata> default_metadata;

 private:
 std::string account_blob_url_;
 std::string account_dfs_url_;

 enum class CredentialKind {
 kAnonymous,
 kTokenCredential,
 kStorageSharedKeyCredential,
 } credential_kind_ = CredentialKind::kAnonymous;

 std::string account_name_;
 std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;
 std::shared_ptr<Azure::Storage::StorageSharedKeyCredential>
 storage_shared_key_credential_;

 std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;

 void SetUrlsForAccountName(const std::string& account_name);

 public:
 AzureOptions();
 ~AzureOptions();
Expand All@@ -92,8 +107,8 @@ struct ARROW_EXPORT AzureOptions {

 bool Equals(const AzureOptions& other) const;

const std::string& AccountBlobUrl() const { return account_blob_url_; }
const std::string& AccountDfsUrl() const { return account_dfs_url_; }
 std::string AccountBlobUrl(const std::string& account_name) const;
 std::string AccountDfsUrl(const std::string& account_name) const;

 Result<std::unique_ptr<Azure::Storage::Blobs::BlobServiceClient>>
 MakeBlobServiceClient() const;
Expand Down

21 changes: 18 additions & 3 deletions
cpp/src/arrow/filesystem/azurefs_test.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,6 +73,13 @@ namespace Blobs = Azure::Storage::Blobs;
namespace Core = Azure::Core;
namespace DataLake = Azure::Storage::Files::DataLake;

enum class AzureBackend {
 /// \brief Official Azure Remote Backend
 kAzure,
 /// \brief Local Simulated Storage
 kAzurite
};

class BaseAzureEnv : public ::testing::Environment {
 protected:
 std::string account_name_;
Expand DownExpand Up@@ -265,8 +272,6 @@ class AzureHierarchicalNSEnv : public AzureEnvImpl<AzureHierarchicalNSEnv> {

TEST(AzureFileSystem, InitializeFilesystemWithDefaultCredential) {
 AzureOptions options;
 options.backend = AzureBackend::kAzurite; // Irrelevant for this test because it
 // doesn't connect to the server.
 ARROW_EXPECT_OK(options.ConfigureDefaultCredential("dummy-account-name"));
 EXPECT_OK_AND_ASSIGN(auto default_credential_fs, AzureFileSystem::Make(options));
}
Expand DownExpand Up@@ -352,7 +357,17 @@ class TestAzureFileSystem : public ::testing::Test {

 static Result<AzureOptions> MakeOptions(BaseAzureEnv* env) {
 AzureOptions options;
 options.backend = env->backend();
 switch (env->backend()) {
 case AzureBackend::kAzurite:
 options.blob_storage_authority = "127.0.0.1:10000";
 options.dfs_storage_authority = "127.0.0.1:10000";
 options.blob_storage_scheme = "http";
 options.dfs_storage_scheme = "http";
 break;
 case AzureBackend::kAzure:
 // Use the default values
 break;
 }
 ARROW_EXPECT_OK(
 options.ConfigureAccountKeyCredential(env->account_name(), env->account_key()));
 return options;
Expand Down