github/azure-sdk-for-cpp
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Add ApiView settings for existing packages. (#4226)

Browse Source 
* Create ApiViewSettings for most existing packages

* Corrected name for blobs storage review name

* Added cspell settings for DCURL

* Create ApiViewSettings for most existing packages

* Corrected name for blobs storage review name

* Added cspell settings for DCURL

* ApiView settings changes for DataLake

* Renamed includeInternal to allowInternal; Added storage common; Fixed package names

* Fixed spelling error

* If there's an error accessing the site with no CRL checks, don't try it any more

* Stop checking example.com because it doesn't work

* Update sdk/attestation/azure-security-attestation/inc/ApiViewSettings.json

Co-authored-by: Ahson Khan <ahkha@microsoft.com>

* Update sdk/core/azure-core/inc/ApiViewSettings.json

Co-authored-by: Ahson Khan <ahkha@microsoft.com>

* Update sdk/keyvault/azure-security-keyvault-secrets/inc/ApiViewSettings.json

Co-authored-by: Ahson Khan <ahkha@microsoft.com>

Co-authored-by: Ahson Khan <ahkha@microsoft.com>
This commit is contained in:
Larry Osterman 2023-01-11 08:16:13 -08:00 committed by GitHub
parent d301dfb60d
commit a34b8d19a5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
13 changed files with 236 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.vscode/cspell.json vendored
View File

@ -50,6 +50,7 @@
"cuse",
"CUSEUAP",
"DCMAKE",
"DCURL",
"DDISABLE",
"deserializers",
"Deserializes",

16
sdk/attestation/azure-security-attestation/inc/ApiViewSettings.json Normal file
View File

@ -0,0 +1,16 @@
{
"sourceFilesToProcess": [ "azure\\attestation.hpp" ],
"additionalIncludeDirectories": [
"../../../core/azure-core/inc"
],
"sourceFilesToSkip": [
],
"additionalCompilerSwitches": [],
"allowInternal": false,
"includeDetail": false,
"includePrivate": false,
"filterNamespace": "Azure::Security::Attestation",
"reviewName": "Azure Attestation API Review",
"serviceName": "Microsoft Azure Attestation",
"packageName": "azure-security-attestation-cpp"
}

21
sdk/core/azure-core/inc/ApiViewSettings.json Normal file
View File

@ -0,0 +1,21 @@
{
"sourceFilesToProcess": null,
"sourceFilesToSkip": [
"azure/core/internal/json/json.hpp",
"azure/core/internal/json/json_optional.hpp"
],
"additionalIncludeDirectories": [
],
"additionalCompilerSwitches": [
"-DBUILD_CURL_HTTP_TRANSPORT_ADAPTER",
"-DBUILD_TRANSPORT_WINHTTP_ADAPTER",
"-DCURL_STATICLIB"
],
"allowInternal": true,
"includeDetail": false,
"includePrivate": false,
"filterNamespace": "Azure::",
"reviewName": "Azure Core API Review",
"serviceName": null,
"packageName": "azure-core-cpp"
}

75
sdk/core/azure-core/test/ut/transport_policy_options.cpp
View File

@ -532,11 +532,12 @@ namespace Azure { namespace Core { namespace Test {
// LetsEncrypt certificates don't contain a distribution point URL extension. While this seems
// to work when run locally, it fails in the CI pipeline. "https://www.wikipedia.org" uses a
// LetsEncrypt certificate, so when testing manually, it is important to add it to the list.
std::vector<std::string> testUrls{
AzureSdkHttpbinServer::Get(), // Uses a Microsoft/DigiCert certificate.
"https://aws.amazon.com", // Uses a Amazon/Starfield Technologies certificate.
"https://www.example.com/", // Uses a DigiCert certificate.
"https://www.google.com/", // Uses a google certificate.
std::vector<std::pair<std::string, bool>> testUrls{
{AzureSdkHttpbinServer::Get(), true}, // Uses a Microsoft/DigiCert certificate.
{"https://aws.amazon.com", true}, // Uses a Amazon/Starfield Technologies certificate.
// {"https://www.example.com/", true}, // Uses a DigiCert certificate. Does not work
// correctly from Linux as of 2023-01-09.
{"https://www.google.com/", true}, // Uses a google certificate.
};
GTEST_LOG_(INFO) << "Basic test calls.";
@ -547,17 +548,27 @@ namespace Azure { namespace Core { namespace Test {
transportOptions.EnableCertificateRevocationListCheck = false;
HttpPipeline pipeline(CreateHttpPipeline(transportOptions));
for (auto const& target : testUrls)
for (auto& target : testUrls)
{
GTEST_LOG_(INFO) << "Test " << target;
Azure::Core::Url url(target);
GTEST_LOG_(INFO) << "Test " << target.first;
Azure::Core::Url url(target.first);
auto request = Azure::Core::Http::Request(Azure::Core::Http::HttpMethod::Get, url);
std::unique_ptr<Azure::Core::Http::RawResponse> response;
EXPECT_NO_THROW(
response = pipeline.Send(request, Azure::Core::Context::ApplicationContext));
if (response && response->GetStatusCode() != Azure::Core::Http::HttpStatusCode::Found)
try
{
EXPECT_EQ(response->GetStatusCode(), Azure::Core::Http::HttpStatusCode::Ok);
response = pipeline.Send(request, Azure::Core::Context::ApplicationContext);
}
catch (Azure::Core::Http::TransportException& ex)
{
GTEST_LOG_(INFO) << "Error " << ex.what() << " accessing site " << target.first;
target.second = false;
}
if (target.second)
{
if (response && response->GetStatusCode() != Azure::Core::Http::HttpStatusCode::Found)
{
EXPECT_EQ(response->GetStatusCode(), Azure::Core::Http::HttpStatusCode::Ok);
}
}
}
}
@ -574,15 +585,19 @@ namespace Azure { namespace Core { namespace Test {
for (auto const& target : testUrls)
{
GTEST_LOG_(INFO) << "Test " << target;
Azure::Core::Url url(target);
auto request = Azure::Core::Http::Request(Azure::Core::Http::HttpMethod::Get, url);
std::unique_ptr<Azure::Core::Http::RawResponse> response;
EXPECT_NO_THROW(
response = pipeline.Send(request, Azure::Core::Context::ApplicationContext));
if (response && response->GetStatusCode() != Azure::Core::Http::HttpStatusCode::Found)
// Only try to access the server if we were able to contact it earlier.
if (target.second)
{
EXPECT_EQ(response->GetStatusCode(), Azure::Core::Http::HttpStatusCode::Ok);
GTEST_LOG_(INFO) << "Test " << target.first;
Azure::Core::Url url(target.first);
auto request = Azure::Core::Http::Request(Azure::Core::Http::HttpMethod::Get, url);
std::unique_ptr<Azure::Core::Http::RawResponse> response;
EXPECT_NO_THROW(
response = pipeline.Send(request, Azure::Core::Context::ApplicationContext));
if (response && response->GetStatusCode() != Azure::Core::Http::HttpStatusCode::Found)
{
EXPECT_EQ(response->GetStatusCode(), Azure::Core::Http::HttpStatusCode::Ok);
}
}
}
}
@ -599,15 +614,18 @@ namespace Azure { namespace Core { namespace Test {
for (auto const& target : testUrls)
{
GTEST_LOG_(INFO) << "Test " << target;
Azure::Core::Url url(target);
auto request = Azure::Core::Http::Request(Azure::Core::Http::HttpMethod::Get, url);
std::unique_ptr<Azure::Core::Http::RawResponse> response;
EXPECT_NO_THROW(
response = pipeline.Send(request, Azure::Core::Context::ApplicationContext));
if (response && response->GetStatusCode() != Azure::Core::Http::HttpStatusCode::Found)
if (target.second)
{
EXPECT_EQ(response->GetStatusCode(), Azure::Core::Http::HttpStatusCode::Ok);
GTEST_LOG_(INFO) << "Test " << target.first;
Azure::Core::Url url(target.first);
auto request = Azure::Core::Http::Request(Azure::Core::Http::HttpMethod::Get, url);
std::unique_ptr<Azure::Core::Http::RawResponse> response;
EXPECT_NO_THROW(
response = pipeline.Send(request, Azure::Core::Context::ApplicationContext));
if (response && response->GetStatusCode() != Azure::Core::Http::HttpStatusCode::Found)
{
EXPECT_EQ(response->GetStatusCode(), Azure::Core::Http::HttpStatusCode::Ok);
}
}
}
}
@ -919,5 +937,4 @@ namespace Azure { namespace Core { namespace Test {
EXPECT_THROW(proxyServer.IsAlive(), Azure::Core::Http::TransportException);
}
}}} // namespace Azure::Core::Test

14
sdk/identity/azure-identity/inc/ApiViewSettings.json Normal file
View File

@ -0,0 +1,14 @@
{
"sourceFilesToProcess": null,
"additionalIncludeDirectories": [
"../../../core/azure-core/inc"
],
"additionalCompilerSwitches": [],
"allowInternal": false,
"includeDetail": false,
"includePrivate": false,
"filterNamespace": "Azure::Identity",
"reviewName": "Azure Identity",
"serviceName": "Azure Identity",
"packageName": "azure-identity-cpp"
}

17
sdk/keyvault/azure-security-keyvault-certificates/inc/ApiViewSettings.json Normal file
View File

@ -0,0 +1,17 @@
{
"sourceFilesToProcess": null,
"additionalIncludeDirectories": [
"../../../core/azure-core/inc",
"../../azure-security-keyvault-shared/inc"
],
"sourceFilesToSkip": [
],
"additionalCompilerSwitches": [],
"allowInternal": false,
"includeDetail": false,
"includePrivate": false,
"filterNamespace": "Azure::Security::KeyVault::Certificates",
"reviewName": "KeyVault Certificates Review",
"serviceName": "Azure Security Keyvault Certificates",
"packageName": "azure-security-keyvault-certificates-cpp"
}

17
sdk/keyvault/azure-security-keyvault-keys/inc/ApiViewSettings.json Normal file
View File

@ -0,0 +1,17 @@
{
"sourceFilesToProcess": null,
"additionalIncludeDirectories": [
"../../../core/azure-core/inc",
"../../azure-security-keyvault-shared/inc"
],
"sourceFilesToSkip": [
],
"additionalCompilerSwitches": [],
"allowInternal": false,
"includeDetail": false,
"includePrivate": false,
"filterNamespace": "Azure::Security::KeyVault::Keys",
"reviewName": "KeyVault Keys Review",
"serviceName": "Azure Security Keyvault Keys",
"packageName": "azure-security-keyvault-keys-cpp"
}

17
sdk/keyvault/azure-security-keyvault-secrets/inc/ApiViewSettings.json Normal file
View File

@ -0,0 +1,17 @@
{
"sourceFilesToProcess": null,
"additionalIncludeDirectories": [
"../../../core/azure-core/inc",
"../../azure-security-keyvault-shared/inc"
],
"sourceFilesToSkip": [
],
"additionalCompilerSwitches": [],
"allowInternal": false,
"includeDetail": false,
"includePrivate": false,
"filterNamespace": "Azure::Security::KeyVault::Secrets",
"reviewName": "KeyVault Secrets API Review",
"serviceName": "Azure Security Keyvault Secrets",
"packageName": "azure-security-keyvault-secrets-cpp"
}

17
sdk/storage/azure-storage-blobs/inc/ApiViewSettings.json Normal file
View File

@ -0,0 +1,17 @@
{
"sourceFilesToProcess": null,
"additionalIncludeDirectories": [
"../../../core/azure-core/inc",
"../../azure-storage-common/inc"
],
"sourceFilesToSkip": [
],
"additionalCompilerSwitches": [],
"allowInternal": false,
"includeDetail": false,
"includePrivate": false,
"filterNamespace": "Azure::Storage::Blobs",
"reviewName": "Storage Blobs Review",
"serviceName": "Azure Storage Blobs",
"packageName": "azure-storage-blobs-cpp"
}

16
sdk/storage/azure-storage-common/inc/ApiViewSettings.json Normal file
View File

@ -0,0 +1,16 @@
{
"sourceFilesToProcess": null,
"additionalIncludeDirectories": [
"../../../core/azure-core/inc"
],
"sourceFilesToSkip": [
],
"additionalCompilerSwitches": [],
"allowInternal": true,
"includeDetail": false,
"includePrivate": false,
"filterNamespace": "Azure::Storage",
"reviewName": "Azure Storage Common API Review",
"serviceName": "Azure Storage",
"packageName": "azure-storage-common-cpp"
}

18
sdk/storage/azure-storage-files-datalake/inc/ApiViewSettings.json Normal file
View File

@ -0,0 +1,18 @@
{
"sourceFilesToProcess": null,
"additionalIncludeDirectories": [
"../../../core/azure-core/inc",
"../../azure-storage-common/inc",
"../../azure-storage-blobs/inc"
],
"sourceFilesToSkip": [
],
"additionalCompilerSwitches": [],
"allowInternal": false,
"includeDetail": false,
"includePrivate": false,
"filterNamespace": ["Azure::Storage::Files::DataLake", "Azure::Storage::Sas"],
"reviewName": "Azure Storage Files DataLake",
"serviceName": "Azure Storage Files DataLake",
"packageName": "azure-storage-files-datalake-cpp"
}

18
sdk/storage/azure-storage-files-shares/inc/ApiViewSettings.json Normal file
View File

@ -0,0 +1,18 @@
{
"sourceFilesToProcess": null,
"additionalIncludeDirectories": [
"../../../core/azure-core/inc",
"../../azure-storage-common/inc",
"../../azure-storage-blobs/inc"
],
"sourceFilesToSkip": [
],
"additionalCompilerSwitches": [],
"allowInternal": false,
"includeDetail": false,
"includePrivate": false,
"filterNamespace": "Azure::Storage::Files::Shares",
"reviewName": "Storage File Shares Review",
"serviceName": "Azure Storage Files Shares",
"packageName": "azure-storage-files-shares-cpp"
}

18
sdk/storage/azure-storage-queues/inc/ApiViewSettings.json Normal file
View File

@ -0,0 +1,18 @@
{
"sourceFilesToProcess": null,
"additionalIncludeDirectories": [
"../../../core/azure-core/inc",
"../../azure-storage-common/inc",
"../../azure-storage-blobs/inc"
],
"sourceFilesToSkip": [
],
"additionalCompilerSwitches": [],
"allowInternal": false,
"includeDetail": false,
"includePrivate": false,
"filterNamespace": "Azure::Storage::Queues",
"reviewName": "Storage Queues Review",
"serviceName": "Azure Storage Queues",
"packageName": "azure-storage-queues-cpp"
}