From b752357dc51576695e6337ab07ebf8582850ad1b Mon Sep 17 00:00:00 2001 From: George Arama <50641385+gearama@users.noreply.github.com> Date: Thu, 7 Jul 2022 10:59:02 -0700 Subject: [PATCH] Changelog updates for release (#3803) * Changelog updates for relelase * Update with API version * quick update --- .../CHANGELOG.md | 4 ++-- .../certificates/certificate_client_options.hpp | 8 +------- .../src/certificate_client.cpp | 4 ++-- .../test/ut/certificate_client_test.cpp | 17 ++++------------- .../azure-security-keyvault-keys/CHANGELOG.md | 4 ++-- .../azure/keyvault/keys/key_client_options.hpp | 8 +------- .../src/key_client.cpp | 2 +- .../test/ut/key_client_test.cpp | 16 ++++------------ .../CHANGELOG.md | 4 ++-- .../azure/keyvault/secrets/keyvault_options.hpp | 8 +------- .../src/secret_client.cpp | 4 ++-- .../test/ut/secret_client_test.cpp | 17 ++++------------- 12 files changed, 26 insertions(+), 70 deletions(-) diff --git a/sdk/keyvault/azure-security-keyvault-certificates/CHANGELOG.md b/sdk/keyvault/azure-security-keyvault-certificates/CHANGELOG.md index 415d41633..a3ad0491f 100644 --- a/sdk/keyvault/azure-security-keyvault-certificates/CHANGELOG.md +++ b/sdk/keyvault/azure-security-keyvault-certificates/CHANGELOG.md @@ -1,6 +1,6 @@ # Release History -## 4.1.0-beta.1 (Unreleased) +## 4.1.0-beta.1 (2022-07-07) ### Features Added @@ -8,7 +8,7 @@ ### Breaking Changes -- Removed ServiceVersion type, replaced with Version field in the CertificateClientOptions type. +- Removed ServiceVersion type, replaced with ApiVersion field in the CertificateClientOptions type. ## 4.0.0 (2022-06-07) diff --git a/sdk/keyvault/azure-security-keyvault-certificates/inc/azure/keyvault/certificates/certificate_client_options.hpp b/sdk/keyvault/azure-security-keyvault-certificates/inc/azure/keyvault/certificates/certificate_client_options.hpp index fd38a403b..54465aa92 100644 --- a/sdk/keyvault/azure-security-keyvault-certificates/inc/azure/keyvault/certificates/certificate_client_options.hpp +++ b/sdk/keyvault/azure-security-keyvault-certificates/inc/azure/keyvault/certificates/certificate_client_options.hpp @@ -28,13 +28,7 @@ namespace Azure { namespace Security { namespace KeyVault { namespace Certificat * @brief Service Version used. * */ - std::string Version; - - /** - * @brief Construct a new Certificate Client Options object. - * - */ - CertificateClientOptions() : Azure::Core::_internal::ClientOptions() { Version = "7.3"; } + const std::string ApiVersion{"7.3"}; }; }}}} // namespace Azure::Security::KeyVault::Certificates diff --git a/sdk/keyvault/azure-security-keyvault-certificates/src/certificate_client.cpp b/sdk/keyvault/azure-security-keyvault-certificates/src/certificate_client.cpp index fd012dc70..852e0b419 100644 --- a/sdk/keyvault/azure-security-keyvault-certificates/src/certificate_client.cpp +++ b/sdk/keyvault/azure-security-keyvault-certificates/src/certificate_client.cpp @@ -66,9 +66,9 @@ CertificateClient::CertificateClient( std::string const& vaultUrl, std::shared_ptr credential, CertificateClientOptions options) - : m_vaultUrl(vaultUrl), m_apiVersion(options.Version) + : m_vaultUrl(vaultUrl), m_apiVersion(options.ApiVersion) { - auto apiVersion = options.Version; + auto apiVersion = options.ApiVersion; std::vector> perRetrypolicies; { diff --git a/sdk/keyvault/azure-security-keyvault-certificates/test/ut/certificate_client_test.cpp b/sdk/keyvault/azure-security-keyvault-certificates/test/ut/certificate_client_test.cpp index 04b2232f5..b9e8d92f7 100644 --- a/sdk/keyvault/azure-security-keyvault-certificates/test/ut/certificate_client_test.cpp +++ b/sdk/keyvault/azure-security-keyvault-certificates/test/ut/certificate_client_test.cpp @@ -893,17 +893,8 @@ TEST_F(KeyVaultCertificateClientTest, ServiceVersion) { auto credential = std::make_shared("tenantID", "AppId", "SecretId"); - { - // 7.3 - EXPECT_NO_THROW(auto options = CertificateClientOptions(); CertificateClient certificateClient( - "http://account.vault.azure.net", credential, options); - EXPECT_EQ(options.Version, "7.3");); - } - { - // arbitrary version - EXPECT_NO_THROW( - auto options = CertificateClientOptions(); options.Version = "1.0"; - CertificateClient certificateClient("http://account.vault.azure.net", credential, options); - EXPECT_EQ(options.Version, "1.0");); - } + // 7.3 + EXPECT_NO_THROW(auto options = CertificateClientOptions(); CertificateClient certificateClient( + "http://account.vault.azure.net", credential, options); + EXPECT_EQ(options.ApiVersion, "7.3");); } diff --git a/sdk/keyvault/azure-security-keyvault-keys/CHANGELOG.md b/sdk/keyvault/azure-security-keyvault-keys/CHANGELOG.md index becf69558..0bf3216cb 100644 --- a/sdk/keyvault/azure-security-keyvault-keys/CHANGELOG.md +++ b/sdk/keyvault/azure-security-keyvault-keys/CHANGELOG.md @@ -1,6 +1,6 @@ # Release History -## 4.3.0-beta.1 (Unreleased) +## 4.3.0-beta.1 (2022-07-07) ### Features Added @@ -8,7 +8,7 @@ ### Breaking Changes -- Removed ServiceVersion type, replaced with Version field in the KeyClientOptions type. +- Removed ServiceVersion type, replaced with ApiVersion field in the KeyClientOptions type. ## 4.2.0 (2021-10-05) diff --git a/sdk/keyvault/azure-security-keyvault-keys/inc/azure/keyvault/keys/key_client_options.hpp b/sdk/keyvault/azure-security-keyvault-keys/inc/azure/keyvault/keys/key_client_options.hpp index 6e880df9a..8912beddc 100644 --- a/sdk/keyvault/azure-security-keyvault-keys/inc/azure/keyvault/keys/key_client_options.hpp +++ b/sdk/keyvault/azure-security-keyvault-keys/inc/azure/keyvault/keys/key_client_options.hpp @@ -53,13 +53,7 @@ namespace Azure { namespace Security { namespace KeyVault { namespace Keys { * @brief Service Version used. * */ - std::string Version; - - /** - * @brief Construct a new Key Client Options object. - * - */ - KeyClientOptions() : Azure::Core::_internal::ClientOptions() { Version = "7.3"; } + const std::string ApiVersion{"7.3"}; }; /** diff --git a/sdk/keyvault/azure-security-keyvault-keys/src/key_client.cpp b/sdk/keyvault/azure-security-keyvault-keys/src/key_client.cpp index 92e597981..e2456c396 100644 --- a/sdk/keyvault/azure-security-keyvault-keys/src/key_client.cpp +++ b/sdk/keyvault/azure-security-keyvault-keys/src/key_client.cpp @@ -68,7 +68,7 @@ KeyClient::KeyClient( std::string const& vaultUrl, std::shared_ptr credential, KeyClientOptions options) - : m_vaultUrl(vaultUrl), m_apiVersion(options.Version) + : m_vaultUrl(vaultUrl), m_apiVersion(options.ApiVersion) { std::vector> perRetrypolicies; { diff --git a/sdk/keyvault/azure-security-keyvault-keys/test/ut/key_client_test.cpp b/sdk/keyvault/azure-security-keyvault-keys/test/ut/key_client_test.cpp index 4fb590c7d..5b924c9f9 100644 --- a/sdk/keyvault/azure-security-keyvault-keys/test/ut/key_client_test.cpp +++ b/sdk/keyvault/azure-security-keyvault-keys/test/ut/key_client_test.cpp @@ -32,18 +32,10 @@ TEST(KeyVaultKeyClientUnitTest, ServiceVersion) { auto credential = std::make_shared("tenantID", "AppId", "SecretId"); - { - // 7.3 - EXPECT_NO_THROW(auto options = KeyClientOptions(); - KeyClient keyClient("http://account.vault.azure.net", credential, options); - EXPECT_EQ(options.Version, "7.3");); - } - { - // arbitrary version - EXPECT_NO_THROW(auto options = KeyClientOptions(); options.Version = "1.0"; - KeyClient keyClient("http://account.vault.azure.net", credential, options); - EXPECT_EQ(options.Version, "1.0");); - } + // 7.3 + EXPECT_NO_THROW(auto options = KeyClientOptions(); + KeyClient keyClient("http://account.vault.azure.net", credential, options); + EXPECT_EQ(options.ApiVersion, "7.3");); } TEST(KeyVaultKeyClientUnitTest, GetUrl) diff --git a/sdk/keyvault/azure-security-keyvault-secrets/CHANGELOG.md b/sdk/keyvault/azure-security-keyvault-secrets/CHANGELOG.md index 6f0a320b8..e848b7c34 100644 --- a/sdk/keyvault/azure-security-keyvault-secrets/CHANGELOG.md +++ b/sdk/keyvault/azure-security-keyvault-secrets/CHANGELOG.md @@ -1,6 +1,6 @@ # Release History -## 4.1.0-beta.1 (Unreleased) +## 4.1.0-beta.1 (2022-07-07) ### Features Added @@ -8,7 +8,7 @@ ### Breaking Changes -- Removed ServiceVersion type, replaced with Version field in the SecretClientOptions type. +- Removed ServiceVersion type, replaced with ApiVersion field in the SecretClientOptions type. ## 4.0.0 (2022-06-07) diff --git a/sdk/keyvault/azure-security-keyvault-secrets/inc/azure/keyvault/secrets/keyvault_options.hpp b/sdk/keyvault/azure-security-keyvault-secrets/inc/azure/keyvault/secrets/keyvault_options.hpp index fa08daf83..6b3e26a57 100644 --- a/sdk/keyvault/azure-security-keyvault-secrets/inc/azure/keyvault/secrets/keyvault_options.hpp +++ b/sdk/keyvault/azure-security-keyvault-secrets/inc/azure/keyvault/secrets/keyvault_options.hpp @@ -21,13 +21,7 @@ namespace Azure { namespace Security { namespace KeyVault { namespace Secrets { * @brief Service Version used. * */ - std::string Version; - - /** - * @brief Construct a new Secret Client Options object. - * - */ - SecretClientOptions() : Azure::Core::_internal::ClientOptions() { Version = "7.3"; } + const std::string ApiVersion{"7.3"}; }; /** diff --git a/sdk/keyvault/azure-security-keyvault-secrets/src/secret_client.cpp b/sdk/keyvault/azure-security-keyvault-secrets/src/secret_client.cpp index 194a9df4d..ac05dbcdf 100644 --- a/sdk/keyvault/azure-security-keyvault-secrets/src/secret_client.cpp +++ b/sdk/keyvault/azure-security-keyvault-secrets/src/secret_client.cpp @@ -61,9 +61,9 @@ SecretClient::SecretClient( std::string const& vaultUrl, std::shared_ptr credential, SecretClientOptions options) - : m_vaultUrl(vaultUrl), m_apiVersion(options.Version) + : m_vaultUrl(vaultUrl), m_apiVersion(options.ApiVersion) { - auto apiVersion = options.Version; + auto apiVersion = options.ApiVersion; Azure::Core::Url url(vaultUrl); std::vector> perRetrypolicies; diff --git a/sdk/keyvault/azure-security-keyvault-secrets/test/ut/secret_client_test.cpp b/sdk/keyvault/azure-security-keyvault-secrets/test/ut/secret_client_test.cpp index 6358f70d9..0a2d425ce 100644 --- a/sdk/keyvault/azure-security-keyvault-secrets/test/ut/secret_client_test.cpp +++ b/sdk/keyvault/azure-security-keyvault-secrets/test/ut/secret_client_test.cpp @@ -28,19 +28,10 @@ TEST(SecretClient, ServiceVersion) { auto credential = std::make_shared("tenantID", "AppId", "SecretId"); - { - // 7.3 - EXPECT_NO_THROW(auto options = SecretClientOptions(); SecretClient SecretClient( - "http://account.vault.azure.net", credential, options); - EXPECT_EQ(options.Version, "7.3");); - } - { - // arbitrary version - EXPECT_NO_THROW( - auto options = SecretClientOptions(); options.Version = "1.0"; - SecretClient secretClient("http://account.vault.azure.net", credential, options); - EXPECT_EQ(options.Version, "1.0");); - } + // 7.3 + EXPECT_NO_THROW(auto options = SecretClientOptions(); + SecretClient SecretClient("http://account.vault.azure.net", credential, options); + EXPECT_EQ(options.ApiVersion, "7.3");); } TEST(SecretClient, GetUrl)